Package adams.flow.transformer

Class SpreadSheetAppendComments

  • 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 SpreadSheetAppendComments
extends AbstractInPlaceSpreadSheetTransformer
    Appends the comments of the spreadsheet. Complete replacement is possible as well.

    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: SpreadSheetAppendComments
 
    -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
 
    -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
 
    -comments <adams.core.base.BaseText> (property: comments)
    The comments to use.
    default: 
 
    -replace <boolean> (property: replace)
    If enabled, any existing comments get replaced with the currently specified 
    ones.
    default: false
    Version:
    $Revision$
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Comments

        protected BaseText m_Comments
        the comments to append.

      • m_Replace

        protected boolean m_Replace
        whether to replace any existing comments with the new one.

    • Constructor Detail

      • SpreadSheetAppendComments

        public SpreadSheetAppendComments()

    • Method Detail

      • setComments

        public void setComments​(BaseText value)
        Sets the comments to use.
        Parameters:
        value - the comments

      • getComments

        public BaseText getComments()
        Returns the comments to use.
        Returns:
        the comments

      • commentsTipText

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

      • setReplace

        public void setReplace​(boolean value)
        Sets whether to replace any existing comments rather than append.
        Parameters:
        value - true if to replace any existing comments

      • getReplace

        public boolean getReplace()
        Returns whether to replace any existing comments rather than append.
        Returns:
        true if to replace any existing comments

      • replaceTipText

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