org.drools.core.reteoo

Class Rete

java.lang.Object

org.drools.core.common.BaseNode

org.drools.core.reteoo.ObjectSource

org.drools.core.reteoo.Rete

All Implemented Interfaces:

Externalizable, Serializable, NetworkNode, ObjectSink, Sink

public class Rete
extends ObjectSource
implements Externalizable, ObjectSink

The Rete-OO network. The Rete class is the root Object. All objects are asserted into the Rete node where it propagates to all matching ObjectTypeNodes. The first time an instance of a Class type is asserted it does a full iteration of all ObjectTyppeNodes looking for matches, any matches are then cached in a HashMap which is used for future assertions. While Rete extends ObjectSource nad implements ObjectSink it nulls the methods attach(), remove() and updateNewNode() as this is the root node they are no applicable

See Also:

ObjectTypeNode, Serialized Form

Field Summary

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

alphaNodeHashingThreshold, alphaNodeRangeIndexThreshold, declaredMask, inferredMask, sink, source

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

associations, hashcode, id, memoryId, partitionId, partitionsEnabled

Constructor Summary

Constructors

Constructor and Description
Rete()
Rete(InternalKnowledgeBase kBase)

Method Summary

Modifier and Type	Method and Description
void	addObjectSink(ObjectSink objectSink) Adds the ObjectSink so that it may receive Objects propagated from this ObjectSource.
void	assertObject(InternalFactHandle factHandle, PropagationContext context, InternalWorkingMemory workingMemory) This is the entry point into the network for all asserted Facts.
void	byPassModifyToBetaNode(InternalFactHandle factHandle, ModifyPreviousTuples modifyPreviousTuples, PropagationContext context, InternalWorkingMemory workingMemory)
BitMask	calculateDeclaredMask(Class modifiedClass, List<String> settableProperties)
void	doAttach(BuildContext context)
protected boolean	doRemove(RuleRemovalContext context, ReteooBuilder builder) Removes the node from the network.
boolean	equals(Object object)
EntryPointNode	getEntryPointNode(EntryPointId entryPoint)
Map<EntryPointId,EntryPointNode>	getEntryPointNodes()
InternalKnowledgeBase	getKnowledgeBase()
List<ObjectTypeNode>	getObjectTypeNodes()
Map<ObjectType,ObjectTypeNode>	getObjectTypeNodes(EntryPointId entryPoint)
short	getType()
void	modifyObject(InternalFactHandle factHandle, ModifyPreviousTuples modifyPreviousTuples, 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 opportunity for state update
void	readExternal(ObjectInput in)
void	removeObjectSink(ObjectSink objectSink) Removes the ObjectSink
void	retractObject(InternalFactHandle handle, PropagationContext context, InternalWorkingMemory workingMemory) Retract a fact object from this RuleBase and the specified WorkingMemory.
void	updateSink(ObjectSink sink, PropagationContext context, InternalWorkingMemory workingMemory)
void	writeExternal(ObjectOutput out)

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

getDeclaredMask, getObjectSinkPropagator, getObjectTypeNode, getParentObjectSource, initDeclaredMask, isInUse, resetInferredMask, setObjectSinkPropagator, setParentObjectSource, setPartitionId, setPartitionIdWithSinks, setSourcePartitionId, updateMask

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, setPartitionsEnabled, setStreamMode, toString

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

Constructor Detail

Rete

public Rete()

Rete

public Rete(InternalKnowledgeBase kBase)

Method Detail

getType

public short getType()

Specified by:

getType in interface NetworkNode

assertObject

public void assertObject(InternalFactHandle factHandle,
                         PropagationContext context,
                         InternalWorkingMemory workingMemory)

This is the entry point into the network for all asserted Facts. Iterates a cache of matching ObjectTypdeNodes asserting the Fact. If the cache does not exist it first iteraes and builds the cache.

Specified by:

assertObject in interface ObjectSink

Parameters:

factHandle - The FactHandle of the fact to assert

context - The PropagationContext of the WorkingMemory action

workingMemory - The working memory session.

retractObject

public void retractObject(InternalFactHandle handle,
                          PropagationContext context,
                          InternalWorkingMemory workingMemory)

Retract a fact object from this RuleBase and the specified WorkingMemory.

Parameters:

handle - The handle of the fact to retract.

workingMemory - The working memory session.

modifyObject

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

Specified by:

modifyObject in interface ObjectSink

addObjectSink

public void addObjectSink(ObjectSink objectSink)

Adds the ObjectSink so that it may receive Objects propagated from this ObjectSource.

Overrides:

addObjectSink in class ObjectSource

Parameters:

objectSink - The ObjectSink to receive propagated Objects. Rete only accepts ObjectTypeNodes as parameters to this method, though.

removeObjectSink

public void removeObjectSink(ObjectSink objectSink)

Description copied from class: ObjectSource

Removes the ObjectSink

Overrides:

removeObjectSink in class ObjectSource

Parameters:

objectSink - The ObjectSink to remove

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

Overrides:

networkUpdated in class ObjectSource

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

Overrides:

doRemove in class ObjectSource

getEntryPointNode

public EntryPointNode getEntryPointNode(EntryPointId entryPoint)

getObjectTypeNodes

public List<ObjectTypeNode> getObjectTypeNodes()

getObjectTypeNodes

public Map<ObjectType,ObjectTypeNode> getObjectTypeNodes(EntryPointId entryPoint)

getKnowledgeBase

public InternalKnowledgeBase getKnowledgeBase()

Overrides:

getKnowledgeBase in class ObjectSource

equals

public boolean equals(Object object)

Overrides:

equals in class Object

updateSink

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

Specified by:

updateSink in class ObjectSource

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class ObjectSource

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class ObjectSource

Throws:

IOException

ClassNotFoundException

getEntryPointNodes

public Map<EntryPointId,EntryPointNode> getEntryPointNodes()

byPassModifyToBetaNode

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

Specified by:

byPassModifyToBetaNode in interface ObjectSink

calculateDeclaredMask

public BitMask calculateDeclaredMask(Class modifiedClass,
                                     List<String> settableProperties)

Specified by:

calculateDeclaredMask in class ObjectSource