Package adams.flow.transformer

Class SpreadSheetColumnIterator

  • All Implemented Interfaces:
    AdditionalInformationHandler, ArrayProvider, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ArrayProvider, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class SpreadSheetColumnIterator
extends AbstractArrayProvider
    Iterates through all columns of a spreadsheet and outputs the names.
    The columns can be limited with the range parameter and furthermore with the regular expression applied to the names.
    Instead of outputting the names, it is also possible to output the 1-based indices.

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


    -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: SpreadSheetColumnIterator
 
    -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
 
    -output-array <boolean> (property: outputArray)
    If enabled, outputs the names as an array rather than one-by-one.
    default: false
 
    -range <adams.data.spreadsheet.SpreadSheetColumnRange> (property: range)
    The range of columns to iterate over; A range is a comma-separated list
    of single 1-based indices or sub-ranges of indices ('start-end'); 'inv(..
    .)' inverts the range '...'; 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: first-last
    example: A range is a comma-separated list of single 1-based indices or sub-ranges of indices ('start-end'); 'inv(...)' inverts the range '...'; 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.
 
    -regexp <adams.core.base.BaseRegExp> (property: regExp)
    The regular expression used to further limit the column set.
    default: .*
    more: https://docs.oracle.com/javase/tutorial/essential/regex/
    https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html
 
    -output-indices <boolean> (property: outputIndices)
    If set to true, 1-based indices of matches are output instead of names.
    default: false
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_RegExp

        protected BaseRegExp m_RegExp
        the regular expression applied to the column names.

      • m_OutputIndices

        protected boolean m_OutputIndices
        whether to output indices instead of the strings.

    • Constructor Detail

      • SpreadSheetColumnIterator

        public SpreadSheetColumnIterator()

    • Method Detail

      • setRange

        public void setRange​(SpreadSheetColumnRange value)
        Sets the range of columns to operate on.
        Parameters:
        value - the range

      • getRange

        public SpreadSheetColumnRange getRange()
        Returns the range of columns to operate on.
        Returns:
        the range

      • rangeTipText

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

      • setRegExp

        public void setRegExp​(BaseRegExp value)
        Sets the regular expression for the names.
        Parameters:
        value - the expression

      • getRegExp

        public BaseRegExp getRegExp()
        Returns the regular expression for the name.
        Returns:
        the prefix

      • regExpTipText

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

      • setOutputIndices

        public void setOutputIndices​(boolean value)
        Sets whether to output 1-based indices of matches instead of the names.
        Parameters:
        value - true if to output indices

      • getOutputIndices

        public boolean getOutputIndices()
        Returns whether to output 1-based indices of matches instead of the names.
        Returns:
        true if to output indices

      • outputIndicesTipText

        public String outputIndicesTipText()
        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:
        adams.data.spreadsheet.SpreadSheet.class

      • doExecute

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