Package adams.flow.transformer

Class SpreadSheetStatistic

  • 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 SpreadSheetStatistic
extends AbstractSpreadSheetTransformer
    Generates statistics from a SpreadSheet object.
    If cells aren't numeric or missing, a default value of zero is used.

    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: SpreadSheetStatistic
 
    -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
 
    -type <ROW_BY_INDEX|COLUMN_BY_INDEX|COLUMN_BY_REGEXP> (property: dataType)
    Whether to retrieve rows or columns from the Instances object.
    default: COLUMN_BY_INDEX
 
    -location <adams.core.base.BaseString> [-location ...] (property: locations)
    The locations of the data, depending on the chosen data type that can be 
    either indices, column names or regular expressions on the column names.
    default: 
 
    -statistic <adams.data.statistics.AbstractArrayStatistic> (property: statistic)
    The statistic to generate from the data.
    default: adams.data.statistics.ArrayMean
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Locations

        protected BaseString[] m_Locations
        the array of indices/regular expressions.

    • Constructor Detail

      • SpreadSheetStatistic

        public SpreadSheetStatistic()

    • Method Detail

      • setDataType

        public void setDataType​(SpreadSheetStatisticDataType value)
        Sets what type of data to retrieve from the Instances object.
        Parameters:
        value - the type of conversion

      • getDataType

        public SpreadSheetStatisticDataType getDataType()
        Returns what type of data to retrieve from the Instances object.
        Returns:
        the type of conversion

      • dataTypeTipText

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

      • setLocations

        public void setLocations​(BaseString[] value)
        Sets the locations of the data (indices/regular expressions on attribute name).
        Parameters:
        value - the locations of the data

      • getLocations

        public BaseString[] getLocations()
        Returns the locations of the data (indices/regular expressions on attribute name).
        Returns:
        the locations of the data

      • locationsTipText

        public String locationsTipText()
        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​(AbstractArrayStatistic value)
        Sets the statistic to use.
        Parameters:
        value - the statistic

      • getStatistic

        public AbstractArrayStatistic getStatistic()
        Returns the statistic in use.
        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.

      • getRow

        protected Double[] getRow​(SpreadSheet sheet,
                          int index)
        Returns the row as Double array. Non-numeric/missing values are defaulted to 0.
        Parameters:
        sheet - the sheet to work on
        index - the 0-based row index
        Returns:
        the numeric values

      • getColumn

        protected Double[] getColumn​(SpreadSheet sheet,
                             int index)
        Returns the column as Double array. Non-numeric/missing values are defaulted to 0.
        Parameters:
        sheet - the sheet to work on
        index - the 0-based column index
        Returns:
        the numeric values

      • doExecute

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