Package adams.flow.transformer

Class SpreadSheetInsertColumn

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, 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.
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • 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

      • 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