Package adams.flow.transformer

Class Sort

  • 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 Sort
extends AbstractTransformer
    Actor for sorting arrays.

    Input/output:
    - accepts:
       adams.flow.core.Unknown[]
    - generates:
       adams.flow.core.Unknown[]


    -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: Sort
 
    -annotation <adams.core.base.BaseText> (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 gets stopped in case this actor encounters an error;
     useful for critical actors.
    default: false
 
    -reverse <boolean> (property: reverse)
    If enabled, then the sorting will be reversed.
    default: false
 
    -unique <boolean> (property: unique)
    If enabled, then only unique entries will be output.
    default: false
 
    -use-comparator <boolean> (property: useComparator)
    If enabled, the selected comparator is used for sorting.
    default: false
 
    -comparator <java.util.Comparator> (property: comparator)
    The comparator to use; must implement java.util.Comparator and java.io.Serializable
    default: adams.core.DefaultCompare
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Reverse

        protected boolean m_Reverse
        reverse sorting.

      • m_Unique

        protected boolean m_Unique
        unqiue entries.

      • m_UseComparator

        protected boolean m_UseComparator
        whether to use a specific Comparator for sorting.

      • m_Comparator

        protected Comparator m_Comparator
        the comparator to use.

    • Constructor Detail

      • Sort

        public Sort()

    • Method Detail

      • setReverse

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

      • getReverse

        public boolean getReverse()
        Returns whether the sorting is reversed.
        Returns:
        true if reversed

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

      • setUnique

        public void setUnique​(boolean value)
        Sets whether to allow only unique entries.
        Parameters:
        value - if true then only unique entries are output

      • getUnique

        public boolean getUnique()
        Returns whether only unique entries are output.
        Returns:
        true if only unique entries are output

      • uniqueTipText

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

      • setUseComparator

        public void setUseComparator​(boolean value)
        Sets whether to use a custom comparator for sorting.
        Parameters:
        value - if true then the selected comparator is used

      • getUseComparator

        public boolean getUseComparator()
        Returns whether to use a custom comparator for sorting.
        Returns:
        true if to use comparator

      • useComparatorTipText

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

      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        Returns:
        adams.flow.core.Unknown[].class

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Returns:
        adams.flow.core.Unknown[].class

      • doExecute

        protected String doExecute()
        Executes the flow item.
        Specified by:
        doExecute in class AbstractActor
        Returns:
        null if everything is fine, otherwise error message