Package adams.flow.transformer

Class SpreadSheetSortColumns

  • 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 SpreadSheetSortColumns
extends AbstractSpreadSheetTransformer
    Reorders a user-defined subset of columns by name using the specified comparator.

    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: SpreadSheetSortColumns
 
    -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
 
    -columns <adams.data.spreadsheet.SpreadSheetColumnRange> (property: columns)
    The subset of columns to perform the sorting on.
    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.
 
    -comparator <java.util.Comparator> (property: comparator)
    The comparator to use; must implement java.util.Comparator and java.io.Serializable
    default: adams.core.DefaultCompare
 
    -reverse <boolean> (property: reverse)
    If enabled, the sorting order gets reversed.
    default: false
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Comparator

        protected Comparator m_Comparator
        the comparator to use.

      • m_Reverse

        protected boolean m_Reverse
        whether to reverse the sorting.

    • Constructor Detail

      • SpreadSheetSortColumns

        public SpreadSheetSortColumns()

    • Method Detail

      • setColumns

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

      • getColumns

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

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

      • setComparator

        public void setComparator​(Comparator value)
        Sets the comparator to use.
        Parameters:
        value - the comparator

      • getComparator

        public Comparator getComparator()
        Returns the comparator to use.
        Returns:
        the comparator

      • comparatorTipText

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

      • setReverse

        public void setReverse​(boolean value)
        Sets whether to reverse the sorting.
        Parameters:
        value - true if to reverse

      • getReverse

        public boolean getReverse()
        Returns whether to reverse the sorting.
        Returns:
        true if to reverse

      • reverseTipText

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