adams.flow.transformer
Class SpreadSheetConvertCells

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

All Implemented Interfaces:

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

public class SpreadSheetConvertCells
extends AbstractInPlaceSpreadSheetTransformer

Finds cells in a spreadsheet and converts them with a conversion scheme.

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

-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
 

-conversion <adams.data.conversion.Conversion> (property: conversion)
    The conversion to apply to the located cells.
    default: adams.data.conversion.ObjectToObject
 

Version:

$Revision: 6997 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

protected Conversion	m_Conversion the conversion to apply to the cells.
protected AbstractCellFinder	m_Finder for locating 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

SpreadSheetConvertCells()

Method Summary

String	conversionTipText() Returns the tip text for this property.
protected String	convertCell(CellLocation location, SpreadSheet sheet) Applies the conversion to the cell.
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.
Conversion	getConversion() Returns the conversion scheme to apply to the located cells.
AbstractCellFinder	getFinder() Returns the cell finder to use.
String	getQuickInfo() Returns a quick info about the actor, which will be displayed in the GUI.
String	globalInfo() Returns a string describing the object.
void	setConversion(Conversion value) Sets the conversion scheme to apply to the located cells.
void	setFinder(AbstractCellFinder value) Sets the cell finder to use.
void	stopExecution() Stops the execution.

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

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, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, handleException, hasErrorHandler, hasStopMessage, index, initialize, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, preExecute, pruneBackup, pruneBackup, setAnnotations, setErrorHandler, setHeadless, setName, setParent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, sizeOf, skipTipText, 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, 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, variableChanged

Methods inherited from interface adams.core.AdditionalInformationHandler

getAdditionalInformation

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager

Field Detail

m_Finder

protected AbstractCellFinder m_Finder

for locating the cells.

m_Conversion

protected Conversion m_Conversion

the conversion to apply to the cells.

Constructor Detail

SpreadSheetConvertCells

public SpreadSheetConvertCells()

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

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.

setConversion

public void setConversion(Conversion value)

Sets the conversion scheme to apply to the located cells.

Parameters:

value - the conversion

getConversion

public Conversion getConversion()

Returns the conversion scheme to apply to the located cells.

Returns:

the conversion

conversionTipText

public String conversionTipText()

Returns the tip text for this property.

Returns:

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

convertCell

protected String convertCell(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

stopExecution

public void stopExecution()

Stops the execution. No message set.

Specified by:

stopExecution in interface Stoppable

Specified by:

stopExecution in interface Actor

Overrides:

stopExecution in class AbstractActor