com.ibm.broker.config.appdev.nodes

Class FilterNode

java.lang.Object

com.ibm.broker.config.appdev.Node

com.ibm.broker.config.appdev.nodes.FilterNode

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class FilterNode
extends Node

FilterNode instance

Filter node routes a message according to message content. You define the route by coding a filter expression in ESQL. See also JavaCompute node

 Change Activity:
 -------- ----------- -------------   ------------------------------------
 Reason:  Date:       Originator:     Comments:
 -------- ----------- -------------   ------------------------------------
 xxxxx.x  2010-08-10  dstorey         creation
 xxxxx.x  xxxx-xx-xx  generated       7.0.0.2 Release
 

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FilterNode.ENUM_FILTER_TRANSACTION ENUM_FILTER_TRANSACTION

Nested classes/interfaces inherited from class com.ibm.broker.config.appdev.Node

Node.RotationKind

Field Summary

Fields

Modifier and Type	Field and Description
InputTerminal	INPUT_TERMINAL_IN
OutputTerminal	OUTPUT_TERMINAL_FAILURE
OutputTerminal	OUTPUT_TERMINAL_FALSE
OutputTerminal	OUTPUT_TERMINAL_TRUE
OutputTerminal	OUTPUT_TERMINAL_UNKNOWN

Fields inherited from class com.ibm.broker.config.appdev.Node

copyright

Constructor Summary

Constructors

Constructor and Description
FilterNode()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getConnectDatasourceBeforeFlowStarts() Get the FilterNode "Connect before flow starts" property
java.lang.String	getDataSource() Get the FilterNode "Data source" property
ESQLModule	getFilterExpression() Get the FilterNode "Filter expression" property
InputTerminal[]	getInputTerminals() Gets the full list of available InputTerminals for this Node
java.lang.String	getNodeName() Gets the label name of this node
OutputTerminal[]	getOutputTerminals() Gets the full list of available OutputTerminals for this Node
boolean	getThrowExceptionOnDatabaseError() Get the FilterNode "Throw exception on database error" property
FilterNode.ENUM_FILTER_TRANSACTION	getTransaction() Get the FilterNode "Transaction" property
boolean	getTreatWarningsAsErrors() Get the FilterNode "Treat warnings as errors" property
java.lang.String	getTypeName() Gets the node type of this node
FilterNode	setConnectDatasourceBeforeFlowStarts(boolean value) Set the FilterNode "Connect before flow starts" property
FilterNode	setDataSource(java.lang.String value) Set the FilterNode "Data source" property
FilterNode	setFilterExpression(ESQLModule value) Set the FilterNode "Filter expression" property
FilterNode	setThrowExceptionOnDatabaseError(boolean value) Set the FilterNode "Throw exception on database error" property
FilterNode	setTransaction(FilterNode.ENUM_FILTER_TRANSACTION value) Set the FilterNode "Transaction" property
FilterNode	setTreatWarningsAsErrors(boolean value) Set the FilterNode "Treat warnings as errors" property

Methods inherited from class com.ibm.broker.config.appdev.Node

addNsmapping, clone, findPropertyByName, getInputTerminal, getInputTerminal, getInstanceNodeProperties, getLocation, getLongDescription, getMandatoryPropertyNames, getNodePropertyTables, getNsmappingtables, getOutputTerminal, getOutputTerminal, getPropertyDefaultValue, getPropertyNames, getPropertyValue, getRotate, getShortDescription, isUdpSupport, removeNsmapping, setLocation, setLocation, setLongDescription, setNodeName, setNsmappingtables, setProperty, setRotate, setShortDescription, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

INPUT_TERMINAL_IN

public final InputTerminal INPUT_TERMINAL_IN

OUTPUT_TERMINAL_FALSE

public final OutputTerminal OUTPUT_TERMINAL_FALSE

OUTPUT_TERMINAL_TRUE

public final OutputTerminal OUTPUT_TERMINAL_TRUE

OUTPUT_TERMINAL_FAILURE

public final OutputTerminal OUTPUT_TERMINAL_FAILURE

OUTPUT_TERMINAL_UNKNOWN

public final OutputTerminal OUTPUT_TERMINAL_UNKNOWN

Constructor Detail

FilterNode

public FilterNode()

Method Detail

getInputTerminals

public InputTerminal[] getInputTerminals()

Description copied from class: Node

Gets the full list of available InputTerminals for this Node

Specified by:

getInputTerminals in class Node

Returns:

InputTerminal[]

getOutputTerminals

public OutputTerminal[] getOutputTerminals()

Description copied from class: Node

Gets the full list of available OutputTerminals for this Node

Specified by:

getOutputTerminals in class Node

Returns:

OutputTerminal[]

getTypeName

public java.lang.String getTypeName()

Description copied from class: Node

Gets the node type of this node

Specified by:

getTypeName in class Node

Returns:

String; the node type

setDataSource

public FilterNode setDataSource(java.lang.String value)

Set the FilterNode "Data source" property

Parameters:

value - String ; the value to set the property "Data source"

getDataSource

public java.lang.String getDataSource()

Get the FilterNode "Data source" property

Returns:

String; the value of the property "Data source"

setConnectDatasourceBeforeFlowStarts

public FilterNode setConnectDatasourceBeforeFlowStarts(boolean value)

Set the FilterNode "Connect before flow starts" property

Parameters:

value - boolean ; the value to set the property "Connect before flow starts"

getConnectDatasourceBeforeFlowStarts

public boolean getConnectDatasourceBeforeFlowStarts()

Get the FilterNode "Connect before flow starts" property

Returns:

boolean; the value of the property "Connect before flow starts"

setTransaction

public FilterNode setTransaction(FilterNode.ENUM_FILTER_TRANSACTION value)

Set the FilterNode "Transaction" property

Parameters:

value - ENUM_FILTER_TRANSACTION ; the value to set the property "Transaction"

getTransaction

public FilterNode.ENUM_FILTER_TRANSACTION getTransaction()

Get the FilterNode "Transaction" property

Returns:

ENUM_FILTER_TRANSACTION; the value of the property "Transaction"

setFilterExpression

public FilterNode setFilterExpression(ESQLModule value)

Set the FilterNode "Filter expression" property

Parameters:

value - ESQLModule ; the value to set the property "Filter expression"

getFilterExpression

public ESQLModule getFilterExpression()

Get the FilterNode "Filter expression" property

Returns:

ESQLModule ; the value of the property "Filter expression"

setTreatWarningsAsErrors

public FilterNode setTreatWarningsAsErrors(boolean value)

Set the FilterNode "Treat warnings as errors" property

Parameters:

value - boolean ; the value to set the property "Treat warnings as errors"

getTreatWarningsAsErrors

public boolean getTreatWarningsAsErrors()

Get the FilterNode "Treat warnings as errors" property

Returns:

boolean; the value of the property "Treat warnings as errors"

setThrowExceptionOnDatabaseError

public FilterNode setThrowExceptionOnDatabaseError(boolean value)

Set the FilterNode "Throw exception on database error" property

Parameters:

value - boolean ; the value to set the property "Throw exception on database error"

getThrowExceptionOnDatabaseError

public boolean getThrowExceptionOnDatabaseError()

Get the FilterNode "Throw exception on database error" property

Returns:

boolean; the value of the property "Throw exception on database error"

getNodeName

public java.lang.String getNodeName()

Description copied from class: Node

Gets the label name of this node

  MessageFlow mf1 = patternInstanceManager.getMessageFlow("MyFlowProject", "mf1.msgflow");
  Node inputMQNode = mf1.getNodeByName("My Input Node");
  inputMQNode.setNodeName("Renamed Input Node");
 

Overrides:

getNodeName in class Node

Returns:

String; the node name