Package adams.flow.transformer

Class SpreadSheetGetCell

  • 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 SpreadSheetGetCell
extends AbstractArrayProvider
    Extracts one or more values from a spreadsheet.

    Input/output:
    - accepts:
       adams.data.spreadsheet.SpreadSheet
       adams.data.spreadsheet.Row
    - 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: SpreadSheetGetCell
 
    -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
 
    -output-array <boolean> (property: outputArray)
    Whether to output the cell values in an array or one-by-one.
    default: false
 
    -row <adams.core.Range> (property: row)
    The row(s) of the cell(s) to retrieve.
    default: 1
    example: A range is a comma-separated list of single 1-based indices or sub-ranges of indices ('start-end'); 'inv(...)' inverts the range '...'; the following placeholders can be used as well: first, second, third, last_2, last_1, last
 
    -col <adams.data.spreadsheet.SpreadSheetColumnRange> (property: column)
    The column(s) of the cell(s) to retrieve; 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
    default: 1
    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
 
    -empty <java.lang.String> (property: empty)
    The value to return in case the cell is empty.
    default: 
 
    -use-native <boolean> (property: useNative)
    If enabled, native objects are output rather than strings.
    default: false
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Row

        protected Range m_Row
        the row of the cell to obtain.

      • m_Empty

        protected String m_Empty
        the value to return if cell is empty.

      • m_UseNative

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

    • Constructor Detail

      • SpreadSheetGetCell

        public SpreadSheetGetCell()

    • Method Detail

      • setRow

        public void setRow​(Range value)
        Sets the row(s) of the cell(s).
        Parameters:
        value - the row(s)

      • getRow

        public Range getRow()
        Returns the row(s) of the cell(s).
        Returns:
        the row(s)

      • rowTipText

        public String rowTipText()
        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​(SpreadSheetColumnRange value)
        Sets the column(s) of the cell(s).
        Parameters:
        value - the column(s)

      • getColumn

        public SpreadSheetColumnRange getColumn()
        Returns the column(s) of the cell(s).
        Returns:
        the column

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

      • setEmpty

        public void setEmpty​(String value)
        Sets the value to return if cell is empty.
        Parameters:
        value - the empty value

      • getEmpty

        public String getEmpty()
        Returns the value to return if cell is empty.
        Returns:
        the empty value

      • emptyTipText

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

      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        Returns:
        adams.data.spreadsheet.SpreadSheet.class, adams.data.spreadsheet.Row.class

      • doExecute

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