adams.flow.transformer
Class SpreadSheetInfo

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

All Implemented Interfaces:

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

public class SpreadSheetInfo
extends AbstractArrayProvider

Outputs statistics of a SpreadSheet object.

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

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

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

-output-array (property: outputArray)
    If enabled, the info items get output as array rather than one-by-one.
 

-type <NAME|NUM_COLUMNS|NUM_ROWS|COLUMN_NAME|COLUMN_TYPE|CELL_TYPES|CELL_VALUES> (property: type)
    The type of information to generate.
    default: NUM_ROWS
 

-column-index <adams.data.spreadsheet.SpreadSheetColumnIndex> (property: columnIndex)
    The column index to use for generating column-specific information. 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: last
 

Version:

$Revision: 7066 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

static class

SpreadSheetInfo.InfoType The type of information to generate.

Field Summary

protected SpreadSheetColumnIndex	m_ColumnIndex the index of the column to get the information for.
protected SpreadSheetInfo.InfoType	m_Type the type of information to generate.

Fields inherited from class adams.flow.transformer.AbstractArrayProvider

m_Index, m_OutputArray, m_Queue

Fields inherited from class adams.flow.transformer.AbstractTransformer

BACKUP_INPUT, BACKUP_OUTPUT, m_InputToken, m_OutputToken

Fields inherited from class adams.flow.core.AbstractActor

m_Annotations, m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_ErrorHandler, m_Executed, m_Executing, m_ExecutionListeningSupporter, m_FullName, m_Headless, m_Name, m_Parent, m_Root, m_ScopeHandler, 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

Fields inherited from interface adams.flow.core.Actor

FILE_EXTENSION, FILE_EXTENSION_GZ

Constructor Summary

SpreadSheetInfo()

Method Summary

Class[]	accepts() Returns the class that the consumer accepts.
String	columnIndexTipText() Returns the tip text for this property.
void	defineOptions() Adds options to the internal list of options.
protected String	doExecute() Executes the flow item.
SpreadSheetColumnIndex	getColumnIndex() Returns the column index to use for column specific information.
protected Class	getItemClass() Returns the base class of the items.
String	getQuickInfo() Returns a quick info about the actor, which will be displayed in the GUI.
SpreadSheetInfo.InfoType	getType() Returns the type of information to generate.
String	globalInfo() Returns a string describing the object.
protected void	initialize() Initializes the members.
String	outputArrayTipText() Returns the tip text for this property.
void	setColumnIndex(SpreadSheetColumnIndex value) Sets the column index to use for column specific information.
void	setType(SpreadSheetInfo.InfoType value) Sets the type of information to generate.
String	typeTipText() Returns the tip text for this property.

Methods inherited from class adams.flow.transformer.AbstractArrayProvider

generates, getOutputArray, hasPendingOutput, output, preExecute, reset, setOutputArray, wrapUp

Methods inherited from class adams.flow.transformer.AbstractTransformer

backupState, execute, input, postExecute, restoreState

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, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, handleException, hasErrorHandler, hasStopMessage, index, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, 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

Methods inherited from interface adams.flow.core.Actor

cleanUp, compareTo, debug, destroy, equals, execute, findVariables, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, isExecuted, isFinished, isHeadless, isStopped, setAnnotations, setErrorHandler, setHeadless, setName, setParent, setSkip, setStopFlowOnError, setUp, setVariables, sizeOf, stopExecution, stopExecution, variableChanged

Methods inherited from interface adams.core.AdditionalInformationHandler

getAdditionalInformation

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager

Field Detail

m_Type

protected SpreadSheetInfo.InfoType m_Type

the type of information to generate.

m_ColumnIndex

protected SpreadSheetColumnIndex m_ColumnIndex

the index of the column to get the information for.

Constructor Detail

SpreadSheetInfo

public SpreadSheetInfo()

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 AbstractArrayProvider

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class AbstractActor

getQuickInfo

public String getQuickInfo()

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

Specified by:

getQuickInfo in interface QuickInfoSupporter

Specified by:

getQuickInfo in interface Actor

Overrides:

getQuickInfo in class AbstractActor

Returns:

null if no info available, otherwise short string

setType

public void setType(SpreadSheetInfo.InfoType value)

Sets the type of information to generate.

Parameters:

value - the type

getType

public SpreadSheetInfo.InfoType getType()

Returns the type of information to generate.

Returns:

the type

typeTipText

public String typeTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setColumnIndex

public void setColumnIndex(SpreadSheetColumnIndex value)

Sets the column index to use for column specific information.

Parameters:

value - the 1-based index

getColumnIndex

public SpreadSheetColumnIndex getColumnIndex()

Returns the column index to use for column specific information.

Returns:

the 1-based index

columnIndexTipText

public String columnIndexTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

outputArrayTipText

public String outputArrayTipText()

Returns the tip text for this property.

Specified by:

outputArrayTipText in interface ArrayProvider

Specified by:

outputArrayTipText in class AbstractArrayProvider

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

getItemClass

protected Class getItemClass()

Returns the base class of the items.

Specified by:

getItemClass in class AbstractArrayProvider

Returns:

the class

accepts

public Class[] accepts()

Returns the class that the consumer accepts.

Returns:

adams.data.spreadsheet.SpreadSheet.class

doExecute

protected String doExecute()

Executes the flow item.

Specified by:

doExecute in class AbstractActor

Returns:

null if everything is fine, otherwise error message