Package adams.flow.core

Interface InteractiveActor

All Superinterfaces:

Actor, AdditionalInformationHandler, CleanUpHandler, Comparable, Destroyable, ErrorHandler, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, Serializable, ShallowCopySupporter<Actor>, StopModeSupporter, Stoppable, StoppableWithFeedback, VariableChangeListener, VariablesInspectionHandler

All Known Subinterfaces:

AutomatableInteractiveActor, InteractiveActorWithCustomParentComponent, OptionalPasswordPrompt

All Known Implementing Classes:

AbstractDatabaseConnection, AbstractInteractiveArrayProvider, AbstractInteractiveSource, AbstractInteractiveTransformer, AbstractInteractiveTransformerDialog, AbstractSelectObjects, CompareObjectLocations, ConfirmationDialog, DatabaseConnection, EnterManyValues, EnterValue, ImageAnnotator, ImageLabeler, ImageObjectAnnotator, ImageSegmentationAnnotator, IMAPConnection, Inspect, PasteFromClipboard, PixelSelector, ProcessActor, RemoveOutliers, SelectArraySubset, SelectCharset, SelectDateTime, SelectDirectory, SelectFile, SelectObjects, SMBConnection, SMTPConnection, SpreadSheetCellSelector, SpreadSheetSelectSubset, SSHConnection, WekaChooseAttributes, WekaSelectDataset, WekaSelectObjects

public interface InteractiveActor
extends Actor, StopModeSupporter

Interface for actors that interact with the user.

Author:

fracpete (fracpete at waikato dot ac dot nz)

Field Summary

Fields

Modifier and Type	Field	Description
static String	INTERACTION_CANCELED

Fields inherited from interface adams.flow.core.Actor

FILE_EXTENSION, FILE_EXTENSION_GZ

Method Summary

Modifier and Type	Method	Description
String	customStopMessageTipText()	Returns the tip text for this property.
String	doInteract()	Performs the interaction with the user.
String	doInteractHeadless()	Performs the interaction with the user in a headless environment.
String	getCustomStopMessage()	Returns the custom message to use when stopping the flow.
boolean	getStopFlowIfCanceled()	Returns whether to stop the flow if dialog canceled.
void	setCustomStopMessage(String value)	Sets the custom message to use when stopping the flow.
void	setStopFlowIfCanceled(boolean value)	Sets whether to stop the flow if dialog canceled.
String	stopFlowIfCanceledTipText()	Returns the tip text for this property.
boolean	supportsHeadlessInteraction()	Returns whether headless interaction is supported.

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, getQuickInfo, 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, defineOptions, getOptionManager

Methods inherited from interface adams.flow.core.StopModeSupporter

getStopMode, setStopMode, stopModeTipText

Methods inherited from interface adams.core.VariablesInspectionHandler

canInspectOptions

Field Detail

INTERACTION_CANCELED

static final String INTERACTION_CANCELED

See Also:

Constant Field Values

Method Detail

setStopFlowIfCanceled

void setStopFlowIfCanceled(boolean value)

Sets whether to stop the flow if dialog canceled.

Parameters:

value - if true flow gets stopped if dialog canceled

getStopFlowIfCanceled

boolean getStopFlowIfCanceled()

Returns whether to stop the flow if dialog canceled.

Returns:

true if the flow gets stopped if dialog canceled

stopFlowIfCanceledTipText

String stopFlowIfCanceledTipText()

Returns the tip text for this property.

Returns:

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

setCustomStopMessage

void setCustomStopMessage(String value)

Sets the custom message to use when stopping the flow.

Parameters:

value - the stop message

getCustomStopMessage

String getCustomStopMessage()

Returns the custom message to use when stopping the flow.

Returns:

the stop message

customStopMessageTipText

String customStopMessageTipText()

Returns the tip text for this property.

Returns:

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

doInteract

String doInteract()

Performs the interaction with the user.

Returns:

null if successfully interacted, otherwise error message

supportsHeadlessInteraction

boolean supportsHeadlessInteraction()

Returns whether headless interaction is supported.

Returns:

true if interaction in headless environment is possible

doInteractHeadless

String doInteractHeadless()

Performs the interaction with the user in a headless environment.

Returns:

null if successfully interacted, otherwise error message