Package adams.flow.transformer

Class LookUpAdd

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class LookUpAdd
extends AbstractTransformer
    Adds key-value pairs to the specified lookup table.
    The input can either an array or a spreadsheet.
    If the input is an array, it must have length 2, with the first element the key and the second one the value. In case of a spreadsheet, the pairs are loaded using the specified columns.

    Input/output:
    - accepts:
       java.lang.String[]
       adams.data.spreadsheet.SpreadSheet
    - generates:
       java.lang.String[]
       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: LookUpAdd
 
    -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
 
    -storage-name <adams.flow.control.StorageName> (property: storageName)
    The name for the lookup table in the internal storage.
    default: lookup
 
    -key-column <adams.data.spreadsheet.SpreadSheetColumnIndex> (property: keyColumn)
    The index of the column in the spreadsheet to use as key; An index is a
    number starting with 1; column names (case-sensitive) as well as the following
    placeholders can be used: first, second, third, last_2, last_1, last; numeric
    indices can be enforced by preceding them with '#' (eg '#12'); column names
    can be surrounded by double quotes.
    default: 1
    example: An index is a number starting with 1; column names (case-sensitive) as well as the following placeholders can be used: first, second, third, last_2, last_1, last; numeric indices can be enforced by preceding them with '#' (eg '#12'); column names can be surrounded by double quotes.
 
    -value-column <adams.data.spreadsheet.SpreadSheetColumnIndex> (property: valueColumn)
    The index of the column in the spreadsheet to use as value; An index is
    a number starting with 1; column names (case-sensitive) as well as the following
    placeholders can be used: first, second, third, last_2, last_1, last; numeric
    indices can be enforced by preceding them with '#' (eg '#12'); column names
    can be surrounded by double quotes.
    default: 2
    example: An index is a number starting with 1; column names (case-sensitive) as well as the following placeholders can be used: first, second, third, last_2, last_1, last; numeric indices can be enforced by preceding them with '#' (eg '#12'); column names can be surrounded by double quotes.
 
    -use-native <boolean> (property: useNative)
    If enabled, native objects are used as value rather than strings.
    default: false
 
    -value-conversion <adams.data.conversion.Conversion> (property: valueConversion)
    The conversion to apply to the value before storing it.
    default: adams.data.conversion.ObjectToObject
    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.

      • m_ValueConversion

        protected Conversion m_ValueConversion
        the conversion to apply to the value.

    • Constructor Detail

      • LookUpAdd

        public LookUpAdd()

    • Method Detail

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

      • setValueConversion

        public void setValueConversion​(Conversion value)
        Sets the conversion to apply to the value before storing it.
        Parameters:
        value - the conversion

      • getValueConversion

        public Conversion getValueConversion()
        Returns the conversion to apply to the value before storing it.
        Returns:
        the conversion

      • valueConversionTipText

        public String valueConversionTipText()
        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.
        Returns:
        the Class of objects that can be processed

      • generates

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

      • convertValue

        protected Object convertValue​(Conversion conv,
                              Object input)
        Applies the conversion to the value, if necessary.
        Parameters:
        conv - the conversion to use, no conversion if null
        input - the input to convert
        Returns:
        the converted value, or input if no conversion of failed to convert

      • doExecute

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