当前页面: 在线文档首页 > JBoss RULES 3.0.6 API 英文版文档

WorkingMemory - JBoss RULES 3.0.6 API 英文版文档

Overview  Package   Class  Tree  Deprecated  Index  Help
PREV CLASS   NEXT CLASS	FRAMES    NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.drools
Interface WorkingMemory

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

InternalWorkingMemoryActions

All Known Implementing Classes:

AbstractWorkingMemory, ReteooWorkingMemory, SynchronizedWorkingMemory

---

public interface WorkingMemory
extends java.io.Serializable

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	addEventListener(AgendaEventListener listener)           Add an event listener.
void	addEventListener(WorkingMemoryEventListener listener)           Add an event listener.
FactHandle	assertObject(java.lang.Object object)           Assert a fact.
FactHandle	assertObject(java.lang.Object object, boolean dynamic)           Assert a fact registering JavaBean PropertyChangeListeners on the Object to automatically trigger modifyObject calls if dynamic is true.
void	clearAgenda()           Clear the Agenda
void	clearAgendaGroup(java.lang.String group)           Clear the Agenda Group
void	dispose()           Forces the workingMemory to be derefenced from
void	fireAllRules()           Fire all items on the agenda until empty.
void	fireAllRules(AgendaFilter agendaFilter)           Fire all items on the agenda until empty, using the given AgendaFiler
Agenda	getAgenda()
java.util.List	getAgendaEventListeners()           Returns all event listeners.
FactHandle	getFactHandle(java.lang.Object object)           Retrieve the FactHandle associated with an Object.
java.util.List	getFactHandles()           Retrieve all known Fact Handles.
AgendaGroup	getFocus()
java.lang.Object	getGlobal(java.lang.String name)           Retrieve a specific piece of global data by name
java.util.Map	getGlobals()           Retrieve all of the set application data in this memory
java.lang.Object	getObject(FactHandle handle)           Retrieve the object associated with a FactHandle.
java.util.List	getObjects()           Retrieve all known objects.
java.util.List	getObjects(java.lang.Class objectClass)           Retrieve all known objects of the specified class.
QueryResults	getQueryResults(java.lang.String query)           Retrieve the QueryResults of the specified query.
RuleBase	getRuleBase()           Retrieve the RuleBase of this working memory.
java.util.List	getWorkingMemoryEventListeners()           Returns all event listeners.
void	modifyObject(FactHandle handle, java.lang.Object object)           Modify a fact.
void	removeEventListener(AgendaEventListener listener)           Remove an event listener.
void	removeEventListener(WorkingMemoryEventListener listener)           Remove an event listener.
void	retractObject(FactHandle handle)           Retract a fact.
void	setAsyncExceptionHandler(AsyncExceptionHandler handler)           Sets the AsyncExceptionHandler to handle exceptions thrown by the Agenda Scheduler used for duration rules.
void	setFocus(AgendaGroup focus)
void	setFocus(java.lang.String focus)
void	setGlobal(java.lang.String name, java.lang.Object value)           Set a specific piece of global in this working memory.

 

Method Detail

addEventListener

void addEventListener(WorkingMemoryEventListener listener)

Add an event listener.

Parameters:

listener - The listener to add.

---

removeEventListener

void removeEventListener(WorkingMemoryEventListener listener)

Remove an event listener.

Parameters:

listener - The listener to remove.

---

getWorkingMemoryEventListeners

java.util.List getWorkingMemoryEventListeners()

Returns all event listeners.

Returns:

listeners The listeners.

---

addEventListener

void addEventListener(AgendaEventListener listener)

Add an event listener.

Parameters:

listener - The listener to add.

---

removeEventListener

void removeEventListener(AgendaEventListener listener)

Remove an event listener.

Parameters:

listener - The listener to remove.

---

getAgendaEventListeners

java.util.List getAgendaEventListeners()

Returns all event listeners.

Returns:

listeners The listeners.

---

getAgenda

Agenda getAgenda()

---

getGlobals

java.util.Map getGlobals()

Retrieve all of the set application data in this memory

Returns:

the application data as a Map

---

setGlobal

void setGlobal(java.lang.String name,
               java.lang.Object value)

Set a specific piece of global in this working memory.

Parameters:

name - the name under which to populate the data

value - the application data

---

getGlobal

java.lang.Object getGlobal(java.lang.String name)

Retrieve a specific piece of global data by name

Returns:

application data or null if nothing is set under this name

---

getRuleBase

RuleBase getRuleBase()

Retrieve the RuleBase of this working memory.

Returns:

The RuleBase.

---

fireAllRules

void fireAllRules()
                  throws FactException

Fire all items on the agenda until empty.

Throws:

FactException - If an error occurs.

---

fireAllRules

void fireAllRules(AgendaFilter agendaFilter)
                  throws FactException

Fire all items on the agenda until empty, using the given AgendaFiler

Throws:

FactException - If an error occurs.

---

getObject

java.lang.Object getObject(FactHandle handle)
                           throws NoSuchFactObjectException

Retrieve the object associated with a FactHandle.

Parameters:

handle - The fact handle.

Returns:

The associated object.

Throws:

NoSuchFactObjectException - If no object is known to be associated with the specified handle.

See Also:

#containsObject

---

getFactHandle

FactHandle getFactHandle(java.lang.Object object)
                         throws NoSuchFactHandleException

Retrieve the FactHandle associated with an Object.

Parameters:

object - The object.

Returns:

The associated fact handle.

Throws:

NoSuchFactHandleException - If no handle is known to be associated with the specified object.

See Also:

#containsObject

---

getObjects

java.util.List getObjects()

Retrieve all known objects.

Returns:

The list of all known objects.

---

getFocus

AgendaGroup getFocus()

---

setFocus

void setFocus(java.lang.String focus)

---

setFocus

void setFocus(AgendaGroup focus)

---

getObjects

java.util.List getObjects(java.lang.Class objectClass)

Retrieve all known objects of the specified class.

Parameters:

objectClass - The class of object to return.

Returns:

The list of all known objects of the specified class.

---

getFactHandles

java.util.List getFactHandles()

Retrieve all known Fact Handles.

Returns:

The list of all known fact handles.

---

assertObject

FactHandle assertObject(java.lang.Object object)
                        throws FactException

Assert a fact.

Parameters:

object - The fact object.

Returns:

The new fact-handle associated with the object.

Throws:

FactException - If an error occurs.

---

getQueryResults

QueryResults getQueryResults(java.lang.String query)

Retrieve the QueryResults of the specified query.

Parameters:

query - The name of the query.

Returns:

The QueryResults of the specified query. If no results match the query it is empty.

Throws:

java.lang.IllegalArgumentException - if no query named "query" is found in the rulebase

---

assertObject

FactHandle assertObject(java.lang.Object object,
                        boolean dynamic)
                        throws FactException

Assert a fact registering JavaBean PropertyChangeListeners on the Object to automatically trigger modifyObject calls if dynamic is true.

Parameters:

object - The fact object.

dynamic - true if Drools should add JavaBean PropertyChangeListeners to the object.

Returns:

The new fact-handle associated with the object.

Throws:

FactException - If an error occurs.

---

retractObject

void retractObject(FactHandle handle)
                   throws FactException

Retract a fact.

Parameters:

handle - The fact-handle associated with the fact to retract.

Throws:

FactException - If an error occurs.

---

modifyObject

void modifyObject(FactHandle handle,
                  java.lang.Object object)
                  throws FactException

Modify a fact.

Parameters:

handle - The fact-handle associated with the fact to modify.

object - The new value of the fact.

Throws:

FactException - If an error occurs.

---

setAsyncExceptionHandler

void setAsyncExceptionHandler(AsyncExceptionHandler handler)

Sets the AsyncExceptionHandler to handle exceptions thrown by the Agenda Scheduler used for duration rules.

Parameters:

handler -

---

clearAgenda

void clearAgenda()

Clear the Agenda

---

clearAgendaGroup

void clearAgendaGroup(java.lang.String group)

Clear the Agenda Group

---

dispose

void dispose()

Forces the workingMemory to be derefenced from

---

Overview  Package   Class  Tree  Deprecated  Index  Help
PREV CLASS   NEXT CLASS	FRAMES    NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---