Package adams.flow.transformer

Class SpreadSheetInsertRow

  • 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 SpreadSheetInsertRow
extends AbstractInPlaceSpreadSheetTransformer
    Inserts a row 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


    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: SpreadSheetInsertRow
 
    -annotation <adams.core.base.BaseAnnotation> (property: annotations)
    The annotations to attach to this actor.
    default:
 
    -skip <boolean> (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded
    as it is.
    default: false
 
    -stop-flow-on-error <boolean> (property: stopFlowOnError)
    If set to true, the flow execution at this level gets stopped in case this
    actor encounters an error; the error gets propagated; useful for critical
    actors.
    default: false
 
    -silent <boolean> (property: silent)
    If enabled, then no errors are output in the console; Note: the enclosing
    actor handler must have this enabled as well.
    default: false
 
    -no-copy <boolean> (property: noCopy)
    If enabled, no copy of the spreadsheet is created before processing it.
    default: false
 
    -position <adams.core.Index> (property: position)
    The position where to insert the column.
    default: last
    example: An index is a number starting with 1; the following placeholders can be used as well: first, second, third, last_2, last_1, last
 
    -after <boolean> (property: after)
    If enabled, the column is inserted after the position instead of at the
    position.
    default: false
 
    -value <java.lang.String> (property: value)
    The value to initialize the cells with; you can use '\t' for tab, '\n' for
    line-feed and '\r' for carriage-return.
    default: ?
 
    -value-type <SINGLE_VALUE|COMMA_SEPARATED_VALUES|BLANK_SEPARATED_VALUES> (property: valueType)
    How to interpret the value string.
    default: SINGLE_VALUE
 
    -placeholder <boolean> (property: valueContainsPlaceholder)
    Set this to true to enable automatic placeholder expansion for the value
    string.
    default: false
 
    -variable <boolean> (property: valueContainsVariable)
    Set this to true to enable automatic variable expansion for the value string.
    default: false
 
    -force-string <boolean> (property: forceString)
    If enabled, the value is set as string, even if it resembles a number.
    default: false
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Position

        protected Index m_Position
        the position where to insert the row.

      • m_After

        protected boolean m_After
        whether to insert after the position instead of at.

      • 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

      • SpreadSheetInsertRow

        public SpreadSheetInsertRow()

    • Method Detail

      • setPosition

        public void setPosition​(Index value)
        Sets the position where to insert the string.
        Parameters:
        value - the position

      • getPosition

        public Index getPosition()
        Returns the position where to insert the string.
        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.

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

      • valueTypeTipText

        public String valueTypeTipText()
        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