Package org.drools.core.reteoo

Class RuleTerminalNodeLeftTuple

java.lang.Object

org.drools.core.reteoo.BaseTuple

org.drools.core.reteoo.BaseLeftTuple

org.drools.core.reteoo.RuleTerminalNodeLeftTuple

All Implemented Interfaces:

Serializable, AgendaItem, LeftTuple, Tuple, Activation, Entry<Tuple>, org.kie.api.runtime.rule.Match

public class RuleTerminalNodeLeftTuple
extends BaseLeftTuple
implements AgendaItem

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected RuleAgendaItem	ruleAgendaItem

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

memory

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

handle, handleNext, handlePrevious, sink, stagedNext, stagedPrevious

Fields inherited from interface org.drools.core.reteoo.Tuple

DELETE, INSERT, NONE, NORMALIZED_DELETE, UPDATE

Constructor Summary

Constructors

Constructor	Description
RuleTerminalNodeLeftTuple()
RuleTerminalNodeLeftTuple(InternalFactHandle factHandle, LeftTuple leftTuple, Sink sink)
RuleTerminalNodeLeftTuple(InternalFactHandle factHandle, Sink sink, boolean leftTupleMemoryEnabled)
RuleTerminalNodeLeftTuple(LeftTuple leftTuple, RightTuple rightTuple, LeftTuple currentLeftChild, LeftTuple currentRightChild, Sink sink, boolean leftTupleMemoryEnabled)
RuleTerminalNodeLeftTuple(LeftTuple leftTuple, RightTuple rightTuple, Sink sink)
RuleTerminalNodeLeftTuple(LeftTuple leftTuple, Sink sink, PropagationContext pctx, boolean leftTupleMemoryEnabled)

Method Summary

Modifier and Type	Method	Description
void	cancel()
void	cancelActivation(ActivationsManager activationsManager)
void	dequeue()
boolean	equals(Object o)
InternalFactHandle	getActivationFactHandle()
ActivationGroupNode	getActivationGroupNode()
ActivationNode	getActivationNode()
long	getActivationNumber()	Each PropgationContext is assigned an id from a counter for the WorkingMemory action it represents.
InternalAgendaGroup	getAgendaGroup()
Runnable	getCallback()
Consequence	getConsequence()
List<String>	getDeclarationIds()
Object	getDeclarationValue(String variableName)
List<org.kie.api.runtime.rule.FactHandle>	getFactHandles()
List<Object>	getObjects()
List<Object>	getObjectsDeep()
int	getQueueIndex()
RuleImpl	getRule()	Retrieve the rule.
RuleAgendaItem	getRuleAgendaItem()
int	getSalience()
GroupElement	getSubRule()	Retrieve the subrule that was activated.
TerminalNode	getTerminalNode()
LeftTuple	getTuple()	Retrieve the tuple.
boolean	hasBlockers()
int	hashCode()
void	init(long activationNumber, int salience, PropagationContext pctx, RuleAgendaItem ruleAgendaItem, InternalAgendaGroup agendaGroup)
boolean	isActive()
boolean	isCanceled()
boolean	isMatched()
boolean	isQueued()
boolean	isRuleAgendaItem()
void	remove()	Cancel the Activation by removing it from the Agenda.
void	setActivationFactHandle(InternalFactHandle factHandle)
void	setActivationGroupNode(ActivationGroupNode activationNode)
void	setActivationNode(ActivationNode activationNode)
void	setActive(boolean active)
void	setCallback(Runnable callback)
void	setMatched(boolean matched)
void	setQueued(boolean queued)
void	setQueueIndex(int queueIndex)
void	setSalience(int salience)
String	toExternalForm()
String	toString()
void	update(int salience, PropagationContext pctx)

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

clear, clearBlocker, clearStaged, get, getBlockedNext, getBlockedPrevious, getBlocker, getFirstChild, getHandleNext, getHandlePrevious, getIndex, getInputOtnId, getLastChild, getLeftParent, getMemory, getNextParentWithHandle, getObject, getParent, getPeer, getRightParent, getRightParentNext, getRightParentPrevious, getStagedNext, getStagedPrevious, getStagedTypeForQueries, getSubTuple, getTupleSink, getTupleSource, initPeer, isStagedOnRight, reAdd, reAddLeft, reAddRight, setBlockedNext, setBlockedPrevious, setBlocker, setFirstChild, setLastChild, setLeftParent, setLeftTupleSink, setMemory, setPeer, setRightParent, setRightParentNext, setRightParentPrevious, setStagedTypeForQueries, size, toExternalString, toFactHandles, toObjects, unlinkFromLeftParent, unlinkFromRightParent

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

decreaseActivationCountForEvents, get, getContextObject, getFactHandle, getNext, getObject, getOriginalFactHandle, getPrevious, getPropagationContext, getRootTuple, getStagedType, getTuple, increaseActivationCountForEvents, isExpired, setContextObject, setExpired, setFactHandle, setHandleNext, setHandlePrevious, setNext, setPrevious, setPropagationContext, setStagedNext, setStagedPrevious, setStagedType, skipEmptyHandles

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.drools.core.rule.consequence.Activation

getPropagationContext

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

getFactHandles, getObjects, getObjectsDeep

Methods inherited from interface org.drools.core.util.Entry

getNext, setNext

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

getAccumulatedObjects, setExpired

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

decreaseActivationCountForEvents, findMostRecentPropagationContext, get, getContextObject, getFactHandle, getObject, getOriginalFactHandle, getPrevious, getPropagationContext, getRootTuple, getStagedType, getTuple, increaseActivationCountForEvents, isDeleted, isExpired, setContextObject, setFactHandle, setHandleNext, setHandlePrevious, setPrevious, setPropagationContext, setStagedNext, setStagedPrevious, setStagedType, skipEmptyHandles, toObjects

Field Detail

ruleAgendaItem

protected RuleAgendaItem ruleAgendaItem

Constructor Detail

RuleTerminalNodeLeftTuple

public RuleTerminalNodeLeftTuple()

RuleTerminalNodeLeftTuple

public RuleTerminalNodeLeftTuple(InternalFactHandle factHandle,
                                 Sink sink,
                                 boolean leftTupleMemoryEnabled)

RuleTerminalNodeLeftTuple

public RuleTerminalNodeLeftTuple(InternalFactHandle factHandle,
                                 LeftTuple leftTuple,
                                 Sink sink)

RuleTerminalNodeLeftTuple

public RuleTerminalNodeLeftTuple(LeftTuple leftTuple,
                                 Sink sink,
                                 PropagationContext pctx,
                                 boolean leftTupleMemoryEnabled)

RuleTerminalNodeLeftTuple

public RuleTerminalNodeLeftTuple(LeftTuple leftTuple,
                                 RightTuple rightTuple,
                                 Sink sink)

RuleTerminalNodeLeftTuple

public RuleTerminalNodeLeftTuple(LeftTuple leftTuple,
                                 RightTuple rightTuple,
                                 LeftTuple currentLeftChild,
                                 LeftTuple currentRightChild,
                                 Sink sink,
                                 boolean leftTupleMemoryEnabled)

Method Detail

init

public void init(long activationNumber,
                 int salience,
                 PropagationContext pctx,
                 RuleAgendaItem ruleAgendaItem,
                 InternalAgendaGroup agendaGroup)

update

public void update(int salience,
                   PropagationContext pctx)

getRule

public RuleImpl getRule()

Retrieve the rule.

Specified by:

getRule in interface Activation

Specified by:

getRule in interface org.kie.api.runtime.rule.Match

Returns:

The rule.

getConsequence

public Consequence getConsequence()

Specified by:

getConsequence in interface Activation

getTuple

public LeftTuple getTuple()

Retrieve the tuple.

Specified by:

getTuple in interface Activation

Returns:

The tuple.

getSalience

public int getSalience()

Specified by:

getSalience in interface Activation

setSalience

public void setSalience(int salience)

Specified by:

setSalience in interface AgendaItem

getActivationFactHandle

public InternalFactHandle getActivationFactHandle()

Specified by:

getActivationFactHandle in interface Activation

setActivationFactHandle

public void setActivationFactHandle(InternalFactHandle factHandle)

Specified by:

setActivationFactHandle in interface AgendaItem

getRuleAgendaItem

public RuleAgendaItem getRuleAgendaItem()

Specified by:

getRuleAgendaItem in interface AgendaItem

getActivationNumber

public long getActivationNumber()

Description copied from interface: Activation

Each PropgationContext is assigned an id from a counter for the WorkingMemory action it represents. All Activations return this id as the ActivationNumber, thus all Activations created from the same PropgationContext will return the same long for this method.

Specified by:

getActivationNumber in interface Activation

Returns:

The activation number

isQueued

public boolean isQueued()

Specified by:

isQueued in interface Activation

setQueued

public void setQueued(boolean queued)

Specified by:

setQueued in interface Activation

setQueueIndex

public void setQueueIndex(int queueIndex)

Specified by:

setQueueIndex in interface Activation

dequeue

public void dequeue()

Specified by:

dequeue in interface Activation

getQueueIndex

public int getQueueIndex()

Specified by:

getQueueIndex in interface Activation

remove

public void remove()

Description copied from interface: Activation

Cancel the Activation by removing it from the Agenda.

Specified by:

remove in interface Activation

getActivationGroupNode

public ActivationGroupNode getActivationGroupNode()

Specified by:

getActivationGroupNode in interface Activation

setActivationGroupNode

public void setActivationGroupNode(ActivationGroupNode activationNode)

Specified by:

setActivationGroupNode in interface Activation

getAgendaGroup

public InternalAgendaGroup getAgendaGroup()

Specified by:

getAgendaGroup in interface Activation

getActivationNode

public ActivationNode getActivationNode()

Specified by:

getActivationNode in interface Activation

setActivationNode

public void setActivationNode(ActivationNode activationNode)

Specified by:

setActivationNode in interface Activation

getSubRule

public GroupElement getSubRule()

Description copied from interface: Activation

Retrieve the subrule that was activated.

Specified by:

getSubRule in interface Activation

Returns:

getTerminalNode

public TerminalNode getTerminalNode()

Specified by:

getTerminalNode in interface AgendaItem

getFactHandles

public List<org.kie.api.runtime.rule.FactHandle> getFactHandles()

Specified by:

getFactHandles in interface AgendaItem

Specified by:

getFactHandles in interface org.kie.api.runtime.rule.Match

toExternalForm

public String toExternalForm()

Specified by:

toExternalForm in interface AgendaItem

getObjects

public List<Object> getObjects()

Specified by:

getObjects in interface org.kie.api.runtime.rule.Match

getObjectsDeep

public List<Object> getObjectsDeep()

Specified by:

getObjectsDeep in interface Activation

getDeclarationValue

public Object getDeclarationValue(String variableName)

Specified by:

getDeclarationValue in interface org.kie.api.runtime.rule.Match

getDeclarationIds

public List<String> getDeclarationIds()

Specified by:

getDeclarationIds in interface org.kie.api.runtime.rule.Match

isCanceled

public boolean isCanceled()

Specified by:

isCanceled in interface AgendaItem

cancel

public void cancel()

Specified by:

cancel in interface AgendaItem

isMatched

public boolean isMatched()

Specified by:

isMatched in interface Activation

setMatched

public void setMatched(boolean matched)

Specified by:

setMatched in interface Activation

isActive

public boolean isActive()

Specified by:

isActive in interface Activation

setActive

public void setActive(boolean active)

Specified by:

setActive in interface Activation

isRuleAgendaItem

public boolean isRuleAgendaItem()

Specified by:

isRuleAgendaItem in interface Activation

hasBlockers

public boolean hasBlockers()

getCallback

public Runnable getCallback()

Specified by:

getCallback in interface AgendaItem

setCallback

public void setCallback(Runnable callback)

Specified by:

setCallback in interface AgendaItem

toString

public String toString()

Overrides:

toString in class BaseLeftTuple

cancelActivation

public void cancelActivation(ActivationsManager activationsManager)

equals

public boolean equals(Object o)

Overrides:

equals in class BaseLeftTuple

hashCode

public int hashCode()

Overrides:

hashCode in class BaseLeftTuple