org.drools.reteoo
Class RuleTerminalNode

java.lang.Object
  org.drools.common.BaseNode
      org.drools.reteoo.RuleTerminalNode

All Implemented Interfaces:

Externalizable, Serializable, NetworkNode, LeftTupleSink, LeftTupleSinkNode, Sink, TerminalNode

public class RuleTerminalNode
extends BaseNode
implements TerminalNode, Externalizable

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

See Also:

Rule, Serialized Form

Nested Class Summary

static class	RuleTerminalNode.RTNCleanupAdapter
static class	RuleTerminalNode.SortDeclarations

Field Summary

Fields inherited from class org.drools.common.BaseNode

associations, id, partitionId, partitionsEnabled

Constructor Summary

RuleTerminalNode()

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

Method Summary

void	assertLeftTuple(LeftTuple leftTuple, PropagationContext context, InternalWorkingMemory workingMemory) Assert a new ReteTuple.
void	attach() Attaches the node into the network.
void	attach(InternalWorkingMemory[] workingMemories)
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)
static void	doInitDeclaredMask(TerminalNode tn, BuildContext context)
static void	doInitInferredMask(TerminalNode tn)
protected void	doRemove(RuleRemovalContext context, ReteooBuilder builder, BaseNode node, InternalWorkingMemory[] workingMemories) Removes the node from teh network.
boolean	equals(Object object)
Declaration[]	getDeclarations()
long	getDeclaredMask()
long	getInferredMask()
int	getLeftInputOtnId()
LeftTupleSource	getLeftTupleSource()
long	getNegativeMask()
LeftTupleSinkNode	getNextLeftTupleSinkNode() Returns the next node
protected ObjectTypeNode	getObjectTypeNode()
LeftTupleSinkNode	getPreviousLeftTupleSinkNode() Returns the previous node
Rule	getRule() Retrieve the Action associated with this node.
int	getSequence()
GroupElement	getSubRule()
short	getType()
int	hashCode() The hashCode return is simply the unique id of the node.
void	initDeclaredMask(BuildContext context)
void	initInferredMask()
boolean	isFireDirect()
boolean	isInUse() Returns true in case the current node is in use (is referenced by any other node)
boolean	isLeftTupleMemoryEnabled()
void	modifyLeftTuple(InternalFactHandle factHandle, ModifyPreviousTuples modifyPreviousTuples, PropagationContext context, InternalWorkingMemory workingMemory)
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	setDeclaredMask(long mask)
void	setFireDirect(boolean fireDirect)
void	setInferredMask(long mask)
void	setLeftInputOtnId(int leftInputOtnId)
void	setLeftTupleMemoryEnabled(boolean tupleMemoryEnabled)
void	setNegativeMask(long mask)
void	setNextLeftTupleSinkNode(LeftTupleSinkNode next) Sets the next node
void	setPreviousLeftTupleSinkNode(LeftTupleSinkNode previous) Sets the previous node
void	setSequence(int seq)
String	toString()
LeftTupleSource	unwrapTupleSource()
void	writeExternal(ObjectOutput out)

Methods inherited from class org.drools.common.BaseNode

addAssociation, getAssociations, getId, getPartitionId, remove, removeAssociation, setPartitionId

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.drools.common.NetworkNode

getId, getPartitionId

Constructor Detail

RuleTerminalNode

public RuleTerminalNode()

RuleTerminalNode

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

Parameters:

id -

source -

rule -

subrule -

subruleIndex -

context -

Method Detail

initDeclaredMask

public void initDeclaredMask(BuildContext context)

doInitDeclaredMask

public static void doInitDeclaredMask(TerminalNode tn,
                                      BuildContext context)

initInferredMask

public void initInferredMask()

Specified by:

initInferredMask in interface TerminalNode

doInitInferredMask

public static void doInitInferredMask(TerminalNode tn)

unwrapTupleSource

public LeftTupleSource unwrapTupleSource()

Specified by:

unwrapTupleSource in interface TerminalNode

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class BaseNode

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class BaseNode

Throws:

IOException

getRule

public Rule getRule()

Retrieve the Action associated with this node.

Returns:

The Action associated with this node.

getSubRule

public GroupElement getSubRule()

setSequence

public void setSequence(int seq)

getSequence

public int getSequence()

getLeftTupleSource

public LeftTupleSource getLeftTupleSource()

Specified by:

getLeftTupleSource in interface LeftTupleSink

Specified by:

getLeftTupleSource in interface TerminalNode

getDeclaredMask

public long getDeclaredMask()

Specified by:

getDeclaredMask in interface TerminalNode

getInferredMask

public long getInferredMask()

Specified by:

getInferredMask in interface TerminalNode

setDeclaredMask

public void setDeclaredMask(long mask)

Specified by:

setDeclaredMask in interface TerminalNode

setInferredMask

public void setInferredMask(long mask)

Specified by:

setInferredMask in interface TerminalNode

getNegativeMask

public long getNegativeMask()

Specified by:

getNegativeMask in interface TerminalNode

setNegativeMask

public void setNegativeMask(long mask)

Specified by:

setNegativeMask in interface TerminalNode

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.

modifyLeftTuple

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

Specified by:

modifyLeftTuple in interface LeftTupleSink

modifyLeftTuple

public void modifyLeftTuple(InternalFactHandle factHandle,
                            ModifyPreviousTuples modifyPreviousTuples,
                            PropagationContext context,
                            InternalWorkingMemory workingMemory)

Specified by:

modifyLeftTuple in interface LeftTupleSink

retractLeftTuple

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

Specified by:

retractLeftTuple in interface LeftTupleSink

toString

public String toString()

Overrides:

toString in class BaseNode

attach

public void attach()

Description copied from class: BaseNode

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

Specified by:

attach in class BaseNode

attach

public void attach(InternalWorkingMemory[] workingMemories)

Specified by:

attach 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

doRemove

protected void doRemove(RuleRemovalContext context,
                        ReteooBuilder builder,
                        BaseNode node,
                        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

isInUse

public boolean isInUse()

Description copied from class: BaseNode

Returns true in case the current node is in use (is referenced by any other node)

Specified by:

isInUse in class BaseNode

Returns:

isLeftTupleMemoryEnabled

public boolean isLeftTupleMemoryEnabled()

Specified by:

isLeftTupleMemoryEnabled in interface LeftTupleSink

setLeftTupleMemoryEnabled

public void setLeftTupleMemoryEnabled(boolean tupleMemoryEnabled)

Specified by:

setLeftTupleMemoryEnabled in interface LeftTupleSink

getDeclarations

public Declaration[] getDeclarations()

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

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

getType

public short getType()

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

getLeftInputOtnId

public int getLeftInputOtnId()

Specified by:

getLeftInputOtnId in interface LeftTupleSink

setLeftInputOtnId

public void setLeftInputOtnId(int leftInputOtnId)

Specified by:

setLeftInputOtnId in interface LeftTupleSink

isFireDirect

public boolean isFireDirect()

setFireDirect

public void setFireDirect(boolean fireDirect)

getObjectTypeNode

protected ObjectTypeNode getObjectTypeNode()