Package adams.flow.source

Class StringConstants

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

adams.flow.source.StringConstants

All Implemented Interfaces:

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

public class StringConstants
extends AbstractArrayProvider

A source for 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: StringConstants
 

-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 execution at this level gets stopped in case this 
    actor encounters an error; the error gets propagated; useful for critical 
    actors.
    default: false
 

-silent <boolean> (property: silent)
    If enabled, then no errors are output in the console; Note: the enclosing 
    actor handler must have this enabled as well.
    default: false
 

-output-array <boolean> (property: outputArray)
    Whether to output the strings as an array or one by one.
    default: false
 

-string <adams.core.base.BaseString> [-string ...] (property: strings)
    The strings to provide.
    default: 
 

-conversion <adams.data.conversion.Conversion> (property: conversion)
    The type of conversion to perform.
    default: adams.data.conversion.StringToString
 

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Conversion	m_Conversion	the type of conversion.
protected BaseString[]	m_Strings	the strings to provide.

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

Constructor Summary

Constructors

Constructor	Description
StringConstants()	Default constructor.
StringConstants(BaseString[] strings)	Initializes with the specified strings.
StringConstants(String[] strings)	Initializes with the specified strings.

Method Summary

Modifier and Type	Method	Description
void	addString(BaseString value)	Adds the string.
void	addString(String value)	Adds the string.
String	conversionTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
protected String	doExecute()	Executes the flow item.
Conversion	getConversion()	Returns the type of conversion to perform.
protected Class	getItemClass()	Returns the based class of the items.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
BaseString[]	getStrings()	Returns the strings to output.
String	globalInfo()	Returns a string describing the object.
String	outputArrayTipText()	Returns the tip text for this property.
void	setConversion(Conversion value)	Sets the type of conversion to perform.
void	setStrings(BaseString[] value)	Sets the strings to output.
void	setStrings(String[] value)	Sets the strings to output.
String	stringsTipText()	Returns the tip text for this property.

Methods inherited from class adams.flow.source.AbstractArrayProvider

generates, getOutputArray, hasPendingOutput, output, preExecute, reset, 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, initialize, 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

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_Strings

protected BaseString[] m_Strings

the strings to provide.

m_Conversion

protected Conversion m_Conversion

the type of conversion.

Constructor Detail

StringConstants

public StringConstants()

Default constructor.

StringConstants

public StringConstants(BaseString[] strings)

Initializes with the specified strings.

Parameters:

strings - the strings to use

StringConstants

public StringConstants(String[] strings)

Initializes with the specified strings.

Parameters:

strings - the strings to use

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 AbstractArrayProvider

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

getItemClass

protected Class getItemClass()

Returns the based class of the items.

Specified by:

getItemClass in class AbstractArrayProvider

Returns:

the class

outputArrayTipText

public String outputArrayTipText()

Returns the tip text for this property.

Specified by:

outputArrayTipText in interface ArrayProvider

Specified by:

outputArrayTipText in interface ArrayProvider

Specified by:

outputArrayTipText in class AbstractArrayProvider

Returns:

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

addString

public void addString(String value)

Adds the string.

Parameters:

value - the string to add

addString

public void addString(BaseString value)

Adds the string.

Parameters:

value - the string to add

setStrings

public void setStrings(String[] value)

Sets the strings to output.

Parameters:

value - the output

setStrings

public void setStrings(BaseString[] value)

Sets the strings to output.

Parameters:

value - the output

getStrings

public BaseString[] getStrings()

Returns the strings to output.

Returns:

the output

stringsTipText

public String stringsTipText()

Returns the tip text for this property.

Returns:

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

setConversion

public void setConversion(Conversion value)

Sets the type of conversion to perform.

Parameters:

value - the type of conversion

getConversion

public Conversion getConversion()

Returns the type of conversion to perform.

Returns:

the type of conversion

conversionTipText

public String conversionTipText()

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