Package adams.flow.transformer

Class AddNote

  • 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 AddNote
extends AbstractTransformer
    Adds a note to the notes handler passing through.
    Pre-defined note types:
    - ERROR:
    - WARNING:
    - PROCESS INFORMATION

    Input/output:
    - accepts:
       adams.data.NotesHandler
    - generates:
       adams.data.NotesHandler


    -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: AddNote
 
    -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
 
    -note-group <java.lang.String> (property: noteGroup)
    The group to file the note under, eg a classname.
    default: 
 
    -note-type <java.lang.String> (property: noteType)
    The type of note to add (prefixes the note value); predefined: ERROR: , 
    WARNING: , PROCESS INFORMATION
    default: 
 
    -note-value <java.lang.String> (property: noteValue)
    The value of the note to add.
    default:
    Version:
    $Revision: 6264 $
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_NoteGroup

        protected String m_NoteGroup
        the group of the note to add (eg classname).

      • m_NoteType

        protected String m_NoteType
        the type of note to add.

      • m_NoteValue

        protected String m_NoteValue
        the note value to add.

    • Constructor Detail

      • AddNote

        public AddNote()

    • Method Detail

      • setNoteGroup

        public void setNoteGroup​(String value)
        Sets the note grpup.
        Parameters:
        value - the grpup

      • getNoteGroup

        public String getNoteGroup()
        Returns the note grpup.
        Returns:
        the grpup

      • noteGroupTipText

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

      • setNoteType

        public void setNoteType​(String value)
        Sets the note type.
        Parameters:
        value - the type

      • getNoteType

        public String getNoteType()
        Returns the note type.
        Returns:
        the type

      • noteTypeTipText

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

      • setNoteValue

        public void setNoteValue​(String value)
        Sets the note value.
        Parameters:
        value - the value

      • getNoteValue

        public String getNoteValue()
        Returns the note value.
        Returns:
        the value

      • noteValueTipText

        public String noteValueTipText()
        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.data.NotesHandler.class

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Returns:
        adams.data.NotesHandler.class

      • doExecute

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