Package adams.flow.source

Class LookUpTable

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, OutputProducer, Serializable, Comparable
    public class LookUpTable
extends AbstractSimpleSource
    Outputs the specified lookup table as spreadsheet, containing to columns: Key with the keys and Value with the associated values.

    Input/output:
    - generates:
       adams.data.spreadsheet.SpreadSheet


    -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: LookUpTable
 
    -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 of the lookup table in the internal storage.
    default: lookup
 
    -use-native <boolean> (property: useNative)
    If enabled, native objects are output rather than strings.
    default: false
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • COLUMN_VALUE

        public static final String COLUMN_VALUE
        the column of the spreadsheet containing the values.
        See Also:
        Constant Field Values

      • m_StorageName

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

      • m_UseNative

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

    • Constructor Detail

      • LookUpTable

        public LookUpTable()

    • Method Detail

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

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Returns:
        the Class of the generated tokens

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

      • doExecute

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