Package adams.flow.transformer

Class LookUpInit

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, StorageUpdater, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class LookUpInit
extends AbstractSpreadSheetTransformer
implements StorageUpdater
    Creates a lookup table from a spreadsheet, using one column as key and another one as value. The lookup table itself gets stored in the internal storage under the specified name.

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


    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: LookUpInit
 
    -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 for the lookup table in the internal storage.
    default: lookup
 
    -key-column <adams.core.Index> (property: keyColumn)
    The index of the column in the spreadsheet to use as key; An index is a 
    number starting with 1; the following placeholders can be used as well: 
    first, second, third, last_2, last_1, last
    default: 1
 
    -value-column <adams.core.Index> (property: valueColumn)
    The index of the column in the spreadsheet to use as value; An index is 
    a number starting with 1; the following placeholders can be used as well:
     first, second, third, last_2, last_1, last
    default: 2
    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_UseNative

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

    • Constructor Detail

      • LookUpInit

        public LookUpInit()

    • Method Detail

      • isUpdatingStorage

        public boolean isUpdatingStorage()
        Returns whether storage items are being updated.
        Specified by:
        isUpdatingStorage in interface StorageUpdater
        Returns:
        true if storage items are updated

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

      • setKeyColumn

        public void setKeyColumn​(SpreadSheetColumnIndex value)
        Sets the index of the column to act as key in the lookup table.
        Parameters:
        value - the index

      • getKeyColumn

        public SpreadSheetColumnIndex getKeyColumn()
        Returns the index of the column to act as key in the lookup table.
        Returns:
        the index

      • keyColumnTipText

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

      • setValueColumn

        public void setValueColumn​(SpreadSheetColumnIndex value)
        Sets the index of the column to act as value in the lookup table.
        Parameters:
        value - the index

      • getValueColumn

        public SpreadSheetColumnIndex getValueColumn()
        Returns the index of the column to act as value in the lookup table.
        Returns:
        the index

      • valueColumnTipText

        public String valueColumnTipText()
        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.

      • doExecute

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