Package adams.flow.transformer

Class SpreadSheetSubset

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, SpreadSheetViewCreator, VariableChangeListener, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class SpreadSheetSubset
extends AbstractSpreadSheetTransformer
implements SpreadSheetViewCreator
    Extracts a subset of rows/columns from a spreadsheet.

    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: SpreadSheetSubset
 
    -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
 
    -row <adams.core.Range> (property: rows)
    The rows of the subset to retrieve.
    default: first-last
    example: 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
 
    -col <adams.data.spreadsheet.SpreadSheetColumnRange> (property: columns)
    The columns of the subset to retrieve; A range is a comma-separated list 
    of single 1-based indices or sub-ranges of indices ('start-end'); 'inv(..
    .)' inverts the range '...'; column names (case-sensitive) as well as the 
    following placeholders can be used: first, second, third, last_2, last_1,
     last; numeric indices can be enforced by preceding them with '#' (eg '#12'
    ); column names can be surrounded by double quotes.
    default: first-last
    example: A range is a comma-separated list of single 1-based indices or sub-ranges of indices ('start-end'); 'inv(...)' inverts the range '...'; column names (case-sensitive) as well as the following placeholders can be used: first, second, third, last_2, last_1, last; numeric indices can be enforced by preceding them with '#' (eg '#12'); column names can be surrounded by double quotes.
 
    -subset <adams.core.base.MatrixSubset> (property: subset)
    R-like matrix subsets with format '<rows>,<cols>'; eg '1:4,' means rows 
    1 to 4 and all columns.
    default: 
 
    -create-view <boolean> (property: createView)
    If enabled, then only a view of the subset is created.
    default: false
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Rows

        protected Range m_Rows
        the rows of the subset to obtain.

      • m_Subset

        protected MatrixSubset m_Subset
        the matrix subset.

      • m_CreateView

        protected boolean m_CreateView
        whether to create a view only.

    • Constructor Detail

      • SpreadSheetSubset

        public SpreadSheetSubset()

    • Method Detail

      • setRows

        public void setRows​(Range value)
        Sets the rows of the subset.
        Parameters:
        value - the rows

      • getRows

        public Range getRows()
        Returns the rows of the subset.
        Returns:
        the rows

      • rowsTipText

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

      • setColumns

        public void setColumns​(SpreadSheetColumnRange value)
        Sets the columns of the subset.
        Parameters:
        value - the columns

      • getColumns

        public SpreadSheetColumnRange getColumns()
        Returns the columns of the subset.
        Returns:
        the columns

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

      • setSubset

        public void setSubset​(MatrixSubset value)
        Sets the R-like matrix subset (eg '1:4,').
        Parameters:
        value - the subset

      • getSubset

        public MatrixSubset getSubset()
        Returns the R-like matrix subset (eg '1:4,').
        Returns:
        the subset

      • subsetTipText

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

      • setCreateView

        public void setCreateView​(boolean value)
        Sets whether to create a view only.
        Specified by:
        setCreateView in interface SpreadSheetViewCreator
        Parameters:
        value - true if to create a view only

      • getCreateView

        public boolean getCreateView()
        Returns whether to create only a view.
        Specified by:
        getCreateView in interface SpreadSheetViewCreator
        Returns:
        true if to create view only

      • createViewTipText

        public String createViewTipText()
        Returns the tip text for this property.
        Specified by:
        createViewTipText in interface SpreadSheetViewCreator
        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