adams.flow.transformer
Class SpreadSheetStatistic

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.flow.core.AbstractActor
              adams.flow.transformer.AbstractTransformer
                  adams.flow.transformer.SpreadSheetStatistic

All Implemented Interfaces:

AdditionalInformationHandler, CleanUpHandler, Debuggable, DebugOutputHandler, Destroyable, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<AbstractActor>, SizeOfHandler, Stoppable, VariableChangeListener, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable

public class SpreadSheetStatistic
extends AbstractTransformer

Generates statistics from a SpreadSheet object.
If cells aren't numeric or missing, a default value of zero is used.

Input/output:
- accepts:
adams.core.io.SpreadSheet
- generates:
adams.core.io.SpreadSheet

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: SpreadSheetStatistic
 

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

-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 or regular expressions on the attribute names.
    default:
 

-statistic <adams.data.statistics.AbstractArrayStatistic [options]> (property: statistic)
    The statistic to generate from the data.
    default: adams.data.statistics.ArrayMean
 

Version:

$Revision: 4584 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

static class

SpreadSheetStatistic.DataType Defines what data to retrieve from an Instances object.

Field Summary

protected SpreadSheetStatistic.DataType	m_DataType the type of data to get from the Instances object (rows or columns).
protected BaseString[]	m_Locations the array of indices/regular expressions.
protected AbstractArrayStatistic	m_Statistic the statistic to generate.

Fields inherited from class adams.flow.transformer.AbstractTransformer

BACKUP_INPUT, BACKUP_OUTPUT, m_InputToken, m_OutputToken

Fields inherited from class adams.flow.core.AbstractActor

FILE_EXTENSION, FILE_EXTENSION_GZ, m_Annotations, m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_ErrorHandler, m_Executed, m_FullName, m_Headless, m_Name, m_Parent, m_Root, m_Self, m_Skip, m_StopFlowOnError, m_StopMessage, m_Stopped, m_StorageHandler, m_VariablesUpdated

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Constructor Summary

SpreadSheetStatistic()

Method Summary

Class[]	accepts() Returns the class that the consumer accepts.
String	dataTypeTipText() Returns the tip text for this property.
void	defineOptions() Adds options to the internal list of options.
protected String	doExecute() Executes the flow item.
Class[]	generates() Returns the class of objects that it generates.
protected Double[]	getColumn(SpreadSheet sheet, int index) Returns the column as Double array.
SpreadSheetStatistic.DataType	getDataType() Returns what type of data to retrieve from the Instances object.
BaseString[]	getLocations() Returns the locations of the data (indices/regular expressions on attribute name).
String	getQuickInfo() Returns a quick info about the actor, which will be displayed in the GUI.
protected Double[]	getRow(SpreadSheet sheet, int index) Returns the row as Double array.
AbstractArrayStatistic	getStatistic() Returns the statistic in use.
String	globalInfo() Returns a string describing the object.
String	locationsTipText() Returns the tip text for this property.
void	setDataType(SpreadSheetStatistic.DataType value) Sets what type of data to retrieve from the Instances object.
void	setLocations(BaseString[] value) Sets the locations of the data (indices/regular expressions on attribute name).
void	setStatistic(AbstractArrayStatistic value) Sets the statistic to use.
String	statisticTipText() Returns the tip text for this property.

Methods inherited from class adams.flow.transformer.AbstractTransformer

backupState, execute, hasPendingOutput, input, output, postExecute, reset, restoreState, wrapUp

Methods inherited from class adams.flow.core.AbstractActor

annotationsTipText, canInspectOptions, canPerformSetUpCheck, cleanUp, compareTo, debug, destroy, equals, findVariables, findVariables, findVariables, forceVariables, forCommandLine, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFullName, getName, getNextSibling, getParent, getPreviousSibling, getRoot, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, initialize, isBackedUp, isExecuted, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, preExecute, pruneBackup, pruneBackup, setAnnotations, setErrorHandler, setHeadless, setName, setParent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, sizeOf, skipTipText, stopExecution, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, debug, debugLevelTipText, finishInit, getDebugLevel, getOptionManager, isDebugOn, newOptionManager, setDebugLevel, toCommandLine, toString

Methods inherited from class adams.core.ConsoleObject

getDebugging, getSystemErr, getSystemOut

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

m_DataType

protected SpreadSheetStatistic.DataType m_DataType

the type of data to get from the Instances object (rows or columns).

m_Locations

protected BaseString[] m_Locations

the array of indices/regular expressions.

m_Statistic

protected AbstractArrayStatistic m_Statistic

the statistic to generate.

Constructor Detail

SpreadSheetStatistic

public SpreadSheetStatistic()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractActor

setDataType

public void setDataType(SpreadSheetStatistic.DataType value)

Sets what type of data to retrieve from the Instances object.

Parameters:

value - the type of conversion

getDataType

public SpreadSheetStatistic.DataType 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.

getQuickInfo

public String getQuickInfo()

Returns a quick info about the actor, which will be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractActor

Returns:

null if no info available, otherwise short string

accepts

public Class[] accepts()

Returns the class that the consumer accepts.

Returns:

adams.core.io.SpreadSheet.class

generates

public Class[] generates()

Returns the class of objects that it generates.

Returns:

adams.core.io.SpreadSheet.class

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