FlowByExpression (interruptible-weka 0.1.4 API)

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

All Implemented Interfaces:: java.io.Serializable, BaseStepExtender, Step

@KFStep(name="FlowByExpression",
        category="Flow",
        toolTipText="Route instances according to the evaluation of a logical expression. The expression can test the values of one or more incoming attributes. The test can involve constants or comparing one attribute\'s values to another. Inequalities along with string operations such as contains, starts-with, ends-with and regular expressions may be used as operators. \"True\" instances can be sent to one downstream step and \"False\" instances sent to another.",
        iconPath="weka/gui/knowledgeflow/icons/FlowByExpression.png")
public class FlowByExpression
extends BaseStep

A step that splits incoming instances (or instance streams) according to the evaluation of a logical expression. The expression can test the values of one or more incoming attributes. The test can involve constants or comparing one attribute's values to another. Inequalities along with string operations such as contains, starts-with, ends-with and regular expressions may be used as operators.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`FlowByExpression.BracketNode` An expression node that encloses other expression nodes in brackets
`static class`	`FlowByExpression.ExpressionClause` An expression node that represents a clause of an expression
`static class`	`FlowByExpression.ExpressionNode` Abstract base class for parts of a boolean expression.

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.concurrent.atomic.AtomicInteger`	`m_batchCount` Keep track of how many incoming batches we've seen
`protected java.lang.String`	`m_customNameOfFalseStep` Name of the step to receive instances that evaluate to false via the expression
`protected java.lang.String`	`m_customNameOfTrueStep` Name of the step to receive instances that evaluate to true via the expression
`protected java.lang.String`	`m_expressionString` The expression tree to use in internal textual format
`protected Instances`	`m_incomingStructure` Incoming structure
`protected boolean`	`m_isReset`
`protected FlowByExpression.ExpressionNode`	`m_root` The root of the expression tree
`protected Data`	`m_streamingData` Re-usable data object for streaming
`protected boolean`	`m_validFalseStep` True if the "false" step is valid (i.e. exists in the flow)
`protected boolean`	`m_validTrueStep` True if the "true" step is valid (i.e. exists in the flow)

Fields inherited from class weka.knowledgeflow.steps.BaseStep
m_stepIsResourceIntensive, m_stepManager, m_stepName

Constructor Summary

Constructors
Constructor and Description

FlowByExpression()

Constructors
Constructor and Description
`FlowByExpression()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getCustomEditorForStep()` Return the fully qualified name of a custom editor component (JComponent) to use for editing the properties of the step.
`java.util.List<java.lang.String>`	`getDownstreamStepNames()` Get a list of the names of connected downstream steps
`java.lang.String`	`getExpressionString()` Get the current expression (in internal format)
`java.lang.String`	`getFalseStepName()` Get the name of the connected step to send "false" instances to
`java.util.List<java.lang.String>`	`getIncomingConnectionTypes()` Get a list of incoming connection types that this step can accept.
`java.util.List<java.lang.String>`	`getOutgoingConnectionTypes()` Get a list of outgoing connection types that this step can produce.
`java.lang.String`	`getTrueStepName()` Get the name of the connected step to send "true" instances to
`Instances`	`outputStructureForConnectionType(java.lang.String connectionName)` If possible, get the output structure for the named connection type as a header-only set of instances.
`protected void`	`processBatch(Data data)` Processes batch data (dataset, training or test) connections.
`void`	`processIncoming(Data data)` Main processing routine
`protected void`	`processStreaming(Data data)` Handles streaming "instance" connections
`void`	`setExpressionString(java.lang.String expressionString)` Set the expression (in internal format)
`void`	`setFalseStepName(java.lang.String falseStep)` Set the name of the connected step to send "false" instances to
`void`	`setTrueStepName(java.lang.String trueStep)` Set the name of the connected step to send "true" instances to
`void`	`stepInit()` Initialize the step.

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

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

- Field Detail
  - m_isReset
```
protected boolean m_isReset
```
  - m_root
```
protected FlowByExpression.ExpressionNode m_root
```
    The root of the expression tree
  - m_expressionString
```
protected java.lang.String m_expressionString
```
    The expression tree to use in internal textual format
  - m_customNameOfTrueStep
```
protected java.lang.String m_customNameOfTrueStep
```
    Name of the step to receive instances that evaluate to true via the expression
  - m_customNameOfFalseStep
```
protected java.lang.String m_customNameOfFalseStep
```
    Name of the step to receive instances that evaluate to false via the expression
  - m_incomingStructure
```
protected Instances m_incomingStructure
```
    Incoming structure
  - m_batchCount
```
protected java.util.concurrent.atomic.AtomicInteger m_batchCount
```
    Keep track of how many incoming batches we've seen
  - m_validTrueStep
```
protected boolean m_validTrueStep
```
    True if the "true" step is valid (i.e. exists in the flow)
  - m_validFalseStep
```
protected boolean m_validFalseStep
```
    True if the "false" step is valid (i.e. exists in the flow)
  - m_streamingData
```
protected Data m_streamingData
```
    Re-usable data object for streaming
- Constructor Detail
  - FlowByExpression
```
public FlowByExpression()
```
- Method Detail
  - setExpressionString
```
public void setExpressionString(java.lang.String expressionString)
```
    Set the expression (in internal format)
    
    Parameters:
    
    expressionString - the expression to use (in internal format)
  - getExpressionString
```
public java.lang.String getExpressionString()
```
    Get the current expression (in internal format)
    
    Returns:
    
    the current expression (in internal format)
  - setTrueStepName
```
public void setTrueStepName(java.lang.String trueStep)
```
    Set the name of the connected step to send "true" instances to
    
    Parameters:
    
    trueStep - the name of the step to send "true" instances to
  - getTrueStepName
```
public java.lang.String getTrueStepName()
```
    Get the name of the connected step to send "true" instances to
    
    Returns:
    
    the name of the step to send "true" instances to
  - setFalseStepName
```
public void setFalseStepName(java.lang.String falseStep)
```
    Set the name of the connected step to send "false" instances to
    
    Parameters:
    
    falseStep - the name of the step to send "false" instances to
  - getFalseStepName
```
public java.lang.String getFalseStepName()
```
    Get the name of the connected step to send "false" instances to
    
    Returns:
    
    the name of the step to send "false" instances to
  - getDownstreamStepNames
```
public java.util.List<java.lang.String> getDownstreamStepNames()
```
    Get a list of the names of connected downstream steps
    
    Returns:
    
    a list of the names of connected downstream steps
  - stepInit
```
public void stepInit()
              throws WekaException
```
    Initialize the step.
    
    Throws:
    
    WekaException - if a problem occurs during initialization
  - getIncomingConnectionTypes
```
public java.util.List<java.lang.String> getIncomingConnectionTypes()
```
    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 java.util.List<java.lang.String> getOutgoingConnectionTypes()
```
    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
  - outputStructureForConnectionType
```
public Instances outputStructureForConnectionType(java.lang.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
  - processIncoming
```
public void processIncoming(Data data)
                     throws WekaException
```
    Main processing routine
    
    Specified by:
    
    processIncoming in interface BaseStepExtender
    
    Specified by:
    
    processIncoming in interface Step
    
    Overrides:
    
    processIncoming in class BaseStep
    
    Parameters:
    
    data - incoming data object
    
    Throws:
    
    WekaException - if a problem occurs
  - processStreaming
```
protected void processStreaming(Data data)
                         throws WekaException
```
    Handles streaming "instance" connections
    
    Parameters:
    
    data - incoming data object encapsulating an instance to process
    
    Throws:
    
    WekaException - if a problem occurs
  - processBatch
```
protected void processBatch(Data data)
                     throws WekaException
```
    Processes batch data (dataset, training or test) connections.
    
    Parameters:
    
    data - the data object to process
    
    Throws:
    
    WekaException - if a problem occurs
  - getCustomEditorForStep
```
public java.lang.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

Class FlowByExpression

Nested Class Summary

Field Summary

Fields inherited from class weka.knowledgeflow.steps.BaseStep

Constructor Summary

Method Summary

Methods inherited from class weka.knowledgeflow.steps.BaseStep

Methods inherited from class java.lang.Object

Field Detail

m_isReset

m_root

m_expressionString

m_customNameOfTrueStep

m_customNameOfFalseStep

m_incomingStructure

m_batchCount

m_validTrueStep

m_validFalseStep

m_streamingData

Constructor Detail

FlowByExpression

Method Detail

setExpressionString

getExpressionString

setTrueStepName

getTrueStepName

setFalseStepName

getFalseStepName

getDownstreamStepNames

stepInit

getIncomingConnectionTypes

getOutgoingConnectionTypes

outputStructureForConnectionType

processIncoming

processStreaming

processBatch

getCustomEditorForStep