adams.flow.transformer
Class SpreadSheetInsertColumn

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

All Implemented Interfaces:

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

public class SpreadSheetInsertColumn
extends AbstractInPlaceSpreadSheetTransformer

Inserts a column at a specific position into spreadsheets coming through.
The cells are initialized with a pre-defined value.

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

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

-position <adams.data.spreadsheet.SpreadSheetColumnIndex> (property: position)
    The position where to insert the column; 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
 

-after (property: after)
    If enabled, the column is inserted after the position instead of at the 
    position.
 

-header <java.lang.String> (property: header)
    The name of the new column.
    default: New
 

-value <java.lang.String> (property: value)
    The value to intialize the cells with; you can use '\t' for tab, '\n' for 
    line-feed and '\r' for carriage-return.
    default: ?
 

-placeholder (property: valueContainsPlaceholder)
    Set this to true to enable automatic placeholder expansion for the value 
    string.
 

-variable (property: valueContainsVariable)
    Set this to true to enable automatic variable expansion for the value string.
 

-force-string (property: forceString)
    If enabled, the value is set as string, even if it resembles a number.
 

Version:

$Revision: 6998 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

protected boolean	m_After whether to insert after the position instead of at.
protected boolean	m_ForceString whether to set value as string.
protected String	m_Header the column header.
protected SpreadSheetColumnIndex	m_Position the position where to insert the column.
protected String	m_Value the value to initialize the cells with.
protected boolean	m_ValueContainsPlaceholder whether the value string contains a placeholder, which needs to be expanded first.
protected boolean	m_ValueContainsVariable whether the value string contains a variable, which needs to be expanded first.

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

SpreadSheetInsertColumn()

Method Summary

String	afterTipText() Returns the tip text for this property.
void	defineOptions() Adds options to the internal list of options.
protected String	doExecute() Executes the flow item.
String	forceStringTipText() Returns the tip text for this property.
boolean	getAfter() Returns whether to insert at or after the position.
boolean	getForceString() Returns whether to force setting the value as string even if it resembles a number.
String	getHeader() Returns the name of the column.
SpreadSheetColumnIndex	getPosition() Returns the position where to insert the column.
String	getQuickInfo() Returns a quick info about the actor, which will be displayed in the GUI.
String	getValue() Returns the value to insert.
boolean	getValueContainsPlaceholder() Returns whether the vaue string contains a placeholder which needs to be expanded first.
boolean	getValueContainsVariable() Returns whether the value string contains a variable which needs to be expanded first.
String	globalInfo() Returns a string describing the object.
String	headerTipText() Returns the tip text for this property.
protected void	initialize() Initializes the members.
String	positionTipText() Returns the tip text for this property.
void	setAfter(boolean value) Sets whether to insert at or after the position.
void	setForceString(boolean value) Sets whether to force setting the value as string even if it resembles a number.
void	setHeader(String value) Sets the name of the column.
void	setPosition(SpreadSheetColumnIndex value) Sets the position where to insert the column.
void	setValue(String value) Sets the value to insert.
void	setValueContainsPlaceholder(boolean value) Sets whether the value string contains a placeholder which needs to be expanded first.
void	setValueContainsVariable(boolean value) Sets whether the value string contains a variable which needs to be expanded first.
String	valueContainsPlaceholderTipText() Returns the tip text for this property.
String	valueContainsVariableTipText() Returns the tip text for this property.
String	valueTipText() 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

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, 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, 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, stopExecution, variableChanged

Methods inherited from interface adams.core.AdditionalInformationHandler

getAdditionalInformation

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager

Field Detail

m_Position

protected SpreadSheetColumnIndex m_Position

the position where to insert the column.

m_After

protected boolean m_After

whether to insert after the position instead of at.

m_Header

protected String m_Header

the column header.

m_Value

protected String m_Value

the value to initialize the cells with.

m_ValueContainsPlaceholder

protected boolean m_ValueContainsPlaceholder

whether the value string contains a placeholder, which needs to be expanded first.

m_ValueContainsVariable

protected boolean m_ValueContainsVariable

whether the value string contains a variable, which needs to be expanded first.

m_ForceString

protected boolean m_ForceString

whether to set value as string.

Constructor Detail

SpreadSheetInsertColumn

public SpreadSheetInsertColumn()

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

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class AbstractActor

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

setPosition

public void setPosition(SpreadSheetColumnIndex value)

Sets the position where to insert the column.

Parameters:

value - the position

getPosition

public SpreadSheetColumnIndex getPosition()

Returns the position where to insert the column.

Returns:

the position

positionTipText

public String positionTipText()

Returns the tip text for this property.

Returns:

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

setAfter

public void setAfter(boolean value)

Sets whether to insert at or after the position.

Parameters:

value - true if to add after

getAfter

public boolean getAfter()

Returns whether to insert at or after the position.

Returns:

true if to add after

afterTipText

public String afterTipText()

Returns the tip text for this property.

Returns:

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

setHeader

public void setHeader(String value)

Sets the name of the column.

Parameters:

value - the name

getHeader

public String getHeader()

Returns the name of the column.

Returns:

the name

headerTipText

public String headerTipText()

Returns the tip text for this property.

Returns:

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

setValue

public void setValue(String value)

Sets the value to insert.

Parameters:

value - the value

getValue

public String getValue()

Returns the value to insert.

Returns:

the value

valueTipText

public String valueTipText()

Returns the tip text for this property.

Returns:

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

setValueContainsPlaceholder

public void setValueContainsPlaceholder(boolean value)

Sets whether the value string contains a placeholder which needs to be expanded first.

Parameters:

value - true if value string contains a placeholder

getValueContainsPlaceholder

public boolean getValueContainsPlaceholder()

Returns whether the vaue string contains a placeholder which needs to be expanded first.

Returns:

true if value string contains a placeholder

valueContainsPlaceholderTipText

public String valueContainsPlaceholderTipText()

Returns the tip text for this property.

Returns:

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

setValueContainsVariable

public void setValueContainsVariable(boolean value)

Sets whether the value string contains a variable which needs to be expanded first.

Parameters:

value - true if value string contains a variable

getValueContainsVariable

public boolean getValueContainsVariable()

Returns whether the value string contains a variable which needs to be expanded first.

Returns:

true if value string contains a variable

valueContainsVariableTipText

public String valueContainsVariableTipText()

Returns the tip text for this property.

Returns:

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

setForceString

public void setForceString(boolean value)

Sets whether to force setting the value as string even if it resembles a number.

Parameters:

value - true if to force string

getForceString

public boolean getForceString()

Returns whether to force setting the value as string even if it resembles a number.

Returns:

true if string type is enforced

forceStringTipText

public String forceStringTipText()

Returns the tip text for this property.

Returns:

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

doExecute

protected String doExecute()

Executes the flow item.

Specified by:

doExecute in class AbstractActor

Returns:

null if everything is fine, otherwise error message