Package adams.flow.transformer

Class CounterInit

  • 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 CounterInit
extends AbstractTransformer
implements StorageUpdater
    Creates a counter from a column in a spreadsheet or an array. The counter itself gets stored in the internal storage under the specified name.

    Input/output:
    - accepts:
       adams.data.spreadsheet.SpreadSheet
       java.lang.Object[]
    - generates:
       adams.data.spreadsheet.SpreadSheet
       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: CounterInit
 
    -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 counter in the internal storage.
    default: counter
 
    -initial-values <adams.core.base.BaseString> [-initial-values ...] (property: initialValues)
    The values to initialize the counter with.
    default:
 
    -initial-count <int> (property: initialCount)
    The count to use for the initial values.
    default: 0
 
    -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
    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_InitialValues

        protected BaseString[] m_InitialValues
        the initial labels to use.

      • m_InitialCount

        protected int m_InitialCount
        the initial counter value to use.

      • m_Column

        protected Index m_Column
        the index of the column which values to store in the counter.

    • Constructor Detail

      • CounterInit

        public CounterInit()

    • 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 counter in the internal storage.
        Parameters:
        value - the name

      • getStorageName

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

      • setInitialValues

        public void setInitialValues​(BaseString[] value)
        Sets the values to initialize the counter with.
        Parameters:
        value - the values

      • getInitialValues

        public BaseString[] getInitialValues()
        Returns the values to initialize the counter with.
        Returns:
        the values

      • initialValuesTipText

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

      • setInitialCount

        public void setInitialCount​(int value)
        Sets the initial count to use for the initial values.
        Parameters:
        value - the count

      • getInitialCount

        public int getInitialCount()
        Returns the initial count to use for the initial values.
        Returns:
        the count

      • initialCountTipText

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