Package adams.data.instances

Class AbstractFieldInstanceGenerator

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.instances.AbstractInstanceGenerator<Spectrum>

adams.data.instances.AbstractSpectrumBasedInstanceGenerator

adams.data.instances.AbstractFieldInstanceGenerator

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<adams.data.instances.AbstractInstanceGenerator>, adams.core.SizeOfHandler, adams.data.instances.InstanceGeneratorWithFields, InstanceGeneratorWithSampleID, adams.db.DatabaseConnectionHandler, adams.db.DatabaseConnectionProvider, adams.db.DatabaseConnectionUser, adams.db.OptionalDatabaseConnectionUser, Serializable, Comparable

Direct Known Subclasses:

AbstractFieldInstanceGeneratorWithClass, FieldInstanceGenerator

public abstract class AbstractFieldInstanceGenerator
extends AbstractSpectrumBasedInstanceGenerator
implements adams.data.instances.InstanceGeneratorWithFields

Abstract base class for schemes that turn spectra into weka.core.Instance objects.

Version:

$Revision: 1286 $

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.instances.AbstractSpectrumBasedInstanceGenerator

m_AddSampleID, m_LoadSampleData, m_Notes

Fields inherited from class adams.data.instances.AbstractInstanceGenerator

LABEL_FALSE, LABEL_TRUE, m_AddDatabaseID, m_DatabaseConnection, m_Offline, 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
AbstractFieldInstanceGenerator()

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.
adams.data.report.Field[]	getFields()	Returns the targets to add.
void	setFields(adams.data.report.Field[] value)	Sets the targets to add.

Methods inherited from class adams.data.instances.AbstractSpectrumBasedInstanceGenerator

addSampleIDTipText, checkInput, getAddSampleID, getDefaultDatabaseConnection, getLoadSampleData, getNotes, loadSampleDataTipText, notesTipText, postProcessHeader, postProcessOutput, setAddSampleID, setLoadSampleData, setNotes

Methods inherited from class adams.data.instances.AbstractInstanceGenerator

addDatabaseIDTipText, checkSetup, cleanUp, compareTo, destroy, equals, forCommandLine, forName, generate, generateHeader, generateOutput, getAddDatabaseID, getDatabaseConnection, getGenerators, getOffline, getOutputHeader, getTolerateHeaderChanges, initialize, interpretePosition, offlineTipText, reset, setAddDatabaseID, setDatabaseConnection, setOffline, setTolerateHeaderChanges, shallowCopy, shallowCopy, tolerateHeaderChangesTipText

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, 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

AbstractFieldInstanceGenerator

public AbstractFieldInstanceGenerator()

Method Detail

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 AbstractSpectrumBasedInstanceGenerator

setFields

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

Sets the targets to add.

Specified by:

setFields in interface adams.data.instances.InstanceGeneratorWithFields

Parameters:

value - the targets

getFields

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

Returns the targets to add.

Specified by:

getFields in interface adams.data.instances.InstanceGeneratorWithFields

Returns:

the targets

fieldsTipText

public String fieldsTipText()

Returns the tip text for this property.

Specified by:

fieldsTipText in interface adams.data.instances.InstanceGeneratorWithFields

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 adams.data.instances.AbstractInstanceGenerator<Spectrum>

Parameters:

data - the input data