org.drools.core.common

Class DefaultAgenda

java.lang.Object

org.drools.core.common.DefaultAgenda

All Implemented Interfaces:

Externalizable, Serializable, InternalAgenda, org.kie.api.runtime.rule.Agenda

Direct Known Subclasses:

PartitionedDefaultAgenda

public class DefaultAgenda
extends Object
implements Externalizable, InternalAgenda

Rule-firing Agenda.

Since many rules may be matched by a single assertObject(...) all scheduled actions are placed into the Agenda.

While processing a scheduled action, it may update or retract objects in other scheduled actions, which must then be removed from the agenda. Non-invalidated actions are left on the agenda, and are executed in turn.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int	activationCounter
protected static org.slf4j.Logger	log
static String	ON_AFTER_ALL_FIRES_CONSEQUENCE_NAME
static String	ON_BEFORE_ALL_FIRES_CONSEQUENCE_NAME
static String	ON_DELETE_MATCH_CONSEQUENCE_NAME
protected InternalWorkingMemory	workingMemory Working memory of this Agenda.

Constructor Summary

Constructors

Constructor and Description
DefaultAgenda()
DefaultAgenda(InternalKnowledgeBase kBase)
DefaultAgenda(InternalKnowledgeBase kBase, boolean initMain)

Method Summary

Modifier and Type	Method and Description
void	activate()
void	activateRuleFlowGroup(InternalRuleFlowGroup group, long processInstanceId, String nodeInstanceId)
void	activateRuleFlowGroup(String name) Activates the RuleFlowGroup with the given name.
void	activateRuleFlowGroup(String name, long processInstanceId, String nodeInstanceId) Activates the RuleFlowGroup with the given name.
void	addAgendaGroup(AgendaGroup agendaGroup)
void	addAgendaGroupOnStack(AgendaGroup agendaGroup)
void	addEagerRuleAgendaItem(RuleAgendaItem item)
void	addItemToActivationGroup(AgendaItem item) If the item belongs to an activation group, add it
void	addPropagation(PropagationEntry propagationEntry)
void	addQueryAgendaItem(RuleAgendaItem item)
int	agendaSize() Iterates all the modules in the focus stack returning the total number of Activations
void	cancelActivation(Tuple leftTuple, PropagationContext context, Activation activation, TerminalNode rtn)
void	clear()
void	clearAndCancel() Clears all Activations from the Agenda
void	clearAndCancelActivationGroup(InternalActivationGroup activationGroup) Clears all Activations from an Activation Group.
void	clearAndCancelActivationGroup(String name) Clears all Activations from an Activation-Group.
void	clearAndCancelAgendaGroup(InternalAgendaGroup agendaGroup) Clears all Activations from an Agenda Group.
void	clearAndCancelAgendaGroup(String name) Clears all Activations from an Agenda Group.
void	clearAndCancelRuleFlowGroup(String name)
AgendaItem	createAgendaItem(RuleTerminalNodeLeftTuple rtnLeftTuple, int salience, PropagationContext context, RuleAgendaItem ruleAgendaItem, InternalAgendaGroup agendaGroup)
RuleAgendaItem	createRuleAgendaItem(int salience, PathMemory rs, TerminalNode rtn)
void	deactivate()
void	deactivateRuleFlowGroup(InternalRuleFlowGroup group)
void	deactivateRuleFlowGroup(String name) Deactivates the RuleFlowGroup with the given name.
boolean	dispose(InternalWorkingMemory wm)
protected void	doRetract(PropagationContext ectx)
void	evaluateEagerList()
void	evaluateQueriesForRule(RuleAgendaItem item)
void	executeFlush()
void	executeTask(ExecutableEntry executable)
int	fireAllRules(org.kie.api.runtime.rule.AgendaFilter agendaFilter, int fireLimit) Fires all activations currently in agenda that match the given agendaFilter until the fireLimit is reached or no more activations exist.
int	fireNextItem(org.kie.api.runtime.rule.AgendaFilter filter, int fireCount, int fireLimit) Fire the next scheduled Agenda item, skipping items that are not allowed by the agenda filter.
void	fireUntilHalt() Keeps firing activations until a halt is called.
void	fireUntilHalt(org.kie.api.runtime.rule.AgendaFilter agendaFilter) Keeps firing activations until a halt is called.
void	flushPropagations()
int	focusStackSize() Iterates all the AgendGroups in the focus stack returning the total number of Activations
Iterator<PropagationEntry>	getActionsIterator()
InternalActivationGroup	getActivationGroup(String name)
Map<String,InternalActivationGroup>	getActivationGroupsMap()
Activation[]	getActivations()
ActivationsFilter	getActivationsFilter() Returns the current activations filter or null if none is set
AgendaGroup	getAgendaGroup(String name)
AgendaGroup	getAgendaGroup(String name, InternalKnowledgeBase kBase)
AgendaGroup[]	getAgendaGroups()
Map<String,InternalAgendaGroup>	getAgendaGroupsMap()
AgendaGroup	getFocus()
String	getFocusName() Returns the name of the agenda group that currently has the focus
KnowledgeHelper	getKnowledgeHelper()
InternalAgendaGroup	getNextFocus()
PropagationList	getPropagationList()
RuleFlowGroup	getRuleFlowGroup(String name)
AgendaGroup[]	getStack()
LinkedList<AgendaGroup>	getStackList()
InternalWorkingMemory	getWorkingMemory() Returns the WorkignMemory for this Agenda
void	halt() Stop agenda from firing any other rule.
void	handleException(InternalWorkingMemory wm, Activation activation, Exception e)
boolean	hasPendingPropagations()
void	insertAndStageActivation(AgendaItem activation)
void	internalHalt()
boolean	isAlive()
boolean	isDeclarativeAgenda()
boolean	isFiring()
boolean	isParallelAgenda()
boolean	isRuleActiveInRuleFlowGroup(String ruleflowGroupName, String ruleName, long processInstanceId)
boolean	isRuleInstanceAgendaItem(String ruleflowGroupName, String ruleName, long processInstanceId) Returns true if there is at least one activation of the given rule name in the given ruleflow group name
void	modifyActivation(AgendaItem activation, boolean previouslyActive) Adds the activation to the agenda.
void	notifyWaitOnRest()
RuleAgendaItem	peekNextRule()
void	readExternal(ObjectInput in)
void	registerExpiration(PropagationContext ectx)
void	removeEagerRuleAgendaItem(RuleAgendaItem item)
void	removeQueryAgendaItem(RuleAgendaItem item)
void	reset()
void	setActivationsFilter(ActivationsFilter filter) Sets a filter that prevents activations from being added to the agenda.
boolean	setFocus(AgendaGroup agendaGroup)
void	setFocus(PropagationContext ctx, String name)
void	setFocus(String name) Sets the Agenda's focus to the specified AgendaGroup
void	setWorkingMemory(InternalWorkingMemory workingMemory)
int	sizeOfRuleFlowGroup(String name)
void	stageLeftTuple(RuleAgendaItem ruleAgendaItem, AgendaItem justified)
boolean	tryDeactivate()
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

ON_BEFORE_ALL_FIRES_CONSEQUENCE_NAME

public static final String ON_BEFORE_ALL_FIRES_CONSEQUENCE_NAME

See Also:

Constant Field Values

ON_AFTER_ALL_FIRES_CONSEQUENCE_NAME

public static final String ON_AFTER_ALL_FIRES_CONSEQUENCE_NAME

See Also:

Constant Field Values

ON_DELETE_MATCH_CONSEQUENCE_NAME

public static final String ON_DELETE_MATCH_CONSEQUENCE_NAME

See Also:

Constant Field Values

log

protected static final transient org.slf4j.Logger log

workingMemory

protected InternalWorkingMemory workingMemory

Working memory of this Agenda.

activationCounter

protected int activationCounter

Constructor Detail

DefaultAgenda

public DefaultAgenda()

DefaultAgenda

public DefaultAgenda(InternalKnowledgeBase kBase)

DefaultAgenda

public DefaultAgenda(InternalKnowledgeBase kBase,
                     boolean initMain)

Method Detail

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

createRuleAgendaItem

public RuleAgendaItem createRuleAgendaItem(int salience,
                                           PathMemory rs,
                                           TerminalNode rtn)

Specified by:

createRuleAgendaItem in interface InternalAgenda

createAgendaItem

public AgendaItem createAgendaItem(RuleTerminalNodeLeftTuple rtnLeftTuple,
                                   int salience,
                                   PropagationContext context,
                                   RuleAgendaItem ruleAgendaItem,
                                   InternalAgendaGroup agendaGroup)

Specified by:

createAgendaItem in interface InternalAgenda

setWorkingMemory

public void setWorkingMemory(InternalWorkingMemory workingMemory)

Specified by:

setWorkingMemory in interface InternalAgenda

getPropagationList

public PropagationList getPropagationList()

Specified by:

getPropagationList in interface InternalAgenda

getWorkingMemory

public InternalWorkingMemory getWorkingMemory()

Description copied from interface: InternalAgenda

Returns the WorkignMemory for this Agenda

Specified by:

getWorkingMemory in interface InternalAgenda

Returns:

The WorkingMemory

addEagerRuleAgendaItem

public void addEagerRuleAgendaItem(RuleAgendaItem item)

Specified by:

addEagerRuleAgendaItem in interface InternalAgenda

removeEagerRuleAgendaItem

public void removeEagerRuleAgendaItem(RuleAgendaItem item)

Specified by:

removeEagerRuleAgendaItem in interface InternalAgenda

addQueryAgendaItem

public void addQueryAgendaItem(RuleAgendaItem item)

Specified by:

addQueryAgendaItem in interface InternalAgenda

removeQueryAgendaItem

public void removeQueryAgendaItem(RuleAgendaItem item)

Specified by:

removeQueryAgendaItem in interface InternalAgenda

addItemToActivationGroup

public void addItemToActivationGroup(AgendaItem item)

If the item belongs to an activation group, add it

Specified by:

addItemToActivationGroup in interface InternalAgenda

Parameters:

item -

insertAndStageActivation

public void insertAndStageActivation(AgendaItem activation)

Specified by:

insertAndStageActivation in interface InternalAgenda

isDeclarativeAgenda

public boolean isDeclarativeAgenda()

Specified by:

isDeclarativeAgenda in interface InternalAgenda

modifyActivation

public void modifyActivation(AgendaItem activation,
                             boolean previouslyActive)

Description copied from interface: InternalAgenda

Adds the activation to the agenda. Depending on the mode the agenda is running, the activation may be added to the agenda priority queue (synchronously or asynchronously) or be executed immediately.

Specified by:

modifyActivation in interface InternalAgenda

addAgendaGroup

public void addAgendaGroup(AgendaGroup agendaGroup)

Specified by:

addAgendaGroup in interface InternalAgenda

isRuleActiveInRuleFlowGroup

public boolean isRuleActiveInRuleFlowGroup(String ruleflowGroupName,
                                           String ruleName,
                                           long processInstanceId)

Specified by:

isRuleActiveInRuleFlowGroup in interface InternalAgenda

cancelActivation

public void cancelActivation(Tuple leftTuple,
                             PropagationContext context,
                             Activation activation,
                             TerminalNode rtn)

Specified by:

cancelActivation in interface InternalAgenda

setFocus

public boolean setFocus(AgendaGroup agendaGroup)

Specified by:

setFocus in interface InternalAgenda

setFocus

public void setFocus(String name)

Description copied from interface: InternalAgenda

Sets the Agenda's focus to the specified AgendaGroup

Specified by:

setFocus in interface InternalAgenda

setFocus

public void setFocus(PropagationContext ctx,
                     String name)

getFocus

public AgendaGroup getFocus()

Specified by:

getFocus in interface InternalAgenda

getNextFocus

public InternalAgendaGroup getNextFocus()

Specified by:

getNextFocus in interface InternalAgenda

peekNextRule

public RuleAgendaItem peekNextRule()

Specified by:

peekNextRule in interface InternalAgenda

getAgendaGroup

public AgendaGroup getAgendaGroup(String name)

Specified by:

getAgendaGroup in interface InternalAgenda

Specified by:

getAgendaGroup in interface org.kie.api.runtime.rule.Agenda

getAgendaGroup

public AgendaGroup getAgendaGroup(String name,
                                  InternalKnowledgeBase kBase)

Specified by:

getAgendaGroup in interface InternalAgenda

getAgendaGroups

public AgendaGroup[] getAgendaGroups()

Specified by:

getAgendaGroups in interface InternalAgenda

getAgendaGroupsMap

public Map<String,InternalAgendaGroup> getAgendaGroupsMap()

Specified by:

getAgendaGroupsMap in interface InternalAgenda

getStack

public AgendaGroup[] getStack()

Specified by:

getStack in interface InternalAgenda

getStackList

public LinkedList<AgendaGroup> getStackList()

Specified by:

getStackList in interface InternalAgenda

addAgendaGroupOnStack

public void addAgendaGroupOnStack(AgendaGroup agendaGroup)

Specified by:

addAgendaGroupOnStack in interface InternalAgenda

getActivationGroupsMap

public Map<String,InternalActivationGroup> getActivationGroupsMap()

Specified by:

getActivationGroupsMap in interface InternalAgenda

getActivationGroup

public InternalActivationGroup getActivationGroup(String name)

Specified by:

getActivationGroup in interface InternalAgenda

Specified by:

getActivationGroup in interface org.kie.api.runtime.rule.Agenda

getRuleFlowGroup

public RuleFlowGroup getRuleFlowGroup(String name)

Specified by:

getRuleFlowGroup in interface InternalAgenda

Specified by:

getRuleFlowGroup in interface org.kie.api.runtime.rule.Agenda

activateRuleFlowGroup

public void activateRuleFlowGroup(String name)

Description copied from interface: InternalAgenda

Activates the RuleFlowGroup with the given name. All activations in the given RuleFlowGroup are added to the agenda. As long as the RuleFlowGroup remains active, its activations are automatically added to the agenda.

Specified by:

activateRuleFlowGroup in interface InternalAgenda

activateRuleFlowGroup

public void activateRuleFlowGroup(String name,
                                  long processInstanceId,
                                  String nodeInstanceId)

Description copied from interface: InternalAgenda

Activates the RuleFlowGroup with the given name. All activations in the given RuleFlowGroup are added to the agenda. As long as the RuleFlowGroup remains active, its activations are automatically added to the agenda. The given processInstanceId and nodeInstanceId define the process context in which this RuleFlowGroup is used.

Specified by:

activateRuleFlowGroup in interface InternalAgenda

activateRuleFlowGroup

public void activateRuleFlowGroup(InternalRuleFlowGroup group,
                                  long processInstanceId,
                                  String nodeInstanceId)

deactivateRuleFlowGroup

public void deactivateRuleFlowGroup(String name)

Description copied from interface: InternalAgenda

Deactivates the RuleFlowGroup with the given name. All activations in the given RuleFlowGroup are removed from the agenda. As long as the RuleFlowGroup remains deactive, its activations are not added to the agenda

Specified by:

deactivateRuleFlowGroup in interface InternalAgenda

deactivateRuleFlowGroup

public void deactivateRuleFlowGroup(InternalRuleFlowGroup group)

focusStackSize

public int focusStackSize()

Description copied from interface: InternalAgenda

Iterates all the AgendGroups in the focus stack returning the total number of Activations

Specified by:

focusStackSize in interface InternalAgenda

Returns:

total number of Activations on the focus stack

agendaSize

public int agendaSize()

Description copied from interface: InternalAgenda

Iterates all the modules in the focus stack returning the total number of Activations

Specified by:

agendaSize in interface InternalAgenda

Returns:

total number of activations on the focus stack

getActivations

public Activation[] getActivations()

Specified by:

getActivations in interface InternalAgenda

clear

public void clear()

Specified by:

clear in interface org.kie.api.runtime.rule.Agenda

reset

public void reset()

Specified by:

reset in interface InternalAgenda

clearAndCancel

public void clearAndCancel()

Description copied from interface: InternalAgenda

Clears all Activations from the Agenda

Specified by:

clearAndCancel in interface InternalAgenda

clearAndCancelAgendaGroup

public void clearAndCancelAgendaGroup(String name)

Description copied from interface: InternalAgenda

Clears all Activations from an Agenda Group. Any Activations that are also in an Xor Group are removed the the Xor Group.

Specified by:

clearAndCancelAgendaGroup in interface InternalAgenda

clearAndCancelAgendaGroup

public void clearAndCancelAgendaGroup(InternalAgendaGroup agendaGroup)

Description copied from interface: InternalAgenda

Clears all Activations from an Agenda Group. Any Activations that are also in an Xor Group are removed the the Xor Group.

Specified by:

clearAndCancelAgendaGroup in interface InternalAgenda

clearAndCancelActivationGroup

public void clearAndCancelActivationGroup(String name)

Description copied from interface: InternalAgenda

Clears all Activations from an Activation-Group. Any Activations that are also in an Agenda Group are removed from the Agenda Group.

Specified by:

clearAndCancelActivationGroup in interface InternalAgenda

clearAndCancelActivationGroup

public void clearAndCancelActivationGroup(InternalActivationGroup activationGroup)

Description copied from interface: InternalAgenda

Clears all Activations from an Activation Group. Any Activations that are also in an Agenda Group are removed from the Agenda Group.

Specified by:

clearAndCancelActivationGroup in interface InternalAgenda

clearAndCancelRuleFlowGroup

public void clearAndCancelRuleFlowGroup(String name)

Specified by:

clearAndCancelRuleFlowGroup in interface InternalAgenda

fireNextItem

public int fireNextItem(org.kie.api.runtime.rule.AgendaFilter filter,
                        int fireCount,
                        int fireLimit)
                 throws ConsequenceException

Fire the next scheduled Agenda item, skipping items that are not allowed by the agenda filter.

Specified by:

fireNextItem in interface InternalAgenda

Returns:

true if an activation was fired. false if no more activations to fire

Throws:

ConsequenceException - If an error occurs while firing an agenda item.

evaluateEagerList

public void evaluateEagerList()

Specified by:

evaluateEagerList in interface InternalAgenda

evaluateQueriesForRule

public void evaluateQueriesForRule(RuleAgendaItem item)

sizeOfRuleFlowGroup

public int sizeOfRuleFlowGroup(String name)

Specified by:

sizeOfRuleFlowGroup in interface InternalAgenda

isRuleInstanceAgendaItem

public boolean isRuleInstanceAgendaItem(String ruleflowGroupName,
                                        String ruleName,
                                        long processInstanceId)

Description copied from interface: InternalAgenda

Returns true if there is at least one activation of the given rule name in the given ruleflow group name

Specified by:

isRuleInstanceAgendaItem in interface InternalAgenda

getFocusName

public String getFocusName()

Description copied from interface: InternalAgenda

Returns the name of the agenda group that currently has the focus

Specified by:

getFocusName in interface InternalAgenda

stageLeftTuple

public void stageLeftTuple(RuleAgendaItem ruleAgendaItem,
                           AgendaItem justified)

Specified by:

stageLeftTuple in interface InternalAgenda

fireUntilHalt

public void fireUntilHalt()

Description copied from interface: InternalAgenda

Keeps firing activations until a halt is called. If in a given moment, there is no activation to fire, it will wait for an activation to be added to an active agenda group or rule flow group.

Specified by:

fireUntilHalt in interface InternalAgenda

fireUntilHalt

public void fireUntilHalt(org.kie.api.runtime.rule.AgendaFilter agendaFilter)

Description copied from interface: InternalAgenda

Keeps firing activations until a halt is called. If in a given moment, there is no activation to fire, it will wait for an activation to be added to an active agenda group or rule flow group.

Specified by:

fireUntilHalt in interface InternalAgenda

Parameters:

agendaFilter - filters the activations that may fire

fireAllRules

public int fireAllRules(org.kie.api.runtime.rule.AgendaFilter agendaFilter,
                        int fireLimit)

Description copied from interface: InternalAgenda

Fires all activations currently in agenda that match the given agendaFilter until the fireLimit is reached or no more activations exist.

Specified by:

fireAllRules in interface InternalAgenda

Parameters:

agendaFilter - the filter on which activations may fire.

fireLimit - the maximum number of activations that may fire. If -1, then it will fire until no more activations exist.

Returns:

the number of rules that were actually fired

isFiring

public boolean isFiring()

Specified by:

isFiring in interface InternalAgenda

executeTask

public void executeTask(ExecutableEntry executable)

Specified by:

executeTask in interface InternalAgenda

executeFlush

public void executeFlush()

Specified by:

executeFlush in interface InternalAgenda

activate

public void activate()

Specified by:

activate in interface InternalAgenda

deactivate

public void deactivate()

Specified by:

deactivate in interface InternalAgenda

tryDeactivate

public boolean tryDeactivate()

Specified by:

tryDeactivate in interface InternalAgenda

halt

public void halt()

Description copied from interface: InternalAgenda

Stop agenda from firing any other rule. It will finish the current rule execution though.

Specified by:

halt in interface InternalAgenda

dispose

public boolean dispose(InternalWorkingMemory wm)

Specified by:

dispose in interface InternalAgenda

isAlive

public boolean isAlive()

Specified by:

isAlive in interface InternalAgenda

internalHalt

public void internalHalt()

setActivationsFilter

public void setActivationsFilter(ActivationsFilter filter)

Description copied from interface: InternalAgenda

Sets a filter that prevents activations from being added to the agenda.

Specified by:

setActivationsFilter in interface InternalAgenda

getActivationsFilter

public ActivationsFilter getActivationsFilter()

Description copied from interface: InternalAgenda

Returns the current activations filter or null if none is set

Specified by:

getActivationsFilter in interface InternalAgenda

handleException

public void handleException(InternalWorkingMemory wm,
                            Activation activation,
                            Exception e)

Specified by:

handleException in interface InternalAgenda

getKnowledgeHelper

public KnowledgeHelper getKnowledgeHelper()

Specified by:

getKnowledgeHelper in interface InternalAgenda

addPropagation

public void addPropagation(PropagationEntry propagationEntry)

Specified by:

addPropagation in interface InternalAgenda

flushPropagations

public void flushPropagations()

Specified by:

flushPropagations in interface InternalAgenda

notifyWaitOnRest

public void notifyWaitOnRest()

Specified by:

notifyWaitOnRest in interface InternalAgenda

getActionsIterator

public Iterator<PropagationEntry> getActionsIterator()

Specified by:

getActionsIterator in interface InternalAgenda

hasPendingPropagations

public boolean hasPendingPropagations()

Specified by:

hasPendingPropagations in interface InternalAgenda

registerExpiration

public void registerExpiration(PropagationContext ectx)

Specified by:

registerExpiration in interface InternalAgenda

doRetract

protected void doRetract(PropagationContext ectx)

isParallelAgenda

public boolean isParallelAgenda()

Specified by:

isParallelAgenda in interface InternalAgenda