org.drools
Class MockWorkingMemory

java.lang.Object
  extended byorg.drools.MockWorkingMemory
All Implemented Interfaces:
java.io.Serializable, WorkingMemory

public class MockWorkingMemory
extends java.lang.Object
implements WorkingMemory

See Also:
Serialized Form
 

Constructor Summary
MockWorkingMemory()
           
 
Method Summary
 void addEventListener(WorkingMemoryEventListener listener)
          add event listener to listeners ArrayList
 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
 boolean containsObject(FactHandle handle)
          Determine if an object is associated with a FactHandle.
 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
 java.lang.Object getApplicationData(java.lang.String name)
          Retrieve a specific piece of application data by name
 java.util.Map getApplicationDataMap()
          Retrieve all of the set application data in this memory
 java.util.List getEventListeners()
          Returns a read-only list of listeners
 FactHandle getFactHandle(java.lang.Object object)
          Retrieve the FactHandle associated with an Object.
 java.util.List getFactHandles()
          Retrieve all known Fact Handles.
 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 cls)
          Retrieve all known objects of the specified class.
 RuleBase getRuleBase()
          Retrieve the RuleBase of this working memory.
 void modifyObject(FactHandle handle, java.lang.Object object)
          Modify a fact.
 void removeEventListener(WorkingMemoryEventListener listener)
          remove event listener from listeners ArrayList
 void retractObject(FactHandle handle)
          Retract a fact.
 void setApplicationData(java.lang.String name, java.lang.Object value)
          Set a specific piece of application data in this working memory
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MockWorkingMemory

public MockWorkingMemory()
Method Detail

addEventListener

public void addEventListener(WorkingMemoryEventListener listener)
add event listener to listeners ArrayList

Specified by:
addEventListener in interface WorkingMemory
Parameters:
listener -

removeEventListener

public void removeEventListener(WorkingMemoryEventListener listener)
remove event listener from listeners ArrayList

Specified by:
removeEventListener in interface WorkingMemory
Parameters:
listener -

getEventListeners

public java.util.List getEventListeners()
Returns a read-only list of listeners

Specified by:
getEventListeners in interface WorkingMemory
Returns:
listeners

getApplicationDataMap

public java.util.Map getApplicationDataMap()
Retrieve all of the set application data in this memory

Specified by:
getApplicationDataMap in interface WorkingMemory
Returns:
the application data as a Map

setApplicationData

public void setApplicationData(java.lang.String name,
                               java.lang.Object value)
Set a specific piece of application data in this working memory

Specified by:
setApplicationData in interface WorkingMemory
Parameters:
name - the name under which to populate the data
value - the application data

getApplicationData

public java.lang.Object getApplicationData(java.lang.String name)
Retrieve a specific piece of application data by name

Specified by:
getApplicationData in interface WorkingMemory
Returns:
application data or null if nothing is set under this name

clearAgenda

public void clearAgenda()
Clear the Agenda

Specified by:
clearAgenda in interface WorkingMemory

getRuleBase

public RuleBase getRuleBase()
Description copied from interface: WorkingMemory
Retrieve the RuleBase of this working memory.

Specified by:
getRuleBase in interface WorkingMemory
Returns:
The RuleBase.

fireAllRules

public void fireAllRules()
                  throws FactException
Description copied from interface: WorkingMemory
Fire all items on the agenda until empty.

Specified by:
fireAllRules in interface WorkingMemory
Throws:
FactException

fireAllRules

public void fireAllRules(AgendaFilter agendaFilter)
                  throws FactException
Description copied from interface: WorkingMemory
Fire all items on the agenda until empty, using the given AgendaFiler

Specified by:
fireAllRules in interface WorkingMemory
Throws:
FactException

getObject

public java.lang.Object getObject(FactHandle handle)
                           throws NoSuchFactObjectException
Description copied from interface: WorkingMemory
Retrieve the object associated with a FactHandle.

Specified by:
getObject in interface WorkingMemory
Throws:
NoSuchFactObjectException
Parameters:
handle - The fact handle.
Returns:
The associated object.
See Also:
WorkingMemory.containsObject(org.drools.FactHandle)

getFactHandle

public FactHandle getFactHandle(java.lang.Object object)
                         throws NoSuchFactHandleException
Description copied from interface: WorkingMemory
Retrieve the FactHandle associated with an Object.

Specified by:
getFactHandle in interface WorkingMemory
Throws:
NoSuchFactHandleException
Parameters:
object - The object.
Returns:
The associated fact handle.
See Also:
WorkingMemory.containsObject(org.drools.FactHandle)

getObjects

public java.util.List getObjects()
Description copied from interface: WorkingMemory
Retrieve all known objects.

Specified by:
getObjects in interface WorkingMemory
Returns:
The list of all known objects.

getObjects

public java.util.List getObjects(java.lang.Class cls)
Description copied from interface: WorkingMemory
Retrieve all known objects of the specified class.

Specified by:
getObjects in interface WorkingMemory
Parameters:
cls - The class of object to return.
Returns:
The list of all known objects of the specified class.

getFactHandles

public java.util.List getFactHandles()
Description copied from interface: WorkingMemory
Retrieve all known Fact Handles.

Specified by:
getFactHandles in interface WorkingMemory
Returns:
The list of all known fact handles.

containsObject

public boolean containsObject(FactHandle handle)
Description copied from interface: WorkingMemory
Determine if an object is associated with a FactHandle.

Specified by:
containsObject in interface WorkingMemory
Parameters:
handle - The fact handle.
Returns:
true if an object is known to be associated with the specified handle, otherwise false.

assertObject

public FactHandle assertObject(java.lang.Object object)
                        throws FactException
Description copied from interface: WorkingMemory
Assert a fact.

Specified by:
assertObject in interface WorkingMemory
Throws:
FactException
Parameters:
object - The fact object.
Returns:
The new fact-handle associated with the object.

assertObject

public FactHandle assertObject(java.lang.Object object,
                               boolean dynamic)
                        throws FactException
Description copied from interface: WorkingMemory
Assert a fact registering JavaBean PropertyChangeListeners on the Object to automatically trigger modifyObject calls if dynamic is true.

Specified by:
assertObject in interface WorkingMemory
Throws:
FactException
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.

retractObject

public void retractObject(FactHandle handle)
                   throws FactException
Description copied from interface: WorkingMemory
Retract a fact.

Specified by:
retractObject in interface WorkingMemory
Throws:
FactException
Parameters:
handle - The fact-handle associated with the fact to retract.

modifyObject

public void modifyObject(FactHandle handle,
                         java.lang.Object object)
                  throws FactException
Description copied from interface: WorkingMemory
Modify a fact.

Specified by:
modifyObject in interface WorkingMemory
Throws:
FactException
Parameters:
handle - The fact-handle associated with the fact to modify.
object - The new value of the fact.