Package adams.gui.tools.previewbrowser.notes

Class CsvNotesReader

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.tools.previewbrowser.notes.AbstractNotesReader

adams.gui.tools.previewbrowser.notes.CsvNotesReader

All Implemented Interfaces:

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

public class CsvNotesReader
extends AbstractNotesReader

Reads notes in CSV format.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

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

Method Summary

Modifier and Type	Method	Description
protected Map<String,String>	doRead(PlaceholderFile file, MessageCollection errors)	Reads the notes from the specified file.
AbstractNotesWriter	getCorrespondingWriter()	Returns the corresponding writer.
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.
String	globalInfo()	Returns a string describing the object.

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

addIfFileExists, check, read, read

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.logging.LoggingLevelHandler

getLoggingLevel

Constructor Detail

CsvNotesReader

public CsvNotesReader()

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).

Returns:

a description suitable for displaying in the file chooser

getFormatExtensions

public String[] getFormatExtensions()

Returns the extension(s) of the format.

Returns:

the extension (without the dot!)

getDefaultFormatExtension

public String getDefaultFormatExtension()

Returns the default extension of the format.

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 AbstractNotesReader

Returns:

the name, no path

getCorrespondingWriter

public AbstractNotesWriter getCorrespondingWriter()

Returns the corresponding writer.

Specified by:

getCorrespondingWriter in class AbstractNotesReader

Returns:

the writer, null if not available

doRead

protected Map<String,String> doRead(PlaceholderFile file,
                                          MessageCollection errors)

Reads the notes from the specified file.

Specified by:

doRead in class AbstractNotesReader

Parameters:

file - the file to read the notes from

errors - for recording errors

Returns:

the notes, null if failed to read