Package adams.data.featureconverter

Class SpreadSheet

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.featureconverter.AbstractFeatureConverter<SpreadSheet,Row>

adams.data.featureconverter.SpreadSheet

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, DataRowTypeHandler, SpreadSheetTypeHandler, Serializable

Direct Known Subclasses:

Dataset

public class SpreadSheet
extends AbstractFeatureConverter<SpreadSheet,Row>
implements SpreadSheetTypeHandler

Generates features in spreadsheet format.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected DataRow	m_DataRowType	the data row type to use.
protected SpreadSheet	m_SpreadSheetType	the type of spreadsheet to use.

Fields inherited from class adams.data.featureconverter.AbstractFeatureConverter

m_Dataset, m_Header, m_HeaderDefinition

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

Method Summary

Modifier and Type	Method	Description
String	dataRowTypeTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
protected SpreadSheet	doGenerateHeader(HeaderDefinition header)	Performs the actual generation of the header data structure using the supplied header definition.
protected Row	doGenerateRow(List<Object> data)	Performs the actual generation of a row from the raw data.
DataRow	getDataRowType()	Returns the type of data row to use.
Class	getDatasetFormat()	Returns the class of the dataset that the converter generates.
protected DataRow	getDefaultDataRowType()	Returns the default row type.
protected SpreadSheet	getDefaultSpreadSheetType()	Returns the default spreadsheet to use.
Class	getRowFormat()	Returns the class of the row that the converter generates.
SpreadSheet	getSpreadSheetType()	Returns the type of spreadsheet to use.
String	globalInfo()	Returns a string describing the object.
void	setDataRowType(DataRow value)	Sets the type of data row to use.
void	setSpreadSheetType(SpreadSheet value)	Sets the type of spreadsheet to use.
String	spreadSheetTypeTipText()	Returns the tip text for this property.

Methods inherited from class adams.data.featureconverter.AbstractFeatureConverter

datasetTipText, generateHeader, generateRow, getDataset, getHeader, getHeaderDefinition, getQuickInfo, isInitialized, reset, setDataset

Methods inherited from class adams.core.option.AbstractOptionHandler

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

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_DataRowType

protected DataRow m_DataRowType

the data row type to use.

m_SpreadSheetType

protected SpreadSheet m_SpreadSheetType

the type of spreadsheet to use.

Constructor Detail

SpreadSheet

public SpreadSheet()

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 AbstractFeatureConverter<SpreadSheet,Row>

getDefaultDataRowType

protected DataRow getDefaultDataRowType()

Returns the default row type.

Returns:

the default

setDataRowType

public void setDataRowType(DataRow value)

Sets the type of data row to use.

Specified by:

setDataRowType in interface DataRowTypeHandler

Parameters:

value - the type

getDataRowType

public DataRow getDataRowType()

Returns the type of data row to use.

Specified by:

getDataRowType in interface DataRowTypeHandler

Returns:

the type

dataRowTypeTipText

public String dataRowTypeTipText()

Returns the tip text for this property.

Specified by:

dataRowTypeTipText in interface DataRowTypeHandler

Returns:

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

getDefaultSpreadSheetType

protected SpreadSheet getDefaultSpreadSheetType()

Returns the default spreadsheet to use.

Returns:

the spreadsheet

setSpreadSheetType

public void setSpreadSheetType(SpreadSheet value)

Sets the type of spreadsheet to use.

Specified by:

setSpreadSheetType in interface SpreadSheetTypeHandler

Parameters:

value - the type

getSpreadSheetType

public SpreadSheet getSpreadSheetType()

Returns the type of spreadsheet to use.

Specified by:

getSpreadSheetType in interface SpreadSheetTypeHandler

Returns:

the type

spreadSheetTypeTipText

public String spreadSheetTypeTipText()

Returns the tip text for this property.

Specified by:

spreadSheetTypeTipText in interface SpreadSheetTypeHandler

Returns:

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

getDatasetFormat

public Class getDatasetFormat()

Returns the class of the dataset that the converter generates.

Specified by:

getDatasetFormat in class AbstractFeatureConverter<SpreadSheet,Row>

Returns:

the format

getRowFormat

public Class getRowFormat()

Returns the class of the row that the converter generates.

Specified by:

getRowFormat in class AbstractFeatureConverter<SpreadSheet,Row>

Returns:

the format

doGenerateHeader

protected SpreadSheet doGenerateHeader(HeaderDefinition header)

Performs the actual generation of the header data structure using the supplied header definition.

Specified by:

doGenerateHeader in class AbstractFeatureConverter<SpreadSheet,Row>

Parameters:

header - the header definition

Returns:

the dataset structure

doGenerateRow

protected Row doGenerateRow(List<Object> data)

Performs the actual generation of a row from the raw data.

Specified by:

doGenerateRow in class AbstractFeatureConverter<SpreadSheet,Row>

Parameters:

data - the data of the row, elements can be null (= missing)

Returns:

the dataset structure