Package adams.data.io.output

Class JsonFlowWriter

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.io.output.AbstractFlowWriter

adams.data.io.output.JsonFlowWriter

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, FileFormatHandler, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, FlowWriter, Serializable

public class JsonFlowWriter
extends AbstractFlowWriter

Writes flows in JSON format.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class adams.data.io.output.AbstractFlowWriter

AbstractFlowWriter.OutputType

Field Summary

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

Method Summary

Modifier and Type	Method	Description
protected boolean	doWrite(Actor content, File file)	Writes the given content to the specified file.
FlowReader	getCorrespondingReader()	Returns the corresponding reader, if available.
String	getFormatDescription()	Returns a string describing the format (used in the file chooser).
String[]	getFormatExtensions()	Returns the extension(s) of the format.
protected AbstractFlowWriter.OutputType	getOutputType()	Returns how to write the data, from a file, stream or writer.
String	globalInfo()	Returns a string describing the object.

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

doWrite, doWrite, getDefaultFormatExtension, getWriters, write, write, write, write

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, defineOptions, 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.Destroyable

destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, defineOptions, getOptionManager, toCommandLine

Constructor Detail

JsonFlowWriter

public JsonFlowWriter()

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 AbstractFlowWriter

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 AbstractFlowWriter

Returns:

the extension (without the dot!)

getOutputType

protected AbstractFlowWriter.OutputType getOutputType()

Returns how to write the data, from a file, stream or writer.

Specified by:

getOutputType in class AbstractFlowWriter

Returns:

how to write the data

doWrite

protected boolean doWrite(Actor content,
                          File file)

Writes the given content to the specified file.

Overrides:

doWrite in class AbstractFlowWriter

Parameters:

content - the content to write

file - the file to write to

Returns:

true if successfully written

getCorrespondingReader

public FlowReader getCorrespondingReader()

Returns the corresponding reader, if available.

Returns:

the reader, null if none available