Package adams.data.spreadsheetrowgenerator

Class SampleDataOnlyRowGenerator

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.spreadsheetrowgenerator.AbstractSpreadSheetRowGenerator

adams.data.spreadsheetrowgenerator.SampleDataOnlyRowGenerator

All Implemented Interfaces:

adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.ShallowCopySupporter<AbstractSpreadSheetRowGenerator>, adams.core.SizeOfHandler, Serializable, Comparable

public class SampleDataOnlyRowGenerator
extends AbstractSpreadSheetRowGenerator

Outputs only sample data values.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected adams.data.report.Field[]	m_Fields	fields to add to the output data.

Fields inherited from class adams.data.spreadsheetrowgenerator.AbstractSpreadSheetRowGenerator

COL_DBID, COL_SAMPLEID, m_AddDatabaseID, m_AddSampleID, m_OutputHeader, m_TolerateHeaderChanges

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

Method Summary

Modifier and Type	Method	Description
protected void	checkHeader(Spectrum data)	Checks whether the number of waves are the same.
void	defineOptions()	Adds options to the internal list of options.
String	fieldsTipText()	Returns the tip text for this property.
protected void	generateHeader(Spectrum data)	Generates the header of the output data.
protected adams.data.spreadsheet.Row	generateOutput(Spectrum data)	Generates the actual data.
adams.data.report.Field[]	getFields()	Returns the fields to add.
String	globalInfo()	Returns a string describing the object.
void	setFields(adams.data.report.Field[] value)	Sets the fields to add.

Methods inherited from class adams.data.spreadsheetrowgenerator.AbstractSpreadSheetRowGenerator

addDatabaseIDTipText, addSampleIDTipText, checkInput, checkSetup, cleanUp, compareTo, destroy, equals, generate, getAddDatabaseID, getAddSampleID, getOutputHeader, getTolerateHeaderChanges, interpretePosition, postProcessHeader, postProcessOutput, reset, setAddDatabaseID, setAddSampleID, setTolerateHeaderChanges, shallowCopy, shallowCopy, tolerateHeaderChangesTipText

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

Field Detail

m_Fields

protected adams.data.report.Field[] m_Fields

fields to add to the output data.

Constructor Detail

SampleDataOnlyRowGenerator

public SampleDataOnlyRowGenerator()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface adams.core.GlobalInfoSupporter

Specified by:

globalInfo in class adams.core.option.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 adams.core.option.OptionHandler

Overrides:

defineOptions in class AbstractSpreadSheetRowGenerator

setFields

public void setFields(adams.data.report.Field[] value)

Sets the fields to add.

Parameters:

value - the fields

getFields

public adams.data.report.Field[] getFields()

Returns the fields to add.

Returns:

the fields

fieldsTipText

public String fieldsTipText()

Returns the tip text for this property.

Returns:

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

checkHeader

protected void checkHeader(Spectrum data)

Checks whether the number of waves are the same.

Specified by:

checkHeader in class AbstractSpreadSheetRowGenerator

Parameters:

data - the input data

generateHeader

protected void generateHeader(Spectrum data)

Generates the header of the output data.

Specified by:

generateHeader in class AbstractSpreadSheetRowGenerator

Parameters:

data - the input data

generateOutput

protected adams.data.spreadsheet.Row generateOutput(Spectrum data)

Generates the actual data.

Specified by:

generateOutput in class AbstractSpreadSheetRowGenerator

Parameters:

data - the input data to transform

Returns:

the generated data