adams.data.featuregenerator
Class FilteredFeatureGenerator

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

All Implemented Interfaces:

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

public class FilteredFeatureGenerator
extends AbstractDatabaseConnectionFeatureGenerator

This feature generator first pushes the data through the provided data filter before applying the actual feature generator. The updated data obtained from the feature generator then replaces the report of the original data container.

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
 

-filter <adams.data.filter.AbstractFilter> (property: filter)
    The filter to apply to the heatmap before pushing it through the feature
    generator.
    default: adams.data.filter.PassThrough
 

-generator <adams.data.featuregenerator.AbstractFeatureGenerator> (property: generator)
    The generator to apply to the filtered data.
    default: adams.data.featuregenerator.PassThrough
 

Version:

$Revision: 6027 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

protected AbstractFilter	m_Filter the pre-filter for filtering the data.
protected AbstractFeatureGenerator	m_Generator the actual feature generator.

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

FilteredFeatureGenerator()

Method Summary

void	defineOptions() Adds options to the internal list of options.
String	filterTipText() Returns the tip text for this property.
String	generatorTipText() Returns the tip text for this property.
protected AbstractDatabaseConnection	getDefaultDatabaseConnection() Returns the default database connection.
AbstractFilter	getFilter() Returns the filter.
AbstractFeatureGenerator	getGenerator() Returns the generator.
String	globalInfo() Returns a string describing the object.
protected Heatmap	processData(Heatmap data) Processes the data/report.
void	setFilter(AbstractFilter value) Sets the filter.
void	setGenerator(AbstractFeatureGenerator value) Sets the generator.
protected void	updateDatabaseConnection() Updates the database connection in dependent schemes.

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_Filter

protected AbstractFilter m_Filter

the pre-filter for filtering the data.

m_Generator

protected AbstractFeatureGenerator m_Generator

the actual feature generator.

Constructor Detail

FilteredFeatureGenerator

public FilteredFeatureGenerator()

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

setFilter

public void setFilter(AbstractFilter value)

Sets the filter.

Parameters:

value - the filter

getFilter

public AbstractFilter getFilter()

Returns the filter.

Returns:

the filter

filterTipText

public String filterTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

setGenerator

public void setGenerator(AbstractFeatureGenerator value)

Sets the generator.

Parameters:

value - the generator

getGenerator

public AbstractFeatureGenerator getGenerator()

Returns the generator.

Returns:

the generator

generatorTipText

public String generatorTipText()

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 dependent schemes.

Overrides:

updateDatabaseConnection in class AbstractDatabaseConnectionFeatureGenerator

processData

protected Heatmap processData(Heatmap data)

Processes the data/report.

Specified by:

processData in class AbstractFeatureGenerator

Parameters:

data - the data to process

Returns:

the processed data