Package adams.flow.transformer

Class SpreadSheetRowStatistic

  • 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 SpreadSheetRowStatistic
extends AbstractSpreadSheetTransformer
    Generates statistics for a chosen row.

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


    -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: SpreadSheetRowStatistic
 
    -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
 
    -row <adams.core.Index> (property: row)
    The row to generate the statistics for.
    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
 
    -statistic <adams.data.spreadsheet.rowstatistic.AbstractRowStatistic> (property: statistic)
    The statistic to generate for the specified row.
    default: adams.data.spreadsheet.rowstatistic.Mean
    Version:
    $Revision: 9765 $
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Row

        protected Index m_Row
        the column to generate the statistic for.

    • Constructor Detail

      • SpreadSheetRowStatistic

        public SpreadSheetRowStatistic()

    • Method Detail

      • setRow

        public void setRow​(Index value)
        Sets the row to generate the statistic for.
        Parameters:
        value - the row

      • getRow

        public Index getRow()
        Returns the row to generate the statistics for.
        Returns:
        the row

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

      • setStatistic

        public void setStatistic​(AbstractRowStatistic value)
        Sets the statistic to generate.
        Parameters:
        value - the statistic

      • getStatistic

        public AbstractRowStatistic getStatistic()
        Returns the statistic to generate
        Returns:
        the statistic

      • statisticTipText

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

      • doExecute

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