Package adams.data.conversion

Class TextRenderer

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.conversion.AbstractConversion

adams.data.conversion.AbstractConversionToString

adams.data.conversion.TextRenderer

All Implemented Interfaces:

AdditionalInformationHandler, ClassCrossReference, CleanUpHandler, CrossReference, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<AbstractConversion>, SizeOfHandler, Stoppable, Conversion, ConversionToString, Serializable

public class TextRenderer
extends AbstractConversionToString
implements ClassCrossReference

Turns incoming objects into their textual representation, either automatic detection based on their data type or by explicitly specifying a renderer.

See also:
adams.flow.transformer.TextRenderer

-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
 

-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 Summary

Fields

Modifier and Type	Field	Description
protected TextRenderer	m_CustomRenderer	the custom renderer to use.
protected boolean	m_UnlimitedRendering	whether to perform unlimited rendering.
protected boolean	m_UseCustomRenderer	whether to use a custom renderer.

Fields inherited from class adams.data.conversion.AbstractConversion

m_Input, m_Output, m_Owner, m_Stopped

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
TextRenderer()

Method Summary

Modifier and Type	Method	Description
Class	accepts()	Returns the class that is accepted as input.
String	customRendererTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
protected Object	doConvert()	Performs the actual conversion.
Class[]	getClassCrossReferences()	Returns the cross-referenced classes.
TextRenderer	getCustomRenderer()	Returns the custom renderer to use.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
boolean	getUnlimitedRendering()	Returns whether to use unlimited rendering if possible.
boolean	getUseCustomRenderer()	Returns whether to use a custom renderer.
String	globalInfo()	Returns a string describing the object.
void	setCustomRenderer(TextRenderer value)	Sets the custom renderer to use.
void	setUnlimitedRendering(boolean value)	Sets whether to use unlimited rendering (if possible).
void	setUseCustomRenderer(boolean value)	Sets whether to use a custom renderer.
String	unlimitedRenderingTipText()	Returns the tip text for this property.
String	useCustomRendererTipText()	Returns the tip text for this property.

Methods inherited from class adams.data.conversion.AbstractConversionToString

generates

Methods inherited from class adams.data.conversion.AbstractConversion

checkData, cleanUp, convert, getAdditionalInformation, getInput, getInput, getOutput, getOutput, getOwner, reset, setInput, setOwner, shallowCopy, shallowCopy, stopExecution

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.CleanUpHandler

cleanUp

Methods inherited from interface adams.data.conversion.Conversion

convert, getInput, getInput, getOutput, getOutput, getOwner, setInput, setOwner

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.Stoppable

stopExecution

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

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

getClassCrossReferences

public Class[] getClassCrossReferences()

Returns the cross-referenced classes.

Specified by:

getClassCrossReferences in interface ClassCrossReference

Returns:

the classes

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

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.

getQuickInfo

public String getQuickInfo()

Returns a quick info about the actor, which will be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractConversion

Returns:

null if no info available, otherwise short string

accepts

public Class accepts()

Returns the class that is accepted as input.

Specified by:

accepts in interface Conversion

Specified by:

accepts in class AbstractConversion

Returns:

the class

doConvert

protected Object doConvert()
                    throws Exception

Performs the actual conversion.

Specified by:

doConvert in class AbstractConversion

Returns:

the converted data

Throws:

Exception - if something goes wrong with the conversion