Class SpreadSheetCopyColumns

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable

    public class SpreadSheetCopyColumns
    extends AbstractSpreadSheetTransformer
    Copies a range of columns to a specific position in the spreadsheets coming through.

    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: SpreadSheetCopyColumns
     
    -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.
     
    -columns <adams.core.Range> (property: columns)
        The range of columns to copy; A range is a comma-separated list of single 
        1-based indices or sub-ranges of indices ('start-end'); 'inv(...)' inverts 
        the range '...'; the following placeholders can be used as well: first, 
        second, third, last_2, last_1, last
        default: first-last
     
    -position <adams.core.Index> (property: position)
        The position where to insert the column; An index is a number starting with 
        1; the following placeholders can be used as well: first, second, third, 
        last_2, last_1, last
        default: first
     
    -after (property: after)
        If enabled, the column is inserted after the position instead of at the 
        position.
     
    -prefix <java.lang.String> (property: prefix)
        The prefix to use for the column headers, can be empty.
        default: Copy-
     
    Version:
    $Revision$
    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_Prefix

        protected String m_Prefix
        the prefix for the new columns.
    • Constructor Detail

      • SpreadSheetCopyColumns

        public SpreadSheetCopyColumns()
    • Method Detail

      • setColumns

        public void setColumns​(SpreadSheetColumnRange value)
        Sets the range of columns to copy.
        Parameters:
        value - the range
      • getColumns

        public SpreadSheetColumnRange getColumns()
        Returns the range of columns to copy.
        Returns:
        the position
      • columnsTipText

        public String columnsTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • setPosition

        public void setPosition​(SpreadSheetColumnIndex value)
        Sets the position where to insert the columns.
        Parameters:
        value - the position
      • getPosition

        public SpreadSheetColumnIndex getPosition()
        Returns the position where to insert the columns.
        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.
      • setPrefix

        public void setPrefix​(String value)
        Sets the prefix to use for the copied column headers.
        Parameters:
        value - the prefix
      • getPrefix

        public String getPrefix()
        Returns the prefix to use for the copied column headers.
        Returns:
        the position
      • prefixTipText

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