Package adams.data.threewayfeatures

Class Flatten

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.threewayfeatures.AbstractThreeWayDataFeatureGenerator

adams.data.threewayfeatures.Flatten

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<AbstractThreeWayDataFeatureGenerator>, adams.core.SizeOfHandler, Serializable, Comparable

public class Flatten
extends AbstractThreeWayDataFeatureGenerator

Simply flattens the 3-way data structure (x -> y -> z).

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected int	m_NthPoint	the n-th point to use.

Fields inherited from class adams.data.threewayfeatures.AbstractThreeWayDataFeatureGenerator

m_Converter, m_Fields, m_Notes, m_Prefix

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

Method Summary

Modifier and Type	Method	Description
adams.data.featureconverter.HeaderDefinition	createHeader(ThreeWayData data)	Creates the header from template data.
void	defineOptions()	Adds options to the internal list of options.
List<Object>[]	generateRows(ThreeWayData data)	Performs the actual feature generation.
int	getNthPoint()	Returns the nth point setting.
String	globalInfo()	Returns a string describing the object.
String	nthPointTipText()	Returns the tip text for this property.
void	setNthPoint(int value)	Sets the nth point setting.

Methods inherited from class adams.data.threewayfeatures.AbstractThreeWayDataFeatureGenerator

checkData, cleanUp, compareTo, converterTipText, destroy, equals, fieldsTipText, generate, getConverter, getDatasetFormat, getFields, getNotes, getPrefix, getRowFormat, notesTipText, postProcessHeader, postProcessRow, postProcessRows, prefixTipText, reset, setConverter, setFields, setNotes, setPrefix, shallowCopy, shallowCopy

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_NthPoint

protected int m_NthPoint

the n-th point to use.

Constructor Detail

Flatten

public Flatten()

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 AbstractThreeWayDataFeatureGenerator

setNthPoint

public void setNthPoint(int value)

Sets the nth point setting.

Parameters:

value - the nth point to use

getNthPoint

public int getNthPoint()

Returns the nth point setting.

Returns:

the nth point

nthPointTipText

public String nthPointTipText()

Returns the tip text for this property.

Returns:

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

createHeader

public adams.data.featureconverter.HeaderDefinition createHeader(ThreeWayData data)

Creates the header from template data.

Specified by:

createHeader in class AbstractThreeWayDataFeatureGenerator

Parameters:

data - the data to act as a template

Returns:

the generated header

generateRows

public List<Object>[] generateRows(ThreeWayData data)

Performs the actual feature generation.

Specified by:

generateRows in class AbstractThreeWayDataFeatureGenerator

Parameters:

data - the data to process

Returns:

the generated features