Package weka.knowledgeflow.steps

# Class WekaAlgorithmWrapper

java.lang.Object
weka.knowledgeflow.steps.BaseStep
weka.knowledgeflow.steps.WekaAlgorithmWrapper

All Implemented Interfaces:
  `Serializable`, `BaseStepExtender`, `Step`

Direct Known Subclasses:
  `ASEvaluator`, `ASSearchStrategy`, `Associator`, `Classifier`, `Clusterer`, `DataGenerator`, `Filter`, `Loader`, `Saver`

public abstract class WekaAlgorithmWrapper extends BaseStep implements Serializable
A step that wraps a class of standard Weka algorithm (e.g. filter, classifier, clusterer etc.)

Version:
  $Revision: $
Author:
  Mark Hall (mhall{[at]}pentaho{[dot]}com)
See Also:
  - Serialized Form

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `WekaAlgorithmWrapper()`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `String`
  `getDefaultIconPath()`
  Get the default icon for this type of wrapped algorithm (i.e.
  `String`
  `getDefaultPackageLevelIconPath()`
  Get the default icon at the package level for this type of wrapped algorithm - e.g.
  `String`
  `getIconPath()`
  Get the path to the icon for this wrapped algorithm
  `Object`
  `getWrappedAlgorithm()`
  Get the wrapped algorithm
  `abstract Class`
  `getWrappedAlgorithmClass()`
  Get the class of the algorithm being wrapped
  `String`
  `globalInfo()`
  Get global "help" info.
  `void`
  `setWrappedAlgorithm(Object algo)`
  Set the wrapped algorithm

  ### Methods inherited from class weka.knowledgeflow.steps.BaseStep

  `environmentSubstitute, getCustomEditorForStep, getDefaultSettings, getInteractiveViewers, getInteractiveViewersImpls, getName, getStepManager, isResourceIntensive, isStopRequested, outputStructureForConnectionType, outputStructureForConnectionType, processIncoming, setName, setStepIsResourceIntensive, setStepManager, setStepMustRunSingleThreaded, start, stepMustRunSingleThreaded, stop`

  ### Methods inherited from class java.lang.Object

  `equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

  ### Methods inherited from interface weka.knowledgeflow.steps.BaseStepExtender

  `getIncomingConnectionTypes, getOutgoingConnectionTypes, stepInit`

  ### Methods inherited from interface weka.knowledgeflow.steps.Step

  `getIncomingConnectionTypes, getOutgoingConnectionTypes, stepInit`

- ## Constructor Details

  - ### WekaAlgorithmWrapper

    public WekaAlgorithmWrapper()

- ## Method Details

  - ### globalInfo

    public String globalInfo()
    Get global "help" info. Returns the global info of the wrapped algorithm
    Overrides:
      `globalInfo` in class `BaseStep`
    Returns:
      global "help" info

  - ### getWrappedAlgorithm

    @NotPersistable @ProgrammaticProperty public Object getWrappedAlgorithm()
    Get the wrapped algorithm
    Returns:
      the wrapped algorithm

  - ### setWrappedAlgorithm

    public void setWrappedAlgorithm(Object algo)
    Set the wrapped algorithm
    Parameters:
      `algo` - the algorithm to wrao

  - ### getIconPath

    public String getIconPath()
    Get the path to the icon for this wrapped algorithm
    Returns:
      the path to the icon

  - ### getDefaultPackageLevelIconPath

    public String getDefaultPackageLevelIconPath()
    Get the default icon at the package level for this type of wrapped algorithm - e.g. weka.classifiers.meta
    Returns:
      the default icon at the package level

  - ### getDefaultIconPath

    public String getDefaultIconPath()
    Get the default icon for this type of wrapped algorithm (i.e. generic Loader, Saver etc.
    Returns:
      the default icon for this wrapped algorithm

  - ### getWrappedAlgorithmClass

    public abstract Class getWrappedAlgorithmClass()
    Get the class of the algorithm being wrapped
    Returns:
      the class of the algorithm being wrapped