Package org.drools.core.reteoo

Class ObjectTypeNode

java.lang.Object

org.drools.core.common.BaseNode

org.drools.core.reteoo.ObjectSource

org.drools.core.reteoo.ObjectTypeNode

All Implemented Interfaces:

MemoryFactory<ObjectTypeNode.ObjectTypeNodeMemory>, NetworkNode, ObjectSink, Sink

Direct Known Subclasses:

ReteObjectTypeNode

public class ObjectTypeNode
extends ObjectSource
implements ObjectSink, MemoryFactory<ObjectTypeNode.ObjectTypeNodeMemory>

ObjectTypeNodes are responsible for filtering and propagating the matching fact assertions propagated from the Rete node using ObjectType interface.

The assert and retract methods do not attempt to filter as this is the role of the Rete node which builds up a cache of matching ObjectTypdeNodess for each asserted object, using the matches(Object object) method. Incorrect propagation in these methods is not checked and will result in ClassCastExpcections later on in the network.

Filters Objects coming from the Rete using a ObjectType semantic module.

See Also:

Rete

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ObjectTypeNode.ExpireJob
static class	ObjectTypeNode.ExpireJobContext
static class	ObjectTypeNode.Id
static class	ObjectTypeNode.InitialFactObjectTypeNodeMemory
static class	ObjectTypeNode.ObjectTypeNodeMemory

Field Summary

Fields

Modifier and Type	Field	Description
static ObjectTypeNode.Id	DEFAULT_ID
protected org.drools.core.reteoo.ObjectTypeNode.IdGenerator	idGenerator
protected ObjectType	objectType	The ObjectType semantic module.

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

alphaNodeHashingThreshold, alphaNodeRangeIndexThreshold, declaredMask, inferredMask, sink, source

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

associatedTerminals, associations, hashcode, id, memoryId, partitionId, partitionsEnabled, posInSegment

Constructor Summary

Constructors

Constructor	Description
ObjectTypeNode()
ObjectTypeNode(int id, EntryPointNode source, ObjectType objectType, BuildContext context)	Construct given a semantic ObjectType and the provided unique id.

Method Summary

Modifier and Type	Method	Description
void	assertInitialFact(InternalFactHandle factHandle, PropagationContext context, ReteEvaluator reteEvaluator)
void	assertObject(InternalFactHandle factHandle, PropagationContext context, ReteEvaluator reteEvaluator)	Propagate the FactHandleimpl through the Rete network.
void	byPassModifyToBetaNode(InternalFactHandle factHandle, ModifyPreviousTuples modifyPreviousTuples, PropagationContext context, ReteEvaluator reteEvaluator)
BitMask	calculateDeclaredMask(ObjectType modifiedType, List<String> settableProperties)
protected void	checkDirty()
ObjectTypeNode.ObjectTypeNodeMemory	createMemory(RuleBaseConfiguration config, ReteEvaluator reteEvaluator)	Creates memory for the node using PrimitiveLongMap as its optimised for storage and reteivals of Longs.
void	doAttach(BuildContext context)	Rete needs to know that this ObjectTypeNode has been added
protected boolean	doRemove(RuleRemovalContext context, ReteooBuilder builder)	OTN needs to override remove to avoid releasing the node ID, since OTN are never removed from the rulebase in the current implementation
static void	doRetractObject(InternalFactHandle factHandle, PropagationContext context, ReteEvaluator reteEvaluator)
boolean	equals(Object object)
static void	expireLeftTuple(LeftTuple leftTuple)
static void	expireRightTuple(RightTuple rightTuple)
EntryPointId	getEntryPoint()
long	getExpirationOffset()
ObjectType	getObjectType()	Retrieve the semantic ObjectType differentiator.
int	getOtnIdCounter()
RuleBasePartitionId	getPartitionId()	Returns the partition ID for which this node belongs to
short	getType()
boolean	isAssignableFrom(ObjectType objectType)
boolean	isObjectMemoryEnabled()
void	mergeExpirationOffset(ObjectTypeNode other)
void	modifyObject(InternalFactHandle factHandle, ModifyPreviousTuples modifyPreviousTuples, PropagationContext context, ReteEvaluator reteEvaluator)
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
ObjectTypeNode.Id	nextOtnId()
void	propagateAssert(InternalFactHandle factHandle, PropagationContext context, ReteEvaluator reteEvaluator)
boolean	remove(RuleRemovalContext context, ReteooBuilder builder)	OTN needs to override remove to avoid releasing the node ID, since OTN are never removed from the rulebase in the current implementation
protected void	resetIdGenerator()
static void	retractLeftTuples(InternalFactHandle factHandle, PropagationContext context, ReteEvaluator reteEvaluator)
static void	retractLeftTuples(InternalFactHandle factHandle, PropagationContext context, ReteEvaluator reteEvaluator, int partition)
void	retractObject(InternalFactHandle factHandle, PropagationContext context, ReteEvaluator reteEvaluator)	Retract the FactHandleimpl from the Rete network.
void	retractObject(InternalFactHandle factHandle, PropagationContext context, ReteEvaluator reteEvaluator, int partition)
static void	retractRightTuples(InternalFactHandle factHandle, PropagationContext context, ReteEvaluator reteEvaluator)
static void	retractRightTuples(InternalFactHandle factHandle, PropagationContext context, ReteEvaluator reteEvaluator, int partition)
void	setExpirationOffset(long expirationOffset)
void	setObjectMemoryEnabled(boolean objectMemoryEnabled)
String	toString()
void	updateSink(ObjectSink sink, PropagationContext context, InternalWorkingMemory workingMemory)
protected static void	updateTupleSinkId(ObjectTypeNode otn, ObjectSource source)

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

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

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

addAssociation, addAssociation, attach, getAssociatedRules, getAssociatedTerminals, getAssociationsSize, getId, getMemoryId, getPosInSegment, getSinks, hashCode, initMemoryId, isAssociatedWith, isStreamMode, removeAssociation, setId, setPartitionsEnabled, setPosInSegment, setStreamMode

Methods inherited from class java.lang.Object

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

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

getMemoryId

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

getAssociatedRules, getAssociatedTerminals, getId, getPosInSegment, getSinks, isAssociatedWith

Field Detail

objectType

protected ObjectType objectType

The ObjectType semantic module.

idGenerator

protected transient org.drools.core.reteoo.ObjectTypeNode.IdGenerator idGenerator

DEFAULT_ID

public static final ObjectTypeNode.Id DEFAULT_ID

Constructor Detail

ObjectTypeNode

public ObjectTypeNode()

ObjectTypeNode

public ObjectTypeNode(int id,
                      EntryPointNode source,
                      ObjectType objectType,
                      BuildContext context)

Construct given a semantic ObjectType and the provided unique id. All ObjectTypdeNode have node memory.

Parameters:

id - The unique id for the node.

objectType - The semantic object-type differentiator.

Method Detail

getOtnIdCounter

public int getOtnIdCounter()

getType

public short getType()

Specified by:

getType in interface NetworkNode

getObjectType

public ObjectType getObjectType()

Retrieve the semantic ObjectType differentiator.

Returns:

The semantic ObjectType differentiator.

getPartitionId

public RuleBasePartitionId getPartitionId()

Returns the partition ID for which this node belongs to

Specified by:

getPartitionId in interface NetworkNode

Overrides:

getPartitionId in class BaseNode

calculateDeclaredMask

public BitMask calculateDeclaredMask(ObjectType modifiedType,
                                     List<String> settableProperties)

Specified by:

calculateDeclaredMask in class ObjectSource

isAssignableFrom

public boolean isAssignableFrom(ObjectType objectType)

assertInitialFact

public void assertInitialFact(InternalFactHandle factHandle,
                              PropagationContext context,
                              ReteEvaluator reteEvaluator)

checkDirty

protected void checkDirty()

assertObject

public void assertObject(InternalFactHandle factHandle,
                         PropagationContext context,
                         ReteEvaluator reteEvaluator)

Propagate the FactHandleimpl through the Rete network. All FactHandleImpl should be remembered in the node memory, so that later runtime rule attachmnents can have the matched facts propagated to them.

Specified by:

assertObject in interface ObjectSink

Parameters:

factHandle - The fact handle.

context - The propagation context.

reteEvaluator - The working memory session.

propagateAssert

public void propagateAssert(InternalFactHandle factHandle,
                            PropagationContext context,
                            ReteEvaluator reteEvaluator)

retractObject

public void retractObject(InternalFactHandle factHandle,
                          PropagationContext context,
                          ReteEvaluator reteEvaluator)

Retract the FactHandleimpl from the Rete network. Also remove the FactHandleImpl from the node memory.

Parameters:

factHandle - The fact handle.

context - The propagation context.

reteEvaluator - The working memory session.

retractObject

public void retractObject(InternalFactHandle factHandle,
                          PropagationContext context,
                          ReteEvaluator reteEvaluator,
                          int partition)

doRetractObject

public static void doRetractObject(InternalFactHandle factHandle,
                                   PropagationContext context,
                                   ReteEvaluator reteEvaluator)

expireLeftTuple

public static void expireLeftTuple(LeftTuple leftTuple)

expireRightTuple

public static void expireRightTuple(RightTuple rightTuple)

retractLeftTuples

public static void retractLeftTuples(InternalFactHandle factHandle,
                                     PropagationContext context,
                                     ReteEvaluator reteEvaluator)

retractLeftTuples

public static void retractLeftTuples(InternalFactHandle factHandle,
                                     PropagationContext context,
                                     ReteEvaluator reteEvaluator,
                                     int partition)

retractRightTuples

public static void retractRightTuples(InternalFactHandle factHandle,
                                      PropagationContext context,
                                      ReteEvaluator reteEvaluator)

retractRightTuples

public static void retractRightTuples(InternalFactHandle factHandle,
                                      PropagationContext context,
                                      ReteEvaluator reteEvaluator,
                                      int partition)

resetIdGenerator

protected void resetIdGenerator()

modifyObject

public void modifyObject(InternalFactHandle factHandle,
                         ModifyPreviousTuples modifyPreviousTuples,
                         PropagationContext context,
                         ReteEvaluator reteEvaluator)

Specified by:

modifyObject in interface ObjectSink

updateSink

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

Specified by:

updateSink in class ObjectSource

doAttach

public void doAttach(BuildContext context)

Rete needs to know that this ObjectTypeNode has been added

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

updateTupleSinkId

protected static void updateTupleSinkId(ObjectTypeNode otn,
                                        ObjectSource source)

nextOtnId

public ObjectTypeNode.Id nextOtnId()

remove

public boolean remove(RuleRemovalContext context,
                      ReteooBuilder builder)

OTN needs to override remove to avoid releasing the node ID, since OTN are never removed from the rulebase in the current implementation

Overrides:

remove in class BaseNode

doRemove

protected boolean doRemove(RuleRemovalContext context,
                           ReteooBuilder builder)

OTN needs to override remove to avoid releasing the node ID, since OTN are never removed from the rulebase in the current implementation

Overrides:

doRemove in class ObjectSource

createMemory

public ObjectTypeNode.ObjectTypeNodeMemory createMemory(RuleBaseConfiguration config,
                                                        ReteEvaluator reteEvaluator)

Creates memory for the node using PrimitiveLongMap as its optimised for storage and reteivals of Longs. However PrimitiveLongMap is not ideal for spase data. So it should be monitored incase its more optimal to switch back to a standard HashMap.

Specified by:

createMemory in interface MemoryFactory<ObjectTypeNode.ObjectTypeNodeMemory>

isObjectMemoryEnabled

public boolean isObjectMemoryEnabled()

setObjectMemoryEnabled

public void setObjectMemoryEnabled(boolean objectMemoryEnabled)

toString

public String toString()

Overrides:

toString in class BaseNode

equals

public boolean equals(Object object)

Overrides:

equals in class Object

getEntryPoint

public EntryPointId getEntryPoint()

Returns:

the entryPoint

getExpirationOffset

public long getExpirationOffset()

setExpirationOffset

public void setExpirationOffset(long expirationOffset)

mergeExpirationOffset

public void mergeExpirationOffset(ObjectTypeNode other)

byPassModifyToBetaNode

public void byPassModifyToBetaNode(InternalFactHandle factHandle,
                                   ModifyPreviousTuples modifyPreviousTuples,
                                   PropagationContext context,
                                   ReteEvaluator reteEvaluator)

Specified by:

byPassModifyToBetaNode in interface ObjectSink