Package adams.ml.preprocessing.unsupervised

Class MultiStream

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.ml.preprocessing.AbstractFilter

adams.ml.preprocessing.AbstractStreamFilter

adams.ml.preprocessing.unsupervised.MultiStream

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, CapabilitiesHandler, BatchFilter, Filter, StreamFilter, Serializable

public class MultiStream
extends AbstractStreamFilter

Applies the specified filters sequentially.

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

-filter <adams.ml.preprocessing.StreamFilter> [-filter ...] (property: filters)
    The filters to apply sequentially.
    default: adams.ml.preprocessing.unsupervised.PassThrough
 

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected StreamFilter[]	m_Filters	the filters to apply.

Fields inherited from class adams.ml.preprocessing.AbstractFilter

m_Initialized, m_OutputFormat

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected Row	doFilter(Row data)	Filters the dataset row coming through.
protected void	doInitFilter(Row data)	Filter-specific initialization.
String	filtersTipText()	Returns the tip text for this property.
Capabilities	getCapabilities()	Returns the capabilities.
StreamFilter[]	getFilters()	Returns the filters to apply.
String	globalInfo()	Returns a string describing the object.
protected Dataset	initOutputFormat(Row data)	Initializes the output format.
void	setFilters(StreamFilter[] value)	Sets the filters to apply.

Methods inherited from class adams.ml.preprocessing.AbstractStreamFilter

filter, filter, initFilter, postInitFilter, preInitFilter

Methods inherited from class adams.ml.preprocessing.AbstractFilter

appendData, appendHeader, getOutputFormat, isInitialized, reset

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, 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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.ml.preprocessing.Filter

getOutputFormat, isInitialized

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_Filters

protected StreamFilter[] m_Filters

the filters to apply.

Constructor Detail

MultiStream

public MultiStream()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

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 AbstractOptionHandler

setFilters

public void setFilters(StreamFilter[] value)

Sets the filters to apply.

Parameters:

value - the filters

getFilters

public StreamFilter[] getFilters()

Returns the filters to apply.

Returns:

the filters

filtersTipText

public String filtersTipText()

Returns the tip text for this property.

Returns:

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

getCapabilities

public Capabilities getCapabilities()

Returns the capabilities.

Returns:

the capabilities

doInitFilter

protected void doInitFilter(Row data)
                     throws Exception

Filter-specific initialization.

Specified by:

doInitFilter in class AbstractStreamFilter

Parameters:

data - the data to initialize with

Throws:

Exception - if initialization fails

initOutputFormat

protected Dataset initOutputFormat(Row data)
                            throws Exception

Initializes the output format.

Specified by:

initOutputFormat in class AbstractStreamFilter

Parameters:

data - the output format

Throws:

Exception - if initialization fails

doFilter

protected Row doFilter(Row data)
                throws Exception

Filters the dataset row coming through.

Specified by:

doFilter in class AbstractStreamFilter

Parameters:

data - the data to filter

Returns:

the filtered data

Throws:

Exception - if filtering fails