Package adams.flow.transformer

Class SpreadSheetRowBinning

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, BinningAlgorithmUser, BinPostProcessingUser, InPlaceProcessing, VariableChangeListener, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class SpreadSheetRowBinning
extends AbstractInPlaceSpreadSheetTransformer
implements BinningAlgorithmUser, BinPostProcessingUser
    Applies a binning algorithm to the values from the specified binning column to filter the rows into specific bins.
    A new column is then added containing the corresponding bin index.

    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: SpreadSheetRowBinning
 
    -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
 
    -binning-column <adams.data.spreadsheet.SpreadSheetColumnIndex> (property: binningColumn)
    The column to obtain the numeric values from to use for binning.
    default: first
    example: An index is a number starting with 1; 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.
 
    -algorithm <adams.data.binning.algorithm.BinningAlgorithm> (property: algorithm)
    The binning algorithm to apply.
    default: adams.data.binning.algorithm.ManualBinning
 
    -post-processing <adams.data.binning.postprocessing.AbstractBinPostProcessing> (property: postProcessing)
    The post-processing algorithm to apply to the bins.
    default: adams.data.binning.postprocessing.PassThrough
 
    -position <adams.data.spreadsheet.SpreadSheetColumnIndex> (property: position)
    The position where to insert the column; An index is a number starting with
    1; 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: last
    example: An index is a number starting with 1; 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.
 
    -after <boolean> (property: after)
    If enabled, the column is inserted after the position instead of at the
    position.
    default: false
 
    -header <java.lang.String> (property: header)
    The name of the new column.
    default: Bin
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_BinningColumn

        protected SpreadSheetColumnIndex m_BinningColumn
        the numeric column to use for determining the bins.

      • m_Algorithm

        protected BinningAlgorithm m_Algorithm
        the binning algorithm to use.

      • m_PostProcessing

        protected BinPostProcessing m_PostProcessing
        for post-processing the bins.

      • m_After

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

      • m_Header

        protected String m_Header
        the column header.

    • Constructor Detail

      • SpreadSheetRowBinning

        public SpreadSheetRowBinning()

    • Method Detail

      • setBinningColumn

        public void setBinningColumn​(SpreadSheetColumnIndex value)
        Sets the numeric column to use for binning.
        Parameters:
        value - the column

      • getBinningColumn

        public SpreadSheetColumnIndex getBinningColumn()
        Returns the numeric column to use for binning.
        Returns:
        the column

      • binningColumnTipText

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

      • algorithmTipText

        public String algorithmTipText()
        Returns the tip text for this property.
        Specified by:
        algorithmTipText in interface BinningAlgorithmUser
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • postProcessingTipText

        public String postProcessingTipText()
        Returns the tip text for this property.
        Specified by:
        postProcessingTipText in interface BinPostProcessingUser
        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 column.
        Parameters:
        value - the position

      • getPosition

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

      • setHeader

        public void setHeader​(String value)
        Sets the name of the column.
        Parameters:
        value - the name

      • getHeader

        public String getHeader()
        Returns the name of the column.
        Returns:
        the name

      • headerTipText

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