MakeResourceIntensive (weka-dev r12423 API)

java.lang.Object
- weka.knowledgeflow.steps.BaseStep
- - weka.knowledgeflow.steps.MakeResourceIntensive

All Implemented Interfaces:: Serializable, BaseStepExtender, Step

@KFStep(name="MakeResourceIntensive",
        category="Flow",
        toolTipText="<html>Makes downstream connected steps resource intensive (or not).<br> This shifts processing of such steps between the main step executor<br>service and the high resource executor service or vice versa.</html>",
        iconPath="weka/gui/knowledgeflow/icons/DiamondPlain.gif")
public class MakeResourceIntensive
extends BaseStep

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

Constructor Summary

Constructors
Constructor and Description

MakeResourceIntensive()

Constructors
Constructor and Description
`MakeResourceIntensive()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<String>`	`getIncomingConnectionTypes()` Get a list of incoming connection types that this step can accept.
`boolean`	`getMakeResourceIntensive()` Get whether downstream steps are to be made resource intensive
`List<String>`	`getOutgoingConnectionTypes()` Get a list of outgoing connection types that this step can produce.
`void`	`processIncoming(Data data)` Process an incoming data payload (if the step accepts incoming connections)
`void`	`setMakeResourceIntensive(boolean resourceIntensive)` Set whether downstream steps are to be made resource intensive or not
`void`	`stepInit()` Initialize the step.

Methods inherited from class weka.knowledgeflow.steps.BaseStep
environmentSubstitute, getCustomEditorForStep, getDefaultSettings, getInteractiveViewers, getInteractiveViewersImpls, getName, getStepManager, globalInfo, isResourceIntensive, isStopRequested, outputStructureForConnectionType, setName, setStepIsResourceIntensive, setStepManager, start, stop

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MakeResourceIntensive
```
public MakeResourceIntensive()
```
- Method Detail
  - setMakeResourceIntensive
```
@OptionMetadata(displayName="Make downstream step(s) high resource",
                description="<html>Makes downstream connected steps resource intensive (or not)<br>This shifts processing of such steps between the main step executor service and the high resource executor service or vice versa.</html>")
public void setMakeResourceIntensive(boolean resourceIntensive)
```
    Set whether downstream steps are to be made resource intensive or not
    
    Parameters:
    
    resourceIntensive - true if the downstream connected steps are to be made resource intensive
  - getMakeResourceIntensive
```
public boolean getMakeResourceIntensive()
```
    Get whether downstream steps are to be made resource intensive
    
    Returns:
    
    true if downstream connected steps are to be made resource intensive
  - stepInit
```
public void stepInit()
              throws WekaException
```
    Description copied from interface: Step
    
    Initialize the step.
    
    Throws:
    
    WekaException - if a problem occurs during initialization
  - 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
  - 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

Class MakeResourceIntensive

Constructor Summary

Method Summary

Methods inherited from class weka.knowledgeflow.steps.BaseStep

Methods inherited from class java.lang.Object

Constructor Detail

MakeResourceIntensive

Method Detail

setMakeResourceIntensive

getMakeResourceIntensive

stepInit

getIncomingConnectionTypes

getOutgoingConnectionTypes

processIncoming