Package org.drools.core.phreak

Class RuleAgendaItem

java.lang.Object

org.drools.core.phreak.RuleAgendaItem

All Implemented Interfaces:

java.io.Serializable, AgendaItem, Activation, Entry<RuleAgendaItem>, LinkedListNode<RuleAgendaItem>, Queue.QueueEntry, org.kie.api.runtime.rule.Match

public class RuleAgendaItem
extends java.lang.Object
implements LinkedListNode<RuleAgendaItem>, AgendaItem

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
RuleAgendaItem()
RuleAgendaItem(long activationNumber, Tuple tuple, int salience, PropagationContext context, PathMemory pmem, TerminalNode rtn, boolean declarativeAgendaEnabled, InternalAgendaGroup agendaGroup)

Method Summary

Modifier and Type	Method	Description
void	cancel()
void	dequeue()
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()
java.lang.Runnable	getCallback()
Consequence	getConsequence()
java.util.List<java.lang.String>	getDeclarationIds()
java.lang.Object	getDeclarationValue(java.lang.String variableName)
java.util.List<org.kie.api.runtime.rule.FactHandle>	getFactHandles()
RuleAgendaItem	getNext()
java.util.List<java.lang.Object>	getObjects()
java.util.List<java.lang.Object>	getObjectsDeep()
RuleBasePartitionId	getPartition()
RuleAgendaItem	getPrevious()	Returns the previous node
PropagationContext	getPropagationContext()	Retrieve the PropagationContext for the Activation
RuleImpl	getRule()	Retrieve the rule.
RuleAgendaItem	getRuleAgendaItem()
RuleExecutor	getRuleExecutor()
int	getSalience()
GroupElement	getSubRule()	Retrieve the subrule that was activated.
TerminalNode	getTerminalNode()
Tuple	getTuple()	Retrieve the tuple.
boolean	isActive()
boolean	isCanceled()
boolean	isInList(LinkedList<RuleAgendaItem> list)
boolean	isMatched()
boolean	isQueued()
boolean	isRuleAgendaItem()
boolean	isRuleInUse()
void	nullPrevNext()
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(java.lang.Runnable callback)
void	setMatched(boolean matched)
void	setNext(RuleAgendaItem next)
void	setPrevious(RuleAgendaItem previous)	Sets the previous node
void	setQueued(boolean queued)
void	setSalience(int salience)
java.lang.String	toExternalForm()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

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

getFactHandles, getObjects, getObjectsDeep

Constructor Detail

RuleAgendaItem

public RuleAgendaItem()

RuleAgendaItem

public RuleAgendaItem(long activationNumber,
                      Tuple tuple,
                      int salience,
                      PropagationContext context,
                      PathMemory pmem,
                      TerminalNode rtn,
                      boolean declarativeAgendaEnabled,
                      InternalAgendaGroup agendaGroup)

Method Detail

getRuleExecutor

public RuleExecutor getRuleExecutor()

isRuleAgendaItem

public boolean isRuleAgendaItem()

Specified by:

isRuleAgendaItem in interface Activation

getPrevious

public RuleAgendaItem getPrevious()

Description copied from interface: LinkedListNode

Returns the previous node

Specified by:

getPrevious in interface LinkedListNode<RuleAgendaItem>

Returns:

The previous LinkedListNode

setPrevious

public void setPrevious(RuleAgendaItem previous)

Description copied from interface: LinkedListNode

Sets the previous node

Specified by:

setPrevious in interface LinkedListNode<RuleAgendaItem>

Parameters:

previous - The previous LinkedListNode

getNext

public RuleAgendaItem getNext()

Specified by:

getNext in interface Entry<RuleAgendaItem>

setNext

public void setNext(RuleAgendaItem next)

Specified by:

setNext in interface Entry<RuleAgendaItem>

isInList

public boolean isInList(LinkedList<RuleAgendaItem> list)

nullPrevNext

public void nullPrevNext()

Specified by:

nullPrevNext in interface LinkedListNode<RuleAgendaItem>

getPropagationContext

public PropagationContext getPropagationContext()

Description copied from interface: Activation

Retrieve the PropagationContext for the Activation

Specified by:

getPropagationContext in interface Activation

Returns:

The propagation context

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.

getPartition

public RuleBasePartitionId getPartition()

getConsequence

public Consequence getConsequence()

Specified by:

getConsequence in interface Activation

getTuple

public Tuple 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 Queue.QueueEntry

setQueued

public void setQueued(boolean queued)

Specified by:

setQueued in interface Queue.QueueEntry

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

dequeue

public void dequeue()

Specified by:

dequeue in interface Queue.QueueEntry

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 java.util.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 java.lang.String toExternalForm()

Specified by:

toExternalForm in interface AgendaItem

getObjects

public java.util.List<java.lang.Object> getObjects()

Specified by:

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

getObjectsDeep

public java.util.List<java.lang.Object> getObjectsDeep()

Specified by:

getObjectsDeep in interface Activation

getDeclarationValue

public java.lang.Object getDeclarationValue(java.lang.String variableName)

Specified by:

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

getDeclarationIds

public java.util.List<java.lang.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

isRuleInUse

public boolean isRuleInUse()

getCallback

public java.lang.Runnable getCallback()

Specified by:

getCallback in interface AgendaItem

setCallback

public void setCallback(java.lang.Runnable callback)

Specified by:

setCallback in interface AgendaItem