Package adams.flow.transformer

Class CounterAdd

  • 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 CounterAdd
extends AbstractTransformer
    Passes a value through the specified counter.
    The input for the actor can be any object, the user has to ensure representation, as a simple string representation is used by the counter.
    In case of arrays, elements get stored one by one.
    SpreadSheet cells with actual data get added as well.

    Input/output:
    - accepts:
       java.lang.Object
       java.lang.Object[]
       adams.data.spreadsheet.SpreadSheet
    - generates:
       java.lang.Object


    -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: CounterAdd
 
    -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 gets stopped in case this actor encounters an error;
     useful for critical actors.
    default: false
 
    -silent <boolean> (property: silent)
    If enabled, then no errors are output in the console.
    default: false
 
    -storage-name <adams.flow.control.StorageName> (property: storageName)
    The name of the counter in the internal storage.
    default: counter
 
    -column <adams.core.Index> (property: column)
    The index of the column in the spreadsheet which values to store in the 
    counter.
    default: first
    example: An index is a number starting with 1; the following placeholders can be used as well: first, second, third, last_2, last_1, last
    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 counter in the internal storage.

      • m_Column

        protected Index m_Column
        the index of the column which values to count.

    • Constructor Detail

      • CounterAdd

        public CounterAdd()

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

      • setColumn

        public void setColumn​(Index value)
        Sets the index of the column to store in the counter.
        Parameters:
        value - the index

      • getColumn

        public Index getColumn()
        Returns the index of the column to store in the counter.
        Returns:
        the index

      • columnTipText

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

      • countValue

        protected void countValue​(NamedCounter counter,
                          Object value)
        Passes the value through the counter.
        Parameters:
        counter - the counter to update
        value - the value to count

      • doExecute

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