Java Doc for WorkingMemory.java in  » Rule-Engine » drolls-Rule-Engine » org » drools » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Rule Engine » drolls Rule Engine » org.drools 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.drools.WorkingMemory

WorkingMemory
public interface WorkingMemory extends EventManager(Code)
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
public  voidclearActivationGroup(String group)
    
 voidclearAgenda()
     Clear the Agenda.
public  voidclearAgendaGroup(String group)
     Clear the Agenda Group, cancelling all its Activations.
public  voidclearRuleFlowGroup(String group)
    
 voidfireAllRules()
     Fire all items on the agenda until empty.
 voidfireAllRules(AgendaFilter agendaFilter)
    
 voidfireAllRules(int fireLimit)
    
 voidfireAllRules(AgendaFilter agendaFilter, int fireLimit)
    
public  AgendagetAgenda()
     Returns the Agenda for this WorkingMemory.
 FactHandlegetFactHandle(Object object)
     Retrieve the FactHandle associated with an Object.
Parameters:
  object - The object.
public  AgendaGroupgetFocus()
     Returns the AgendaGroup which has the current WorkingMemory focus.
 ObjectgetGlobal(String identifier)
    
 GlobalResolvergetGlobalResolver()
    
 ObjectgetObject(FactHandle handle)
     Retrieve the object associated with a FactHandle.
Parameters:
  handle - The fact handle.
public  QueryResultsgetQueryResults(String query)
     Retrieve the QueryResults of the specified query.
Parameters:
  query - The name of the query.
public  QueryResultsgetQueryResults(String query, Object[] arguments)
    
 RuleBasegetRuleBase()
     Retrieve the RuleBase for this working memory.
public  voidhalt()
    
 FactHandleinsert(Object object)
     Assert a fact.
Parameters:
  object - The fact object.
 FactHandleinsert(Object object, boolean dynamic)
     Insert a fact registering JavaBean PropertyChangeListeners on the Object to automatically trigger update calls if dynamic is true.
Parameters:
  object - The fact object.
Parameters:
  dynamic - true if Drools should add JavaBeanPropertyChangeListeners to the object.
 IteratoriterateFactHandles()
     Returns an Iterator for the FactHandles in the Working Memory.
 IteratoriterateFactHandles(ObjectFilter filter)
     Returns an Iterator for the Objects in the Working Memory.
 IteratoriterateObjects()
     Returns an Iterator for the Objects in the Working Memory.
 IteratoriterateObjects(ObjectFilter filter)
     Returns an Iterator for the Objects in the Working Memory.
public  voidmodifyInsert(FactHandle factHandle, Object object)
    
public  voidmodifyRetract(FactHandle factHandle)
    
 voidretract(FactHandle handle)
     Retract a fact.
 voidsetAsyncExceptionHandler(AsyncExceptionHandler handler)
     Sets the AsyncExceptionHandler to handle exceptions thrown by the Agenda Scheduler used for duration rules.
 voidsetFocus(String focus)
    
 voidsetFocus(AgendaGroup focus)
    
 voidsetGlobal(String identifier, Object value)
     Set a specific instance as a global in this working memory.
 voidsetGlobalResolver(GlobalResolver globalResolver)
     Sets the GlobalResolver instance to be used when resolving globals, replaces the current GlobalResolver.
 ProcessInstancestartProcess(String processId)
     Starts a new process instance for the process with the given id.
 voidupdate(FactHandle handle, Object object)
     Inform the WorkingMemory that a Fact has been modified and that it should now update the network.



Method Detail
clearActivationGroup
public void clearActivationGroup(String group)(Code)
Clears the Activation Group, cancellings all its Activations
Parameters:
  group -



clearAgenda
void clearAgenda()(Code)
Clear the Agenda. Iterates over each AgendaGroup cancalling all Activations.



clearAgendaGroup
public void clearAgendaGroup(String group)(Code)
Clear the Agenda Group, cancelling all its Activations.



clearRuleFlowGroup
public void clearRuleFlowGroup(String group)(Code)
Clears the RuleFlow group, cancelling all its Activations
Parameters:
  group -



fireAllRules
void fireAllRules() throws FactException(Code)
Fire all items on the agenda until empty.
throws:
  FactException - If a RuntimeException error occurs.



fireAllRules
void fireAllRules(AgendaFilter agendaFilter) throws FactException(Code)
Fire all items on the agenda until empty, using the given AgendaFiler
throws:
  FactException - If a RuntimeException error occurs.



fireAllRules
void fireAllRules(int fireLimit) throws FactException(Code)
Fire all items on the agenda until empty or at most 'fireLimit' rules have fired
throws:
  FactException - If a RuntimeException error occurs.



fireAllRules
void fireAllRules(AgendaFilter agendaFilter, int fireLimit) throws FactException(Code)
Fire all items on the agenda using the given AgendaFiler until empty or at most 'fireLimit' rules have fired
throws:
  FactException - If a RuntimeException error occurs.



getAgenda
public Agenda getAgenda()(Code)
Returns the Agenda for this WorkingMemory. While the WorkingMemory interface is considered public, the Agenda interface is more subject to change. the Agenda



getFactHandle
FactHandle getFactHandle(Object object)(Code)
Retrieve the FactHandle associated with an Object.
Parameters:
  object - The object. The associated fact handle.



getFocus
public AgendaGroup getFocus()(Code)
Returns the AgendaGroup which has the current WorkingMemory focus. The AgendaGroup interface is subject to change. the AgendaGroup



getGlobal
Object getGlobal(String identifier)(Code)
Retrieve a specific instance of global data by identifier application data or null if nothing is set under this identifier



getGlobalResolver
GlobalResolver getGlobalResolver()(Code)
Returns the current GlobalResolver



getObject
Object getObject(FactHandle handle)(Code)
Retrieve the object associated with a FactHandle.
Parameters:
  handle - The fact handle. The associated object.



getQueryResults
public QueryResults getQueryResults(String query)(Code)
Retrieve the QueryResults of the specified query.
Parameters:
  query - The name of the query. The QueryResults of the specified query.If no results match the query it is empty.
throws:
  IllegalArgumentException - if no query named "query" is found in the rulebase



getQueryResults
public QueryResults getQueryResults(String query, Object[] arguments)(Code)
Retrieve the QueryResults of the specified query and arguments
Parameters:
  query - The name of the query.
Parameters:
  arguments - The arguments used for the query The QueryResults of the specified query.If no results match the query it is empty.
throws:
  IllegalArgumentException - if no query named "query" is found in the rulebase



getRuleBase
RuleBase getRuleBase()(Code)
Retrieve the RuleBase for this working memory. The RuleBase.



halt
public void halt()(Code)
Stops rule firing after the currect rule finishes executing



insert
FactHandle insert(Object object) throws FactException(Code)
Assert a fact.
Parameters:
  object - The fact object. The new fact-handle associated with the object.
throws:
  FactException - If a RuntimeException error occurs.



insert
FactHandle insert(Object object, boolean dynamic) throws FactException(Code)
Insert a fact registering JavaBean PropertyChangeListeners on the Object to automatically trigger update calls if dynamic is true.
Parameters:
  object - The fact object.
Parameters:
  dynamic - true if Drools should add JavaBeanPropertyChangeListeners to the object. The new fact-handle associated with the object.
throws:
  FactException - If a RuntimeException error occurs.



iterateFactHandles
Iterator iterateFactHandles()(Code)
Returns an Iterator for the FactHandles in the Working Memory. This Iterator is not thread safe. the Iterator



iterateFactHandles
Iterator iterateFactHandles(ObjectFilter filter)(Code)
Returns an Iterator for the Objects in the Working Memory. This Iterator will filter out any objects that the ObjectFilter does not accept. This Iterator is not thread safe.
Parameters:
  filter - the Iterator



iterateObjects
Iterator iterateObjects()(Code)
Returns an Iterator for the Objects in the Working Memory. This Iterator is not thread safe. the Iterator



iterateObjects
Iterator iterateObjects(ObjectFilter filter)(Code)
Returns an Iterator for the Objects in the Working Memory. This Iterator will filter out any objects that the ObjectFilter does not accept. This Iterator is not thread safe.
Parameters:
  filter - the Iterator



modifyInsert
public void modifyInsert(FactHandle factHandle, Object object)(Code)

Parameters:
  factHandle -
Parameters:
  object -



modifyRetract
public void modifyRetract(FactHandle factHandle)(Code)

Parameters:
  factHandle -



retract
void retract(FactHandle handle) throws FactException(Code)
Retract a fact.
Parameters:
  handle - The fact-handle associated with the fact to retract.
throws:
  FactException - If a RuntimeException error occurs.



setAsyncExceptionHandler
void setAsyncExceptionHandler(AsyncExceptionHandler handler)(Code)
Sets the AsyncExceptionHandler to handle exceptions thrown by the Agenda Scheduler used for duration rules.
Parameters:
  handler -



setFocus
void setFocus(String focus)(Code)
Set the focus to the specified AgendaGroup
Parameters:
  focus -



setFocus
void setFocus(AgendaGroup focus)(Code)
Set the focus to the specified AgendaGroup
Parameters:
  focus -



setGlobal
void setGlobal(String identifier, Object value)(Code)
Set a specific instance as a global in this working memory. Null values will return doing nothing. The global identifier and its type must be declared in the drl.
Parameters:
  identifier - the identifier under which to populate the data
Parameters:
  value - the global value, cannot be null



setGlobalResolver
void setGlobalResolver(GlobalResolver globalResolver)(Code)
Sets the GlobalResolver instance to be used when resolving globals, replaces the current GlobalResolver. Typcicaly a delegating GlobalResolver is created that first gets a reference to the current GlobalResolver, for delegating
Parameters:
  globalResolver -



startProcess
ProcessInstance startProcess(String processId)(Code)
Starts a new process instance for the process with the given id.



update
void update(FactHandle handle, Object object) throws FactException(Code)
Inform the WorkingMemory that a Fact has been modified and that it should now update the network.
Parameters:
  handle - The fact-handle associated with the fact to modify.
Parameters:
  object - The new value of the fact.
throws:
  FactException - If a RuntimeException error occurs.



www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.