org.drools.core.reteoo

Class AlphaNode

java.lang.Object

org.drools.core.common.BaseNode

org.drools.core.reteoo.ObjectSource

org.drools.core.reteoo.AlphaNode

All Implemented Interfaces:

Externalizable, Serializable, MemoryFactory<AlphaNode.AlphaMemory>, NetworkNode, ObjectSink, ObjectSinkNode, Sink

public class AlphaNode
extends ObjectSource
implements ObjectSinkNode, MemoryFactory<AlphaNode.AlphaMemory>

AlphaNodes are nodes in the Rete network used to apply FieldConstraint<.code>s on asserted fact objects where the FieldConstraints have no dependencies on any other of the facts in the current Rule.

See Also:

AlphaNodeFieldConstraint, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AlphaNode.AlphaMemory

Field Summary

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

declaredMask, inferredMask, sink, source

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

associations, id, partitionId, partitionsEnabled

Constructor Summary

Constructors

Constructor and Description
AlphaNode()
AlphaNode(int id, AlphaNodeFieldConstraint constraint, ObjectSource objectSource, BuildContext context) Construct an AlphaNode with a unique id using the provided FieldConstraint and the given ObjectSource.

Method Summary

Methods

Modifier and Type	Method and Description
void	addObjectSink(ObjectSink objectSink) Adds the ObjectSink so that it may receive FactHandleImpl propagated from this ObjectSource.
void	assertObject(InternalFactHandle factHandle, PropagationContext context, InternalWorkingMemory workingMemory)
void	attach(BuildContext context) Attaches the node into the network.
void	byPassModifyToBetaNode(InternalFactHandle factHandle, ModifyPreviousTuples modifyPreviousTuples, PropagationContext context, InternalWorkingMemory workingMemory)
BitMask	calculateDeclaredMask(List<String> settableProperties)
int	calculateHashCode()
AlphaNode.AlphaMemory	createMemory(RuleBaseConfiguration config, InternalWorkingMemory wm) Creates a HashSet for the AlphaNode's memory.
boolean	equals(Object object)
AlphaNodeFieldConstraint	getConstraint() Retruns the FieldConstraint
BitMask	getDeclaredMask()
BitMask	getInferredMask()
ObjectSinkNode	getNextObjectSinkNode() Returns the next node
ObjectSinkNode	getPreviousObjectSinkNode() Returns the previous node
short	getType()
int	hashCode() The hashCode return is simply the unique id of the node.
void	modifyObject(InternalFactHandle factHandle, ModifyPreviousTuples modifyPreviousTuples, PropagationContext context, InternalWorkingMemory workingMemory)
void	readExternal(ObjectInput in)
void	setNextObjectSinkNode(ObjectSinkNode next) Sets the next node
void	setPreviousObjectSinkNode(ObjectSinkNode previous) Sets the previous node
String	toString()
void	updateSink(ObjectSink sink, PropagationContext context, InternalWorkingMemory workingMemory)
void	writeExternal(ObjectOutput out)

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

doRemove, getKnowledgeBase, getObjectTypeNode, getParentObjectSource, getSinkPropagator, initDeclaredMask, isInUse, networkUpdated, removeObjectSink, resetInferredMask, updateMask

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

addAssociation, attach, getAssociations, getId, getPartitionId, isStreamMode, remove, removeAssociation, setId, setPartitionId, setStreamMode

Methods inherited from class java.lang.Object

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

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

getAssociations, getId, getPartitionId

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

getId

Constructor Detail

AlphaNode

public AlphaNode()

AlphaNode

public AlphaNode(int id,
         AlphaNodeFieldConstraint constraint,
         ObjectSource objectSource,
         BuildContext context)

Construct an AlphaNode with a unique id using the provided FieldConstraint and the given ObjectSource. Set the boolean flag to true if the node is supposed to have local memory, or false otherwise. Memory is optional for AlphaNodes and is only of benefic when adding additional Rules at runtime.

Parameters:

id - Node's ID

constraint - Node's constraints

objectSource - Node's object source

Method Detail

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class ObjectSource

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class ObjectSource

Throws:

IOException

getConstraint

public AlphaNodeFieldConstraint getConstraint()

Retruns the FieldConstraint

Returns:

FieldConstraint

getType

public short getType()

Specified by:

getType in interface NetworkNode

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

assertObject

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

Specified by:

assertObject in interface ObjectSink

modifyObject

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

Specified by:

modifyObject in interface ObjectSink

byPassModifyToBetaNode

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

Specified by:

byPassModifyToBetaNode in interface ObjectSink

updateSink

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

Specified by:

updateSink in class ObjectSource

createMemory

public AlphaNode.AlphaMemory createMemory(RuleBaseConfiguration config,
                                 InternalWorkingMemory wm)

Creates a HashSet for the AlphaNode's memory.

Specified by:

createMemory in interface MemoryFactory<AlphaNode.AlphaMemory>

toString

public String toString()

Overrides:

toString in class BaseNode

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

calculateHashCode

public int calculateHashCode()

equals

public boolean equals(Object object)

Overrides:

equals in class Object

getNextObjectSinkNode

public ObjectSinkNode getNextObjectSinkNode()

Returns the next node

Specified by:

getNextObjectSinkNode in interface ObjectSinkNode

Returns:

The next ObjectSinkNode

setNextObjectSinkNode

public void setNextObjectSinkNode(ObjectSinkNode next)

Sets the next node

Specified by:

setNextObjectSinkNode in interface ObjectSinkNode

Parameters:

next - The next ObjectSinkNode

getPreviousObjectSinkNode

public ObjectSinkNode getPreviousObjectSinkNode()

Returns the previous node

Specified by:

getPreviousObjectSinkNode in interface ObjectSinkNode

Returns:

The previous ObjectSinkNode

setPreviousObjectSinkNode

public void setPreviousObjectSinkNode(ObjectSinkNode previous)

Sets the previous node

Specified by:

setPreviousObjectSinkNode in interface ObjectSinkNode

Parameters:

previous - The previous ObjectSinkNode

calculateDeclaredMask

public BitMask calculateDeclaredMask(List<String> settableProperties)

Specified by:

calculateDeclaredMask in class ObjectSource

getDeclaredMask

public BitMask getDeclaredMask()

Overrides:

getDeclaredMask in class ObjectSource

getInferredMask

public BitMask getInferredMask()

addObjectSink

public void addObjectSink(ObjectSink objectSink)

Description copied from class: ObjectSource

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

Overrides:

addObjectSink in class ObjectSource

Parameters:

objectSink - The ObjectSink to receive propagated FactHandleImpl.