Package weka.knowledgeflow.steps

# Class DataGrid

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

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

@KFStep(name="DataGrid", category="DataSources", toolTipText="Specify a grid of data to turn into instances", iconPath="weka/gui/knowledgeflow/icons/ArffLoader.gif") public class DataGrid extends BaseStep
A step that allows the user to define instances to output

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

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `DataGrid()`

- ## 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.
  `String`
  `getData()`
  Get the data to be output by this `DataGrid` in textual ARFF format
  `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.
  `Instances`
  `outputStructureForConnectionType(String connectionName)`
  If possible, get the output structure for the named connection type as a header-only set of instances.
  `void`
  `setData(String data)`
  Set the data to be output by this `DataGrid` in textual ARFF format.
  `void`
  `start()`
  Start processing
  `void`
  `stepInit()`
  Initialize the step;

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

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

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

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

- ## Constructor Details

  - ### DataGrid

    public DataGrid()

- ## Method Details

  - ### setData

    @ProgrammaticProperty public void setData(String data)
    Set the data to be output by this `DataGrid` in textual ARFF format.
    Parameters:
      `data` - the data to be output in textual ARFF format

  - ### getData

    public String getData()
    Get the data to be output by this `DataGrid` in textual ARFF format
    Returns:
      the data to be output in textual ARFF format

  - ### stepInit

    public void stepInit() throws WekaException
    Initialize the step;
    Throws:
      `WekaException` - if a problem occurs

  - ### start

    public void start() throws WekaException
    Start processing
    Specified by:
      `start` in interface `BaseStepExtender`
    Specified by:
      `start` in interface `Step`
    Overrides:
      `start` in class `BaseStep`
    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

  - ### 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

  - ### 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