Package adams.flow.source

Class AbstractSelectObjects

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.core.AbstractActor

adams.flow.source.AbstractSource

adams.flow.source.AbstractInteractiveSource

adams.flow.source.AbstractInteractiveArrayProvider

adams.flow.source.AbstractSelectObjects

All Implemented Interfaces:

AdditionalInformationHandler, ArrayProvider, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ArrayProvider, AutomatableInteraction, AutomatableInteractiveActor, ErrorHandler, InteractiveActor, InteractiveActorWithCustomParentComponent, OutputProducer, StopModeSupporter, Serializable, Comparable

Direct Known Subclasses:

SelectObjects, WekaSelectObjects

public abstract class AbstractSelectObjects
extends AbstractInteractiveArrayProvider
implements AutomatableInteractiveActor

Ancestor for sources that promp the user to select a number of objects to be broadcasted as tokens.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected BaseString[]	m_InitialObjects	the initial objects.
protected boolean	m_NonInteractive	whether to automate the actor.
protected boolean	m_ShortTitle	whether to use just the actor name or the full name as title.
protected BaseClassname	m_SuperClass	the superclass.

Fields inherited from class adams.flow.source.AbstractInteractiveArrayProvider

m_Index, m_OutputArray, m_Queue

Fields inherited from class adams.flow.source.AbstractInteractiveSource

m_CallableActor, m_CustomStopMessage, m_Helper, m_ParentComponentActor, m_ParentComponentActorConfigured, m_StopFlowIfCanceled, m_StopMode, m_UseOuterWindow

Fields inherited from class adams.flow.core.AbstractActor

m_Annotations, m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_ErrorHandler, m_Executed, m_Executing, m_ExecutionListeningSupporter, m_FullName, m_LoggingPrefix, m_Name, m_Parent, m_ScopeHandler, m_Self, m_Silent, m_Skip, m_StopFlowOnError, m_StopMessage, m_Stopped, m_StorageHandler, m_VariablesUpdated

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Fields inherited from interface adams.flow.core.Actor

FILE_EXTENSION, FILE_EXTENSION_GZ

Fields inherited from interface adams.flow.core.InteractiveActor

INTERACTION_CANCELED

Constructor Summary

Constructors

Constructor	Description
AbstractSelectObjects()

Method Summary

Modifier and Type	Method	Description
protected abstract Object	commandlineToObject(String cmdline)	Turns a commandline into an object.
void	defineOptions()	Adds options to the internal list of options.
protected String	doExecute()	Executes the flow item.
String	doInteract()	Performs the interaction with the user.
BaseString[]	getDefaultInitialObjects()	Returns the default set of objects (in their commandline representation) to use.
protected BaseClassname	getDefaultSuperClass()	Returns the default superclass to use.
BaseString[]	getInitialObjects()	Returns the initial objects.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
boolean	getShortTitle()	Returns whether to use just the name of the actor or the full name.
BaseClassname	getSuperClass()	Returns the superclass for the class hierarchy in use.
protected abstract void	initializeDialog()	Initializes the interactive dialog with the
String	initialObjectsTipText()	Returns the tip text for this property.
boolean	isNonInteractive()	Returns whether interactiveness is enabled/disabled.
String	nonInteractiveTipText()	Returns the tip text for this property.
void	setInitialObjects(BaseString[] value)	Sets the initial objects (commandlines).
void	setNonInteractive(boolean value)	Sets whether to enable/disable interactiveness.
void	setShortTitle(boolean value)	Sets whether to use just the name of the actor or the full name.
void	setSuperClass(BaseClassname value)	Sets the superclass for the class hierarchy to use.
String	shortTitleTipText()	Returns the tip text for this property.
protected abstract Object[]	showDialog()	Displays the dialog, prompting the user to select classes.
String	superClassTipText()	Returns the tip text for this property.

Methods inherited from class adams.flow.source.AbstractInteractiveArrayProvider

generates, getItemClass, getOutputArray, hasPendingOutput, output, outputArrayTipText, preExecute, reset, setOutputArray, wrapUp

Methods inherited from class adams.flow.source.AbstractInteractiveSource

customStopMessageTipText, deregisterWindow, doInteractHeadless, findCallableActor, getActualParentComponent, getCustomStopMessage, getParentComponentActor, getStopFlowIfCanceled, getStopMode, getUseOuterWindow, initialize, parentComponentActorTipText, registerWindow, setCustomStopMessage, setParentComponentActor, setStopFlowIfCanceled, setStopMode, setUseOuterWindow, stopFlowIfCanceledTipText, stopModeTipText, supportsHeadlessInteraction, useOuterWindowTipText

Methods inherited from class adams.flow.core.AbstractActor

annotationsTipText, backupState, canInspectOptions, canPerformSetUpCheck, cleanUp, compareTo, configureLogger, destroy, equals, execute, finalUpdateVariables, findVariables, findVariables, forceVariables, forCommandLine, forName, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, handleException, hasErrorHandler, hasStopMessage, index, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, performVariableChecks, postExecute, pruneBackup, pruneBackup, restoreState, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, silentTipText, sizeOf, skipTipText, stopExecution, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged

Methods inherited from class adams.core.option.AbstractOptionHandler

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

Methods inherited from class adams.core.logging.LoggingObject

getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.flow.core.Actor

cleanUp, compareTo, destroy, equals, execute, findVariables, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, isExecuted, isFinished, isHeadless, isStopped, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, sizeOf, stopExecution, stopExecution, toCommandLine, variableChanged, wrapUp

Methods inherited from interface adams.core.AdditionalInformationHandler

getAdditionalInformation

Methods inherited from interface adams.flow.core.InteractiveActor

customStopMessageTipText, doInteractHeadless, getCustomStopMessage, getStopFlowIfCanceled, setCustomStopMessage, setStopFlowIfCanceled, stopFlowIfCanceledTipText, supportsHeadlessInteraction

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel, setLoggingLevel

Methods inherited from interface adams.core.logging.LoggingSupporter

getLogger, isLoggingEnabled

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager

Methods inherited from interface adams.flow.core.StopModeSupporter

getStopMode, setStopMode, stopModeTipText

Methods inherited from interface adams.core.VariablesInspectionHandler

canInspectOptions

Field Detail

m_SuperClass

protected BaseClassname m_SuperClass

the superclass.

m_InitialObjects

protected BaseString[] m_InitialObjects

the initial objects.

m_NonInteractive

protected boolean m_NonInteractive

whether to automate the actor.

m_ShortTitle

protected boolean m_ShortTitle

whether to use just the actor name or the full name as title.

Constructor Detail

AbstractSelectObjects

public AbstractSelectObjects()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractInteractiveArrayProvider

getDefaultSuperClass

protected BaseClassname getDefaultSuperClass()

Returns the default superclass to use.

Returns:

the default superclass

setSuperClass

public void setSuperClass(BaseClassname value)

Sets the superclass for the class hierarchy to use.

Parameters:

value - the superclass

getSuperClass

public BaseClassname getSuperClass()

Returns the superclass for the class hierarchy in use.

Returns:

the superclass

superClassTipText

public String superClassTipText()

Returns the tip text for this property.

Returns:

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

getDefaultInitialObjects

public BaseString[] getDefaultInitialObjects()

Returns the default set of objects (in their commandline representation) to use.

setInitialObjects

public void setInitialObjects(BaseString[] value)

Sets the initial objects (commandlines).

Parameters:

value - the initial objects

getInitialObjects

public BaseString[] getInitialObjects()

Returns the initial objects.

Returns:

the initial objects

initialObjectsTipText

public String initialObjectsTipText()

Returns the tip text for this property.

Returns:

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

setNonInteractive

public void setNonInteractive(boolean value)

Sets whether to enable/disable interactiveness.

Specified by:

setNonInteractive in interface AutomatableInteraction

Specified by:

setNonInteractive in interface AutomatableInteractiveActor

Parameters:

value - if true actor is not interactive, but automated

isNonInteractive

public boolean isNonInteractive()

Returns whether interactiveness is enabled/disabled.

Specified by:

isNonInteractive in interface AutomatableInteraction

Specified by:

isNonInteractive in interface AutomatableInteractiveActor

Returns:

true if actor is not interactive i.e., automated

nonInteractiveTipText

public String nonInteractiveTipText()

Returns the tip text for this property.

Specified by:

nonInteractiveTipText in interface AutomatableInteraction

Specified by:

nonInteractiveTipText in interface AutomatableInteractiveActor

Returns:

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

setShortTitle

public void setShortTitle(boolean value)

Sets whether to use just the name of the actor or the full name.

Parameters:

value - if true just the name will get used, otherwise the full name

getShortTitle

public boolean getShortTitle()

Returns whether to use just the name of the actor or the full name.

Returns:

true if just the name used, otherwise full name

shortTitleTipText

public String shortTitleTipText()

Returns the tip text for this property.

Returns:

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

getQuickInfo

public String getQuickInfo()

Returns a quick info about the actor, which will be displayed in the GUI.

Specified by:

getQuickInfo in interface Actor

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractActor

Returns:

null if no info available, otherwise short string

commandlineToObject

protected abstract Object commandlineToObject(String cmdline)

Turns a commandline into an object.

Parameters:

cmdline - the commandline to convert

Returns:

the generated object, null if failed to convert

initializeDialog

protected abstract void initializeDialog()

Initializes the interactive dialog with the

showDialog

protected abstract Object[] showDialog()

Displays the dialog, prompting the user to select classes.

Returns:

the selected objects, null in case of user cancelling the dialog

doInteract

public String doInteract()

Performs the interaction with the user.

Specified by:

doInteract in interface InteractiveActor

Specified by:

doInteract in class AbstractInteractiveSource

Returns:

null if successfully interacted

doExecute

protected String doExecute()

Executes the flow item.

Overrides:

doExecute in class AbstractInteractiveSource

Returns:

null if everything is fine, otherwise error message