Package adams.data.textrenderer

Class CollectionTextRenderer

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.textrenderer.AbstractTextRenderer

adams.data.textrenderer.AbstractLimitedTextRenderer

adams.data.textrenderer.AbstractLineNumberedLimitedTextRenderer

adams.data.textrenderer.CollectionTextRenderer

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, LimitedTextRenderer, LineNumberTextRenderer, TextRenderer, Serializable

public class CollectionTextRenderer
extends AbstractLineNumberedLimitedTextRenderer

Just uses the object's toString() method. Also handles null objects.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields inherited from class adams.data.textrenderer.AbstractLineNumberedLimitedTextRenderer

m_OutputLineNumbers

Fields inherited from class adams.data.textrenderer.AbstractLimitedTextRenderer

DOTS, m_ActualLimit, m_Limit

Fields inherited from class adams.data.textrenderer.AbstractTextRenderer

m_Default, m_Renderers

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
CollectionTextRenderer()

Method Summary

Modifier and Type	Method	Description
protected String	doRender(Object obj)	Renders the object as text.
int	getDefaultLimit()	Returns the default limit.
Integer	getMaxLimit()	Returns the maximum limit.
Integer	getMinLimit()	Returns the minimum limit.
String	globalInfo()	Returns a string describing the object.
boolean	handles(Class cls)	Checks whether the class is handled.
boolean	handles(Object obj)	Checks whether the object is handled.
String	limitTipText()	Returns the tip text for this property.

Methods inherited from class adams.data.textrenderer.AbstractLineNumberedLimitedTextRenderer

defineOptions, getDefaultOutputLineNumbers, getOutputLineNumbers, outputLineNumbersTipText, setOutputLineNumbers

Methods inherited from class adams.data.textrenderer.AbstractLimitedTextRenderer

getActualLimit, getLimit, render, renderUnlimited, setLimit

Methods inherited from class adams.data.textrenderer.AbstractTextRenderer

check, getDefaultRenderer, getRenderer, getRenderer, getRenderers, getRenderers, renderObject

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, 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.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.data.textrenderer.TextRenderer

render

Constructor Detail

CollectionTextRenderer

public CollectionTextRenderer()

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

getDefaultLimit

public int getDefaultLimit()

Returns the default limit.

Specified by:

getDefaultLimit in interface LimitedTextRenderer

Specified by:

getDefaultLimit in class AbstractLimitedTextRenderer

Returns:

the default

getMinLimit

public Integer getMinLimit()

Returns the minimum limit.

Specified by:

getMinLimit in interface LimitedTextRenderer

Specified by:

getMinLimit in class AbstractLimitedTextRenderer

Returns:

the minimum

getMaxLimit

public Integer getMaxLimit()

Returns the maximum limit.

Specified by:

getMaxLimit in interface LimitedTextRenderer

Specified by:

getMaxLimit in class AbstractLimitedTextRenderer

Returns:

the maximum

limitTipText

public String limitTipText()

Returns the tip text for this property.

Specified by:

limitTipText in interface LimitedTextRenderer

Specified by:

limitTipText in class AbstractLimitedTextRenderer

Returns:

tip text for this property suitable for displaying in the explorer/experimenter gui

handles

public boolean handles(Object obj)

Checks whether the object is handled.

Parameters:

obj - the object to check

Returns:

true if handled

handles

public boolean handles(Class cls)

Checks whether the class is handled.

Parameters:

cls - the class to check

Returns:

true if handled

doRender

protected String doRender(Object obj)

Renders the object as text.

Specified by:

doRender in class AbstractTextRenderer

Parameters:

obj - the object to render

Returns:

the generated string or null if failed to render