Package adams.data.io.input

Class AbstractSimpleReportReader<T extends Report>

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.io.input.AbstractReportReader<T>

adams.data.io.input.AbstractSimpleReportReader<T>

Type Parameters:

T - the type of report to use

All Implemented Interfaces:

CleanUpHandler, Destroyable, GlobalInfoSupporter, FileFormatHandler, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<AbstractReportReader>, SizeOfHandler, Stoppable, StoppableWithFeedback, ReportReader<T>, StringReportReader<T>, Serializable, Comparable

Direct Known Subclasses:

DefaultSimpleReportReader

public abstract class AbstractSimpleReportReader<T extends Report>
extends AbstractReportReader<T>
implements StringReportReader<T>

Abstract ancestor for reports to be written in properties format.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	FILE_EXTENSION	the file extension.
static String	FILE_EXTENSION_GZ	the file extension for compressed files.

Fields inherited from class adams.data.io.input.AbstractReportReader

m_Input, m_Stopped

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

Method Summary

Modifier and Type	Method	Description
protected int	determineParentID(Report report)	Tries to determine the parent ID for the current report.
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.
List<T>	read(String s)	Reads the data.
protected List<T>	readData()	Performs the actual reading.

Methods inherited from class adams.data.io.input.AbstractReportReader

checkData, cleanUp, compareTo, defineOptions, destroy, equals, forCommandLine, forName, getDefaultFormatExtension, getInput, getReaders, inputTipText, isStopped, newInstance, postRead, read, reset, setInput, shallowCopy, shallowCopy, stopExecution

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

Methods inherited from interface adams.data.io.input.ReportReader

getInput, inputTipText, read, setInput

Field Detail

FILE_EXTENSION

public static final String FILE_EXTENSION

the file extension.

See Also:

Constant Field Values

FILE_EXTENSION_GZ

public static final String FILE_EXTENSION_GZ

the file extension for compressed files.

See Also:

Constant Field Values

Constructor Detail

AbstractSimpleReportReader

public AbstractSimpleReportReader()

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 AbstractReportReader<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 AbstractReportReader<T extends Report>

Returns:

the extension(s) (without the dot!)

determineParentID

protected int determineParentID(Report report)

Tries to determine the parent ID for the current report.

Specified by:

determineParentID in class AbstractReportReader<T extends Report>

Parameters:

report - the report to determine the ID for

Returns:

the parent database ID, -1 if it cannot be determined

readData

protected List<T> readData()

Performs the actual reading.

Specified by:

readData in class AbstractReportReader<T extends Report>

Returns:

the reports that were read

read

public List<T> read(String s)

Reads the data.

Specified by:

read in interface StringReportReader<T extends Report>

Parameters:

s - the string to read from

Returns:

the report loaded from the string