Package adams.flow.transformer

Class LookUp

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, StorageUser, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class LookUp
extends AbstractTransformer
implements StorageUser
    Forwards the value associated with the key that the actor gets as input, using the specified lookup table from internal storage.

    Input/output:
    - accepts:
       java.lang.String
    - 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: LookUp
 
    -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
 
    -storage-name <adams.flow.control.StorageName> (property: storageName)
    The name for the lookup table in the internal storage.
    default: lookup
 
    -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: ???
 
    -use-native <boolean> (property: useNative)
    If enabled, native objects are output rather than strings.
    default: false
 
    -suppress-missing-key-warnings <boolean> (property: suppressMissingKeyWarnings)
    If enabled, warnings about missing keys are suppressed.
    default: false
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_StorageName

        protected StorageName m_StorageName
        the name of the lookup table in the internal storage.

      • m_MissingKey

        protected MissingLookUpKey m_MissingKey
        the behavior for missing keys.

      • m_MissingValue

        protected String m_MissingValue
        the missing value.

      • m_UseNative

        protected boolean m_UseNative
        whether to output native objects rather than strings.

      • m_SuppressMissingKeyWarnings

        protected boolean m_SuppressMissingKeyWarnings
        whether to suppress warnings when key is not present.

    • Constructor Detail

      • LookUp

        public LookUp()

    • Method Detail

      • isUsingStorage

        public boolean isUsingStorage()
        Returns whether storage items are being used.
        Specified by:
        isUsingStorage in interface StorageUser
        Returns:
        true if storage items are used

      • setStorageName

        public void setStorageName​(StorageName value)
        Sets the name for the lookup table in the internal storage.
        Parameters:
        value - the name

      • getStorageName

        public StorageName getStorageName()
        Returns the name for 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.

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

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

      • setUseNative

        public void setUseNative​(boolean value)
        Sets whether to output native objects rather than strings.
        Parameters:
        value - true if to output native objects

      • getUseNative

        public boolean getUseNative()
        Returns whether native objects are output rather than strings.
        Returns:
        true if native objects are used

      • useNativeTipText

        public String useNativeTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setSuppressMissingKeyWarnings

        public void setSuppressMissingKeyWarnings​(boolean value)
        Sets whether to suppress warnings about missing keys.
        Parameters:
        value - true if to suppress warnings

      • getSuppressMissingKeyWarnings

        public boolean getSuppressMissingKeyWarnings()
        Returns whether to suppress warnings about missing keys.
        Returns:
        true if warnings suppressed

      • suppressMissingKeyWarningsTipText

        public String suppressMissingKeyWarningsTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        Specified by:
        accepts in interface InputConsumer
        Returns:
        the Class of objects that can be processed

      • 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

      • doExecute

        protected String doExecute()
        Executes the flow item.
        Specified by:
        doExecute in class AbstractActor
        Returns:
        null if everything is fine, otherwise error message