Package weka.knowledgeflow.steps
Class Filter
java.lang.Object
weka.knowledgeflow.steps.BaseStep
weka.knowledgeflow.steps.WekaAlgorithmWrapper
weka.knowledgeflow.steps.Filter
- All Implemented Interfaces:
Serializable,BaseStepExtender,Step
@KFStep(name="Filter",
category="Filters",
toolTipText="Weka filter wrapper",
iconPath="")
public class Filter
extends WekaAlgorithmWrapper
Step that wraps a Weka filter. Handles dataSet, trainingSet, testSet and
instance connections.
- Version:
- $Revision: $
- Author:
- Mark Hall (mhall{[at]}pentaho{[dot]}com)
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGet the filter.Get a list of incoming connection types that this step can accept.Get a list of outgoing connection types that this step can produce.Get the class of the wrapped algorithmoutputStructureForConnectionType(String connectionName) If possible, get the output structure for the named connection type as a header-only set of instances.voidprocessIncoming(Data data) Process an incoming data payload (if the step accepts incoming connections)voidSet the filter.voidsetWrappedAlgorithm(Object algo) Set the wrapped algorithm (filter)voidstepInit()Initialize the step.Methods inherited from class weka.knowledgeflow.steps.WekaAlgorithmWrapper
getDefaultIconPath, getDefaultPackageLevelIconPath, getIconPath, getWrappedAlgorithm, globalInfoMethods inherited from class weka.knowledgeflow.steps.BaseStep
environmentSubstitute, getCustomEditorForStep, getDefaultSettings, getInteractiveViewers, getInteractiveViewersImpls, getName, getStepManager, isResourceIntensive, isStopRequested, outputStructureForConnectionType, setName, setStepIsResourceIntensive, setStepManager, setStepMustRunSingleThreaded, start, stepMustRunSingleThreaded, stop
-
Constructor Details
-
Filter
public Filter()
-
-
Method Details
-
getWrappedAlgorithmClass
Get the class of the wrapped algorithm- Specified by:
getWrappedAlgorithmClassin classWekaAlgorithmWrapper- Returns:
- the class of the wrapped algorithm
-
setWrappedAlgorithm
Set the wrapped algorithm (filter)- Overrides:
setWrappedAlgorithmin classWekaAlgorithmWrapper- Parameters:
algo- the algorithm to wrap
-
setFilter
Set the filter. CallssetWrappedAlgorithm()- Parameters:
filter- the filter to use
-
getFilter
Get the filter. Convenience method that callsgetWrappedAlgorithm()- Returns:
- the filter
-
getIncomingConnectionTypes
Get a list of incoming connection types that this step can accept. Ideally (and if appropriate), this should take into account the state of the step and any existing incoming connections. E.g. a step might be able to accept one (and only one) incoming batch data connection.- Returns:
- a list of incoming connections that this step can accept given its current state
-
getOutgoingConnectionTypes
Get a list of outgoing connection types that this step can produce. Ideally (and if appropriate), this should take into account the state of the step and the incoming connections. E.g. depending on what incoming connection is present, a step might be able to produce a trainingSet output, a testSet output or neither, but not both.- Returns:
- a list of outgoing connections that this step can produce
-
stepInit
Initialize the step.- Throws:
WekaException- if a problem occurs during initialization
-
processIncoming
Process an incoming data payload (if the step accepts incoming connections)- Specified by:
processIncomingin interfaceBaseStepExtender- Specified by:
processIncomingin interfaceStep- Overrides:
processIncomingin classBaseStep- Parameters:
data- the payload to process- Throws:
WekaException- if a problem occurs
-
outputStructureForConnectionType
If possible, get the output structure for the named connection type as a header-only set of instances. Can return null if the specified connection type is not representable as Instances or cannot be determined at present.- Specified by:
outputStructureForConnectionTypein interfaceStep- Overrides:
outputStructureForConnectionTypein classBaseStep- Parameters:
connectionName- the name of the connection type to get the output structure for- Returns:
- the output structure as a header-only Instances object
- Throws:
WekaException- if a problem occurs
-