Package adams.flow.transformer

Class TextRenderer

  • All Implemented Interfaces:
    AdditionalInformationHandler, ClassCrossReference, CleanUpHandler, CrossReference, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class TextRenderer
extends AbstractTransformer
implements ClassCrossReference
    Turns incoming objects into their textual representation, either automatic detection based on their data type or by explicitly specifying a renderer.

    Input/output:
    - accepts:
       java.lang.Object
    - generates:
       java.lang.String


    -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: TextRenderer
 
    -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
 
    -use-custom-renderer <boolean> (property: useCustomRenderer)
    If enabled, uses the specified custom renderer.
    default: false
 
    -custom-renderer <adams.data.textrenderer.TextRenderer> (property: customRenderer)
    The custom renderer to use (if enabled).
    default: adams.data.textrenderer.DefaultTextRenderer
 
    -unlimited-rendering <boolean> (property: unlimitedRendering)
    If enabled (and the renderer implements adams.data.textrenderer.LimitedTextRenderer
    ), unlimited rendering is performed.
    default: false
    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 renderer.

      • m_CustomRenderer

        protected TextRenderer m_CustomRenderer
        the custom renderer to use.

      • m_UnlimitedRendering

        protected boolean m_UnlimitedRendering
        whether to perform unlimited rendering.

    • Constructor Detail

      • TextRenderer

        public TextRenderer()

    • Method Detail

      • setUseCustomRenderer

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

      • getUseCustomRenderer

        public boolean getUseCustomRenderer()
        Returns whether to use a custom renderer.
        Returns:
        true if custom

      • 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.

      • setUnlimitedRendering

        public void setUnlimitedRendering​(boolean value)
        Sets whether to use unlimited rendering (if possible).
        Parameters:
        value - true if unlimited

      • getUnlimitedRendering

        public boolean getUnlimitedRendering()
        Returns whether to use unlimited rendering if possible.
        Returns:
        true if unlimited

      • unlimitedRenderingTipText

        public String unlimitedRenderingTipText()
        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.
        Specified by:
        accepts in interface InputConsumer
        Returns:
        the Class of objects that can be processed

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Specified by:
        generates in interface OutputProducer
        Returns:
        the Class of the generated tokens

      • doExecute

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