Package adams.flow.transformer

Class SpreadSheetInsertRowScore

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, InPlaceProcessing, VariableChangeListener, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class SpreadSheetInsertRowScore
extends AbstractInPlaceSpreadSheetTransformer
    Inserts a score column at a specific position into spreadsheets coming through.

    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: SpreadSheetInsertRowScore
 
    -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 gets stopped in case this actor encounters an error;
     useful for critical actors.
    default: false
 
    -no-copy <boolean> (property: noCopy)
    If enabled, no copy of the spreadsheet is created before processing it.
    default: false
 
    -position <adams.data.spreadsheet.SpreadSheetColumnIndex> (property: position)
    The position where to insert the score 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
    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
 
    -after <boolean> (property: after)
    If enabled, the score column is inserted after the position instead of at 
    the position.
    default: true
 
    -header <java.lang.String> (property: header)
    The name of the score column.
    default: Score
 
    -score <adams.data.spreadsheet.rowscore.AbstractRowScore> (property: score)
    The score algorithm to use.
    default: adams.data.spreadsheet.rowscore.RowStatistic -statistic adams.data.spreadsheet.rowstatistic.Mean
    Version:
    $Revision: 7726 $
    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_Header

        protected String m_Header
        the column header.

    • Constructor Detail

      • SpreadSheetInsertRowScore

        public SpreadSheetInsertRowScore()

    • Method Detail

      • setPosition

        public void setPosition​(SpreadSheetColumnIndex value)
        Sets the position where to insert the score column.
        Parameters:
        value - the position

      • getPosition

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

      • getHeader

        public String getHeader()
        Returns the name of the score 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.

      • setScore

        public void setScore​(AbstractRowScore value)
        Sets the score algorithm to use.
        Parameters:
        value - the algorithm

      • getScore

        public AbstractRowScore getScore()
        Returns the score algorithm to use.
        Returns:
        the algorithm

      • scoreTipText

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