Package adams.flow.standalone

Class Java

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.core.AbstractActor

adams.flow.standalone.AbstractStandalone

adams.flow.standalone.Java

All Implemented Interfaces:

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

public class Java
extends AbstractStandalone

Calls the main method of a Java class.

Valid options are:

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

-annotation <adams.core.base.BaseText> (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
 

-cmd <java.lang.String> (property: command)
    The command to run, Java classname with options.
    default: adams.core.SystemInfo
 

-placeholder <boolean> (property: commandContainsPlaceholder)
    Set this to true to enable automatic placeholder expansion for the command 
    string.
    default: false
 

-variable <boolean> (property: commandContainsVariable)
    Set this to true to enable automatic variable expansion for the command 
    string.
    default: false
 

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	m_Command	the command to run.
protected boolean	m_CommandContainsPlaceholder	whether the replace string contains a placeholder, which needs to be expanded first.
protected boolean	m_CommandContainsVariable	whether the replace string contains a variable, which needs to be expanded first.

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

Constructor Summary

Constructors

Constructor	Description
Java()

Method Summary

Modifier and Type	Method	Description
String	commandContainsPlaceholderTipText()	Returns the tip text for this property.
String	commandContainsVariableTipText()	Returns the tip text for this property.
String	commandTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
protected String	doExecute()	Executes the flow item.
String	getCommand()	Returns the command to run.
boolean	getCommandContainsPlaceholder()	Returns whether the command string contains a placeholder which needs to be expanded first.
boolean	getCommandContainsVariable()	Returns whether the command string contains a variable which needs to be expanded first.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
String	globalInfo()	Returns a string describing the object.
void	setCommand(String value)	Sets the command to run.
void	setCommandContainsPlaceholder(boolean value)	Sets whether the command string contains a placeholder which needs to be expanded first.
void	setCommandContainsVariable(boolean value)	Sets whether the command string contains a variable which needs to be expanded first.

Methods inherited from class adams.flow.standalone.AbstractStandalone

preExecute

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, initialize, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, performVariableChecks, postExecute, pruneBackup, pruneBackup, reset, 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

toCommandLine

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

Field Detail

m_Command

protected String m_Command

the command to run.

m_CommandContainsPlaceholder

protected boolean m_CommandContainsPlaceholder

whether the replace string contains a placeholder, which needs to be expanded first.

m_CommandContainsVariable

protected boolean m_CommandContainsVariable

whether the replace string contains a variable, which needs to be expanded first.

Constructor Detail

Java

public Java()

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 AbstractActor

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

setCommand

public void setCommand(String value)

Sets the command to run.

Parameters:

value - the command

getCommand

public String getCommand()

Returns the command to run.

Returns:

the command

commandTipText

public String commandTipText()

Returns the tip text for this property.

Returns:

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

setCommandContainsPlaceholder

public void setCommandContainsPlaceholder(boolean value)

Sets whether the command string contains a placeholder which needs to be expanded first.

Parameters:

value - true if command string contains a placeholder

getCommandContainsPlaceholder

public boolean getCommandContainsPlaceholder()

Returns whether the command string contains a placeholder which needs to be expanded first.

Returns:

true if command string contains a placeholder

commandContainsPlaceholderTipText

public String commandContainsPlaceholderTipText()

Returns the tip text for this property.

Returns:

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

setCommandContainsVariable

public void setCommandContainsVariable(boolean value)

Sets whether the command string contains a variable which needs to be expanded first.

Parameters:

value - true if command string contains a variable

getCommandContainsVariable

public boolean getCommandContainsVariable()

Returns whether the command string contains a variable which needs to be expanded first.

Returns:

true if command string contains a variable

commandContainsVariableTipText

public String commandContainsVariableTipText()

Returns the tip text for this property.

Returns:

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

doExecute

protected String doExecute()

Executes the flow item.

Specified by:

doExecute in class AbstractActor

Returns:

null if everything is fine, otherwise error message