Package adams.flow.transformer

Class SpreadSheetGetHeaderCell

  • 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 SpreadSheetGetHeaderCell
extends AbstractTransformer
    Extracts a single value from a spreadsheet's header.

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


    Valid options are: 

    -D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to 
    the console (0 = off).
    default: 0
    minimum: 0
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: SpreadSheetGetHeaderCell
 
    -annotation <adams.core.base.BaseText> (property: annotations)
    The annotations to attach to this actor.
    default: 
 
    -skip (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded 
    as it is.
 
    -stop-flow-on-error (property: stopFlowOnError)
    If set to true, the flow gets stopped in case this actor encounters an error;
     useful for critical actors.
 
    -col <adams.data.spreadsheet.SpreadSheetColumnIndex> (property: column)
    The column of the header cell to retrieve; An index is a number starting 
    with 1; apart from column names (case-sensitive), the following placeholders 
    can be used as well: first, second, third, last_2, last_1, last
    default: 1
 
    -empty <java.lang.String> (property: empty)
    The value to return in case the header cell is empty.
    default:
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Empty

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

    • Constructor Detail

      • SpreadSheetGetHeaderCell

        public SpreadSheetGetHeaderCell()

    • Method Detail

      • setColumn

        public void setColumn​(SpreadSheetColumnIndex value)
        Sets the column of the cell.
        Parameters:
        value - 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.

      • accepts

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

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Returns:
        java.lang.String.class

      • doExecute

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