Package weka.knowledgeflow.steps

# Class Note

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

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

public class Note extends BaseStep
A Knowledge Flow "step" that implements a note on the GUI layout

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

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `Note()`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `String`
  `getCustomEditorForStep()`
  Return the fully qualified name of a custom editor component (JComponent) to use for editing the properties of the step.
  `List<String>`
  `getIncomingConnectionTypes()`
  Get incoming connections accepted - none in the case of a note :-)
  `String`
  `getNoteText()`
  Get the text of the note
  `List<String>`
  `getOutgoingConnectionTypes()`
  Get outgoing connections produced - none in the case of a note :-)
  `void`
  `setNoteText(String text)`
  Set the text of the note
  `void`
  `stepInit()`
  Initialize - does nothing in the case of a note :-)

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

  `environmentSubstitute, getDefaultSettings, getInteractiveViewers, getInteractiveViewersImpls, getName, getStepManager, globalInfo, 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`

- ## Constructor Details

  - ### Note

    public Note()

- ## Method Details

  - ### stepInit

    public void stepInit()
    Initialize - does nothing in the case of a note :-)

  - ### setNoteText

    public void setNoteText(String text)
    Set the text of the note
    Parameters:
      `text` - the text

  - ### getNoteText

    public String getNoteText()
    Get the text of the note
    Returns:
      the text

  - ### getIncomingConnectionTypes

    public List<String> getIncomingConnectionTypes()
    Get incoming connections accepted - none in the case of a note :-)
    Returns:
      a list of incoming connections

  - ### getOutgoingConnectionTypes

    public List<String> getOutgoingConnectionTypes()
    Get outgoing connections produced - none in the case of a note :-)
    Returns:
      a list of outgoing connections

  - ### getCustomEditorForStep

    public String getCustomEditorForStep()
    Return the fully qualified name of a custom editor component (JComponent) to use for editing the properties of the step. This method can return null, in which case the system will dynamically generate an editor using the GenericObjectEditor
    Specified by:
      `getCustomEditorForStep` in interface `Step`
    Overrides:
      `getCustomEditorForStep` in class `BaseStep`
    Returns:
      the fully qualified name of a step editor component