Package org.drools.core.common

Class DefaultAgenda

java.lang.Object

org.drools.core.common.DefaultAgenda

All Implemented Interfaces:

Externalizable, Serializable, ActivationsManager, 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	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	Description
DefaultAgenda()
DefaultAgenda(InternalKnowledgeBase kBase)
DefaultAgenda(InternalKnowledgeBase kBase, boolean initMain)

Method Summary

Modifier and Type	Method	Description
void	activate()
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	activateRuleFlowGroup(InternalRuleFlowGroup group, Object processInstanceId, String nodeInstanceId)
void	addEagerRuleAgendaItem(RuleAgendaItem item)
void	addItemToActivationGroup(AgendaItem activation)
void	addPropagation(PropagationEntry propagationEntry)
void	addQueryAgendaItem(RuleAgendaItem item)
void	cancelActivation(Activation activation)
void	clear()
void	clearAndCancel()	Clears all Activations from the Agenda
void	clearAndCancelActivationGroup(String name)	Clears all Activations from an Activation-Group.
void	clearAndCancelActivationGroup(InternalActivationGroup activationGroup)
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()
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()
Iterator<PropagationEntry>	getActionsIterator()
InternalActivationGroup	getActivationGroup(String name)
Map<String,InternalActivationGroup>	getActivationGroupsMap()
ActivationsFilter	getActivationsFilter()
AgendaEventSupport	getAgendaEventSupport()
org.kie.api.runtime.rule.AgendaGroup	getAgendaGroup(String name)
AgendaGroupsManager	getAgendaGroupsManager()
String	getFocusName()	Returns the name of the agenda group that currently has the focus
KnowledgeHelper	getKnowledgeHelper()
PropagationList	getPropagationList()
ReteEvaluator	getReteEvaluator()
RuleFlowGroup	getRuleFlowGroup(String name)
InternalWorkingMemory	getWorkingMemory()	Returns the WorkignMemory for this Agenda
void	halt()	Stop agenda from firing any other rule.
void	handleException(Activation activation, Exception e)
boolean	hasPendingPropagations()
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
protected boolean	isRuleInstanceAgendaItem(String ruleflowGroupName, String ruleName, Object processInstanceId)
void	notifyWaitOnRest()
RuleAgendaItem	peekNextRule()
void	readExternal(ObjectInput in)
void	registerExpiration(PropagationContext ectx)
void	removeEagerRuleAgendaItem(RuleAgendaItem item)
void	removeQueryAgendaItem(RuleAgendaItem item)
void	reset()
protected boolean	sameProcessInstance(Object processInstanceId, org.kie.api.runtime.process.ProcessInstance value)
void	setActivationsFilter(ActivationsFilter filter)	Sets a filter that prevents activations from being added to the agenda.
void	setFocus(String name)	Sets the Agenda's focus to the specified AgendaGroup
void	setFocus(PropagationContext ctx, String name)
void	setWorkingMemory(InternalWorkingMemory workingMemory)
int	sizeOfRuleFlowGroup(String name)
boolean	tryDeactivate()
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

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

stageLeftTuple

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 ActivationsManager

createAgendaItem

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

Specified by:

createAgendaItem in interface ActivationsManager

setWorkingMemory

public void setWorkingMemory(InternalWorkingMemory workingMemory)

Specified by:

setWorkingMemory in interface InternalAgenda

getPropagationList

public PropagationList getPropagationList()

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 ActivationsManager

removeEagerRuleAgendaItem

public void removeEagerRuleAgendaItem(RuleAgendaItem item)

Specified by:

removeEagerRuleAgendaItem in interface ActivationsManager

addQueryAgendaItem

public void addQueryAgendaItem(RuleAgendaItem item)

Specified by:

addQueryAgendaItem in interface ActivationsManager

removeQueryAgendaItem

public void removeQueryAgendaItem(RuleAgendaItem item)

Specified by:

removeQueryAgendaItem in interface ActivationsManager

addItemToActivationGroup

public void addItemToActivationGroup(AgendaItem activation)

Specified by:

addItemToActivationGroup in interface ActivationsManager

peekNextRule

public RuleAgendaItem peekNextRule()

Specified by:

peekNextRule in interface ActivationsManager

isDeclarativeAgenda

public boolean isDeclarativeAgenda()

Specified by:

isDeclarativeAgenda in interface InternalAgenda

isRuleActiveInRuleFlowGroup

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

Specified by:

isRuleActiveInRuleFlowGroup in interface InternalAgenda

cancelActivation

public void cancelActivation(Activation activation)

Specified by:

cancelActivation in interface ActivationsManager

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)

getReteEvaluator

public ReteEvaluator getReteEvaluator()

Specified by:

getReteEvaluator in interface ActivationsManager

getAgendaGroupsManager

public AgendaGroupsManager getAgendaGroupsManager()

Specified by:

getAgendaGroupsManager in interface ActivationsManager

getAgendaEventSupport

public AgendaEventSupport getAgendaEventSupport()

Specified by:

getAgendaEventSupport in interface ActivationsManager

getActivationGroupsMap

public Map<String,InternalActivationGroup> getActivationGroupsMap()

Specified by:

getActivationGroupsMap in interface InternalAgenda

getActivationGroup

public InternalActivationGroup getActivationGroup(String name)

Specified by:

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

getRuleFlowGroup

public RuleFlowGroup getRuleFlowGroup(String name)

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,
                                  Object processInstanceId,
                                  String nodeInstanceId)

clear

public void clear()

Specified by:

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

getAgendaGroup

public org.kie.api.runtime.rule.AgendaGroup getAgendaGroup(String name)

Specified by:

getAgendaGroup 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

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 ActivationsManager

Specified by:

clearAndCancelActivationGroup in interface InternalAgenda

clearAndCancelActivationGroup

public void clearAndCancelActivationGroup(InternalActivationGroup activationGroup)

Specified by:

clearAndCancelActivationGroup in interface ActivationsManager

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)

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 ActivationsManager

evaluateQueriesForRule

public void evaluateQueriesForRule(RuleAgendaItem item)

Specified by:

evaluateQueriesForRule in interface ActivationsManager

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

isRuleInstanceAgendaItem

protected boolean isRuleInstanceAgendaItem(String ruleflowGroupName,
                                           String ruleName,
                                           Object processInstanceId)

sameProcessInstance

protected boolean sameProcessInstance(Object processInstanceId,
                                      org.kie.api.runtime.process.ProcessInstance value)

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

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 ActivationsManager

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 ActivationsManager

executeTask

public void executeTask(ExecutableEntry executable)

Specified by:

executeTask in interface ActivationsManager

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()

Specified by:

getActivationsFilter in interface ActivationsManager

handleException

public void handleException(Activation activation,
                            Exception e)

Specified by:

handleException in interface ActivationsManager

getKnowledgeHelper

public KnowledgeHelper getKnowledgeHelper()

Specified by:

getKnowledgeHelper in interface ActivationsManager

addPropagation

public void addPropagation(PropagationEntry propagationEntry)

Specified by:

addPropagation in interface ActivationsManager

flushPropagations

public void flushPropagations()

Specified by:

flushPropagations in interface ActivationsManager

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 ActivationsManager

doRetract

protected void doRetract(PropagationContext ectx)

isParallelAgenda

public boolean isParallelAgenda()

Specified by:

isParallelAgenda in interface InternalAgenda