Package adams.flow.sink

Class SimpleLogging

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, Serializable, Comparable
    public class SimpleLogging
extends AbstractSink
    Turns the incoming objects into strings, formats them with the selected formatter and then outputs them with the specified output(s).

    Input/output:
    - accepts:
       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
    min-user-mode: Expert
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: SimpleLogging
 
    -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
    min-user-mode: Expert
 
    -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
    min-user-mode: Expert
 
    -use-custom-renderer <boolean> (property: useCustomRenderer)
    If enabled, the specified custom renderer is used for turning the object
    into a string rather than automatically determining a renderer.
    default: false
 
    -custom-renderer <adams.data.textrenderer.TextRenderer> (property: customRenderer)
    The custom renderer to use.
    default: adams.data.textrenderer.DefaultTextRenderer
 
    -format <adams.flow.sink.simplelogging.format.SimpleFormat> (property: format)
    The formatting scheme to use.
    default: adams.flow.sink.simplelogging.format.NoFormat
 
    -output <adams.flow.sink.simplelogging.output.SimpleOutput> (property: output)
    The type of output to use for the formatted message.
    default: adams.flow.sink.simplelogging.output.ConsoleOutput
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_UseCustomRenderer

        protected boolean m_UseCustomRenderer
        whether to use a custom text renderer.

      • m_CustomRenderer

        protected TextRenderer m_CustomRenderer
        the custom renderer to use.

      • m_Format

        protected SimpleFormat m_Format
        the formatter to use.

      • m_Output

        protected SimpleOutput m_Output
        the output to use.

    • Constructor Detail

      • SimpleLogging

        public SimpleLogging()

    • Method Detail

      • setUseCustomRenderer

        public void setUseCustomRenderer​(boolean value)
        Sets whether to use a custom renderer instead of automatically determining it.
        Parameters:
        value - true if to use custom renderer

      • getUseCustomRenderer

        public boolean getUseCustomRenderer()
        Returns whether to use a custom renderer instead of automatically determining it.
        Returns:
        true if to use custom renderer

      • useCustomRendererTipText

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

      • setCustomRenderer

        public void setCustomRenderer​(TextRenderer value)
        Sets the custom renderer to use.
        Parameters:
        value - the renderer

      • getCustomRenderer

        public TextRenderer getCustomRenderer()
        Returns the custom renderer to use.
        Returns:
        the renderer

      • customRendererTipText

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

      • setFormat

        public void setFormat​(SimpleFormat value)
        Sets the formatting scheme to use.
        Parameters:
        value - the format

      • getFormat

        public SimpleFormat getFormat()
        Returns the formatting scheme to use.
        Returns:
        the format

      • formatTipText

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

      • setOutput

        public void setOutput​(SimpleOutput value)
        Sets the type of output to use.
        Parameters:
        value - the output

      • getOutput

        public SimpleOutput getOutput()
        Returns the type of output to use.
        Returns:
        the output

      • outputTipText

        public String outputTipText()
        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:
        the Class of objects that can be processed

      • doExecute

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