Package adams.gui.tools.previewbrowser.notes

Class JsonNotesWriter

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.tools.previewbrowser.notes.AbstractNotesWriter

adams.gui.tools.previewbrowser.notes.JsonNotesWriter

All Implemented Interfaces:

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

public class JsonNotesWriter
extends AbstractNotesWriter
implements PrettyPrintingSupporter

Writes the notes 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.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
JsonNotesWriter()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected String	doWrite(Map<String,String> notes, PlaceholderFile file)	Writes the notes to the specified file.
AbstractNotesReader	getCorrespondingReader()	Returns the corresponding reader.
protected String	getDefaultFileName()	Returns the default file name for the notes file.
String	getDefaultFormatExtension()	Returns the default extension of the format.
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.

Methods inherited from class adams.gui.tools.previewbrowser.notes.AbstractNotesWriter

check, getSortedFiles, write, write

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

Field Detail

m_PrettyPrinting

protected boolean m_PrettyPrinting

whether to use pretty printing.

Constructor Detail

JsonNotesWriter

public JsonNotesWriter()

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

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

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.

getFormatDescription

public String getFormatDescription()

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

Specified by:

getFormatDescription in interface FileFormatHandler

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

Returns:

the extension (without the dot!)

getDefaultFormatExtension

public String getDefaultFormatExtension()

Returns the default extension of the format.

Specified by:

getDefaultFormatExtension in interface FileFormatHandler

Returns:

the default extension (without the dot!)

getDefaultFileName

protected String getDefaultFileName()

Returns the default file name for the notes file.

Specified by:

getDefaultFileName in class AbstractNotesWriter

Returns:

the name, no path

getCorrespondingReader

public AbstractNotesReader getCorrespondingReader()

Returns the corresponding reader.

Specified by:

getCorrespondingReader in class AbstractNotesWriter

Returns:

the reader, null if not available

doWrite

protected String doWrite(Map<String,String> notes,
                         PlaceholderFile file)

Writes the notes to the specified file.

Specified by:

doWrite in class AbstractNotesWriter

Parameters:

notes - the notes to write

file - the file to store the notes in

Returns:

null if successfully written, otherwise error message