[jboss-svn-commits] JBL Code SVN: r14975 - labs/jbossrules/trunk/documentation/manual/en/Chapter-Rule_Engine.

[jboss-svn-commits at lists.jboss.org]

Author: mark.proctor at jboss.com
Date: 2007-09-09 17:54:42 -0400 (Sun, 09 Sep 2007)
New Revision: 14975

Modified:
   labs/jbossrules/trunk/documentation/manual/en/Chapter-Rule_Engine/Section-The_Drools_Rule_Engine.xml
   labs/jbossrules/trunk/documentation/manual/en/Chapter-Rule_Engine/StatelessSession.png
   labs/jbossrules/trunk/documentation/manual/en/Chapter-Rule_Engine/StatelessSessionResult.png
Log:
JBRULES-1165 StatelessSessionResult should have getGlobal
-updated docs.

Modified: labs/jbossrules/trunk/documentation/manual/en/Chapter-Rule_Engine/Section-The_Drools_Rule_Engine.xml
===================================================================
--- labs/jbossrules/trunk/documentation/manual/en/Chapter-Rule_Engine/Section-The_Drools_Rule_Engine.xml	2007-09-09 17:21:37 UTC (rev 14974)
+++ labs/jbossrules/trunk/documentation/manual/en/Chapter-Rule_Engine/Section-The_Drools_Rule_Engine.xml	2007-09-09 21:54:42 UTC (rev 14975)
@@ -694,6 +694,41 @@
     <para>StatelessSessions also support sequential mode, which is a special
     optimised mode that uses less memory and executes faster; please see the
     Sequential section for more details.</para>
+
+    <figure>
+      <title>StatelessSessionResult</title>
+
+      <mediaobject>
+        <imageobject>
+          <imagedata align="center" fileref="StatelessSessionResult.svg"
+                     format="SVG" />
+        </imageobject>
+
+        <imageobject>
+          <imagedata align="center" fileref="StatelessSessionResult.png"
+                     format="PNG" />
+        </imageobject>
+      </mediaobject>
+    </figure>
+
+    <para>StatelessSession.executeWithResults(....) returns a minimal api to
+    examine the sessions data. The inserted Objects can be iterated over,
+    querries can be executed and globals retrieved. Once the
+    StatelessSessionResult is serialised it loses the reference to the
+    underlying WorkingMemory and RuleBase, so querries can no longer be
+    executed, however globals can still be retrieved and objects iterated. To
+    retrieve globals they must be exported from the StatelessSession; the
+    GlobalExporter strategy is set with StatelessSession.setGlobalExporter(
+    GlobalExporter globalExporter ). Two implementations of GlobalExporter are
+    available and users may implement their own strategies.
+    CopyIdentifiersGlobalExporter copies named identifiers into a new
+    GlobalResovler that is passed to the StatelessSessionResult; the
+    constructor takes a String[] array of identifiers, if no identifiers are
+    specified it copies all identifiers declaredin the RuleBase.
+    ReferenceOriginalGlobalExporter just passes a reference to the original
+    Global Resolver; the later should be used with care as identifier
+    instances can be changed at any time by the StatelessSession and the
+    GlobalResolver may not be serialisable freindly.</para>
   </section>
 
   <section>

Modified: labs/jbossrules/trunk/documentation/manual/en/Chapter-Rule_Engine/StatelessSession.png
===================================================================
(Binary files differ)

Modified: labs/jbossrules/trunk/documentation/manual/en/Chapter-Rule_Engine/StatelessSessionResult.png
===================================================================
(Binary files differ)