Package adams.flow.processor

Class ListObjectCommandlines

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.processor.AbstractActorProcessor

adams.flow.processor.AbstractListingProcessor

adams.flow.processor.ListObjectCommandlines

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<ActorProcessor>, SizeOfHandler, ActorProcessor, GraphicalOutputProducingProcessor, ListingProcessor, Serializable, Comparable<ActorProcessor>

public class ListObjectCommandlines
extends AbstractListingProcessor

Lists the command-lines of the objects of the specified superclass.

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 

-classname <adams.core.base.BaseClassname> (property: classname)
    The class to look for.
    default: adams.flow.core.Actor
 

-add-full-actor-name <boolean> (property: addFullActorName)
    Whether to add the full actor name (separated by tab), if the enclosing
    object is of type adams.flow.core.Actor.
    default: false
 

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_AddFullActorName	whether to add the full name of an enclosing actor (if available).
protected Class	m_Class	the class we are looking for.
protected BaseClassname	m_Classname	the classname to look for.

Fields inherited from class adams.flow.processor.AbstractListingProcessor

m_List

Fields inherited from class adams.flow.processor.AbstractActorProcessor

m_Errors

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
ListObjectCommandlines()

Method Summary

Modifier and Type	Method	Description
String	addFullActorNameTipText()	Returns the tip text for this property.
String	classnameTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
boolean	getAddFullActorName()	Returns whether to add the full name of the enclosing actor (if available).
BaseClassname	getClassname()	Returns the class to look for.
protected String	getHeader()	Returns the header to use in the dialog, i.e., the one-liner that explains the output.
String	getTitle()	Returns the title for the dialog.
String	globalInfo()	Returns a string describing the object.
protected boolean	isSortedList()	Returns whether the list should be sorted.
protected boolean	isUniqueList()	Returns whether the list should not contain any duplicates.
protected boolean	isValid(AbstractOption option, Object obj, OptionTraversalPath path)	Checks whether the object is valid and should be added to the list.
protected String	objectToString(AbstractOption option, Object obj, OptionTraversalPath path)	Returns the string representation of the object that is to be added to the list.
void	reset()	Resets the scheme.
void	setAddFullActorName(boolean value)	Sets whether to add the full name of the enclosing actor (if available).
void	setClassname(BaseClassname value)	Sets the class to look for.

Methods inherited from class adams.flow.processor.AbstractListingProcessor

finalizeList, generatesMultipleItems, getDefaultSize, getGraphicalOutput, getList, hasGraphicalOutput, initializeList, objectToStrings, process, processActor

Methods inherited from class adams.flow.processor.AbstractActorProcessor

addError, addError, checkData, compareTo, equals, getErrors, hasErrors, initialize, process, shallowCopy, shallowCopy

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.flow.processor.ActorProcessor

compareTo, getErrors, hasErrors, process, shallowCopy, shallowCopy

Methods inherited from interface adams.core.Destroyable

destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Field Detail

m_Classname

protected BaseClassname m_Classname

the classname to look for.

m_AddFullActorName

protected boolean m_AddFullActorName

whether to add the full name of an enclosing actor (if available).

m_Class

protected transient Class m_Class

the class we are looking for.

Constructor Detail

ListObjectCommandlines

public ListObjectCommandlines()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

reset

public void reset()

Resets the scheme.

Overrides:

reset in class AbstractActorProcessor

setClassname

public void setClassname(BaseClassname value)

Sets the class to look for.

Parameters:

value - the class

getClassname

public BaseClassname getClassname()

Returns the class to look for.

Returns:

the class

classnameTipText

public String classnameTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setAddFullActorName

public void setAddFullActorName(boolean value)

Sets whether to add the full name of the enclosing actor (if available).

Parameters:

value - the class

getAddFullActorName

public boolean getAddFullActorName()

Returns whether to add the full name of the enclosing actor (if available).

Returns:

true if to add

addFullActorNameTipText

public String addFullActorNameTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

objectToString

protected String objectToString(AbstractOption option,
                                Object obj,
                                OptionTraversalPath path)

Returns the string representation of the object that is to be added to the list.

Overrides:

objectToString in class AbstractListingProcessor

Parameters:

option - the current option

obj - the object to turn into a string

path - the traversal path of properties

Returns:

the string representation, null if to ignore the item

isValid

protected boolean isValid(AbstractOption option,
                          Object obj,
                          OptionTraversalPath path)

Checks whether the object is valid and should be added to the list.

Specified by:

isValid in class AbstractListingProcessor

Parameters:

option - the current option

obj - the object to check

path - the traversal path of properties

Returns:

true if valid

isSortedList

protected boolean isSortedList()

Returns whether the list should be sorted.

Specified by:

isSortedList in class AbstractListingProcessor

Returns:

true if the list should get sorted

isUniqueList

protected boolean isUniqueList()

Returns whether the list should not contain any duplicates.

Specified by:

isUniqueList in class AbstractListingProcessor

Returns:

true if the list contains no duplicates

getTitle

public String getTitle()

Returns the title for the dialog.

Returns:

the title

getHeader

protected String getHeader()

Returns the header to use in the dialog, i.e., the one-liner that explains the output.

Specified by:

getHeader in class AbstractListingProcessor

Returns:

the header, null if no header available