Package adams.flow.source

Class SelectCharset

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.SelectCharset

All Implemented Interfaces:

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

public class SelectCharset
extends AbstractInteractiveSource
implements AutomatableInteractiveActor

Prompts the user to select a character set.

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: SelectCharset
 

-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
 

-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: 
 

-initial-charset <adams.core.base.BaseCharset> (property: initialCharset)
    The initial character set to use for the dialog.
    default: Default
 

-non-interactive <boolean> (property: nonInteractive)
    If enabled, the initial directory 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 BaseCharset	m_InitialCharset	the initial directory.
protected boolean	m_NonInteractive	whether to automate the actor.
protected Token	m_OutputToken	for the chosen directory.

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
SelectCharset()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
String	doInteract()	Performs the interaction with the user.
String	doInteractHeadless()	Performs the interaction with the user in a headless environment.
Class[]	generates()	Returns the class of objects that it generates.
BaseCharset	getInitialCharset()	Returns the initial character set.
protected Class	getItemClass()	Returns the base class of the items.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
String	globalInfo()	Returns a string describing the object.
boolean	hasPendingOutput()	Checks whether there is pending output to be collected after executing the flow item.
String	initialCharsetTipText()	Returns the tip text for this property.
boolean	isNonInteractive()	Returns whether interactiveness is enabled/disabled.
String	nonInteractiveTipText()	Returns the tip text for this property.
Token	output()	Returns the generated token.
protected void	reset()	Resets the actor.
void	setInitialCharset(BaseCharset value)	Sets the initial character set.
void	setNonInteractive(boolean value)	Sets whether to enable/disable interactiveness.
boolean	supportsHeadlessInteraction()	Returns whether headless interaction is supported.

Methods inherited from class adams.flow.source.AbstractInteractiveSource

customStopMessageTipText, deregisterWindow, doExecute, findCallableActor, getActualParentComponent, getCustomStopMessage, getParentComponentActor, getStopFlowIfCanceled, getStopMode, getUseOuterWindow, initialize, parentComponentActorTipText, registerWindow, setCustomStopMessage, setParentComponentActor, setStopFlowIfCanceled, setStopMode, setUseOuterWindow, stopFlowIfCanceledTipText, stopModeTipText, 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, preExecute, pruneBackup, pruneBackup, restoreState, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, silentTipText, sizeOf, skipTipText, stopExecution, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged, wrapUp

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.flow.core.InteractiveActor

customStopMessageTipText, getCustomStopMessage, getStopFlowIfCanceled, setCustomStopMessage, setStopFlowIfCanceled, stopFlowIfCanceledTipText

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_InitialCharset

protected BaseCharset m_InitialCharset

the initial directory.

m_NonInteractive

protected boolean m_NonInteractive

whether to automate the actor.

m_OutputToken

protected Token m_OutputToken

for the chosen directory.

Constructor Detail

SelectCharset

public SelectCharset()

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 AbstractInteractiveSource

reset

protected void reset()

Resets the actor.

Overrides:

reset in class AbstractInteractiveSource

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

setInitialCharset

public void setInitialCharset(BaseCharset value)

Sets the initial character set.

Parameters:

value - the initial character set

getInitialCharset

public BaseCharset getInitialCharset()

Returns the initial character set.

Returns:

the initial character set

initialCharsetTipText

public String initialCharsetTipText()

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.

getItemClass

protected Class getItemClass()

Returns the base class of the items.

Returns:

the class

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, otherwise error message

supportsHeadlessInteraction

public boolean supportsHeadlessInteraction()

Returns whether headless interaction is supported.

Specified by:

supportsHeadlessInteraction in interface InteractiveActor

Overrides:

supportsHeadlessInteraction in class AbstractInteractiveSource

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:

doInteractHeadless in interface InteractiveActor

Overrides:

doInteractHeadless in class AbstractInteractiveSource

Returns:

true if successfully interacted

generates

public Class[] generates()

Returns the class of objects that it generates.

Specified by:

generates in interface OutputProducer

Returns:

the Class of the generated tokens

output

public Token output()

Returns the generated token.

Specified by:

output in interface OutputProducer

Returns:

the generated token

hasPendingOutput

public boolean hasPendingOutput()

Checks whether there is pending output to be collected after executing the flow item.

Specified by:

hasPendingOutput in interface OutputProducer

Returns:

true if there is pending output