org.drools.core.reteoo

Class ConditionalBranchNode

java.lang.Object

org.drools.core.common.BaseNode

org.drools.core.reteoo.LeftTupleSource

org.drools.core.reteoo.ConditionalBranchNode

All Implemented Interfaces:

Externalizable, Serializable, MemoryFactory<ConditionalBranchNode.ConditionalBranchMemory>, NetworkNode, LeftTupleNode, LeftTupleSink, LeftTupleSinkNode, Sink

public class ConditionalBranchNode
extends LeftTupleSource
implements LeftTupleSinkNode, MemoryFactory<ConditionalBranchNode.ConditionalBranchMemory>

Node which allows to follow different paths in the Rete-OO network, based on the result of a boolean Test.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConditionalBranchNode.ConditionalBranchMemory

Field Summary

Fields

Modifier and Type	Field and Description
protected ConditionalBranchEvaluator	branchEvaluator
protected boolean	tupleMemoryEnabled

Fields inherited from class org.drools.core.reteoo.LeftTupleSource

leftDeclaredMask, leftInferredMask, leftInput, leftNegativeMask, sink

Fields inherited from class org.drools.core.common.BaseNode

associations, hashcode, id, memoryId, partitionId, partitionsEnabled

Constructor Summary

Constructors

Constructor and Description
ConditionalBranchNode()
ConditionalBranchNode(int id, LeftTupleSource tupleSource, ConditionalBranchEvaluator branchEvaluator, BuildContext context)

Method Summary

Modifier and Type	Method and Description
LeftTuple	createLeftTuple(InternalFactHandle factHandle, boolean leftTupleMemoryEnabled)
LeftTuple	createLeftTuple(InternalFactHandle factHandle, LeftTuple leftTuple, Sink sink)
LeftTuple	createLeftTuple(LeftTuple leftTuple, RightTuple rightTuple, LeftTuple currentLeftChild, LeftTuple currentRightChild, Sink sink, boolean leftTupleMemoryEnabled)
LeftTuple	createLeftTuple(LeftTuple leftTuple, RightTuple rightTuple, Sink sink)
LeftTuple	createLeftTuple(LeftTuple leftTuple, Sink sink, PropagationContext pctx, boolean leftTupleMemoryEnabled)
ConditionalBranchNode.ConditionalBranchMemory	createMemory(RuleBaseConfiguration config, InternalWorkingMemory wm)
LeftTuple	createPeer(LeftTuple original)
void	doAttach(BuildContext context)
protected boolean	doRemove(RuleRemovalContext context, ReteooBuilder builder) Removes the node from the network.
boolean	equals(Object object)
ConditionalBranchEvaluator	getBranchEvaluator()
LeftTupleSinkNode	getNextLeftTupleSinkNode() Returns the next node
ObjectTypeNode	getObjectTypeNode()
LeftTupleSinkNode	getPreviousLeftTupleSinkNode() Returns the previous node
short	getType()
protected void	initDeclaredMask(BuildContext context, LeftTupleSource leftInput)
boolean	isLeftTupleMemoryEnabled()
void	networkUpdated(UpdateContext updateContext) A method that is called for all nodes whose network below them changed, after the change is complete, providing them with an opportunity for state update
void	readExternal(ObjectInput in)
void	setLeftTupleMemoryEnabled(boolean tupleMemoryEnabled)
void	setNextLeftTupleSinkNode(LeftTupleSinkNode next) Sets the next node
void	setPreviousLeftTupleSinkNode(LeftTupleSinkNode previous) Sets the previous node
String	toString() Produce a debug string.
void	writeExternal(ObjectOutput out)

Methods inherited from class org.drools.core.reteoo.LeftTupleSource

addTupleSink, addTupleSink, addTupleSink, getLeftDeclaredMask, getLeftInferredMask, getLeftInputOtnId, getLeftInputPattern, getLeftNegativeMask, getLeftTupleSource, getObjectCount, getObjectType, getObjectTypeForPropertyReactivity, getPathIndex, getSinkPropagator, initInferredMask, initMasks, isInUse, removeTupleSink, setLeftInferredMask, setLeftInputOtnId, setLeftListenedProperties, setLeftTupleSource, setNodeConstraintsPropertyReactiveMask, setObjectCount, setPartitionIdWithSinks, setSourcePartitionId, setSourcePartitionId

Methods inherited from class org.drools.core.common.BaseNode

addAssociation, addAssociation, attach, getAssociatedRules, getAssociatedRuleSize, getAssociationsSize, getAssociationsSize, getId, getMemoryId, getPartitionId, getSinks, hashCode, initMemoryId, isAssociatedWith, isStreamMode, remove, removeAssociation, setId, setPartitionId, setPartitionsEnabled, setStreamMode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.drools.core.reteoo.LeftTupleSink

getLeftInferredMask, getLeftInputOtnId, setLeftInputOtnId, setPartitionIdWithSinks

Methods inherited from interface org.drools.core.reteoo.LeftTupleNode

getLeftTupleSource, getObjectCount, getPathIndex, getSinkPropagator, setObjectCount

Methods inherited from interface org.drools.core.common.NetworkNode

getAssociatedRuleSize, getAssociationsSize, getAssociationsSize, getId, getPartitionId, isAssociatedWith

Methods inherited from interface org.drools.core.common.MemoryFactory

getMemoryId

Field Detail

branchEvaluator

protected ConditionalBranchEvaluator branchEvaluator

tupleMemoryEnabled

protected boolean tupleMemoryEnabled

Constructor Detail

ConditionalBranchNode

public ConditionalBranchNode()

ConditionalBranchNode

public ConditionalBranchNode(int id,
                             LeftTupleSource tupleSource,
                             ConditionalBranchEvaluator branchEvaluator,
                             BuildContext context)

Method Detail

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class LeftTupleSource

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class LeftTupleSource

Throws:

IOException

getBranchEvaluator

public ConditionalBranchEvaluator getBranchEvaluator()

doAttach

public void doAttach(BuildContext context)

Overrides:

doAttach in class BaseNode

networkUpdated

public void networkUpdated(UpdateContext updateContext)

Description copied from class: BaseNode

A method that is called for all nodes whose network below them changed, after the change is complete, providing them with an opportunity for state update

Specified by:

networkUpdated in class BaseNode

toString

public String toString()

Produce a debug string.

Overrides:

toString in class BaseNode

Returns:

The debug string.

equals

public boolean equals(Object object)

Overrides:

equals in class Object

createMemory

public ConditionalBranchNode.ConditionalBranchMemory createMemory(RuleBaseConfiguration config,
                                                                  InternalWorkingMemory wm)

Specified by:

createMemory in interface MemoryFactory<ConditionalBranchNode.ConditionalBranchMemory>

createPeer

public LeftTuple createPeer(LeftTuple original)

Specified by:

createPeer in interface LeftTupleSink

Specified by:

createPeer in class LeftTupleSource

isLeftTupleMemoryEnabled

public boolean isLeftTupleMemoryEnabled()

Specified by:

isLeftTupleMemoryEnabled in interface LeftTupleSink

Specified by:

isLeftTupleMemoryEnabled in class LeftTupleSource

setLeftTupleMemoryEnabled

public void setLeftTupleMemoryEnabled(boolean tupleMemoryEnabled)

Specified by:

setLeftTupleMemoryEnabled in interface LeftTupleSink

getNextLeftTupleSinkNode

public LeftTupleSinkNode getNextLeftTupleSinkNode()

Returns the next node

Specified by:

getNextLeftTupleSinkNode in interface LeftTupleSinkNode

Returns:

The next TupleSinkNode

setNextLeftTupleSinkNode

public void setNextLeftTupleSinkNode(LeftTupleSinkNode next)

Sets the next node

Specified by:

setNextLeftTupleSinkNode in interface LeftTupleSinkNode

Parameters:

next - The next TupleSinkNode

getPreviousLeftTupleSinkNode

public LeftTupleSinkNode getPreviousLeftTupleSinkNode()

Returns the previous node

Specified by:

getPreviousLeftTupleSinkNode in interface LeftTupleSinkNode

Returns:

The previous TupleSinkNode

setPreviousLeftTupleSinkNode

public void setPreviousLeftTupleSinkNode(LeftTupleSinkNode previous)

Sets the previous node

Specified by:

setPreviousLeftTupleSinkNode in interface LeftTupleSinkNode

Parameters:

previous - The previous TupleSinkNode

getType

public short getType()

Specified by:

getType in interface NetworkNode

Specified by:

getType in class LeftTupleSource

createLeftTuple

public LeftTuple createLeftTuple(InternalFactHandle factHandle,
                                 boolean leftTupleMemoryEnabled)

Specified by:

createLeftTuple in interface LeftTupleSink

createLeftTuple

public LeftTuple createLeftTuple(InternalFactHandle factHandle,
                                 LeftTuple leftTuple,
                                 Sink sink)

Specified by:

createLeftTuple in interface LeftTupleSink

createLeftTuple

public LeftTuple createLeftTuple(LeftTuple leftTuple,
                                 Sink sink,
                                 PropagationContext pctx,
                                 boolean leftTupleMemoryEnabled)

Specified by:

createLeftTuple in interface LeftTupleSink

createLeftTuple

public LeftTuple createLeftTuple(LeftTuple leftTuple,
                                 RightTuple rightTuple,
                                 Sink sink)

Specified by:

createLeftTuple in interface LeftTupleSink

createLeftTuple

public LeftTuple createLeftTuple(LeftTuple leftTuple,
                                 RightTuple rightTuple,
                                 LeftTuple currentLeftChild,
                                 LeftTuple currentRightChild,
                                 Sink sink,
                                 boolean leftTupleMemoryEnabled)

Specified by:

createLeftTuple in interface LeftTupleSink

getObjectTypeNode

public ObjectTypeNode getObjectTypeNode()

Specified by:

getObjectTypeNode in class BaseNode

doRemove

protected boolean doRemove(RuleRemovalContext context,
                           ReteooBuilder builder)

Description copied from class: BaseNode

Removes the node from the network. Usually from the parent ObjectSource or TupleSource

Specified by:

doRemove in class BaseNode

initDeclaredMask

protected void initDeclaredMask(BuildContext context,
                                LeftTupleSource leftInput)

Overrides:

initDeclaredMask in class LeftTupleSource