|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WorkingMemory
A knowledge session for a RuleBase
.
While this object can be serialised out, it cannot be serialised in. This is because
the RuleBase reference is transient. Please see the RuleBase interface for serializing
in WorkingMemories from an InputStream.
Method Summary | |
---|---|
void |
clearActivationGroup(String group)
Clears the Activation Group, cancellings all its Activations |
void |
clearAgenda()
Clear the Agenda. |
void |
clearAgendaGroup(String group)
Clear the Agenda Group, cancelling all its Activations. |
void |
clearRuleFlowGroup(String group)
Clears the RuleFlow group, cancelling all its Activations |
int |
fireAllRules()
Fire all items on the agenda until empty. |
int |
fireAllRules(AgendaFilter agendaFilter)
Fire all items on the agenda until empty, using the given AgendaFiler |
int |
fireAllRules(AgendaFilter agendaFilter,
int fireLimit)
Fire all items on the agenda using the given AgendaFiler until empty or at most 'fireLimit' rules have fired |
int |
fireAllRules(int fireLimit)
Fire all items on the agenda until empty or at most 'fireLimit' rules have fired |
Agenda |
getAgenda()
Returns the Agenda for this WorkingMemory. |
org.drools.runtime.Environment |
getEnvironment()
|
FactHandle |
getFactHandle(Object object)
Retrieve the FactHandle associated with an Object. |
FactHandle |
getFactHandleByIdentity(Object object)
|
Object |
getGlobal(String identifier)
Retrieve a specific instance of global data by identifier |
GlobalResolver |
getGlobalResolver()
Returns the current GlobalResolver |
Object |
getObject(org.drools.runtime.rule.FactHandle handle)
Retrieve the object associated with a FactHandle . |
org.drools.runtime.process.ProcessInstance |
getProcessInstance(long id)
Returns the process instance with the given id. |
Collection<org.drools.runtime.process.ProcessInstance> |
getProcessInstances()
Returns the list of process instances of this working memory. |
QueryResults |
getQueryResults(String query,
Object... arguments)
Retrieve the QueryResults of the specified query and arguments |
RuleBase |
getRuleBase()
Retrieve the RuleBase for this working memory. |
org.drools.time.SessionClock |
getSessionClock()
Returns the session clock instance associated with this session |
WorkingMemoryEntryPoint |
getWorkingMemoryEntryPoint(String id)
Returns the interface instance for a given entry point, so that the application can manage entry-point-scoped facts. |
org.drools.runtime.process.WorkItemManager |
getWorkItemManager()
|
void |
halt()
Stops rule firing after the current rule finishes executing |
Iterator<?> |
iterateFactHandles()
Returns an Iterator for the FactHandles in the Working Memory. |
Iterator<?> |
iterateFactHandles(org.drools.runtime.ObjectFilter filter)
Returns an Iterator for the Objects in the Working Memory. |
Iterator<?> |
iterateObjects()
Returns an Iterator for the Objects in the Working Memory. |
Iterator<?> |
iterateObjects(org.drools.runtime.ObjectFilter filter)
Returns an Iterator for the Objects in the Working Memory. |
void |
setAsyncExceptionHandler(AsyncExceptionHandler handler)
Sets the AsyncExceptionHandler to handle exceptions thrown by the Agenda Scheduler used for duration rules. |
void |
setFocus(String focus)
Set the focus to the specified AgendaGroup |
void |
setGlobal(String identifier,
Object value)
Set a specific instance as a global in this working memory. |
void |
setGlobalResolver(GlobalResolver globalResolver)
Sets the GlobalResolver instance to be used when resolving globals, replaces the current GlobalResolver. |
org.drools.runtime.process.ProcessInstance |
startProcess(String processId)
Starts a new process instance for the process with the given id. |
org.drools.runtime.process.ProcessInstance |
startProcess(String processId,
Map<String,Object> parameters)
Starts a new process instance for the process with the given id. |
Methods inherited from interface org.drools.WorkingMemoryEventManager |
---|
addEventListener, addEventListener, getAgendaEventListeners, getWorkingMemoryEventListeners, removeEventListener, removeEventListener |
Methods inherited from interface org.drools.RuleBaseEventManager |
---|
addEventListener, getRuleBaseEventListeners, removeEventListener |
Methods inherited from interface org.drools.WorkingMemoryEntryPoint |
---|
dispose, insert, insert, retract, update |
Methods inherited from interface org.drools.runtime.rule.WorkingMemoryEntryPoint |
---|
getEntryPointId, getFactCount, getFactHandles, getFactHandles, getObjects, getObjects |
Method Detail |
---|
Agenda getAgenda()
void setGlobal(String identifier, Object value)
identifier
- the identifier under which to populate the datavalue
- the global value, cannot be nullObject getGlobal(String identifier)
org.drools.runtime.Environment getEnvironment()
void setGlobalResolver(GlobalResolver globalResolver)
globalResolver
- GlobalResolver getGlobalResolver()
RuleBase getRuleBase()
RuleBase
for this working memory.
RuleBase
.int fireAllRules() throws FactException
FactException
- If a RuntimeException error occurs.int fireAllRules(AgendaFilter agendaFilter) throws FactException
FactException
- If a RuntimeException error occurs.int fireAllRules(int fireLimit) throws FactException
FactException
- If a RuntimeException error occurs.int fireAllRules(AgendaFilter agendaFilter, int fireLimit) throws FactException
FactException
- If a RuntimeException error occurs.Object getObject(org.drools.runtime.rule.FactHandle handle)
FactHandle
.
getObject
in interface org.drools.runtime.rule.WorkingMemoryEntryPoint
handle
- The fact handle.
FactHandle getFactHandle(Object object)
FactHandle
associated with an Object.
getFactHandle
in interface org.drools.runtime.rule.WorkingMemoryEntryPoint
object
- The object.
FactHandle getFactHandleByIdentity(Object object)
Iterator<?> iterateObjects()
Iterator<?> iterateObjects(org.drools.runtime.ObjectFilter filter)
filter
-
Iterator<?> iterateFactHandles()
Iterator<?> iterateFactHandles(org.drools.runtime.ObjectFilter filter)
filter
-
void setFocus(String focus)
focus
- QueryResults getQueryResults(String query, Object... arguments)
query
- The name of the query.arguments
- The arguments used for the query
IllegalArgumentException
- if no query named "query" is found in the rulebasevoid setAsyncExceptionHandler(AsyncExceptionHandler handler)
handler
- void clearAgenda()
void clearAgendaGroup(String group)
void clearActivationGroup(String group)
group
- void clearRuleFlowGroup(String group)
group
- org.drools.runtime.process.ProcessInstance startProcess(String processId)
org.drools.runtime.process.ProcessInstance startProcess(String processId, Map<String,Object> parameters)
Collection<org.drools.runtime.process.ProcessInstance> getProcessInstances()
org.drools.runtime.process.ProcessInstance getProcessInstance(long id)
org.drools.runtime.process.WorkItemManager getWorkItemManager()
void halt()
WorkingMemoryEntryPoint getWorkingMemoryEntryPoint(String id)
id
- the id of the entry point, as defined in the rules file
org.drools.time.SessionClock getSessionClock()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |