adams.data.featuregenerator
Class MultiGenerator

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.data.featuregenerator.AbstractFeatureGenerator
              adams.data.featuregenerator.AbstractDatabaseConnectionFeatureGenerator
                  adams.data.featuregenerator.MultiGenerator

All Implemented Interfaces:

Debuggable, Destroyable, OptionHandler, ShallowCopySupporter<AbstractFeatureGenerator>, SizeOfHandler, DatabaseConnectionHandler, DatabaseConnectionProvider, Serializable, Comparable

public class MultiGenerator
extends AbstractDatabaseConnectionFeatureGenerator

A meta-generator that applies multiple feature generators to the data.

Valid options are:

-D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to
    the console (0 = off).
    default: 0
    minimum: 0
 

-prefix <java.lang.String> (property: prefix)
    The prefix to use in the field for the generated features.
    default: Feature
 

-generator <adams.data.featuregenerator.AbstractFeatureGenerator> [-generator ...] (property: subGenerators)
    The array of generators to use.
    default: adams.data.featuregenerator.PassThrough
 

-override-prefix (property: overridePrefix)
    If enabled, then this prefix will override the ones specified by the sub-generators.
 

Version:

$Revision: 6027 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

protected AbstractFeatureGenerator[]	m_Generators the generators.
protected boolean	m_OverridePrefix whether to override the sub-generators' prefix.

Fields inherited from class adams.data.featuregenerator.AbstractDatabaseConnectionFeatureGenerator

m_DatabaseConnection

Fields inherited from class adams.data.featuregenerator.AbstractFeatureGenerator

m_Prefix, PREFIX_FEATURE

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Constructor Summary

MultiGenerator()

Method Summary

void	defineOptions() Adds options to the internal list of options.
protected AbstractDatabaseConnection	getDefaultDatabaseConnection() Returns the default database connection.
boolean	getOverridePrefix() Returns whether the prefix of the generators are overridden.
AbstractFeatureGenerator[]	getSubGenerators() Returns the generators in use.
String	globalInfo() Returns a string describing the object.
String	overridePrefixTipText() Returns the tip text for this property.
protected Heatmap	processData(Heatmap data) Performs the actual feature generation.
void	setOverridePrefix(boolean value) Sets whether to override the generators' prefix.
void	setSubGenerators(AbstractFeatureGenerator[] value) Sets the generators to use.
String	subGeneratorsTipText() Returns the tip text for this property.
protected void	updateDatabaseConnection() Updates the database connection in the sub-generators.

Methods inherited from class adams.data.featuregenerator.AbstractDatabaseConnectionFeatureGenerator

getDatabaseConnection, initialize, setDatabaseConnection

Methods inherited from class adams.data.featuregenerator.AbstractFeatureGenerator

addFeature, addFeature, checkData, cleanUp, compareTo, equals, forCommandLine, forName, generate, getDefaultPrefix, getGenerators, getPrefix, prefixTipText, reset, setPrefix, shallowCopy, shallowCopy

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, debug, debug, debugLevelTipText, destroy, finishInit, getDebugLevel, getOptionManager, isDebugOn, newOptionManager, setDebugLevel, toCommandLine, toString

Methods inherited from class adams.core.ConsoleObject

getDebugging, getSystemErr, getSystemOut, sizeOf

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

m_Generators

protected AbstractFeatureGenerator[] m_Generators

the generators.

m_OverridePrefix

protected boolean m_OverridePrefix

whether to override the sub-generators' prefix.

Constructor Detail

MultiGenerator

public MultiGenerator()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

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 AbstractFeatureGenerator

getDefaultDatabaseConnection

protected AbstractDatabaseConnection getDefaultDatabaseConnection()

Returns the default database connection.

Specified by:

getDefaultDatabaseConnection in class AbstractDatabaseConnectionFeatureGenerator

Returns:

the default database connection

setSubGenerators

public void setSubGenerators(AbstractFeatureGenerator[] value)

Sets the generators to use.

Parameters:

value - the generators to use

getSubGenerators

public AbstractFeatureGenerator[] getSubGenerators()

Returns the generators in 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

setOverridePrefix

public void setOverridePrefix(boolean value)

Sets whether to override the generators' prefix.

Parameters:

value - if true then the prefix of the sub-generators will be overridden

getOverridePrefix

public boolean getOverridePrefix()

Returns whether the prefix of the generators are overridden.

Returns:

true if the prefix of the sub-generators gets overridden

overridePrefixTipText

public String overridePrefixTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

updateDatabaseConnection

protected void updateDatabaseConnection()

Updates the database connection in the sub-generators.

Overrides:

updateDatabaseConnection in class AbstractDatabaseConnectionFeatureGenerator

processData

protected Heatmap processData(Heatmap data)

Performs the actual feature generation.

Specified by:

processData in class AbstractFeatureGenerator

Parameters:

data - the data to process

Returns:

the processed data