Package adams.flow.source
Class WekaSelectDataset
-
- 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
public class WekaSelectDataset extends AbstractArrayProvider implements InteractiveActorWithCustomParentComponent, AutomatableInteractiveActor
Pops up a file chooser dialog, prompting the user to select one or more datasets. The filenames of the datasets then get forwarded as strings.
Input/output:
- generates:
java.lang.String
-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel) The logging level for outputting errors and debugging output. default: WARNING
-name <java.lang.String> (property: name) The name of the actor. default: WekaSelectDataset
-annotation <adams.core.base.BaseAnnotation> (property: annotations) The annotations to attach to this actor. default:
-skip <boolean> (property: skip) If set to true, transformation is skipped and the input token is just forwarded as it is. default: false
-stop-flow-on-error <boolean> (property: stopFlowOnError) If set to true, the flow gets stopped in case this actor encounters an error; useful for critical actors. default: false
-silent <boolean> (property: silent) If enabled, then no errors are output in the console. default: false
-output-array <boolean> (property: outputArray) Whether to output the files as array or one-by-one. default: false
-stop-if-canceled <boolean> (property: stopFlowIfCanceled) If enabled, the flow gets stopped in case the user cancels the dialog. default: false
-custom-stop-message <java.lang.String> (property: customStopMessage) The custom stop message to use in case a user cancelation stops the flow (default is the full name of the actor) default:
-file-chooser-title <java.lang.String> (property: fileChooserTitle) The title for the file chooser dialog. default:
-initial-dir <adams.core.io.PlaceholderDirectory> (property: initialDirectory) The initial directory for the file chooser. default: ${CWD}-initial-file <adams.core.io.PlaceholderFile> [-initial-file ...] (property: initialFiles) The initial files for the file chooser. default:
-non-interactive <boolean> (property: nonInteractive) If enabled, the initial value is forwarded without user interaction. default: false
- Author:
- fracpete (fracpete at waikato dot ac dot nz)
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected Actorm_CallableActorthe callable actor.protected Stringm_CustomStopMessagethe custom stop message to use if flow gets stopped due to cancelation.protected Stringm_FileChooserTitlethe title of the file chooser dialog.protected CallableActorHelperm_Helperthe helper class.protected PlaceholderDirectorym_InitialDirectorythe initial directory.protected PlaceholderFile[]m_InitialFilesthe initial files to use.protected booleanm_NonInteractivewhether to automate the actor.protected CallableActorReferencem_ParentComponentActorthe (optional) parent component to use.protected booleanm_ParentComponentActorConfiguredwhether the callable actor has been configured.protected booleanm_StopFlowIfCanceledwhether to stop the flow if canceled.protected StopModem_StopModehow to perform the stop.protected booleanm_UseOuterWindowwhether to use the outer window as parent.-
Fields inherited from class adams.flow.source.AbstractArrayProvider
m_Index, m_OutputArray, m_Queue
-
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 WekaSelectDataset()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StringcustomStopMessageTipText()Returns the tip text for this property.voiddefineOptions()Adds options to the internal list of options.protected StringdoExecute()Executes the flow item.StringdoInteract()Performs the interaction with the user.StringdoInteractHeadless()Performs the interaction with the user in a headless environment.StringfileChooserTitleTipText()Returns the tip text for this property.protected ActorfindCallableActor()Tries to find the callable actor referenced by its callable name.ComponentgetActualParentComponent()Returns the parent component to use.StringgetCustomStopMessage()Returns the custom message to use when stopping the flow.StringgetFileChooserTitle()Returns the title for the file chooser dialog.PlaceholderDirectorygetInitialDirectory()Returns the initial directory.PlaceholderFile[]getInitialFiles()Returns the initial files.protected ClassgetItemClass()Returns the base class of the items.CallableActorReferencegetParentComponentActor()Returns the (optional) callable actor to use as parent component instead of the flow panel.StringgetQuickInfo()Returns a quick info about the actor, which will be displayed in the GUI.booleangetStopFlowIfCanceled()Returns whether to stop the flow if dialog canceled.StopModegetStopMode()Returns the stop mode.booleangetUseOuterWindow()Returns whether to use the outer window as parent.StringglobalInfo()Returns a string describing the object.StringinitialDirectoryTipText()Returns the tip text for this property.StringinitialFilesTipText()Returns the tip text for this property.protected voidinitialize()Initializes the members.booleanisNonInteractive()Returns whether interactiveness is enabled/disabled.StringnonInteractiveTipText()Returns the tip text for this property.StringoutputArrayTipText()Returns the tip text for this property.StringparentComponentActorTipText()Returns the tip text for this property.protected voidreset()Resets the scheme.voidsetCustomStopMessage(String value)Sets the custom message to use when stopping the flow.voidsetFileChooserTitle(String value)Sets the title for the file chooser dialog.voidsetInitialDirectory(PlaceholderDirectory value)Sets the initial directory.voidsetInitialFiles(PlaceholderFile[] value)Sets the initial files.voidsetNonInteractive(boolean value)Sets whether to enable/disable interactiveness.voidsetParentComponentActor(CallableActorReference value)Sets the (optional) callable actor to use as parent component instead of the flow panel.voidsetStopFlowIfCanceled(boolean value)Sets whether to stop the flow if dialog canceled.voidsetStopMode(StopMode value)Sets the stop mode.voidsetUseOuterWindow(boolean value)Sets whether to use the outer window as parent.StringstopFlowIfCanceledTipText()Returns the tip text for this property.StringstopModeTipText()Returns the tip text for this property.booleansupportsHeadlessInteraction()Returns whether headless interaction is supported.StringuseOuterWindowTipText()Returns the tip text for this property.-
Methods inherited from class adams.flow.source.AbstractArrayProvider
generates, getOutputArray, hasPendingOutput, output, preExecute, setOutputArray, wrapUp
-
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, 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.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.core.VariablesInspectionHandler
canInspectOptions
-
-
-
-
Field Detail
-
m_FileChooserTitle
protected String m_FileChooserTitle
the title of the file chooser dialog.
-
m_InitialDirectory
protected PlaceholderDirectory m_InitialDirectory
the initial directory.
-
m_InitialFiles
protected PlaceholderFile[] m_InitialFiles
the initial files to use.
-
m_StopFlowIfCanceled
protected boolean m_StopFlowIfCanceled
whether to stop the flow if canceled.
-
m_CustomStopMessage
protected String m_CustomStopMessage
the custom stop message to use if flow gets stopped due to cancelation.
-
m_StopMode
protected StopMode m_StopMode
how to perform the stop.
-
m_NonInteractive
protected boolean m_NonInteractive
whether to automate the actor.
-
m_ParentComponentActor
protected CallableActorReference m_ParentComponentActor
the (optional) parent component to use.
-
m_CallableActor
protected Actor m_CallableActor
the callable actor.
-
m_ParentComponentActorConfigured
protected boolean m_ParentComponentActorConfigured
whether the callable actor has been configured.
-
m_Helper
protected CallableActorHelper m_Helper
the helper class.
-
m_UseOuterWindow
protected boolean m_UseOuterWindow
whether to use the outer window as parent.
-
-
Method Detail
-
globalInfo
public String globalInfo()
Returns a string describing the object.- Specified by:
globalInfoin interfaceGlobalInfoSupporter- Specified by:
globalInfoin classAbstractOptionHandler- Returns:
- a description suitable for displaying in the gui
-
defineOptions
public void defineOptions()
Adds options to the internal list of options.- Specified by:
defineOptionsin interfaceOptionHandler- Overrides:
defineOptionsin classAbstractArrayProvider
-
reset
protected void reset()
Resets the scheme.- Overrides:
resetin classAbstractArrayProvider
-
initialize
protected void initialize()
Initializes the members.- Overrides:
initializein classAbstractActor
-
getQuickInfo
public String getQuickInfo()
Returns a quick info about the actor, which will be displayed in the GUI.- Specified by:
getQuickInfoin interfaceActor- Specified by:
getQuickInfoin interfaceQuickInfoSupporter- Overrides:
getQuickInfoin classAbstractActor- Returns:
- null if no info available, otherwise short string
-
outputArrayTipText
public String outputArrayTipText()
Returns the tip text for this property.- Specified by:
outputArrayTipTextin interfaceArrayProvider- Specified by:
outputArrayTipTextin interfaceArrayProvider- Specified by:
outputArrayTipTextin classAbstractArrayProvider- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setFileChooserTitle
public void setFileChooserTitle(String value)
Sets the title for the file chooser dialog.- Parameters:
value- the title
-
getFileChooserTitle
public String getFileChooserTitle()
Returns the title for the file chooser dialog.- Returns:
- the title
-
fileChooserTitleTipText
public String fileChooserTitleTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setInitialDirectory
public void setInitialDirectory(PlaceholderDirectory value)
Sets the initial directory.- Parameters:
value- the initial directory
-
getInitialDirectory
public PlaceholderDirectory getInitialDirectory()
Returns the initial directory.- Returns:
- the initial directory
-
initialDirectoryTipText
public String initialDirectoryTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setInitialFiles
public void setInitialFiles(PlaceholderFile[] value)
Sets the initial files.- Parameters:
value- the initial files
-
getInitialFiles
public PlaceholderFile[] getInitialFiles()
Returns the initial files.- Returns:
- the initial files
-
initialFilesTipText
public String initialFilesTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setStopFlowIfCanceled
public void setStopFlowIfCanceled(boolean value)
Sets whether to stop the flow if dialog canceled.- Specified by:
setStopFlowIfCanceledin interfaceInteractiveActor- Parameters:
value- if true flow gets stopped if dialog canceled
-
getStopFlowIfCanceled
public boolean getStopFlowIfCanceled()
Returns whether to stop the flow if dialog canceled.- Specified by:
getStopFlowIfCanceledin interfaceInteractiveActor- Returns:
- true if the flow gets stopped if dialog canceled
-
stopFlowIfCanceledTipText
public String stopFlowIfCanceledTipText()
Returns the tip text for this property.- Specified by:
stopFlowIfCanceledTipTextin interfaceInteractiveActor- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setCustomStopMessage
public void setCustomStopMessage(String value)
Sets the custom message to use when stopping the flow.- Specified by:
setCustomStopMessagein interfaceInteractiveActor- Parameters:
value- the stop message
-
getCustomStopMessage
public String getCustomStopMessage()
Returns the custom message to use when stopping the flow.- Specified by:
getCustomStopMessagein interfaceInteractiveActor- Returns:
- the stop message
-
customStopMessageTipText
public String customStopMessageTipText()
Returns the tip text for this property.- Specified by:
customStopMessageTipTextin interfaceInteractiveActor- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setStopMode
public void setStopMode(StopMode value)
Sets the stop mode.- Specified by:
setStopModein interfaceStopModeSupporter- Parameters:
value- the mode
-
getStopMode
public StopMode getStopMode()
Returns the stop mode.- Specified by:
getStopModein interfaceStopModeSupporter- Returns:
- the mode
-
stopModeTipText
public String stopModeTipText()
Returns the tip text for this property.- Specified by:
stopModeTipTextin interfaceStopModeSupporter- 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:
setNonInteractivein interfaceAutomatableInteraction- Specified by:
setNonInteractivein interfaceAutomatableInteractiveActor- Parameters:
value- if true actor is not interactive, but automated
-
isNonInteractive
public boolean isNonInteractive()
Returns whether interactiveness is enabled/disabled.- Specified by:
isNonInteractivein interfaceAutomatableInteraction- Specified by:
isNonInteractivein interfaceAutomatableInteractiveActor- Returns:
- true if actor is not interactive i.e., automated
-
nonInteractiveTipText
public String nonInteractiveTipText()
Returns the tip text for this property.- Specified by:
nonInteractiveTipTextin interfaceAutomatableInteraction- Specified by:
nonInteractiveTipTextin interfaceAutomatableInteractiveActor- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setParentComponentActor
public void setParentComponentActor(CallableActorReference value)
Sets the (optional) callable actor to use as parent component instead of the flow panel.- Specified by:
setParentComponentActorin interfaceInteractiveActorWithCustomParentComponent- Parameters:
value- the callable actor
-
getParentComponentActor
public CallableActorReference getParentComponentActor()
Returns the (optional) callable actor to use as parent component instead of the flow panel.- Specified by:
getParentComponentActorin interfaceInteractiveActorWithCustomParentComponent- Returns:
- the callable actor
-
parentComponentActorTipText
public String parentComponentActorTipText()
Returns the tip text for this property.- Specified by:
parentComponentActorTipTextin interfaceInteractiveActorWithCustomParentComponent- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setUseOuterWindow
public void setUseOuterWindow(boolean value)
Sets whether to use the outer window as parent.- Specified by:
setUseOuterWindowin interfaceInteractiveActorWithCustomParentComponent- Parameters:
value- true if to use outer window
-
getUseOuterWindow
public boolean getUseOuterWindow()
Returns whether to use the outer window as parent.- Specified by:
getUseOuterWindowin interfaceInteractiveActorWithCustomParentComponent- Returns:
- true if to use outer window
-
useOuterWindowTipText
public String useOuterWindowTipText()
Returns the tip text for this property.- Specified by:
useOuterWindowTipTextin interfaceInteractiveActorWithCustomParentComponent- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
findCallableActor
protected Actor findCallableActor()
Tries to find the callable actor referenced by its callable name.- Returns:
- the callable actor or null if not found
-
getActualParentComponent
public Component getActualParentComponent()
Returns the parent component to use.- Specified by:
getActualParentComponentin interfaceInteractiveActorWithCustomParentComponent- Returns:
- the parent
-
getItemClass
protected Class getItemClass()
Returns the base class of the items.- Specified by:
getItemClassin classAbstractArrayProvider- Returns:
- the class
-
doInteract
public String doInteract()
Performs the interaction with the user.- Specified by:
doInteractin interfaceInteractiveActor- Returns:
- null if successfully interacted, otherwise error message
-
supportsHeadlessInteraction
public boolean supportsHeadlessInteraction()
Returns whether headless interaction is supported.- Specified by:
supportsHeadlessInteractionin interfaceInteractiveActor- Returns:
- true if interaction in headless environment is possible
-
doInteractHeadless
public String doInteractHeadless()
Performs the interaction with the user in a headless environment.- Specified by:
doInteractHeadlessin interfaceInteractiveActor- Returns:
- true if successfully interacted
-
doExecute
protected String doExecute()
Executes the flow item.- Specified by:
doExecutein classAbstractActor- Returns:
- null if everything is fine, otherwise error message
-
-