Package weka.knowledgeflow.steps

# Class SendToPerspective

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

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

@KFStep(name="SendToPerspective", category="Flow", toolTipText="Send instances to a perspective (graphical environment only)", iconPath="weka/gui/knowledgeflow/icons/DiamondPlain.gif") public class SendToPerspective extends BaseStep
Step that can send incoming instances to a perspective. Only operates in a graphical (i.e. non-headless) environment.

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

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `SendToPerspective()`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `List<String>`
  `getIncomingConnectionTypes()`
  Get a list of incoming connection types that this step can accept.
  `List<String>`
  `getOutgoingConnectionTypes()`
  Get a list of outgoing connection types that this step can produce.
  `String`
  `getPerspectiveName()`
  `void`
  `processIncoming(Data data)`
  Process an incoming data payload (if the step accepts incoming connections)
  `void`
  `setPerspectiveName(String name)`
  `void`
  `stepInit()`
  Initialize the step.

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

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

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

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

- ## Constructor Details

  - ### SendToPerspective

    public SendToPerspective()

- ## Method Details

  - ### setPerspectiveName

    public void setPerspectiveName(String name)

  - ### getPerspectiveName

    public String getPerspectiveName()

  - ### stepInit

    public void stepInit() throws WekaException
    Description copied from interface: `Step`
    Initialize the step.
    Throws:
      `WekaException` - if a problem occurs during initialization

  - ### processIncoming

    public void processIncoming(Data data) throws WekaException
    Description copied from class: `BaseStep`
    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

  - ### getIncomingConnectionTypes

    public List<String> getIncomingConnectionTypes()
    Description copied from interface: `Step`
    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()
    Description copied from interface: `Step`
    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