adams.flow.transformer
Class SpreadSheetTransformCells

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.flow.core.AbstractActor
              adams.flow.transformer.AbstractTransformer
                  adams.flow.transformer.AbstractSpreadSheetTransformer
                      adams.flow.transformer.AbstractInPlaceSpreadSheetTransformer
                          adams.flow.transformer.SpreadSheetTransformCells

All Implemented Interfaces:

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

public class SpreadSheetTransformCells
extends AbstractInPlaceSpreadSheetTransformer
implements GlobalActorUser

Finds cells in a spreadsheet and transforms them with a global transformer.

Input/output:
- accepts:
adams.data.spreadsheet.SpreadSheet
- generates:
adams.data.spreadsheet.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: SpreadSheetTransformCells
 

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

-no-copy (property: noCopy)
    If enabled, no copy of the spreadsheet is created before processing it.
 

-finder <adams.data.spreadsheet.cellfinder.AbstractCellFinder> (property: finder)
    The cell finder to use.
    default: adams.data.spreadsheet.cellfinder.CellRange
 

-transformer <adams.flow.core.GlobalActorReference> (property: transformer)
    The global transformer to apply to the located cells.
    default: 
 

Version:

$Revision: 6997 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

static String	BACKUP_GLOBALACTOR the key for backing up the global actor.
protected AbstractCellFinder	m_Finder for locating the cells.
protected AbstractActor	m_GlobalActor the global actor.
protected GlobalActorHelper	m_Helper the helper class.
protected GlobalActorReference	m_Transformer the global transformer to apply to the cells.

Fields inherited from class adams.flow.transformer.AbstractInPlaceSpreadSheetTransformer

m_NoCopy

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

SpreadSheetTransformCells()

Method Summary

protected Hashtable<String,Object>	backupState() Backs up the current state of the actor before update the variables.
void	defineOptions() Adds options to the internal list of options.
protected String	doExecute() Executes the flow item.
String	finderTipText() Returns the tip text for this property.
protected AbstractActor	findGlobalActor() Tries to find the global actor referenced by its global name.
AbstractCellFinder	getFinder() Returns the cell finder to use.
AbstractActor	getGlobalActor() Returns the currently set global actor.
String	getQuickInfo() Returns a quick info about the actor, which will be displayed in the GUI.
GlobalActorReference	getTransformer() Returns the reference to the global transformer.
String	globalInfo() Returns a string describing the object.
boolean	hasGlobalActor() Checks whether a reference to the global actor is currently available.
protected void	initialize() Initializes the members.
protected void	pruneBackup() Removes entries from the backup.
protected void	reset() Resets the scheme.
protected void	restoreState(Hashtable<String,Object> state) Restores the state of the actor before the variables got updated.
void	setFinder(AbstractCellFinder value) Sets the cell finder to use.
void	setTransformer(GlobalActorReference value) Sets the reference to the global transformer.
String	setUp() Initializes the item for flow execution.
protected String	setUpGlobalActor() Configures the global actor.
protected String	transformCell(CellLocation location, SpreadSheet sheet) Applies the conversion to the cell.
String	transformerTipText() Returns the tip text for this property.

Methods inherited from class adams.flow.transformer.AbstractInPlaceSpreadSheetTransformer

getNoCopy, noCopyTipText, setNoCopy

Methods inherited from class adams.flow.transformer.AbstractSpreadSheetTransformer

accepts, generates

Methods inherited from class adams.flow.transformer.AbstractTransformer

execute, hasPendingOutput, input, output, postExecute, 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, 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, preExecute, pruneBackup, setAnnotations, setErrorHandler, setHeadless, setName, setParent, setSkip, setStopFlowOnError, 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, setVariables, sizeOf, stopExecution, stopExecution, variableChanged, wrapUp

Methods inherited from interface adams.core.AdditionalInformationHandler

getAdditionalInformation

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager

Field Detail

BACKUP_GLOBALACTOR

public static final String BACKUP_GLOBALACTOR

the key for backing up the global actor.

See Also:

Constant Field Values

m_Finder

protected AbstractCellFinder m_Finder

for locating the cells.

m_Transformer

protected GlobalActorReference m_Transformer

the global transformer to apply to the cells.

m_Helper

protected GlobalActorHelper m_Helper

the helper class.

m_GlobalActor

protected AbstractActor m_GlobalActor

the global actor.

Constructor Detail

SpreadSheetTransformCells

public SpreadSheetTransformCells()

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 AbstractInPlaceSpreadSheetTransformer

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class AbstractActor

reset

protected void reset()

Resets the scheme.

Overrides:

reset in class AbstractTransformer

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

setFinder

public void setFinder(AbstractCellFinder value)

Sets the cell finder to use.

Parameters:

value - the finder

getFinder

public AbstractCellFinder getFinder()

Returns the cell finder to use.

Returns:

the finder

finderTipText

public String finderTipText()

Returns the tip text for this property.

Returns:

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

setTransformer

public void setTransformer(GlobalActorReference value)

Sets the reference to the global transformer.

Parameters:

value - the reference

getTransformer

public GlobalActorReference getTransformer()

Returns the reference to the global transformer.

Returns:

the conversion

transformerTipText

public String transformerTipText()

Returns the tip text for this property.

Returns:

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

findGlobalActor

protected AbstractActor findGlobalActor()

Tries to find the global actor referenced by its global name.

Returns:

the global actor or null if not found

hasGlobalActor

public boolean hasGlobalActor()

Checks whether a reference to the global actor is currently available.

Returns:

true if a reference is available

See Also:

getGlobalActor()

getGlobalActor

public AbstractActor getGlobalActor()

Returns the currently set global actor.

Specified by:

getGlobalActor in interface GlobalActorUser

Returns:

the actor, can be null

pruneBackup

protected void pruneBackup()

Removes entries from the backup.

Overrides:

pruneBackup in class AbstractActor

backupState

protected Hashtable<String,Object> backupState()

Backs up the current state of the actor before update the variables.

Overrides:

backupState in class AbstractTransformer

Returns:

the backup

restoreState

protected void restoreState(Hashtable<String,Object> state)

Restores the state of the actor before the variables got updated.

Overrides:

restoreState in class AbstractTransformer

Parameters:

state - the backup of the state to restore from

setUpGlobalActor

protected String setUpGlobalActor()

Configures the global actor.

Returns:

null if successful, otherwise error message

setUp

public String setUp()

Initializes the item for flow execution.

Specified by:

setUp in interface Actor

Overrides:

setUp in class AbstractActor

Returns:

null if everything is fine, otherwise error message

transformCell

protected String transformCell(CellLocation location,
                               SpreadSheet sheet)

Applies the conversion to the cell.

Parameters:

location - the cell location to convert

sheet - the sheet to process

Returns:

null if successful, otherwise error message

doExecute

protected String doExecute()

Executes the flow item.

Specified by:

doExecute in class AbstractActor

Returns:

null if everything is fine, otherwise error message