adams.flow.source
Class LookUp

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.flow.core.AbstractActor
              adams.flow.source.AbstractSource
                  adams.flow.source.LookUp

All Implemented Interfaces:

AdditionalInformationHandler, CleanUpHandler, Debuggable, DebugOutputHandler, Destroyable, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<AbstractActor>, SizeOfHandler, Stoppable, VariableChangeListener, Actor, ErrorHandler, OutputProducer, Serializable, Comparable

public class LookUp
extends AbstractSource

Forwards the value associated with the given key, using the specified lookup table from internal storage.

Input/output:
- generates:
java.lang.String

Valid options are:

-D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to 
    the console (0 = off).
    default: 0
    minimum: 0
 

-name <java.lang.String> (property: name)
    The name of the actor.
    default: LookUp
 

-annotation <adams.core.base.BaseText> (property: annotations)
    The annotations to attach to this actor.
    default: 
 

-skip (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded 
    as it is.
 

-stop-flow-on-error (property: stopFlowOnError)
    If set to true, the flow gets stopped in case this actor encounters an error;
     useful for critical actors.
 

-storage-name <adams.flow.control.StorageName> (property: storageName)
    The name of the lookup table in the internal storage.
    default: lookup
 

-key <java.lang.String> (property: key)
    The key of the value to output.
    default: 
 

-missing-key <NO_OUTPUT|OUTPUT_MISSING_VALUE|OUTPUT_KEY|CAUSE_ERROR> (property: missingKey)
    The behavior in case a lookup key is missing (ie not found in the lookup 
    table).
    default: NO_OUTPUT
 

-missing-value <java.lang.String> (property: missingValue)
    The value to forward if the missing key behavior is OUTPUT_MISSING_VALUE.
    default: ???
 

Version:

$Revision: 6830 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

protected String	m_Key the key to lookup and forward the value for.
protected MissingLookUpKey	m_MissingKey the behavior for missing keys.
protected String	m_MissingValue the missing value (only used for MissingValue#OUTPUT_MISSING_VALUE).
protected Token	m_OutputToken the token to forward.
protected StorageName	m_StorageName the name of the lookup table in the internal storage.

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_Headless, m_Name, m_Parent, m_Root, m_ScopeHandler, m_Self, m_Skip, m_StopFlowOnError, m_StopMessage, m_Stopped, m_StorageHandler, m_VariablesUpdated

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Fields inherited from interface adams.flow.core.Actor

FILE_EXTENSION, FILE_EXTENSION_GZ

Constructor Summary

LookUp()

Method Summary

void	defineOptions() Adds options to the internal list of options.
protected String	doExecute() Executes the flow item.
Class[]	generates() Returns the class of objects that it generates.
String	getKey() Returns the key of the value to output.
MissingLookUpKey	getMissingKey() Returns the behavior for missing keys.
String	getMissingValue() Returns the value used if behavior is MissingLookUpKey.OUTPUT_MISSING_VALUE.
String	getQuickInfo() Returns a quick info about the actor, which will be displayed in the GUI.
StorageName	getStorageName() Returns the name of the lookup table in the internal storage.
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	keyTipText() Returns the tip text for this property.
String	missingKeyTipText() Returns the tip text for this property.
String	missingValueTipText() Returns the tip text for this property.
Token	output() Returns the generated token.
protected void	reset() Resets the object.
void	setKey(String value) Sets the key of the value to output.
void	setMissingKey(MissingLookUpKey value) Sets the behavior for missing keys.
void	setMissingValue(String value) Sets the value to be used if behavior is MissingLookUpKey.OUTPUT_MISSING_VALUE.
void	setStorageName(StorageName value) Sets the name of the lookup table in the internal storage.
String	storageNameTipText() Returns the tip text for this property.

Methods inherited from class adams.flow.core.AbstractActor

annotationsTipText, backupState, canInspectOptions, canPerformSetUpCheck, cleanUp, compareTo, debug, destroy, equals, execute, findVariables, findVariables, findVariables, forceVariables, forCommandLine, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, handleException, hasErrorHandler, hasStopMessage, index, initialize, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, postExecute, preExecute, pruneBackup, pruneBackup, restoreState, setAnnotations, setErrorHandler, setHeadless, setName, setParent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, sizeOf, skipTipText, stopExecution, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged, wrapUp

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, debug, debugLevelTipText, finishInit, getDebugLevel, getOptionManager, isDebugOn, newOptionManager, setDebugLevel, toCommandLine, toString

Methods inherited from class adams.core.ConsoleObject

getDebugging, getSystemErr, getSystemOut

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, debug, destroy, equals, execute, findVariables, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, isExecuted, isFinished, isHeadless, isStopped, setAnnotations, setErrorHandler, setHeadless, setName, setParent, setSkip, setStopFlowOnError, setUp, setVariables, sizeOf, stopExecution, stopExecution, variableChanged, wrapUp

Methods inherited from interface adams.core.AdditionalInformationHandler

getAdditionalInformation

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager

Field Detail

m_StorageName

protected StorageName m_StorageName

the name of the lookup table in the internal storage.

m_Key

protected String m_Key

the key to lookup and forward the value for.

m_MissingKey

protected MissingLookUpKey m_MissingKey

the behavior for missing keys.

m_MissingValue

protected String m_MissingValue

the missing value (only used for MissingValue#OUTPUT_MISSING_VALUE).

m_OutputToken

protected Token m_OutputToken

the token to forward.

Constructor Detail

LookUp

public LookUp()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

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

reset

protected void reset()

Resets the object.

Overrides:

reset 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 QuickInfoSupporter

Specified by:

getQuickInfo in interface Actor

Overrides:

getQuickInfo in class AbstractActor

Returns:

null if no info available, otherwise short string

setStorageName

public void setStorageName(StorageName value)

Sets the name of the lookup table in the internal storage.

Parameters:

value - the name

getStorageName

public StorageName getStorageName()

Returns the name of the lookup table in the internal storage.

Returns:

the name

storageNameTipText

public String storageNameTipText()

Returns the tip text for this property.

Returns:

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

setKey

public void setKey(String value)

Sets the key of the value to output.

Parameters:

value - the key

getKey

public String getKey()

Returns the key of the value to output.

Returns:

the key

keyTipText

public String keyTipText()

Returns the tip text for this property.

Returns:

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

setMissingKey

public void setMissingKey(MissingLookUpKey value)

Sets the behavior for missing keys.

Parameters:

value - the behavior

getMissingKey

public MissingLookUpKey getMissingKey()

Returns the behavior for missing keys.

Returns:

the behavior

missingKeyTipText

public String missingKeyTipText()

Returns the tip text for this property.

Returns:

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

setMissingValue

public void setMissingValue(String value)

Sets the value to be used if behavior is MissingLookUpKey.OUTPUT_MISSING_VALUE.

Parameters:

value - the value to use

See Also:

MissingLookUpKey.OUTPUT_MISSING_VALUE

getMissingValue

public String getMissingValue()

Returns the value used if behavior is MissingLookUpKey.OUTPUT_MISSING_VALUE.

Returns:

the value in use

See Also:

MissingLookUpKey.OUTPUT_MISSING_VALUE

missingValueTipText

public String missingValueTipText()

Returns the tip text for this property.

Returns:

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

generates

public Class[] generates()

Returns the class of objects that it generates.

Returns:

the Class of the generated tokens

doExecute

protected String doExecute()

Executes the flow item.

Specified by:

doExecute in class AbstractActor

Returns:

null if everything is fine, otherwise error message

output

public Token output()

Returns the generated token.

Returns:

the generated token

hasPendingOutput

public boolean hasPendingOutput()

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

Returns:

true if there is pending output