org.drools.core.reteoo

Class RuleTerminalNode

java.lang.Object

org.drools.core.common.BaseNode

org.drools.core.reteoo.AbstractTerminalNode

org.drools.core.reteoo.RuleTerminalNode

All Implemented Interfaces:

Externalizable, Serializable, MemoryFactory<PathMemory>, NetworkNode, LeftTupleNode, LeftTupleSink, LeftTupleSinkNode, PathEndNode, Sink, TerminalNode

public class RuleTerminalNode
extends AbstractTerminalNode

Leaf Rete-OO node responsible for enacting Action s on a matched Rule.

See Also:

Rule, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RuleTerminalNode.RTNCleanupAdapter
static class	RuleTerminalNode.SortDeclarations

Field Summary

Fields

Modifier and Type	Field and Description
protected Declaration[]	allDeclarations
protected String	consequenceName
protected Declaration[]	enabledDeclarations
protected boolean	fireDirect
protected ObjectTypeNode.Id	leftInputOtnId
protected LeftTupleSinkNode	nextTupleSinkNode
protected LeftTupleSinkNode	previousTupleSinkNode
protected Declaration[]	requiredDeclarations
protected RuleImpl	rule The rule to invoke upon match.
protected Declaration[]	salienceDeclarations
protected GroupElement	subrule the subrule reference is needed to resolve declarations because declarations may have different offsets in each subrule
protected int	subruleIndex
protected Declaration[][]	timerDeclarations

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

associations, hashcode, id, partitionId, partitionsEnabled

Constructor Summary

Constructors

Constructor and Description
RuleTerminalNode()
RuleTerminalNode(int id, LeftTupleSource source, RuleImpl rule, GroupElement subrule, int subruleIndex, BuildContext context)

Method Summary

Modifier and Type	Method and Description
void	assertLeftTuple(LeftTuple leftTuple, PropagationContext context, InternalWorkingMemory workingMemory) Assert a new ReteTuple.
void	attach(BuildContext context) Attaches the node into the network.
void	cancelMatch(AgendaItem match, InternalWorkingMemoryActions workingMemory)
LeftTuple	createLeftTuple(InternalFactHandle factHandle, LeftTuple leftTuple, Sink sink)
LeftTuple	createLeftTuple(InternalFactHandle factHandle, Sink sink, boolean leftTupleMemoryEnabled)
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)
boolean	equals(Object object)
static PropagationContext	findMostRecentPropagationContext(Tuple leftTuple, PropagationContext context)
Declaration[]	getAllDeclarations()
String	getConsequenceName()
Declaration[]	getEnabledDeclarations()
ObjectTypeNode.Id	getLeftInputOtnId()
LeftTupleSinkNode	getNextLeftTupleSinkNode() Returns the next node
protected ObjectTypeNode	getObjectTypeNode()
LeftTupleSinkNode	getPreviousLeftTupleSinkNode() Returns the previous node
Declaration[]	getRequiredDeclarations()
RuleImpl	getRule() Retrieve the Action associated with this node.
Declaration[]	getSalienceDeclarations()
GroupElement	getSubRule()
Declaration[][]	getTimerDeclarations()
short	getType()
protected boolean	internalEquals(Object object)
boolean	isFireDirect()
void	modifyLeftTuple(LeftTuple leftTuple, PropagationContext context, InternalWorkingMemory workingMemory)
void	readExternal(ObjectInput in)
void	retractLeftTuple(LeftTuple leftTuple, PropagationContext context, InternalWorkingMemory workingMemory)
void	setDeclarations(Map<String,Declaration> decls)
void	setFireDirect(boolean fireDirect)
void	setLeftInputOtnId(ObjectTypeNode.Id leftInputOtnId)
void	setNextLeftTupleSinkNode(LeftTupleSinkNode next) Sets the next node
void	setPreviousLeftTupleSinkNode(LeftTupleSinkNode previous) Sets the previous node
void	setSalienceDeclarations(Declaration[] salienceDeclarations)
String	toString()
void	writeExternal(ObjectOutput out)

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

createMemory, createPeer, doRemove, getDeclaredMask, getInferredMask, getLeftInferredMask, getLeftTupleSource, getNegativeMask, getPathEndNodes, getPathNodes, getPathNodes, getPositionInPath, getSinkPropagator, hasPathNode, initDeclaredMask, initInferredMask, initPathMemory, isInUse, isLeftTupleMemoryEnabled, isTerminalNodeOf, modifyLeftTuple, networkUpdated, setDeclaredMask, setInferredMask, setLeftTupleMemoryEnabled, setNegativeMask, setPathEndNodes, unwrapTupleSource

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

addAssociation, addAssociation, getAssociatedRuleSize, getAssociationsSize, getAssociationsSize, getId, getPartitionId, hashCode, isAssociatedWith, isStreamMode, remove, removeAssociation, setId, setPartitionId, setStreamMode, thisNodeEquals

Methods inherited from class java.lang.Object

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

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

getAssociatedRuleSize, getAssociationsSize, getAssociationsSize, getId, getPartitionId, isAssociatedWith, thisNodeEquals

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

getId

Field Detail

rule

protected RuleImpl rule

The rule to invoke upon match.

subrule

protected GroupElement subrule

the subrule reference is needed to resolve declarations because declarations may have different offsets in each subrule

subruleIndex

protected int subruleIndex

allDeclarations

protected Declaration[] allDeclarations

requiredDeclarations

protected Declaration[] requiredDeclarations

timerDeclarations

protected Declaration[][] timerDeclarations

salienceDeclarations

protected Declaration[] salienceDeclarations

enabledDeclarations

protected Declaration[] enabledDeclarations

previousTupleSinkNode

protected LeftTupleSinkNode previousTupleSinkNode

nextTupleSinkNode

protected LeftTupleSinkNode nextTupleSinkNode

fireDirect

protected boolean fireDirect

leftInputOtnId

protected transient ObjectTypeNode.Id leftInputOtnId

consequenceName

protected String consequenceName

Constructor Detail

RuleTerminalNode

public RuleTerminalNode()

RuleTerminalNode

public RuleTerminalNode(int id,
                        LeftTupleSource source,
                        RuleImpl rule,
                        GroupElement subrule,
                        int subruleIndex,
                        BuildContext context)

Method Detail

setDeclarations

public void setDeclarations(Map<String,Declaration> decls)

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class AbstractTerminalNode

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class AbstractTerminalNode

Throws:

IOException

getRule

public RuleImpl getRule()

Retrieve the Action associated with this node.

Specified by:

getRule in interface TerminalNode

Specified by:

getRule in class AbstractTerminalNode

Returns:

The Action associated with this node.

getSubRule

public GroupElement getSubRule()

findMostRecentPropagationContext

public static PropagationContext findMostRecentPropagationContext(Tuple leftTuple,
                                                                  PropagationContext context)

toString

public String toString()

Overrides:

toString in class BaseNode

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

getAllDeclarations

public Declaration[] getAllDeclarations()

getRequiredDeclarations

public Declaration[] getRequiredDeclarations()

getTimerDeclarations

public Declaration[][] getTimerDeclarations()

getSalienceDeclarations

public Declaration[] getSalienceDeclarations()

setSalienceDeclarations

public void setSalienceDeclarations(Declaration[] salienceDeclarations)

getEnabledDeclarations

public Declaration[] getEnabledDeclarations()

getConsequenceName

public String getConsequenceName()

cancelMatch

public void cancelMatch(AgendaItem match,
                        InternalWorkingMemoryActions workingMemory)

getNextLeftTupleSinkNode

public LeftTupleSinkNode getNextLeftTupleSinkNode()

Returns the next node

Returns:

The next TupleSinkNode

setNextLeftTupleSinkNode

public void setNextLeftTupleSinkNode(LeftTupleSinkNode next)

Sets the next node

Parameters:

next - The next TupleSinkNode

getPreviousLeftTupleSinkNode

public LeftTupleSinkNode getPreviousLeftTupleSinkNode()

Returns the previous node

Returns:

The previous TupleSinkNode

setPreviousLeftTupleSinkNode

public void setPreviousLeftTupleSinkNode(LeftTupleSinkNode previous)

Sets the previous node

Parameters:

previous - The previous TupleSinkNode

equals

public boolean equals(Object object)

Overrides:

equals in class Object

internalEquals

protected boolean internalEquals(Object object)

Specified by:

internalEquals in class BaseNode

getType

public short getType()

createLeftTuple

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

createLeftTuple

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

createLeftTuple

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

createLeftTuple

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

createLeftTuple

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

getLeftInputOtnId

public ObjectTypeNode.Id getLeftInputOtnId()

setLeftInputOtnId

public void setLeftInputOtnId(ObjectTypeNode.Id leftInputOtnId)

isFireDirect

public boolean isFireDirect()

setFireDirect

public void setFireDirect(boolean fireDirect)

getObjectTypeNode

protected ObjectTypeNode getObjectTypeNode()

assertLeftTuple

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

Description copied from interface: LeftTupleSink

Assert a new ReteTuple.

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)

modifyLeftTuple

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