Package weka.filters

Class FlowFilter

  • All Implemented Interfaces:
    Serializable, weka.core.CapabilitiesHandler, weka.core.CapabilitiesIgnorer, weka.core.CommandlineRunnable, weka.core.OptionHandler, weka.core.RevisionHandler
    public class FlowFilter
extends weka.filters.SimpleBatchFilter
    Processes the data with a flow. The flow's outer control actor must be a adams.flow.control.SubProcess actor, which takes weka.core.Instances as input and generates weka.core.Instances again.

    Valid options are: 

     -D
  Turns on output of debugging information.
     -flow-file <file>
  The flow to use for processing the data.
  (default: .)
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected FlowFile m_FlowFile
      the flow file to process the data with.
      protected SubProcess m_SubProcess
      the flow for processing the data.

      • Fields inherited from class weka.filters.Filter

        m_Debug, m_DoNotCheckCapabilities, m_FirstBatchDone, m_InputRelAtts, m_InputStringAtts, m_NewBatch, m_OutputRelAtts, m_OutputStringAtts

    • Constructor Summary

      Constructors 
      Constructor Description
      FlowFilter()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected weka.core.Instances determineOutputFormat​(weka.core.Instances inputFormat)
      Determines the output format based on the input format and returns this.
      String flowFileTipText()
      Returns the tip text for this property.
      weka.core.Capabilities getCapabilities()
      Returns the Capabilities of this filter.
      FlowFile getFlowFile()
      Returns the flow to process the data with.
      String[] getOptions()
      returns the options of the current setup.
      String globalInfo()
      Returns a string describing this classifier.
      Enumeration listOptions()
      Gets an enumeration describing the available options.
      protected weka.core.Instances process​(weka.core.Instances instances)
      Processes the given data (may change the provided dataset) and returns the modified version.
      protected void reset()
      Resets the filter.
      void setFlowFile​(FlowFile value)
      Sets the flow to process the data with.
      void setOptions​(String[] options)
      Parses the options for this object.

      • Methods inherited from class weka.filters.SimpleBatchFilter

        allowAccessToFullInputFormat, batchFinished, hasImmediateOutputFormat, input, input

      • Methods inherited from class weka.filters.SimpleFilter

        setInputFormat

      • Methods inherited from class weka.filters.Filter

        batchFilterFile, bufferInput, copyValues, copyValues, debugTipText, doNotCheckCapabilitiesTipText, filterFile, flushInput, getCapabilities, getCopyOfInputFormat, getDebug, getDoNotCheckCapabilities, getInputFormat, getOutputFormat, getRevision, initInputLocators, initOutputLocators, inputFormatPeek, isFirstBatchDone, isNewBatch, isOutputFormatDefined, main, makeCopies, makeCopy, mayRemoveInstanceAfterFirstBatchDone, numPendingOutput, output, outputFormatPeek, outputPeek, postExecution, preExecution, push, push, resetQueue, run, runFilter, setDebug, setDoNotCheckCapabilities, setOutputFormat, testInputFormat, toString, useFilter, wekaStaticWrapper

    • Field Detail

      • m_FlowFile

        protected FlowFile m_FlowFile
        the flow file to process the data with.

      • m_SubProcess

        protected SubProcess m_SubProcess
        the flow for processing the data.

    • Constructor Detail

      • FlowFilter

        public FlowFilter()

    • Method Detail

      • globalInfo

        public String globalInfo()
        Returns a string describing this classifier.
        Specified by:
        globalInfo in class weka.filters.SimpleFilter
        Returns:
        a description of the classifier suitable for displaying in the explorer/experimenter gui

      • reset

        protected void reset()
        Resets the filter.
        Overrides:
        reset in class weka.filters.SimpleFilter

      • listOptions

        public Enumeration listOptions()
        Gets an enumeration describing the available options.
        Specified by:
        listOptions in interface weka.core.OptionHandler
        Overrides:
        listOptions in class weka.filters.Filter
        Returns:
        an enumeration of all the available options.

      • getOptions

        public String[] getOptions()
        returns the options of the current setup.
        Specified by:
        getOptions in interface weka.core.OptionHandler
        Overrides:
        getOptions in class weka.filters.Filter
        Returns:
        the current options

      • setOptions

        public void setOptions​(String[] options)
                throws Exception
        Parses the options for this object.

        Valid options are: 

         -D
  Turns on output of debugging information.
         -flow-file <file>
  The flow to use for processing the data.
  (default: .)
        Specified by:
        setOptions in interface weka.core.OptionHandler
        Overrides:
        setOptions in class weka.filters.Filter
        Parameters:
        options - the options to use
        Throws:
        Exception - if the option setting fails

      • setFlowFile

        public void setFlowFile​(FlowFile value)
        Sets the flow to process the data with.
        Parameters:
        value - the flow

      • getFlowFile

        public FlowFile getFlowFile()
        Returns the flow to process the data with.
        Returns:
        the flow

      • flowFileTipText

        public String flowFileTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the explorer/experimenter gui

      • determineOutputFormat

        protected weka.core.Instances determineOutputFormat​(weka.core.Instances inputFormat)
                                             throws Exception
        Determines the output format based on the input format and returns this. In case the output format cannot be returned immediately, i.e., immediateOutputFormat() returns false, then this method will be called from batchFinished().

        Simply returns the input format. The process() method determines the actual format as the format is not known apriori.
        Specified by:
        determineOutputFormat in class weka.filters.SimpleFilter
        Parameters:
        inputFormat - the input format to base the output format on
        Returns:
        the output format
        Throws:
        Exception - in case the determination goes wrong

      • getCapabilities

        public weka.core.Capabilities getCapabilities()
        Returns the Capabilities of this filter.
        Specified by:
        getCapabilities in interface weka.core.CapabilitiesHandler
        Overrides:
        getCapabilities in class weka.filters.Filter
        Returns:
        the capabilities of this object
        See Also:
        Capabilities

      • process

        protected weka.core.Instances process​(weka.core.Instances instances)
                               throws Exception
        Processes the given data (may change the provided dataset) and returns the modified version. This method is called in batchFinished().
        Specified by:
        process in class weka.filters.SimpleFilter
        Parameters:
        instances - the data to process
        Returns:
        the modified data
        Throws:
        Exception - in case the processing goes wrong