org.drools.core.reteoo

Class AbstractTerminalNode

java.lang.Object

org.drools.core.common.BaseNode

org.drools.core.reteoo.AbstractTerminalNode

All Implemented Interfaces:

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

Direct Known Subclasses:

QueryTerminalNode, RuleTerminalNode

public abstract class AbstractTerminalNode
extends BaseNode
implements TerminalNode, PathEndNode, Externalizable

See Also:

Serialized Form

Field Summary

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

associations, hashcode, id, partitionId, partitionsEnabled

Constructor Summary

Constructors

Constructor and Description
AbstractTerminalNode()
AbstractTerminalNode(int id, RuleBasePartitionId partitionId, boolean partitionsEnabled, LeftTupleSource source, BuildContext context)

Method Summary

Modifier and Type	Method and Description
PathMemory	createMemory(RuleBaseConfiguration config, InternalWorkingMemory wm)
LeftTuple	createPeer(LeftTuple original)
protected boolean	doRemove(RuleRemovalContext context, ReteooBuilder builder, InternalWorkingMemory[] workingMemories) Removes the node from teh network.
BitMask	getDeclaredMask()
BitMask	getInferredMask()
BitMask	getLeftInferredMask()
LeftTupleSource	getLeftTupleSource()
BitMask	getNegativeMask()
PathEndNode[]	getPathEndNodes()
LeftTupleNode[]	getPathNodes()
static LeftTupleNode[]	getPathNodes(PathEndNode endNode)
int	getPositionInPath()
abstract RuleImpl	getRule()
LeftTupleSinkPropagator	getSinkPropagator()
boolean	hasPathNode(LeftTupleNode node)
void	initDeclaredMask(BuildContext context)
void	initInferredMask()
static void	initPathMemory(PathMemory pmem, LeftTupleSource startTupleSource, InternalWorkingMemory wm, TerminalNode removingTN) Creates and return the node memory
boolean	isInUse() Returns true in case the current node is in use (is referenced by any other node)
boolean	isLeftTupleMemoryEnabled()
boolean	isTerminalNodeOf(LeftTupleNode node)
void	modifyLeftTuple(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 oportunity for state update
void	readExternal(ObjectInput in)
void	setDeclaredMask(BitMask mask)
void	setInferredMask(BitMask mask)
void	setLeftTupleMemoryEnabled(boolean tupleMemoryEnabled)
void	setNegativeMask(BitMask mask)
void	setPathEndNodes(PathEndNode[] pathEndNodes)
LeftTupleSource	unwrapTupleSource()
void	writeExternal(ObjectOutput out)

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.drools.core.reteoo.TerminalNode

getAllDeclarations, getRequiredDeclarations, getSalienceDeclarations, getSubRule, getTimerDeclarations, isFireDirect

Methods inherited from interface org.drools.core.reteoo.LeftTupleSinkNode

getNextLeftTupleSinkNode, getPreviousLeftTupleSinkNode, setNextLeftTupleSinkNode, setPreviousLeftTupleSinkNode

Methods inherited from interface org.drools.core.reteoo.LeftTupleSink

assertLeftTuple, createLeftTuple, createLeftTuple, createLeftTuple, createLeftTuple, createLeftTuple, getLeftInputOtnId, modifyLeftTuple, retractLeftTuple, setLeftInputOtnId

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

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

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

getId

Constructor Detail

AbstractTerminalNode

public AbstractTerminalNode()

AbstractTerminalNode

public AbstractTerminalNode(int id,
                            RuleBasePartitionId partitionId,
                            boolean partitionsEnabled,
                            LeftTupleSource source,
                            BuildContext context)

Method Detail

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

setPathEndNodes

public void setPathEndNodes(PathEndNode[] pathEndNodes)

Specified by:

setPathEndNodes in interface PathEndNode

getPathEndNodes

public PathEndNode[] getPathEndNodes()

Specified by:

getPathEndNodes in interface PathEndNode

getPositionInPath

public int getPositionInPath()

Specified by:

getPositionInPath in interface LeftTupleNode

initDeclaredMask

public void initDeclaredMask(BuildContext context)

initInferredMask

public void initInferredMask()

Specified by:

initInferredMask in interface TerminalNode

unwrapTupleSource

public LeftTupleSource unwrapTupleSource()

Specified by:

unwrapTupleSource in interface TerminalNode

modifyLeftTuple

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

Specified by:

modifyLeftTuple in interface LeftTupleSink

getRule

public abstract RuleImpl getRule()

Specified by:

getRule in interface TerminalNode

createMemory

public PathMemory createMemory(RuleBaseConfiguration config,
                               InternalWorkingMemory wm)

Specified by:

createMemory in interface MemoryFactory<PathMemory>

initPathMemory

public static void initPathMemory(PathMemory pmem,
                                  LeftTupleSource startTupleSource,
                                  InternalWorkingMemory wm,
                                  TerminalNode removingTN)

Creates and return the node memory

createPeer

public LeftTuple createPeer(LeftTuple original)

Specified by:

createPeer in interface LeftTupleSink

doRemove

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

getLeftTupleSource

public LeftTupleSource getLeftTupleSource()

Specified by:

getLeftTupleSource in interface LeftTupleNode

Specified by:

getLeftTupleSource in interface TerminalNode

getDeclaredMask

public BitMask getDeclaredMask()

Specified by:

getDeclaredMask in interface TerminalNode

getInferredMask

public BitMask getInferredMask()

Specified by:

getInferredMask in interface TerminalNode

getLeftInferredMask

public BitMask getLeftInferredMask()

Specified by:

getLeftInferredMask in interface LeftTupleSink

setDeclaredMask

public void setDeclaredMask(BitMask mask)

Specified by:

setDeclaredMask in interface TerminalNode

setInferredMask

public void setInferredMask(BitMask mask)

Specified by:

setInferredMask in interface TerminalNode

getNegativeMask

public BitMask getNegativeMask()

Specified by:

getNegativeMask in interface TerminalNode

setNegativeMask

public void setNegativeMask(BitMask mask)

Specified by:

setNegativeMask in interface TerminalNode

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

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

isLeftTupleMemoryEnabled

public boolean isLeftTupleMemoryEnabled()

Specified by:

isLeftTupleMemoryEnabled in interface LeftTupleSink

setLeftTupleMemoryEnabled

public void setLeftTupleMemoryEnabled(boolean tupleMemoryEnabled)

Specified by:

setLeftTupleMemoryEnabled in interface LeftTupleSink

getPathNodes

public static LeftTupleNode[] getPathNodes(PathEndNode endNode)

getPathNodes

public LeftTupleNode[] getPathNodes()

Specified by:

getPathNodes in interface PathEndNode

hasPathNode

public final boolean hasPathNode(LeftTupleNode node)

Specified by:

hasPathNode in interface PathEndNode

isTerminalNodeOf

public final boolean isTerminalNodeOf(LeftTupleNode node)

Specified by:

isTerminalNodeOf in interface TerminalNode

getSinkPropagator

public LeftTupleSinkPropagator getSinkPropagator()

Specified by:

getSinkPropagator in interface LeftTupleNode