Package adams.data.io.output

Class AbstractSimpleJsonReportWriter<T extends Report>

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.io.output.AbstractReportWriter<T>

adams.data.io.output.AbstractSimpleJsonReportWriter<T>

Type Parameters:

T - the type of report to handle

All Implemented Interfaces:

CleanUpHandler, Destroyable, GlobalInfoSupporter, FileFormatHandler, PrettyPrintingSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<AbstractReportWriter>, SizeOfHandler, ReportWriter<T>, Serializable, Comparable

Direct Known Subclasses:

DefaultSimpleJsonReportWriter

public abstract class AbstractSimpleJsonReportWriter<T extends Report>
extends AbstractReportWriter<T>
implements PrettyPrintingSupporter

Abstract ancestor for writing reports in Json format.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_PrettyPrinting	whether to use pretty-printing.

Fields inherited from class adams.data.io.output.AbstractReportWriter

m_Output

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
String	getFormatDescription()	Returns a string describing the format (used in the file chooser).
String[]	getFormatExtensions()	Returns the extension(s) of the format.
boolean	getPrettyPrinting()	Returns whether pretty-printing is used or not.
String	globalInfo()	Returns a string describing the object.
String	prettyPrintingTipText()	Returns the tip text for this property.
void	setPrettyPrinting(boolean value)	Sets whether to use pretty-printing or not.
protected boolean	writeData(T data)	Performs the actual writing.

Methods inherited from class adams.data.io.output.AbstractReportWriter

checkData, cleanUp, compareTo, destroy, equals, forCommandLine, forName, getDefaultFormatExtension, getOutput, getWriters, outputTipText, reset, setOutput, shallowCopy, shallowCopy, write

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, 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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_PrettyPrinting

protected boolean m_PrettyPrinting

whether to use pretty-printing.

Constructor Detail

AbstractSimpleJsonReportWriter

public AbstractSimpleJsonReportWriter()

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

getFormatDescription

public String getFormatDescription()

Returns a string describing the format (used in the file chooser).

Specified by:

getFormatDescription in interface FileFormatHandler

Specified by:

getFormatDescription in class AbstractReportWriter<T extends Report>

Returns:

a description suitable for displaying in the file chooser

getFormatExtensions

public String[] getFormatExtensions()

Returns the extension(s) of the format.

Specified by:

getFormatExtensions in interface FileFormatHandler

Specified by:

getFormatExtensions in class AbstractReportWriter<T extends Report>

Returns:

the extension(s) (without the dot!)

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractReportWriter<T extends Report>

setPrettyPrinting

public void setPrettyPrinting(boolean value)

Sets whether to use pretty-printing or not.

Specified by:

setPrettyPrinting in interface PrettyPrintingSupporter

Parameters:

value - true if to use pretty-printing

getPrettyPrinting

public boolean getPrettyPrinting()

Returns whether pretty-printing is used or not.

Specified by:

getPrettyPrinting in interface PrettyPrintingSupporter

Returns:

true if to use pretty-printing

prettyPrintingTipText

public String prettyPrintingTipText()

Returns the tip text for this property.

Specified by:

prettyPrintingTipText in interface PrettyPrintingSupporter

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

writeData

protected boolean writeData(T data)

Performs the actual writing.

Specified by:

writeData in class AbstractReportWriter<T extends Report>

Parameters:

data - the data to write

Returns:

true if successfully written