Package adams.data.threewayfeatures

Class MultiThreeWayDataFeatureGenerator

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.threewayfeatures.AbstractThreeWayDataFeatureGenerator

adams.data.threewayfeatures.MultiThreeWayDataFeatureGenerator

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 MultiThreeWayDataFeatureGenerator
extends AbstractThreeWayDataFeatureGenerator

Applies multiple generators to the same 3-way data and merges the generated a feature vectors side-by-side. If one of the generators should create fewer a feature vectors, missing values are used in that case.

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

-converter <adams.data.featureconverter.AbstractFeatureConverter> (property: converter)
    The feature converter to use to produce the output data.
    default: adams.data.featureconverter.SpreadSheet -data-row-type adams.data.spreadsheet.DenseDataRow -spreadsheet-type adams.data.spreadsheet.DefaultSpreadSheet
 

-prefix <java.lang.String> (property: prefix)
    The (optional) prefix to use for the feature names.
    default:
 

-field <adams.data.report.Field> [-field ...] (property: fields)
    The fields to add to the output.
    default:
 

-notes <adams.core.base.BaseString> [-notes ...] (property: notes)
    The notes to add as attributes to the generated data, eg 'PROCESS INFORMATION'
    .
    default:
 

-sub-generator <adams.data.threewayfeatures.AbstractThreeWayDataFeatureGenerator> [-sub-generator ...] (property: subGenerators)
    The generators to apply to the data.
    default:
 

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractThreeWayDataFeatureGenerator[]	m_SubGenerators	the generators to use.
protected adams.data.featureconverter.HeaderDefinition[]	m_SubHeaders	the sub-headers.

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

Method Summary

Modifier and Type	Method	Description
adams.data.featureconverter.HeaderDefinition	createHeader(ThreeWayData data)	Creates the header from template data.
protected String	createPrefix(int index)	Generates the prefix for the specified flattener.
void	defineOptions()	Adds options to the internal list of options.
List<Object>[]	generateRows(ThreeWayData data)	Performs the actual feature generation.
AbstractThreeWayDataFeatureGenerator[]	getSubGenerators()	Returns the generators to use.
String	globalInfo()	Returns a string describing the object.
void	setSubGenerators(AbstractThreeWayDataFeatureGenerator[] value)	Sets the generators to use.
String	subGeneratorsTipText()	Returns the tip text for this property.

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_SubGenerators

protected AbstractThreeWayDataFeatureGenerator[] m_SubGenerators

the generators to use.

m_SubHeaders

protected adams.data.featureconverter.HeaderDefinition[] m_SubHeaders

the sub-headers.

Constructor Detail

MultiThreeWayDataFeatureGenerator

public MultiThreeWayDataFeatureGenerator()

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

setSubGenerators

public void setSubGenerators(AbstractThreeWayDataFeatureGenerator[] value)

Sets the generators to use.

Parameters:

value - the generators

getSubGenerators

public AbstractThreeWayDataFeatureGenerator[] getSubGenerators()

Returns the generators to use.

Returns:

the generators

subGeneratorsTipText

public String subGeneratorsTipText()

Returns the tip text for this property.

Returns:

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

createPrefix

protected String createPrefix(int index)

Generates the prefix for the specified flattener.

Parameters:

index - the index of the flattener

Returns:

the prefix

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