Package org.drools.kiesession.agenda

Class DefaultAgenda

java.lang.Object

org.drools.kiesession.agenda.DefaultAgenda

All Implemented Interfaces:

ActivationsManager, InternalAgenda, Agenda

Direct Known Subclasses:

PartitionedDefaultAgenda

public class DefaultAgenda
extends Object
implements 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.

Field Summary

Fields

Modifier and Type	Field	Description
protected int	activationCounter
protected static final org.slf4j.Logger	log
protected final InternalWorkingMemory	workingMemory

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

ON_AFTER_ALL_FIRES_CONSEQUENCE_NAME, ON_BEFORE_ALL_FIRES_CONSEQUENCE_NAME, ON_DELETE_MATCH_CONSEQUENCE_NAME

Constructor Summary

Constructors

Constructor	Description
DefaultAgenda(InternalWorkingMemory workingMemory)

Method Summary

Modifier and Type	Method	Description
void	activate()
void	activateRuleFlowGroup(String name)
void	activateRuleFlowGroup(String name, String processInstanceId, String nodeInstanceId)
void	activateRuleFlowGroup(InternalRuleFlowGroup group, Object processInstanceId, String nodeInstanceId)
void	addEagerRuleAgendaItem(RuleAgendaItem item)
void	addItemToActivationGroup(InternalMatch internalMatch)
void	addPropagation(PropagationEntry propagationEntry)
void	addQueryAgendaItem(RuleAgendaItem item)
void	cancelActivation(InternalMatch internalMatch)
void	clear()
void	clearAndCancel()
void	clearAndCancelActivationGroup(String name)
void	clearAndCancelActivationGroup(InternalActivationGroup activationGroup)
void	clearAndCancelAgendaGroup(String name)
void	clearAndCancelRuleFlowGroup(String name)
InternalMatch	createAgendaItem(RuleTerminalNodeLeftTuple rtnLeftTuple, int salience, PropagationContext context, RuleAgendaItem ruleAgendaItem, InternalAgendaGroup agendaGroup)
protected PropagationList	createPropagationList()
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(AgendaFilter agendaFilter, int fireLimit)
void	fireUntilHalt()
void	fireUntilHalt(AgendaFilter agendaFilter)
void	flushPropagations()
Iterator<PropagationEntry>	getActionsIterator()
InternalActivationGroup	getActivationGroup(String name)
Map<String,InternalActivationGroup>	getActivationGroupsMap()
ActivationsFilter	getActivationsFilter()
AgendaEventSupport	getAgendaEventSupport()
AgendaGroup	getAgendaGroup(String name)
AgendaGroupsManager	getAgendaGroupsManager()
String	getFocusName()
KnowledgeHelper	getKnowledgeHelper()
PropagationList	getPropagationList()
ReteEvaluator	getReteEvaluator()
RuleFlowGroup	getRuleFlowGroup(String name)
InternalWorkingMemory	getWorkingMemory()
void	halt()
void	haltGroupEvaluation()
void	handleException(InternalMatch internalMatch, Exception e)
boolean	hasPendingPropagations()
void	internalHalt()
boolean	isAlive()
boolean	isDeclarativeAgenda()
boolean	isFiring()
boolean	isParallelAgenda()
protected boolean	isPendingRemoveFactHandleFromStore(InternalFactHandle factHandle)
boolean	isRuleActiveInRuleFlowGroup(String ruleflowGroupName, String ruleName, String processInstanceId)
void	notifyWaitOnRest()
RuleAgendaItem	peekNextRule()
void	registerExpiration(PropagationContext ectx)
void	removeEagerRuleAgendaItem(RuleAgendaItem item)
void	removeQueryAgendaItem(RuleAgendaItem item)
void	reset()
void	resetKnowledgeHelper()
protected void	retractFactHandle(PropagationContext ectx, InternalFactHandle factHandle)
void	setActivationsFilter(ActivationsFilter filter)
boolean	setFocus(String name)
boolean	setFocus(PropagationContext ctx, String name)
int	sizeOfRuleFlowGroup(String name)
boolean	tryDeactivate()

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

getPartitionedAgenda, getPartitionedAgendaForNode, stageLeftTuple

Field Details

log

protected static final org.slf4j.Logger log

workingMemory

protected final InternalWorkingMemory workingMemory

activationCounter

protected int activationCounter

Constructor Details

DefaultAgenda

public DefaultAgenda(InternalWorkingMemory workingMemory)

Method Details

createRuleAgendaItem

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

Specified by:

createRuleAgendaItem in interface ActivationsManager

createAgendaItem

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

Specified by:

createAgendaItem in interface ActivationsManager

createPropagationList

protected PropagationList createPropagationList()

getPropagationList

public PropagationList getPropagationList()

getWorkingMemory

public InternalWorkingMemory getWorkingMemory()

Specified by:

getWorkingMemory in interface InternalAgenda

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

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

Specified by:

isRuleActiveInRuleFlowGroup in interface InternalAgenda

cancelActivation

public void cancelActivation(InternalMatch internalMatch)

Specified by:

cancelActivation in interface ActivationsManager

setFocus

public boolean setFocus(String name)

Specified by:

setFocus in interface InternalAgenda

setFocus

public boolean 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 Agenda

getRuleFlowGroup

public RuleFlowGroup getRuleFlowGroup(String name)

Specified by:

getRuleFlowGroup in interface Agenda

activateRuleFlowGroup

public void activateRuleFlowGroup(String name)

Specified by:

activateRuleFlowGroup in interface InternalAgenda

activateRuleFlowGroup

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

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 Agenda

getAgendaGroup

public AgendaGroup getAgendaGroup(String name)

Specified by:

getAgendaGroup in interface Agenda

reset

public void reset()

Specified by:

reset in interface InternalAgenda

clearAndCancel

public void clearAndCancel()

Specified by:

clearAndCancel in interface InternalAgenda

clearAndCancelAgendaGroup

public void clearAndCancelAgendaGroup(String name)

Specified by:

clearAndCancelAgendaGroup in interface InternalAgenda

clearAndCancelActivationGroup

public void clearAndCancelActivationGroup(String name)

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

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

getFocusName

public String getFocusName()

Specified by:

getFocusName in interface InternalAgenda

fireUntilHalt

public void fireUntilHalt()

Specified by:

fireUntilHalt in interface InternalAgenda

fireUntilHalt

public void fireUntilHalt(AgendaFilter agendaFilter)

Specified by:

fireUntilHalt in interface InternalAgenda

fireAllRules

public int fireAllRules(AgendaFilter agendaFilter,
 int fireLimit)

Specified by:

fireAllRules in interface ActivationsManager

Specified by:

fireAllRules in interface InternalAgenda

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

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)

Specified by:

setActivationsFilter in interface InternalAgenda

getActivationsFilter

public ActivationsFilter getActivationsFilter()

Specified by:

getActivationsFilter in interface ActivationsManager

handleException

public void handleException(InternalMatch internalMatch,
 Exception e)

Specified by:

handleException in interface ActivationsManager

getKnowledgeHelper

public KnowledgeHelper getKnowledgeHelper()

Specified by:

getKnowledgeHelper in interface ActivationsManager

resetKnowledgeHelper

public void resetKnowledgeHelper()

Specified by:

resetKnowledgeHelper in interface ActivationsManager

haltGroupEvaluation

public void haltGroupEvaluation()

Specified by:

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

retractFactHandle

protected void retractFactHandle(PropagationContext ectx,
 InternalFactHandle factHandle)

isPendingRemoveFactHandleFromStore

protected boolean isPendingRemoveFactHandleFromStore(InternalFactHandle factHandle)

isParallelAgenda

public boolean isParallelAgenda()

Specified by:

isParallelAgenda in interface InternalAgenda