org.drools.reteoo
Class ConditionalBranchNode

java.lang.Object
  org.drools.common.BaseNode
      org.drools.reteoo.LeftTupleSource
          org.drools.reteoo.ConditionalBranchNode

All Implemented Interfaces:

Externalizable, Serializable, NetworkNode, NodeMemory, LeftTupleSink, LeftTupleSinkNode, Sink

public class ConditionalBranchNode
extends LeftTupleSource
implements LeftTupleSinkNode, NodeMemory

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

static class

ConditionalBranchNode.ConditionalBranchMemory

Field Summary

protected boolean

tupleMemoryEnabled

Fields inherited from class org.drools.reteoo.LeftTupleSource

sink

Fields inherited from class org.drools.common.BaseNode

associations, id, partitionId, partitionsEnabled

Constructor Summary

ConditionalBranchNode()

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

Method Summary

void	assertLeftTuple(LeftTuple leftTuple, PropagationContext context, InternalWorkingMemory workingMemory) Assert a new ReteTuple.
void	attach(BuildContext context) Attaches the node into the network.
LeftTuple	createLeftTuple(InternalFactHandle factHandle, LeftTupleSink sink, boolean leftTupleMemoryEnabled)
LeftTuple	createLeftTuple(LeftTuple leftTuple, LeftTupleSink sink, boolean leftTupleMemoryEnabled)
LeftTuple	createLeftTuple(LeftTuple leftTuple, RightTuple rightTuple, LeftTuple currentLeftChild, LeftTuple currentRightChild, LeftTupleSink sink, boolean leftTupleMemoryEnabled)
LeftTuple	createLeftTuple(LeftTuple leftTuple, RightTuple rightTuple, LeftTupleSink sink)
Memory	createMemory(RuleBaseConfiguration config)
protected void	doCollectAncestors(NodeSet nodeSet)
protected void	doRemove(RuleRemovalContext context, ReteooBuilder builder, InternalWorkingMemory[] workingMemories) Removes the node from teh network.
boolean	equals(Object object)
LeftTupleSource	getLeftTupleSource()
LeftTupleSinkNode	getNextLeftTupleSinkNode() Returns the next node
protected ObjectTypeNode	getObjectTypeNode()
LeftTupleSinkNode	getPreviousLeftTupleSinkNode() Returns the previous node
short	getType()
int	hashCode() The hashCode return is simply the unique id of the node.
boolean	isLeftTupleMemoryEnabled()
void	modifyLeftTuple(LeftTuple leftTuple, PropagationContext context, InternalWorkingMemory workingMemory)
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 oportunity for state update
void	readExternal(ObjectInput in)
void	retractLeftTuple(LeftTuple leftTuple, PropagationContext context, InternalWorkingMemory workingMemory)
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	updateSink(LeftTupleSink sink, PropagationContext context, InternalWorkingMemory workingMemory)
void	updateSinkOnAttach(BuildContext context, PropagationContext propagationContext, InternalWorkingMemory workingMemory)
void	writeExternal(ObjectOutput out)

Methods inherited from class org.drools.reteoo.LeftTupleSource

addTupleSink, addTupleSink, addTupleSink, doModifyLeftTuple, getLeftDeclaredMask, getLeftInferredMask, getLeftInputOtnId, getLeftNegativeMask, getObjectType, getSinkPropagator, initDeclaredMask, initInferredMask, initMasks, isInUse, modifyLeftTuple, removeTupleSink, setLeftInferredMask, setLeftInputOtnId, setLeftListenedProperties, unwrapLeftInput

Methods inherited from class org.drools.common.BaseNode

addAssociation, attach, collectAncestors, getAssociations, getId, getPartitionId, remove, removeAssociation, setPartitionId, updateSinkOnAttach

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.drools.reteoo.LeftTupleSink

getLeftInputOtnId, modifyLeftTuple, setLeftInputOtnId

Methods inherited from interface org.drools.common.NetworkNode

getId, getPartitionId

Methods inherited from interface org.drools.common.NodeMemory

getId

Field Detail

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

attach

public void attach(BuildContext context)

Description copied from class: BaseNode

Attaches the node into the network. Usually to the parent ObjectSource or TupleSource

Specified by:

attach in class BaseNode

updateSinkOnAttach

public void updateSinkOnAttach(BuildContext context,
                               PropagationContext propagationContext,
                               InternalWorkingMemory workingMemory)

Specified by:

updateSinkOnAttach 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 oportunity for state update

Specified by:

networkUpdated in class BaseNode

getLeftTupleSource

public LeftTupleSource getLeftTupleSource()

Specified by:

getLeftTupleSource in interface LeftTupleSink

assertLeftTuple

public void assertLeftTuple(LeftTuple leftTuple,
                            PropagationContext context,
                            InternalWorkingMemory workingMemory)

Description copied from interface: LeftTupleSink

Assert a new ReteTuple.

Specified by:

assertLeftTuple in interface LeftTupleSink

Parameters:

leftTuple - The ReteTuple to propagate.

context - The PropagationContext of the WorkingMemory action

workingMemory - the WorkingMemory session.

retractLeftTuple

public void retractLeftTuple(LeftTuple leftTuple,
                             PropagationContext context,
                             InternalWorkingMemory workingMemory)

Specified by:

retractLeftTuple in interface LeftTupleSink

modifyLeftTuple

public void modifyLeftTuple(LeftTuple leftTuple,
                            PropagationContext context,
                            InternalWorkingMemory workingMemory)

Specified by:

modifyLeftTuple in interface LeftTupleSink

toString

public String toString()

Produce a debug string.

Overrides:

toString in class BaseNode

Returns:

The debug string.

hashCode

public int hashCode()

Description copied from class: BaseNode

The hashCode return is simply the unique id of the node. It is expected that base classes will also implement equals(Object object).

Overrides:

hashCode in class BaseNode

equals

public boolean equals(Object object)

Overrides:

equals in class Object

createMemory

public Memory createMemory(RuleBaseConfiguration config)

Specified by:

createMemory in interface NodeMemory

updateSink

public void updateSink(LeftTupleSink sink,
                       PropagationContext context,
                       InternalWorkingMemory workingMemory)

Specified by:

updateSink in class LeftTupleSource

doRemove

protected void doRemove(RuleRemovalContext context,
                        ReteooBuilder builder,
                        InternalWorkingMemory[] workingMemories)

Description copied from class: BaseNode

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

Specified by:

doRemove in class BaseNode

doCollectAncestors

protected void doCollectAncestors(NodeSet nodeSet)

Specified by:

doCollectAncestors in class BaseNode

isLeftTupleMemoryEnabled

public boolean isLeftTupleMemoryEnabled()

Specified by:

isLeftTupleMemoryEnabled in interface LeftTupleSink

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 interface LeftTupleSink

createLeftTuple

public LeftTuple createLeftTuple(InternalFactHandle factHandle,
                                 LeftTupleSink sink,
                                 boolean leftTupleMemoryEnabled)

Specified by:

createLeftTuple in interface LeftTupleSink

createLeftTuple

public LeftTuple createLeftTuple(LeftTuple leftTuple,
                                 LeftTupleSink sink,
                                 boolean leftTupleMemoryEnabled)

Specified by:

createLeftTuple in interface LeftTupleSink

createLeftTuple

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

Specified by:

createLeftTuple in interface LeftTupleSink

createLeftTuple

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

Specified by:

createLeftTuple in interface LeftTupleSink

getObjectTypeNode

protected ObjectTypeNode getObjectTypeNode()

Specified by:

getObjectTypeNode in class LeftTupleSource