Package adams.data.conversion

Class TimeseriesToSpreadSheet

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.conversion.AbstractConversion

adams.data.conversion.TimeseriesToSpreadSheet

All Implemented Interfaces:

AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<AbstractConversion>, SizeOfHandler, Stoppable, Conversion, DataRowTypeHandler, SpreadSheetTypeHandler, Serializable

public class TimeseriesToSpreadSheet
extends AbstractConversion
implements SpreadSheetTypeHandler

Turns a timeseries into a SpreadSheet object.

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 

-data-row-type <adams.data.spreadsheet.DataRow> (property: dataRowType)
    The type of row to use for the data.
    default: adams.data.spreadsheet.DenseDataRow
 

-spreadsheet-type <adams.data.spreadsheet.SpreadSheet> (property: spreadSheetType)
    The type of spreadsheet to use for the data.
    default: adams.data.spreadsheet.SpreadSheet
 

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.conversion.AbstractConversion

m_Input, m_Output, m_Owner, 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
TimeseriesToSpreadSheet()

Method Summary

Modifier and Type	Method	Description
Class	accepts()	Returns the class that is accepted as input.
String	dataRowTypeTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
protected Object	doConvert()	Performs the actual conversion.
Class	generates()	Returns the class that is generated as output.
DataRow	getDataRowType()	Returns the type of data row to use.
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.conversion.AbstractConversion

checkData, cleanUp, convert, getAdditionalInformation, getInput, getInput, getOutput, getOutput, getOwner, getQuickInfo, reset, setInput, setOwner, shallowCopy, shallowCopy, stopExecution

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

TimeseriesToSpreadSheet

public TimeseriesToSpreadSheet()

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

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.

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.

accepts

public Class accepts()

Returns the class that is accepted as input.

Specified by:

accepts in interface Conversion

Specified by:

accepts in class AbstractConversion

Returns:

the class

generates

public Class generates()

Returns the class that is generated as output.

Specified by:

generates in interface Conversion

Specified by:

generates in class AbstractConversion

Returns:

the class

doConvert

protected Object doConvert()
                    throws Exception

Performs the actual conversion.

Specified by:

doConvert in class AbstractConversion

Returns:

the converted data

Throws:

Exception - if something goes wrong with the conversion