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 Details

    • Filter

      public Filter()

  • Method Details

    • getWrappedAlgorithmClass

      public Class getWrappedAlgorithmClass()
      Get the class of the wrapped algorithm
      Specified by:
      getWrappedAlgorithmClass in class WekaAlgorithmWrapper
      Returns:
      the class of the wrapped algorithm

    • setWrappedAlgorithm

      public void setWrappedAlgorithm(Object algo)
      Set the wrapped algorithm (filter)
      Overrides:
      setWrappedAlgorithm in class WekaAlgorithmWrapper
      Parameters:
      algo - the algorithm to wrap

    • setFilter

      @ProgrammaticProperty public void setFilter(Filter filter)
      Set the filter. Calls setWrappedAlgorithm()
      Parameters:
      filter - the filter to use

    • getFilter

      public Filter getFilter()
      Get the filter. Convenience method that calls getWrappedAlgorithm()
      Returns:
      the filter

    • getIncomingConnectionTypes

      public List<String> 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

      public List<String> 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

      public void stepInit() throws WekaException
      Initialize the step.
      Throws:
      WekaException - if a problem occurs during initialization

    • processIncoming

      public void processIncoming(Data data) throws WekaException
      Process an incoming data payload (if the step accepts incoming connections)
      Specified by:
      processIncoming in interface BaseStepExtender
      Specified by:
      processIncoming in interface Step
      Overrides:
      processIncoming in class BaseStep
      Parameters:
      data - the payload to process
      Throws:
      WekaException - if a problem occurs

    • outputStructureForConnectionType

      public Instances outputStructureForConnectionType(String connectionName) throws WekaException
      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:
      outputStructureForConnectionType in interface Step
      Overrides:
      outputStructureForConnectionType in class BaseStep
      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