adams.flow.transformer
Class WekaFilter

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.flow.core.AbstractActor
              adams.flow.transformer.AbstractTransformer
                  adams.flow.transformer.AbstractWekaInstanceAndWekaInstancesTransformer
                      adams.flow.transformer.WekaFilter

All Implemented Interfaces:

AdditionalInformationHandler, CleanUpHandler, Debuggable, DebugOutputHandler, Destroyable, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<AbstractActor>, SizeOfHandler, Stoppable, VariableChangeListener, ErrorHandler, InputConsumer, OutputProducer, ProvenanceSupporter, Serializable, Comparable

public class WekaFilter
extends AbstractWekaInstanceAndWekaInstancesTransformer
implements ProvenanceSupporter

Filters Instances/Instance objects using the specified filter.

Input/output:
- accepts:
weka.core.Instance
weka.core.Instances
adams.data.instance.Instance
- generates:
weka.core.Instance
weka.core.Instances
adams.data.instance.Instance

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
 

-name <java.lang.String> (property: name)
    The name of the actor.
    default: WekaFilter
 

-annotation <adams.core.base.BaseText> (property: annotations)
    The annotations to attach to this actor.
    default:
 

-skip (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded
    as it is.
 

-filter <weka.filters.Filter [options]> (property: filter)
    The filter to use for filtering the Instances/Instance objects.
    default: weka.filters.AllFilter
 

-init-once (property: initializeOnce)
    If set to true, then the filter will get initialized only with the first
    batch of data; otherwise every time data gets passed through.
 

-keep (property: keepRelationName)
    If set to true, then the filter won't change the relation name of the incoming
    dataset.
 

Version:

$Revision: 4584 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

static String	BACKUP_INITIALIZED the key for storing the current initialized state in the backup.
protected weka.filters.Filter	m_Filter the filter to apply.
protected boolean	m_Initialized whether the filter has been initialized.
protected boolean	m_InitializeOnce whether to initialize filter only with the first batch.
protected boolean	m_KeepRelationName whether to keep the incoming relation name.

Fields inherited from class adams.flow.transformer.AbstractTransformer

BACKUP_INPUT, BACKUP_OUTPUT, m_InputToken, m_OutputToken

Fields inherited from class adams.flow.core.AbstractActor

FILE_EXTENSION, FILE_EXTENSION_GZ, m_Annotations, m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_ErrorHandler, m_Executed, m_FullName, m_Headless, m_Name, m_Parent, m_Root, m_Self, m_Skip, m_StopFlowOnError, m_StopMessage, m_Stopped, m_StorageHandler, m_VariablesUpdated

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Constructor Summary

WekaFilter()

Method Summary

protected Hashtable<String,Object>	backupState() Backs up the current state of the actor before update the variables.
void	defineOptions() Adds options to the internal list of options.
protected String	doExecute() Executes the flow item.
String	filterTipText() Returns the tip text for this property.
weka.filters.Filter	getFilter() Returns the filter in use.
boolean	getInitializeOnce() Returns whether the filter gets initialized only with the first batch.
boolean	getKeepRelationName() Returns whether the filter doesn't change the relation name.
String	getQuickInfo() Returns a quick info about the actor, which will be displayed in the GUI.
String	globalInfo() Returns a string describing the object.
String	initializeOnceTipText() Returns the tip text for this property.
String	keepRelationNameTipText() Returns the tip text for this property.
protected void	pruneBackup() Removes entries from the backup.
protected void	reset() Resets the scheme.
protected void	restoreState(Hashtable<String,Object> state) Restores the state of the actor before the variables got updated.
void	setFilter(weka.filters.Filter value) Sets the filter to use.
void	setInitializeOnce(boolean value) Sets whether the filter gets initialized only with the first batch.
void	setKeepRelationName(boolean value) Sets whether the filter doesn't change the relation name.
void	updateProvenance(ProvenanceContainer cont) Updates the provenance information in the provided container.

Methods inherited from class adams.flow.transformer.AbstractWekaInstanceAndWekaInstancesTransformer

accepts, generates

Methods inherited from class adams.flow.transformer.AbstractTransformer

execute, hasPendingOutput, input, output, postExecute, wrapUp

Methods inherited from class adams.flow.core.AbstractActor

annotationsTipText, canInspectOptions, canPerformSetUpCheck, cleanUp, compareTo, debug, destroy, equals, findVariables, findVariables, findVariables, forceVariables, forCommandLine, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFullName, getName, getNextSibling, getParent, getPreviousSibling, getRoot, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, initialize, isBackedUp, isExecuted, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, preExecute, pruneBackup, setAnnotations, setErrorHandler, setHeadless, setName, setParent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, sizeOf, skipTipText, stopExecution, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged

Methods inherited from class adams.core.option.AbstractOptionHandler

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

Methods inherited from class adams.core.ConsoleObject

getDebugging, getSystemErr, getSystemOut

Methods inherited from class java.lang.Object

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

Field Detail

BACKUP_INITIALIZED

public static final String BACKUP_INITIALIZED

the key for storing the current initialized state in the backup.

See Also:

Constant Field Values

m_Filter

protected weka.filters.Filter m_Filter

the filter to apply.

m_InitializeOnce

protected boolean m_InitializeOnce

whether to initialize filter only with the first batch.

m_KeepRelationName

protected boolean m_KeepRelationName

whether to keep the incoming relation name.

m_Initialized

protected boolean m_Initialized

whether the filter has been initialized.

Constructor Detail

WekaFilter

public WekaFilter()

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 AbstractActor

setFilter

public void setFilter(weka.filters.Filter value)

Sets the filter to use.

Parameters:

value - the filter

getFilter

public weka.filters.Filter getFilter()

Returns the filter in use.

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 or for listing the options.

setInitializeOnce

public void setInitializeOnce(boolean value)

Sets whether the filter gets initialized only with the first batch.

Parameters:

value - true if the filter gets only initialized once

getInitializeOnce

public boolean getInitializeOnce()

Returns whether the filter gets initialized only with the first batch.

Returns:

true if the filter gets only initialized once

initializeOnceTipText

public String initializeOnceTipText()

Returns the tip text for this property.

Returns:

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

setKeepRelationName

public void setKeepRelationName(boolean value)

Sets whether the filter doesn't change the relation name.

Parameters:

value - true if the filter won't change the relation name

getKeepRelationName

public boolean getKeepRelationName()

Returns whether the filter doesn't change the relation name.

Returns:

true if the filter doesn't change the relation name

keepRelationNameTipText

public String keepRelationNameTipText()

Returns the tip text for this property.

Returns:

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

getQuickInfo

public String getQuickInfo()

Returns a quick info about the actor, which will be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractActor

Returns:

null if no info available, otherwise short string

pruneBackup

protected void pruneBackup()

Removes entries from the backup.

Overrides:

pruneBackup in class AbstractActor

backupState

protected Hashtable<String,Object> backupState()

Backs up the current state of the actor before update the variables.

Overrides:

backupState in class AbstractTransformer

Returns:

the backup

restoreState

protected void restoreState(Hashtable<String,Object> state)

Restores the state of the actor before the variables got updated.

Overrides:

restoreState in class AbstractTransformer

Parameters:

state - the backup of the state to restore from

reset

protected void reset()

Resets the scheme.

Overrides:

reset in class AbstractTransformer

doExecute

protected String doExecute()

Executes the flow item.

Specified by:

doExecute in class AbstractActor

Returns:

null if everything is fine, otherwise error message

updateProvenance

public void updateProvenance(ProvenanceContainer cont)

Updates the provenance information in the provided container.

Specified by:

updateProvenance in interface ProvenanceSupporter

Parameters:

cont - the provenance container to update