public class DefaultAgenda extends Object implements Externalizable, InternalAgenda
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.
| Modifier and Type | Field and Description |
|---|---|
protected int |
activationCounter |
protected KnowledgeHelper |
knowledgeHelper |
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 and Description |
|---|
DefaultAgenda() |
DefaultAgenda(InternalKnowledgeBase kBase) |
DefaultAgenda(InternalKnowledgeBase kBase,
boolean initMain) |
| Modifier and Type | Method and Description |
|---|---|
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. |
boolean |
addActivation(AgendaItem activation)
Adds the activation to the agenda.
|
void |
addAgendaGroup(AgendaGroup agendaGroup) |
void |
addAgendaGroupOnStack(AgendaGroup agendaGroup) |
void |
addAgendaItemToGroup(AgendaItem item) |
void |
addEagerRuleAgendaItem(RuleAgendaItem item) |
void |
addItemToActivationGroup(AgendaItem item)
If the item belongs to an activation group, add it
|
void |
addQueryAgendaItem(RuleAgendaItem item) |
int |
agendaSize()
Iterates all the modules in the focus stack returning the total number of
Activations |
void |
cancelActivation(LeftTuple leftTuple,
PropagationContext context,
InternalWorkingMemory workingMemory,
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 |
clearAndCancelAndCancel(RuleFlowGroup ruleFlowGroup) |
void |
clearAndCancelRuleFlowGroup(String name) |
void |
clearAndCancelStagedActivations() |
void |
clearFocusStack() |
boolean |
createActivation(LeftTuple tuple,
PropagationContext context,
InternalWorkingMemory workingMemory,
TerminalNode rtn) |
AgendaItem |
createAgendaItem(RuleTerminalNodeLeftTuple rtnLeftTuple,
int salience,
PropagationContext context,
RuleAgendaItem ruleAgendaItem,
InternalAgendaGroup agendaGroup) |
boolean |
createPostponedActivation(LeftTuple tuple,
PropagationContext context,
InternalWorkingMemory workingMemory,
TerminalNode rtn) |
RuleAgendaItem |
createRuleAgendaItem(int salience,
PathMemory rs,
TerminalNode rtn) |
void |
deactivateRuleFlowGroup(InternalRuleFlowGroup group) |
void |
deactivateRuleFlowGroup(String name)
Deactivates the
RuleFlowGroup with the given name. |
void |
evaluateEagerList() |
void |
executeTask(ExecutableEntry executable) |
void |
fireActivation(Activation activation)
Fire this item.
|
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.
|
void |
fireConsequenceEvent(Activation activation,
String consequenceName) |
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. |
boolean |
fireTimedActivation(Activation activation) |
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.
|
int |
focusStackSize()
Iterates all the
AgendGroup |
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() |
ConsequenceExceptionHandler |
getConsequenceExceptionHandler() |
AgendaGroup |
getFocus() |
String |
getFocusName()
Returns the name of the agenda group that currently
has the focus
|
KnowledgeHelper |
getKnowledgeHelper() |
InternalAgendaGroup |
getMainAgendaGroup() |
InternalAgendaGroup |
getNextFocus() |
RuleFlowGroup |
getRuleFlowGroup(String name) |
Activation[] |
getScheduledActivations() |
<M extends ModedAssertion<M>> |
getScheduledActivationsLinkedList() |
AgendaGroup[] |
getStack() |
LinkedList<AgendaGroup> |
getStackList() |
InternalActivationGroup |
getStageActivationsGroup() |
InternalWorkingMemory |
getWorkingMemory()
Returns the WorkignMemory for this Agenda
|
void |
halt()
Stop agenda from firing any other rule.
|
void |
insertAndStageActivation(AgendaItem activation) |
boolean |
isDeclarativeAgenda() |
boolean |
isFiring() |
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) |
RuleAgendaItem |
peekNextRule() |
void |
readExternal(ObjectInput in) |
void |
removeActivation(AgendaItem activation) |
void |
removeEagerRuleAgendaItem(RuleAgendaItem item) |
boolean |
removeGroup(InternalAgendaGroup group) |
InternalAgendaGroup |
removeLast() |
void |
removeQueryAgendaItem(RuleAgendaItem item) |
void |
removeScheduleItem(ScheduledAgendaItem item) |
void |
reset() |
void |
scheduleItem(ScheduledAgendaItem item,
InternalWorkingMemory wm) |
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) |
int |
unstageActivations() |
void |
writeExternal(ObjectOutput out) |
public static final String ON_BEFORE_ALL_FIRES_CONSEQUENCE_NAME
public static final String ON_AFTER_ALL_FIRES_CONSEQUENCE_NAME
public static final String ON_DELETE_MATCH_CONSEQUENCE_NAME
protected static final transient org.slf4j.Logger log
protected InternalWorkingMemory workingMemory
protected KnowledgeHelper knowledgeHelper
protected int activationCounter
public DefaultAgenda()
public DefaultAgenda(InternalKnowledgeBase kBase)
public DefaultAgenda(InternalKnowledgeBase kBase, boolean initMain)
public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException
readExternal in interface ExternalizableIOExceptionClassNotFoundExceptionpublic void writeExternal(ObjectOutput out) throws IOException
writeExternal in interface ExternalizableIOExceptionpublic RuleAgendaItem createRuleAgendaItem(int salience, PathMemory rs, TerminalNode rtn)
createRuleAgendaItem in interface InternalAgendapublic AgendaItem createAgendaItem(RuleTerminalNodeLeftTuple rtnLeftTuple, int salience, PropagationContext context, RuleAgendaItem ruleAgendaItem, InternalAgendaGroup agendaGroup)
createAgendaItem in interface InternalAgendapublic void setWorkingMemory(InternalWorkingMemory workingMemory)
setWorkingMemory in interface InternalAgendapublic InternalWorkingMemory getWorkingMemory()
InternalAgendagetWorkingMemory in interface InternalAgendapublic void addEagerRuleAgendaItem(RuleAgendaItem item)
addEagerRuleAgendaItem in interface InternalAgendapublic void removeEagerRuleAgendaItem(RuleAgendaItem item)
removeEagerRuleAgendaItem in interface InternalAgendapublic void addQueryAgendaItem(RuleAgendaItem item)
addQueryAgendaItem in interface InternalAgendapublic void removeQueryAgendaItem(RuleAgendaItem item)
removeQueryAgendaItem in interface InternalAgendapublic void scheduleItem(ScheduledAgendaItem item, InternalWorkingMemory wm)
scheduleItem in interface InternalAgendapublic void addItemToActivationGroup(AgendaItem item)
addItemToActivationGroup in interface InternalAgendaitem - public InternalActivationGroup getStageActivationsGroup()
public void insertAndStageActivation(AgendaItem activation)
insertAndStageActivation in interface InternalAgendapublic boolean addActivation(AgendaItem activation)
InternalAgendaaddActivation in interface InternalAgendapublic boolean isDeclarativeAgenda()
isDeclarativeAgenda in interface InternalAgendapublic void removeActivation(AgendaItem activation)
removeActivation in interface InternalAgendapublic void modifyActivation(AgendaItem activation, boolean previouslyActive)
modifyActivation in interface InternalAgendapublic void clearAndCancelStagedActivations()
public int unstageActivations()
unstageActivations in interface InternalAgendapublic void addAgendaItemToGroup(AgendaItem item)
addAgendaItemToGroup in interface InternalAgendapublic void removeScheduleItem(ScheduledAgendaItem item)
removeScheduleItem in interface InternalAgendapublic void addAgendaGroup(AgendaGroup agendaGroup)
addAgendaGroup in interface InternalAgendapublic boolean createActivation(LeftTuple tuple, PropagationContext context, InternalWorkingMemory workingMemory, TerminalNode rtn)
createActivation in interface InternalAgendapublic boolean createPostponedActivation(LeftTuple tuple, PropagationContext context, InternalWorkingMemory workingMemory, TerminalNode rtn)
createPostponedActivation in interface InternalAgendapublic boolean isRuleActiveInRuleFlowGroup(String ruleflowGroupName, String ruleName, long processInstanceId)
isRuleActiveInRuleFlowGroup in interface InternalAgendapublic void cancelActivation(LeftTuple leftTuple, PropagationContext context, InternalWorkingMemory workingMemory, Activation activation, TerminalNode rtn)
cancelActivation in interface InternalAgendapublic boolean setFocus(AgendaGroup agendaGroup)
setFocus in interface InternalAgendapublic void setFocus(String name)
InternalAgendasetFocus in interface InternalAgendapublic void setFocus(PropagationContext ctx, String name)
public AgendaGroup getFocus()
getFocus in interface InternalAgendapublic InternalAgendaGroup getNextFocus()
getNextFocus in interface InternalAgendapublic InternalAgendaGroup removeLast()
public boolean removeGroup(InternalAgendaGroup group)
public void clearFocusStack()
public RuleAgendaItem peekNextRule()
peekNextRule in interface InternalAgendapublic AgendaGroup getAgendaGroup(String name)
getAgendaGroup in interface InternalAgendagetAgendaGroup in interface org.kie.api.runtime.rule.Agendapublic AgendaGroup getAgendaGroup(String name, InternalKnowledgeBase kBase)
getAgendaGroup in interface InternalAgendapublic AgendaGroup[] getAgendaGroups()
getAgendaGroups in interface InternalAgendapublic Map<String,InternalAgendaGroup> getAgendaGroupsMap()
getAgendaGroupsMap in interface InternalAgendapublic InternalAgendaGroup getMainAgendaGroup()
public AgendaGroup[] getStack()
getStack in interface InternalAgendapublic LinkedList<AgendaGroup> getStackList()
getStackList in interface InternalAgendapublic void addAgendaGroupOnStack(AgendaGroup agendaGroup)
addAgendaGroupOnStack in interface InternalAgendapublic Map<String,InternalActivationGroup> getActivationGroupsMap()
getActivationGroupsMap in interface InternalAgendapublic InternalActivationGroup getActivationGroup(String name)
getActivationGroup in interface InternalAgendagetActivationGroup in interface org.kie.api.runtime.rule.Agendapublic RuleFlowGroup getRuleFlowGroup(String name)
getRuleFlowGroup in interface InternalAgendagetRuleFlowGroup in interface org.kie.api.runtime.rule.Agendapublic void activateRuleFlowGroup(String name)
InternalAgendaRuleFlowGroup 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.activateRuleFlowGroup in interface InternalAgendapublic void activateRuleFlowGroup(String name, long processInstanceId, String nodeInstanceId)
InternalAgendaRuleFlowGroup 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.activateRuleFlowGroup in interface InternalAgendapublic void activateRuleFlowGroup(InternalRuleFlowGroup group, long processInstanceId, String nodeInstanceId)
public void deactivateRuleFlowGroup(String name)
InternalAgendaRuleFlowGroup 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 agendadeactivateRuleFlowGroup in interface InternalAgendapublic void deactivateRuleFlowGroup(InternalRuleFlowGroup group)
public int focusStackSize()
InternalAgendaAgendGroups in the focus stack returning the total number of ActivationsfocusStackSize in interface InternalAgendaActivations on the focus stackpublic int agendaSize()
InternalAgendaActivationsagendaSize in interface InternalAgendapublic Activation[] getActivations()
getActivations in interface InternalAgendapublic Activation[] getScheduledActivations()
getScheduledActivations in interface InternalAgendapublic <M extends ModedAssertion<M>> LinkedList<ScheduledAgendaItem<M>> getScheduledActivationsLinkedList()
getScheduledActivationsLinkedList in interface InternalAgendapublic void clear()
clear in interface org.kie.api.runtime.rule.Agendapublic void reset()
public void clearAndCancel()
InternalAgendaclearAndCancel in interface InternalAgendapublic void clearAndCancelAgendaGroup(String name)
InternalAgendaclearAndCancelAgendaGroup in interface InternalAgendapublic void clearAndCancelAgendaGroup(InternalAgendaGroup agendaGroup)
InternalAgendaclearAndCancelAgendaGroup in interface InternalAgendapublic void clearAndCancelActivationGroup(String name)
InternalAgendaclearAndCancelActivationGroup in interface InternalAgendapublic void clearAndCancelActivationGroup(InternalActivationGroup activationGroup)
InternalAgendaclearAndCancelActivationGroup in interface InternalAgendapublic void clearAndCancelRuleFlowGroup(String name)
clearAndCancelRuleFlowGroup in interface InternalAgendapublic void clearAndCancelAndCancel(RuleFlowGroup ruleFlowGroup)
clearAndCancelAndCancel in interface InternalAgendapublic int fireNextItem(org.kie.api.runtime.rule.AgendaFilter filter,
int fireCount,
int fireLimit)
throws ConsequenceException
Agenda item, skipping items
that are not allowed by the agenda filter.fireNextItem in interface InternalAgendaConsequenceException - If an error occurs while firing an agenda item.public void evaluateEagerList()
evaluateEagerList in interface InternalAgendapublic int sizeOfRuleFlowGroup(String name)
sizeOfRuleFlowGroup in interface InternalAgendapublic void fireActivation(Activation activation) throws ConsequenceException
fireActivation in interface InternalAgendaactivation - The activation to fireConsequenceException - If an error occurs while attempting to fire the consequence.public void fireConsequenceEvent(Activation activation, String consequenceName)
fireConsequenceEvent in interface InternalAgendapublic boolean fireTimedActivation(Activation activation) throws ConsequenceException
fireTimedActivation in interface InternalAgendaConsequenceExceptionpublic boolean isRuleInstanceAgendaItem(String ruleflowGroupName, String ruleName, long processInstanceId)
InternalAgendaisRuleInstanceAgendaItem in interface InternalAgendapublic String getFocusName()
InternalAgendagetFocusName in interface InternalAgendapublic void stageLeftTuple(RuleAgendaItem ruleAgendaItem, AgendaItem justified)
stageLeftTuple in interface InternalAgendapublic void fireUntilHalt()
InternalAgendafireUntilHalt in interface InternalAgendapublic void fireUntilHalt(org.kie.api.runtime.rule.AgendaFilter agendaFilter)
InternalAgendafireUntilHalt in interface InternalAgendaagendaFilter - filters the activations that may firepublic int fireAllRules(org.kie.api.runtime.rule.AgendaFilter agendaFilter,
int fireLimit)
InternalAgendafireAllRules in interface InternalAgendaagendaFilter - 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.public boolean isFiring()
isFiring in interface InternalAgendapublic void executeTask(ExecutableEntry executable)
executeTask in interface InternalAgendapublic void halt()
InternalAgendahalt in interface InternalAgendapublic ConsequenceExceptionHandler getConsequenceExceptionHandler()
public void setActivationsFilter(ActivationsFilter filter)
InternalAgendasetActivationsFilter in interface InternalAgendapublic ActivationsFilter getActivationsFilter()
InternalAgendagetActivationsFilter in interface InternalAgendapublic KnowledgeHelper getKnowledgeHelper()
Copyright © 2001–2015 JBoss by Red Hat. All rights reserved.