[jboss-svn-commits] JBL Code SVN: r33413 - in labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US: Chapter-Commands and 2 other directories.
jboss-svn-commits at lists.jboss.org
jboss-svn-commits at lists.jboss.org
Tue Jun 8 21:14:06 EDT 2010
Author: lucazamador
Date: 2010-06-08 21:14:05 -0400 (Tue, 08 Jun 2010)
New Revision: 33413
Added:
labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/
labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Chapter-Commands.xml
labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-API/
labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-API/Section-API.xml
labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/
labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-AbortWorkItemCommand.xml
labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-BatchExecutionCommand.xml
labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-Commands.xml
labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-CompleteWorkItemCommand.xml
labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-FireAllRulesCommand.xml
labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-GetGlobalCommand.xml
labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-GetObjectCommand.xml
labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-GetObjectsCommand.xml
labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-InsertElementsCommand.xml
labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-InsertObjectCommand.xml
labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-ModifyCommand.xml
labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-QueryCommand.xml
labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-RetractCommand.xml
labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-SetGlobalCommand.xml
labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-SignalEventCommand.xml
labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-StartProcessCommand.xml
Modified:
labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/master.xml
Log:
JBRULES-2542: Drools Commands documentation
- added commands using XStream and JSON
Added: labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Chapter-Commands.xml
===================================================================
--- labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Chapter-Commands.xml (rev 0)
+++ labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Chapter-Commands.xml 2010-06-09 01:14:05 UTC (rev 33413)
@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter version="5.0" xmlns="http://docbook.org/ns/docbook"
+ xmlns:xlink="http://www.w3.org/1999/xlink"
+ xmlns:xi="http://www.w3.org/2001/XInclude"
+ xmlns:svg="http://www.w3.org/2000/svg"
+ xmlns:m="http://www.w3.org/1998/Math/MathML"
+ xmlns:html="http://www.w3.org/1999/xhtml"
+ xmlns:db="http://docbook.org/ns/docbook">
+ <title>Drools Commands</title>
+
+ <xi:include href="Section-API/Section-API.xml" />
+
+ <xi:include href="Section-Commands/Section-Commands.xml" />
+
+</chapter>
Property changes on: labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Chapter-Commands.xml
___________________________________________________________________
Name: svn:eol-style
+ native
Added: labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-API/Section-API.xml
===================================================================
--- labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-API/Section-API.xml (rev 0)
+++ labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-API/Section-API.xml 2010-06-09 01:14:05 UTC (rev 33413)
@@ -0,0 +1,69 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<section version="5.0" xmlns="http://docbook.org/ns/docbook"
+ xmlns:xlink="http://www.w3.org/1999/xlink"
+ xmlns:xi="http://www.w3.org/2001/XInclude"
+ xmlns:svg="http://www.w3.org/2000/svg"
+ xmlns:m="http://www.w3.org/1998/Math/MathML"
+ xmlns:html="http://www.w3.org/1999/xhtml"
+ xmlns:db="http://docbook.org/ns/docbook">
+
+ <title>API</title>
+
+ <para>XML marshalling/unmarshalling of the Drools Commands have to use
+ special classes that are going to be described in the next
+ sections.</para>
+
+ <section>
+ <title>XStream</title>
+
+ <para>To use the XStream commands marshaller you need to use the
+ DroolsHelperProvider to obtain a XStream instance. We need to use this
+ because has the commands converters registered.</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Marshalling</para>
+
+ <para>BatchExecutionHelperProviderImpl.newXStreamMarshaller().toXML(command);</para>
+ </listitem>
+
+ <listitem>
+ <para>Unmarshalling</para>
+
+ <para>BatchExecutionHelperProviderImpl.newXStreamMarshaller().fromXML(xml)</para>
+ </listitem>
+ </itemizedlist>
+
+ <para></para>
+ </section>
+
+ <section>
+ <title>JSON</title>
+
+ <para>The JSON API are similar to the XStream, you only need to know the
+ next:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Marshalling</para>
+
+ <para>BatchExecutionHelper.newJSonMarshaller().toXML(command);</para>
+ </listitem>
+
+ <listitem>
+ <para>Unmarshalling</para>
+
+ <para>BatchExecutionHelper.newJSonMarshaller().fromXML(xml)</para>
+ </listitem>
+ </itemizedlist>
+
+ <para></para>
+ </section>
+
+ <section>
+ <title>JAXB</title>
+
+ <para>TODO</para>
+ </section>
+
+</section>
Property changes on: labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-API/Section-API.xml
___________________________________________________________________
Name: svn:eol-style
+ native
Added: labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-AbortWorkItemCommand.xml
===================================================================
--- labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-AbortWorkItemCommand.xml (rev 0)
+++ labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-AbortWorkItemCommand.xml 2010-06-09 01:14:05 UTC (rev 33413)
@@ -0,0 +1,97 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<section version="5.0" xmlns="http://docbook.org/ns/docbook"
+ xmlns:xlink="http://www.w3.org/1999/xlink"
+ xmlns:xi="http://www.w3.org/2001/XInclude"
+ xmlns:svg="http://www.w3.org/2000/svg"
+ xmlns:m="http://www.w3.org/1998/Math/MathML"
+ xmlns:html="http://www.w3.org/1999/xhtml"
+ xmlns:db="http://docbook.org/ns/docbook">
+ <title>AbortWorkItemCommand</title>
+
+ <para></para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Description: Allow abort an WorkItem. The same as
+ session.getWorkItemManager().abortWorkItem(workItemId)</para>
+ </listitem>
+
+ <listitem>
+ <para>Attributes</para>
+
+ <table>
+ <title>AbortWorkItemCommand attributes</title>
+
+ <tgroup cols="3">
+ <colspec align="center" />
+
+ <thead>
+ <row>
+ <entry align="center">Name</entry>
+
+ <entry align="center">Description</entry>
+
+ <entry align="center">required</entry>
+ </row>
+ </thead>
+
+ <tbody>
+ <row>
+ <entry>workItemId</entry>
+
+ <entry>The ID of the WorkItem to be completed</entry>
+
+ <entry>true</entry>
+ </row>
+
+ </tbody>
+ </tgroup>
+ </table>
+ </listitem>
+
+ <listitem>
+ <para>Command creation<programlisting>BatchExecutionCommand command = new BatchExecutionCommand();
+command.setLookup("ksession1");
+AbortWorkItemCommand abortWorkItemCommand = new AbortWorkItemCommand();
+abortWorkItemCommand.setWorkItemId(1001);
+command.getCommands().add(abortWorkItemCommand);
+String xml = BatchExecutionHelper.newXStreamMarshaller().toXML(command);</programlisting></para>
+
+ <para></para>
+ </listitem>
+
+ <listitem>
+ <para>XML output</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>XStream</para>
+
+ <para><programlisting><batch-execution lookup="ksession1">
+ <abort-work-item id="1001"/>
+</batch-execution></programlisting></para>
+
+ <para></para>
+ </listitem>
+
+ <listitem>
+ <para>JSON</para>
+
+ <para><programlisting>{"batch-execution":{"lookup":"ksession1","commands":{"abort-work-item":{"id":1001}}}} </programlisting></para>
+
+ <para></para>
+ </listitem>
+
+ <listitem>
+ <para>JAXB</para>
+
+ <para><programlisting>TODO</programlisting></para>
+
+ <para></para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </itemizedlist>
+
+ <para></para>
+</section>
Property changes on: labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-AbortWorkItemCommand.xml
___________________________________________________________________
Name: svn:eol-style
+ native
Added: labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-BatchExecutionCommand.xml
===================================================================
--- labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-BatchExecutionCommand.xml (rev 0)
+++ labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-BatchExecutionCommand.xml 2010-06-09 01:14:05 UTC (rev 33413)
@@ -0,0 +1,113 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<section version="5.0" xmlns="http://docbook.org/ns/docbook"
+ xmlns:xlink="http://www.w3.org/1999/xlink"
+ xmlns:xi="http://www.w3.org/2001/XInclude"
+ xmlns:svg="http://www.w3.org/2000/svg"
+ xmlns:m="http://www.w3.org/1998/Math/MathML"
+ xmlns:html="http://www.w3.org/1999/xhtml"
+ xmlns:db="http://docbook.org/ns/docbook">
+ <title>BatchExecutionCommand</title>
+
+ <para></para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Description: The main command, used to group a set of commands to
+ are going to be executed.</para>
+ </listitem>
+
+ <listitem>
+ <para>Attributes</para>
+
+ <table>
+ <title>BatchExecutionCommand attributes</title>
+
+ <tgroup cols="3">
+ <colspec align="center" />
+
+ <thead>
+ <row>
+ <entry align="center">Name</entry>
+
+ <entry align="center">Description</entry>
+
+ <entry align="center">required</entry>
+ </row>
+ </thead>
+
+ <tbody>
+ <row>
+ <entry>lookup</entry>
+
+ <entry>Sets the knowledge session id on which the commands are
+ going to be executed</entry>
+
+ <entry>true</entry>
+ </row>
+
+ <row>
+ <entry>commands</entry>
+
+ <entry>List of commands to be executed</entry>
+
+ <entry>false</entry>
+ </row>
+
+ </tbody>
+ </tgroup>
+ </table>
+ </listitem>
+
+ <listitem>
+ <para>Command creation<programlisting>BatchExecutionCommand command = new BatchExecutionCommand();
+command.setLookup("ksession1");
+InsertObjectCommand insertObjectCommand = new InsertObjectCommand(new Person("john", 25));
+FireAllRulesCommand fireAllRulesCommand = new FireAllRulesCommand();
+command.getCommands().add(insertObjectCommand);
+command.getCommands().add(fireAllRulesCommand);
+String xml = BatchExecutionHelper.newXStreamMarshaller().toXML(command);</programlisting></para>
+
+ <para></para>
+ </listitem>
+
+ <listitem>
+ <para>XML output</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>XStream</para>
+
+ <para><programlisting><batch-execution lookup="ksession1">
+ <insert>
+ <org.drools.test.Person>
+ <name>john</name>
+ <age>25</age>
+ </org.drools.test.Person>
+ </insert>
+ <fire-all-rules/>
+</batch-execution></programlisting></para>
+
+ <para></para>
+ </listitem>
+
+ <listitem>
+ <para>JSON</para>
+
+ <para><programlisting>{"batch-execution":{"lookup":"ksession1","commands":[{"insert":{"object":{"org.drools.test.Person":{"name":"john","age":25}}}},{"fire-all-rules":""}]}} </programlisting></para>
+
+ <para></para>
+ </listitem>
+
+ <listitem>
+ <para>JAXB</para>
+
+ <para><programlisting>TODO</programlisting></para>
+
+ <para></para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </itemizedlist>
+
+ <para></para>
+</section>
Property changes on: labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-BatchExecutionCommand.xml
___________________________________________________________________
Name: svn:eol-style
+ native
Added: labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-Commands.xml
===================================================================
--- labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-Commands.xml (rev 0)
+++ labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-Commands.xml 2010-06-09 01:14:05 UTC (rev 33413)
@@ -0,0 +1,123 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<section version="5.0" xmlns="http://docbook.org/ns/docbook"
+ xmlns:xlink="http://www.w3.org/1999/xlink"
+ xmlns:xi="http://www.w3.org/2001/XInclude"
+ xmlns:svg="http://www.w3.org/2000/svg"
+ xmlns:m="http://www.w3.org/1998/Math/MathML"
+ xmlns:html="http://www.w3.org/1999/xhtml"
+ xmlns:db="http://docbook.org/ns/docbook">
+ <title>Commands supported</title>
+
+ <para>At this moment the next commands are supported</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>BatchExecutionCommand</para>
+ </listitem>
+
+ <listitem>
+ <para>InsertObjectCommand</para>
+ </listitem>
+
+ <listitem>
+ <para>RetractCommand</para>
+ </listitem>
+
+ <listitem>
+ <para>ModifyCommand</para>
+ </listitem>
+
+ <listitem>
+ <para>GetObjectCommand</para>
+ </listitem>
+
+ <listitem>
+ <para>InsertElementsCommand</para>
+ </listitem>
+
+ <listitem>
+ <para>FireAllRulesCommand</para>
+ </listitem>
+
+ <listitem>
+ <para>StartProcessCommand</para>
+ </listitem>
+
+ <listitem>
+ <para>SignalEventCommand</para>
+ </listitem>
+
+ <listitem>
+ <para>CompleteWorkItemCommand</para>
+ </listitem>
+
+ <listitem>
+ <para>AbortWorkItemCommand</para>
+ </listitem>
+
+ <listitem>
+ <para>QueryCommand</para>
+ </listitem>
+
+ <listitem>
+ <para>SetGlobalCommand</para>
+ </listitem>
+
+ <listitem>
+ <para>GetGlobalCommand</para>
+ </listitem>
+
+ <listitem>
+ <para>GetObjectsCommand</para>
+ </listitem>
+ </itemizedlist>
+
+ <para></para>
+
+ <para><note>
+ In the next snippets code we are going to use a POJO org.drools.test.Person that have two fields
+
+ <itemizedlist>
+ <listitem>
+ <para>name: String</para>
+ </listitem>
+
+ <listitem>
+ <para>age: Integer</para>
+ </listitem>
+ </itemizedlist>
+
+
+ </note></para>
+
+ <xi:include href="Section-BatchExecutionCommand.xml" />
+
+ <xi:include href="Section-InsertObjectCommand.xml" />
+
+ <xi:include href="Section-RetractCommand.xml" />
+
+ <xi:include href="Section-ModifyCommand.xml" />
+
+ <xi:include href="Section-GetObjectCommand.xml" />
+
+ <xi:include href="Section-InsertElementsCommand.xml" />
+
+ <xi:include href="Section-FireAllRulesCommand.xml" />
+
+ <xi:include href="Section-StartProcessCommand.xml" />
+
+ <xi:include href="Section-SignalEventCommand.xml" />
+
+ <xi:include href="Section-CompleteWorkItemCommand.xml" />
+
+ <xi:include href="Section-AbortWorkItemCommand.xml" />
+
+ <xi:include href="Section-QueryCommand.xml" />
+
+ <xi:include href="Section-SetGlobalCommand.xml" />
+
+ <xi:include href="Section-GetGlobalCommand.xml" />
+
+ <xi:include href="Section-GetObjectsCommand.xml" />
+
+</section>
Property changes on: labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-Commands.xml
___________________________________________________________________
Name: svn:eol-style
+ native
Added: labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-CompleteWorkItemCommand.xml
===================================================================
--- labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-CompleteWorkItemCommand.xml (rev 0)
+++ labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-CompleteWorkItemCommand.xml 2010-06-09 01:14:05 UTC (rev 33413)
@@ -0,0 +1,104 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<section version="5.0" xmlns="http://docbook.org/ns/docbook"
+ xmlns:xlink="http://www.w3.org/1999/xlink"
+ xmlns:xi="http://www.w3.org/2001/XInclude"
+ xmlns:svg="http://www.w3.org/2000/svg"
+ xmlns:m="http://www.w3.org/1998/Math/MathML"
+ xmlns:html="http://www.w3.org/1999/xhtml"
+ xmlns:db="http://docbook.org/ns/docbook">
+ <title>CompleteWorkItemCommand</title>
+
+ <para></para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Description: Allow to complete a WorkItem.</para>
+ </listitem>
+
+ <listitem>
+ <para>Attributes</para>
+
+ <table>
+ <title>CompleteWorkItemCommand attributes</title>
+
+ <tgroup cols="3">
+ <colspec align="center" />
+
+ <thead>
+ <row>
+ <entry align="center">Name</entry>
+
+ <entry align="center">Description</entry>
+
+ <entry align="center">required</entry>
+ </row>
+ </thead>
+
+ <tbody>
+ <row>
+ <entry>workItemId</entry>
+
+ <entry>The ID of the WorkItem to be completed</entry>
+
+ <entry>true</entry>
+ </row>
+
+ <row>
+ <entry>results</entry>
+
+ <entry></entry>
+
+ <entry>false</entry>
+ </row>
+
+ </tbody>
+ </tgroup>
+ </table>
+ </listitem>
+
+ <listitem>
+ <para>Command creation<programlisting>BatchExecutionCommand command = new BatchExecutionCommand();
+command.setLookup("ksession1");
+CompleteWorkItemCommand completeWorkItemCommand = new CompleteWorkItemCommand();
+completeWorkItemCommand.setWorkItemId(1001);
+command.getCommands().add(completeWorkItemCommand);
+String xml = BatchExecutionHelper.newXStreamMarshaller().toXML(command);</programlisting></para>
+
+ <para></para>
+ </listitem>
+
+ <listitem>
+ <para>XML output</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>XStream</para>
+
+ <para><programlisting><batch-execution lookup="ksession1">
+ <complete-work-item id="1001"/>
+</batch-execution></programlisting></para>
+
+ <para></para>
+ </listitem>
+
+ <listitem>
+ <para>JSON</para>
+
+ <para><programlisting>{"batch-execution":{"lookup":"ksession1","commands":{"complete-work-item":{"id":1001}}}} </programlisting></para>
+
+ <para></para>
+ </listitem>
+
+ <listitem>
+ <para>JAXB</para>
+
+ <para><programlisting>TODO</programlisting></para>
+
+ <para></para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </itemizedlist>
+
+ <para></para>
+</section>
Property changes on: labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-CompleteWorkItemCommand.xml
___________________________________________________________________
Name: svn:eol-style
+ native
Added: labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-FireAllRulesCommand.xml
===================================================================
--- labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-FireAllRulesCommand.xml (rev 0)
+++ labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-FireAllRulesCommand.xml 2010-06-09 01:14:05 UTC (rev 33413)
@@ -0,0 +1,114 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<section version="5.0" xmlns="http://docbook.org/ns/docbook"
+ xmlns:xlink="http://www.w3.org/1999/xlink"
+ xmlns:xi="http://www.w3.org/2001/XInclude"
+ xmlns:svg="http://www.w3.org/2000/svg"
+ xmlns:m="http://www.w3.org/1998/Math/MathML"
+ xmlns:html="http://www.w3.org/1999/xhtml"
+ xmlns:db="http://docbook.org/ns/docbook">
+ <title>FireAllRulesCommand</title>
+
+ <para></para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Description: Allow execution of the rules activations
+ created.</para>
+ </listitem>
+
+ <listitem>
+ <para>Attributes</para>
+
+ <table>
+ <title>FireAllRulesCommand attributes</title>
+
+ <tgroup cols="3">
+ <colspec align="center" />
+
+ <thead>
+ <row>
+ <entry align="center">Name</entry>
+
+ <entry align="center">Description</entry>
+
+ <entry align="center">required</entry>
+ </row>
+ </thead>
+
+ <tbody>
+ <row>
+ <entry>max</entry>
+
+ <entry>The max number of rules activations to be executed.
+ default is -1 and will not put any restriction on
+ execution</entry>
+
+ <entry>false</entry>
+ </row>
+
+ <row>
+ <entry>outIdentifier</entry>
+
+ <entry>Add the number of rules activations fired on the
+ execution results</entry>
+
+ <entry>false</entry>
+ </row>
+
+ <row>
+ <entry>agendaFilter</entry>
+
+ <entry>Allow the rules execution using an Agenda Filter</entry>
+
+ <entry>false</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </listitem>
+
+ <listitem>
+ <para>Command creation<programlisting>BatchExecutionCommand command = new BatchExecutionCommand();
+command.setLookup("ksession1");
+FireAllRulesCommand fireAllRulesCommand = new FireAllRulesCommand();
+command.getCommands().add(fireAllRulesCommand);
+String xml = BatchExecutionHelper.newXStreamMarshaller().toXML(command);</programlisting></para>
+
+ <para></para>
+ </listitem>
+
+ <listitem>
+ <para>XML output</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>XStream</para>
+
+ <para><programlisting><batch-execution lookup="ksession1">
+ <fire-all-rules/>
+</batch-execution></programlisting></para>
+
+ <para></para>
+ </listitem>
+
+ <listitem>
+ <para>JSON</para>
+
+ <para><programlisting>{"batch-execution":{"lookup":"ksession1","commands":{"fire-all-rules":""}}} </programlisting></para>
+
+ <para></para>
+ </listitem>
+
+ <listitem>
+ <para>JAXB</para>
+
+ <para><programlisting>TODO</programlisting></para>
+
+ <para></para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </itemizedlist>
+
+ <para></para>
+</section>
Property changes on: labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-FireAllRulesCommand.xml
___________________________________________________________________
Name: svn:eol-style
+ native
Added: labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-GetGlobalCommand.xml
===================================================================
--- labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-GetGlobalCommand.xml (rev 0)
+++ labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-GetGlobalCommand.xml 2010-06-09 01:14:05 UTC (rev 33413)
@@ -0,0 +1,107 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<section version="5.0" xmlns="http://docbook.org/ns/docbook"
+ xmlns:xlink="http://www.w3.org/1999/xlink"
+ xmlns:xi="http://www.w3.org/2001/XInclude"
+ xmlns:svg="http://www.w3.org/2000/svg"
+ xmlns:m="http://www.w3.org/1998/Math/MathML"
+ xmlns:html="http://www.w3.org/1999/xhtml"
+ xmlns:db="http://docbook.org/ns/docbook">
+ <title>GetGlobalCommand</title>
+
+ <para></para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Description: Allow to get a global previously defined.</para>
+ </listitem>
+
+ <listitem>
+ <para>Attributes</para>
+
+ <table>
+ <title>GetGlobalCommand attributes</title>
+
+ <tgroup cols="3">
+ <colspec align="center" />
+
+ <thead>
+ <row>
+ <entry align="center">Name</entry>
+
+ <entry align="center">Description</entry>
+
+ <entry align="center">required</entry>
+ </row>
+ </thead>
+
+ <tbody>
+ <row>
+ <entry>identifier</entry>
+
+ <entry>The identifier of the global defined in the knowledge
+ base</entry>
+
+ <entry>true</entry>
+ </row>
+
+ <row>
+ <entry>outIdentifier</entry>
+
+ <entry>The identifier to be used in the execution
+ results</entry>
+
+ <entry>false</entry>
+ </row>
+
+ </tbody>
+ </tgroup>
+ </table>
+ </listitem>
+
+ <listitem>
+ <para>Command creation<programlisting>BatchExecutionCommand command = new BatchExecutionCommand();
+command.setLookup("ksession1");
+GetGlobalCommand setGlobalCommand = new GetGlobalCommand();
+setGlobalCommand.setIdentifier("helper");
+setGlobalCommand.setOutIdentifier("helperOutput");
+command.getCommands().add(setGlobalCommand);
+String xml = BatchExecutionHelper.newXStreamMarshaller().toXML(command);</programlisting></para>
+
+ <para></para>
+ </listitem>
+
+ <listitem>
+ <para>XML output</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>XStream</para>
+
+ <para><programlisting><batch-execution lookup="ksession1">
+ <get-global identifier="helper" out-identifier="helperOutput"/>
+</batch-execution></programlisting></para>
+
+ <para></para>
+ </listitem>
+
+ <listitem>
+ <para>JSON</para>
+
+ <para><programlisting>{"batch-execution":{"lookup":"ksession1","commands":{"get-global":{"identifier":"helper","out-identifier":"helperOutput"}}}} </programlisting></para>
+
+ <para></para>
+ </listitem>
+
+ <listitem>
+ <para>JAXB</para>
+
+ <para><programlisting>TODO</programlisting></para>
+
+ <para></para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </itemizedlist>
+
+ <para></para>
+</section>
Property changes on: labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-GetGlobalCommand.xml
___________________________________________________________________
Name: svn:eol-style
+ native
Added: labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-GetObjectCommand.xml
===================================================================
--- labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-GetObjectCommand.xml (rev 0)
+++ labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-GetObjectCommand.xml 2010-06-09 01:14:05 UTC (rev 33413)
@@ -0,0 +1,108 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<section version="5.0" xmlns="http://docbook.org/ns/docbook"
+ xmlns:xlink="http://www.w3.org/1999/xlink"
+ xmlns:xi="http://www.w3.org/2001/XInclude"
+ xmlns:svg="http://www.w3.org/2000/svg"
+ xmlns:m="http://www.w3.org/1998/Math/MathML"
+ xmlns:html="http://www.w3.org/1999/xhtml"
+ xmlns:db="http://docbook.org/ns/docbook">
+ <title>GetObjectCommand</title>
+
+ <para></para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Description: Used to get an object from a knowledge session</para>
+ </listitem>
+
+ <listitem>
+ <para>Attributes</para>
+
+ <table>
+ <title>GetObjectCommand attributes</title>
+
+ <tgroup cols="3">
+ <colspec align="center" />
+
+ <thead>
+ <row>
+ <entry align="center">Name</entry>
+
+ <entry align="center">Description</entry>
+
+ <entry align="center">required</entry>
+ </row>
+ </thead>
+
+ <tbody>
+ <row>
+ <entry>factHandle</entry>
+
+ <entry>The FactHandle associated to the object to be
+ retracted</entry>
+
+ <entry>true</entry>
+ </row>
+
+ <row>
+ <entry>outIdentifier</entry>
+
+ <entry>Id to identify the FactHandle created in the object
+ insertion and added to the execution results</entry>
+
+ <entry>false</entry>
+ </row>
+
+ </tbody>
+ </tgroup>
+ </table>
+ </listitem>
+
+ <listitem>
+ <para>Command creation<programlisting>BatchExecutionCommand command = new BatchExecutionCommand();
+command.setLookup("ksession1");
+GetObjectCommand getObjectCommand = new GetObjectCommand();
+getObjectCommand.setFactHandleFromString("123:234:345:456:567");
+getObjectCommand.setOutIdentifier("john");
+command.getCommands().add(getObjectCommand);
+String xml = BatchExecutionHelper.newXStreamMarshaller().toXML(command);</programlisting></para>
+
+ <para></para>
+ </listitem>
+
+ <listitem>
+ <para>XML output</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>XStream</para>
+
+ <para><programlisting><batch-execution lookup="ksession1">
+ <get-object fact-handle="0:234:345:456:567" out-identifier="john"/>
+</batch-execution></programlisting></para>
+
+ <para></para>
+ </listitem>
+
+ <listitem>
+ <para>JSON</para>
+
+ <para><programlisting>{"batch-execution":{"lookup":"ksession1","commands":{"get-object":{"fact-handle":"0:234:345:456:567","out-identifier":"john"}}}}
+</programlisting></para>
+
+ <para></para>
+ </listitem>
+
+ <listitem>
+ <para>JAXB</para>
+
+ <para><programlisting>TODO</programlisting></para>
+
+ <para></para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </itemizedlist>
+
+ <para></para>
+</section>
Property changes on: labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-GetObjectCommand.xml
___________________________________________________________________
Name: svn:eol-style
+ native
Added: labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-GetObjectsCommand.xml
===================================================================
--- labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-GetObjectsCommand.xml (rev 0)
+++ labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-GetObjectsCommand.xml 2010-06-09 01:14:05 UTC (rev 33413)
@@ -0,0 +1,106 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<section version="5.0" xmlns="http://docbook.org/ns/docbook"
+ xmlns:xlink="http://www.w3.org/1999/xlink"
+ xmlns:xi="http://www.w3.org/2001/XInclude"
+ xmlns:svg="http://www.w3.org/2000/svg"
+ xmlns:m="http://www.w3.org/1998/Math/MathML"
+ xmlns:html="http://www.w3.org/1999/xhtml"
+ xmlns:db="http://docbook.org/ns/docbook">
+ <title>GetObjectsCommand</title>
+
+ <para></para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Description: Returns all the objects from the current session as a
+ Collection.</para>
+ </listitem>
+
+ <listitem>
+ <para>Attributes</para>
+
+ <table>
+ <title>GetObjectsCommand attributes</title>
+
+ <tgroup cols="3">
+ <colspec align="center" />
+
+ <thead>
+ <row>
+ <entry align="center">Name</entry>
+
+ <entry align="center">Description</entry>
+
+ <entry align="center">required</entry>
+ </row>
+ </thead>
+
+ <tbody>
+ <row>
+ <entry>objectFilter</entry>
+
+ <entry>An ObjectFilter to filter the objects returned from the
+ current session</entry>
+
+ <entry>false</entry>
+ </row>
+
+ <row>
+ <entry>outIdentifier</entry>
+
+ <entry>The identifier to be used in the execution
+ results</entry>
+
+ <entry>false</entry>
+ </row>
+
+ </tbody>
+ </tgroup>
+ </table>
+ </listitem>
+
+ <listitem>
+ <para>Command creation<programlisting>BatchExecutionCommand command = new BatchExecutionCommand();
+command.setLookup("ksession1");
+GetObjectsCommand getObjectsCommand = new GetObjectsCommand();
+command.getCommands().add(getObjectsCommand);
+String xml = BatchExecutionHelper.newXStreamMarshaller().toXML(command);</programlisting></para>
+
+ <para></para>
+ </listitem>
+
+ <listitem>
+ <para>XML output</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>XStream</para>
+
+ <para><programlisting><batch-execution lookup="ksession1">
+ <get-objects/>
+</batch-execution></programlisting></para>
+
+ <para></para>
+ </listitem>
+
+ <listitem>
+ <para>JSON</para>
+
+ <para><programlisting>{"batch-execution":{"lookup":"ksession1","commands":{"get-objects":""}}} </programlisting></para>
+
+ <para></para>
+ </listitem>
+
+ <listitem>
+ <para>JAXB</para>
+
+ <para><programlisting>TODO</programlisting></para>
+
+ <para></para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </itemizedlist>
+
+ <para></para>
+</section>
Property changes on: labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-GetObjectsCommand.xml
___________________________________________________________________
Name: svn:eol-style
+ native
Added: labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-InsertElementsCommand.xml
===================================================================
--- labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-InsertElementsCommand.xml (rev 0)
+++ labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-InsertElementsCommand.xml 2010-06-09 01:14:05 UTC (rev 33413)
@@ -0,0 +1,126 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<section version="5.0" xmlns="http://docbook.org/ns/docbook"
+ xmlns:xlink="http://www.w3.org/1999/xlink"
+ xmlns:xi="http://www.w3.org/2001/XInclude"
+ xmlns:svg="http://www.w3.org/2000/svg"
+ xmlns:m="http://www.w3.org/1998/Math/MathML"
+ xmlns:html="http://www.w3.org/1999/xhtml"
+ xmlns:db="http://docbook.org/ns/docbook">
+ <title>InsertElementsCommand</title>
+
+ <para></para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Description: Used to insert a list of objects.</para>
+ </listitem>
+
+ <listitem>
+ <para>Attributes</para>
+
+ <table>
+ <title>InsertElementsCommand attributes</title>
+
+ <tgroup cols="3">
+ <colspec align="center" />
+
+ <thead>
+ <row>
+ <entry align="center">Name</entry>
+
+ <entry align="center">Description</entry>
+
+ <entry align="center">required</entry>
+ </row>
+ </thead>
+
+ <tbody>
+ <row>
+ <entry>objects</entry>
+
+ <entry>The list of objects to be inserted on the knowledge
+ session</entry>
+
+ <entry>true</entry>
+ </row>
+
+ <row>
+ <entry>outIdentifier</entry>
+
+ <entry>Id to identify the FactHandle created in the object
+ insertion and added to the execution results</entry>
+
+ <entry>false</entry>
+ </row>
+
+ <row>
+ <entry>returnObject</entry>
+
+ <entry>Boolean to establish if the object must be returned in
+ the execution results. Default value: true</entry>
+
+ <entry>false</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </listitem>
+
+ <listitem>
+ <para>Command creation<programlisting>BatchExecutionCommand command = new BatchExecutionCommand();
+command.setLookup("ksession1");
+InsertElementsCommand insertElementsCommand = new InsertElementsCommand();
+List<Object> objects = new ArrayList<Object>();
+objects.add(new Person("john", 25));
+objects.add(new Person("sarah", 35));
+insertElementsCommand.setObjects(objects);
+command.getCommands().add(insertElementsCommand);
+String xml = BatchExecutionHelper.newXStreamMarshaller().toXML(command);</programlisting></para>
+
+ <para></para>
+ </listitem>
+
+ <listitem>
+ <para>XML output</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>XStream</para>
+
+ <para><programlisting><batch-execution lookup="ksession1">
+ <insert-elements>
+ <org.drools.test.Person>
+ <name>john</name>
+ <age>25</age>
+ </org.drools.test.Person>
+ <org.drools.test.Person>
+ <name>sarah</name>
+ <age>35</age>
+ </org.drools.test.Person>
+ </insert-elements>
+</batch-execution></programlisting></para>
+
+ <para></para>
+ </listitem>
+
+ <listitem>
+ <para>JSON</para>
+
+ <para><programlisting>{"batch-execution":{"lookup":"ksession1","commands":{"insert-elements":{"objects":[{"containedObject":{"@class":"org.drools.test.Person","name":"john","age":25}},{"containedObject":{"@class":"org.drools.test.Person","name":"sarah","age":35}}]}}}} </programlisting></para>
+
+ <para></para>
+ </listitem>
+
+ <listitem>
+ <para>JAXB</para>
+
+ <para><programlisting>TODO</programlisting></para>
+
+ <para></para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </itemizedlist>
+
+ <para></para>
+</section>
Property changes on: labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-InsertElementsCommand.xml
___________________________________________________________________
Name: svn:eol-style
+ native
Added: labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-InsertObjectCommand.xml
===================================================================
--- labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-InsertObjectCommand.xml (rev 0)
+++ labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-InsertObjectCommand.xml 2010-06-09 01:14:05 UTC (rev 33413)
@@ -0,0 +1,120 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<section version="5.0" xmlns="http://docbook.org/ns/docbook"
+ xmlns:xlink="http://www.w3.org/1999/xlink"
+ xmlns:xi="http://www.w3.org/2001/XInclude"
+ xmlns:svg="http://www.w3.org/2000/svg"
+ xmlns:m="http://www.w3.org/1998/Math/MathML"
+ xmlns:html="http://www.w3.org/1999/xhtml"
+ xmlns:db="http://docbook.org/ns/docbook">
+ <title>InsertObjectCommand</title>
+
+ <para></para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Description: Insert an object in the knowledge session.</para>
+ </listitem>
+
+ <listitem>
+ <para>Attributes</para>
+
+ <table>
+ <title>InsertObjectCommand attributes</title>
+
+ <tgroup cols="3">
+ <colspec align="center" />
+
+ <thead>
+ <row>
+ <entry align="center">Name</entry>
+
+ <entry align="center">Description</entry>
+
+ <entry align="center">required</entry>
+ </row>
+ </thead>
+
+ <tbody>
+ <row>
+ <entry>object</entry>
+
+ <entry>The object to be inserted</entry>
+
+ <entry>true</entry>
+ </row>
+
+ <row>
+ <entry>outIdentifier</entry>
+
+ <entry>Id to identify the FactHandle created in the object
+ insertion and added to the execution results</entry>
+
+ <entry>false</entry>
+ </row>
+
+ <row>
+ <entry>returnObject</entry>
+
+ <entry>Boolean to establish if the object must be returned in
+ the execution results. Default value: true</entry>
+
+ <entry>false</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </listitem>
+
+ <listitem>
+ <para>Command creation<programlisting>BatchExecutionCommand command = new BatchExecutionCommand();
+command.setLookup("ksession1");
+InsertObjectCommand insertObjectCommand = new InsertObjectCommand(new Person("john", 25));
+insertObjectCommand.setOutIdentifier("john");
+insertObjectCommand.setReturnObject(false);
+command.getCommands().add(insertObjectCommand);
+String xml = BatchExecutionHelper.newXStreamMarshaller().toXML(command);</programlisting></para>
+
+ <para></para>
+ </listitem>
+
+ <listitem>
+ <para>XML output</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>XStream</para>
+
+ <para><programlisting><batch-execution lookup="ksession1">
+ <insert out-identifier="john" return-object="false">
+ <org.drools.test.Person>
+ <name>john</name>
+ <age>25</age>
+ </org.drools.test.Person>
+ </insert>
+</batch-execution></programlisting></para>
+
+ <para></para>
+ </listitem>
+
+ <listitem>
+ <para>JSON</para>
+
+ <para><programlisting>{"batch-execution":{"lookup":"ksession1","commands":{"insert":{"out-identifier":"john","return-object":false,"object":{"org.drools.test.Person":{"name":"john","age":25}}}}}}
+</programlisting></para>
+
+ <para></para>
+ </listitem>
+
+ <listitem>
+ <para>JAXB</para>
+
+ <para><programlisting>TODO</programlisting></para>
+
+ <para></para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </itemizedlist>
+
+ <para></para>
+</section>
Property changes on: labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-InsertObjectCommand.xml
___________________________________________________________________
Name: svn:eol-style
+ native
Added: labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-ModifyCommand.xml
===================================================================
--- labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-ModifyCommand.xml (rev 0)
+++ labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-ModifyCommand.xml 2010-06-09 01:14:05 UTC (rev 33413)
@@ -0,0 +1,109 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<section version="5.0" xmlns="http://docbook.org/ns/docbook"
+ xmlns:xlink="http://www.w3.org/1999/xlink"
+ xmlns:xi="http://www.w3.org/2001/XInclude"
+ xmlns:svg="http://www.w3.org/2000/svg"
+ xmlns:m="http://www.w3.org/1998/Math/MathML"
+ xmlns:html="http://www.w3.org/1999/xhtml"
+ xmlns:db="http://docbook.org/ns/docbook">
+ <title>ModifyCommand</title>
+
+ <para></para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Description: Allow to modify a previously inserted object in the
+ knowledge session.</para>
+ </listitem>
+
+ <listitem>
+ <para>Attributes</para>
+
+ <table>
+ <title>ModifyCommand attributes</title>
+
+ <tgroup cols="3">
+ <colspec align="center" />
+
+ <thead>
+ <row>
+ <entry align="center">Name</entry>
+
+ <entry align="center">Description</entry>
+
+ <entry align="center">required</entry>
+ </row>
+ </thead>
+
+ <tbody>
+ <row>
+ <entry>handle</entry>
+
+ <entry>The FactHandle associated to the object to be
+ retracted</entry>
+
+ <entry>true</entry>
+ </row>
+
+ <row>
+ <entry>setters</entry>
+
+ <entry>List of setters object's modifications</entry>
+
+ <entry>true</entry>
+ </row>
+
+ </tbody>
+ </tgroup>
+ </table>
+ </listitem>
+
+ <listitem>
+ <para>Command creation<programlisting>BatchExecutionCommand command = new BatchExecutionCommand();
+command.setLookup("ksession1");
+ModifyCommand modifyCommand = new ModifyCommand();
+modifyCommand.setFactHandleFromString("123:234:345:456:567");
+List<Setter> setters = new ArrayList<Setter>();
+setters.add(new SetterImpl("age", "30"));
+modifyCommand.setSetters(setters);
+command.getCommands().add(modifyCommand);
+String xml = BatchExecutionHelper.newXStreamMarshaller().toXML(command);</programlisting></para>
+
+ <para></para>
+ </listitem>
+
+ <listitem>
+ <para>XML output</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>XStream</para>
+
+ <para><programlisting><batch-execution lookup="ksession1">
+ <modify fact-handle="0:234:345:456:567">
+ <set accessor="age" value="30"/>
+ </modify>
+</batch-execution></programlisting></para>
+
+ <para></para>
+ </listitem>
+
+ <listitem>
+ <para>JSON</para>
+
+ <para><programlisting>{"batch-execution":{"lookup":"ksession1","commands":{"modify":{"fact-handle":"0:234:345:456:567","setters":{"accessor":"age","value":30}}}}} </programlisting></para>
+ </listitem>
+
+ <listitem>
+ <para>JAXB</para>
+
+ <para><programlisting>TODO</programlisting></para>
+
+ <para></para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </itemizedlist>
+
+ <para></para>
+</section>
Property changes on: labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-ModifyCommand.xml
___________________________________________________________________
Name: svn:eol-style
+ native
Added: labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-QueryCommand.xml
===================================================================
--- labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-QueryCommand.xml (rev 0)
+++ labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-QueryCommand.xml 2010-06-09 01:14:05 UTC (rev 33413)
@@ -0,0 +1,115 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<section version="5.0" xmlns="http://docbook.org/ns/docbook"
+ xmlns:xlink="http://www.w3.org/1999/xlink"
+ xmlns:xi="http://www.w3.org/2001/XInclude"
+ xmlns:svg="http://www.w3.org/2000/svg"
+ xmlns:m="http://www.w3.org/1998/Math/MathML"
+ xmlns:html="http://www.w3.org/1999/xhtml"
+ xmlns:db="http://docbook.org/ns/docbook">
+ <title>QueryCommand</title>
+
+ <para></para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Description: Executes a query defined in knowledge base.</para>
+ </listitem>
+
+ <listitem>
+ <para>Attributes</para>
+
+ <table>
+ <title>QueryCommand attributes</title>
+
+ <tgroup cols="3">
+ <colspec align="center" />
+
+ <thead>
+ <row>
+ <entry align="center">Name</entry>
+
+ <entry align="center">Description</entry>
+
+ <entry align="center">required</entry>
+ </row>
+ </thead>
+
+ <tbody>
+ <row>
+ <entry>name</entry>
+
+ <entry>The query name</entry>
+
+ <entry>true</entry>
+ </row>
+
+ <row>
+ <entry>outIdentifier</entry>
+
+ <entry>The identifier of the query results. The query results
+ are going to be added in the execution results with this
+ identifier</entry>
+
+ <entry>false</entry>
+ </row>
+
+ <row>
+ <entry>arguments</entry>
+
+ <entry>A list of objects to be passed as a query
+ parameter</entry>
+
+ <entry>false</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </listitem>
+
+ <listitem>
+ <para>Command creation<programlisting>BatchExecutionCommand command = new BatchExecutionCommand();
+command.setLookup("ksession1");
+QueryCommand queryCommand = new QueryCommand();
+queryCommand.setName("persons");
+queryCommand.setOutIdentifier("persons");
+command.getCommands().add(queryCommand);
+String xml = BatchExecutionHelper.newXStreamMarshaller().toXML(command);</programlisting></para>
+
+ <para></para>
+ </listitem>
+
+ <listitem>
+ <para>XML output</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>XStream</para>
+
+ <para><programlisting><batch-execution lookup="ksession1">
+ <query out-identifier="persons" name="persons"/>
+</batch-execution></programlisting></para>
+
+ <para></para>
+ </listitem>
+
+ <listitem>
+ <para>JSON</para>
+
+ <para><programlisting>{"batch-execution":{"lookup":"ksession1","commands":{"query":{"out-identifier":"persons","name":"persons"}}}} </programlisting></para>
+
+ <para></para>
+ </listitem>
+
+ <listitem>
+ <para>JAXB</para>
+
+ <para><programlisting>TODO</programlisting></para>
+
+ <para></para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </itemizedlist>
+
+ <para></para>
+</section>
Property changes on: labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-QueryCommand.xml
___________________________________________________________________
Name: svn:eol-style
+ native
Added: labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-RetractCommand.xml
===================================================================
--- labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-RetractCommand.xml (rev 0)
+++ labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-RetractCommand.xml 2010-06-09 01:14:05 UTC (rev 33413)
@@ -0,0 +1,116 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<section version="5.0" xmlns="http://docbook.org/ns/docbook"
+ xmlns:xlink="http://www.w3.org/1999/xlink"
+ xmlns:xi="http://www.w3.org/2001/XInclude"
+ xmlns:svg="http://www.w3.org/2000/svg"
+ xmlns:m="http://www.w3.org/1998/Math/MathML"
+ xmlns:html="http://www.w3.org/1999/xhtml"
+ xmlns:db="http://docbook.org/ns/docbook">
+ <title>RetractCommand</title>
+
+ <para></para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Description: Retract an object from the knowledge session.</para>
+ </listitem>
+
+ <listitem>
+ <para>Attributes</para>
+
+ <table>
+ <title>RetractCommand attributes</title>
+
+ <tgroup cols="3">
+ <colspec align="center" />
+
+ <thead>
+ <row>
+ <entry align="center">Name</entry>
+
+ <entry align="center">Description</entry>
+
+ <entry align="center">required</entry>
+ </row>
+ </thead>
+
+ <tbody>
+ <row>
+ <entry>handle</entry>
+
+ <entry>The FactHandle associated to the object to be
+ retracted</entry>
+
+ <entry>true</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </listitem>
+
+ <listitem>
+ <para>Command creation: we have two options, with the same output
+ result:</para>
+
+ <orderedlist>
+ <listitem>
+ <para>Create the Fact Handle from a string</para>
+
+ <para><programlisting>BatchExecutionCommand command = new BatchExecutionCommand();
+command.setLookup("ksession1");
+InsertObjectCommand insertObjectCommand = new InsertObjectCommand(new Person("john", 25));
+FireAllRulesCommand fireAllRulesCommand = new FireAllRulesCommand();
+command.getCommands().add(insertObjectCommand);
+command.getCommands().add(fireAllRulesCommand);
+String xml = BatchExecutionHelper.newXStreamMarshaller().toXML(command);</programlisting></para>
+ </listitem>
+
+ <listitem>
+ <para>Create the Fact Handle from a string</para>
+
+ <para><programlisting>BatchExecutionCommand command = new BatchExecutionCommand();
+command.setLookup("ksession1");
+RetractCommand retractCommand = new RetractCommand(factHandle);
+command.getCommands().add(retractCommand);
+String xml = BatchExecutionHelper.newXStreamMarshaller().toXML(command);</programlisting></para>
+ </listitem>
+ </orderedlist>
+
+ <para></para>
+ </listitem>
+
+ <listitem>
+ <para>XML output</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>XStream</para>
+
+ <para><programlisting><batch-execution lookup="ksession1">
+ <retract fact-handle="0:234:345:456:567"/>
+</batch-execution></programlisting></para>
+
+ <para></para>
+ </listitem>
+
+ <listitem>
+ <para>JSON</para>
+
+ <para><programlisting>{"batch-execution":{"lookup":"ksession1","commands":{"retract":{"fact-handle":"0:234:345:456:567"}}}}</programlisting></para>
+
+ <para></para>
+ </listitem>
+
+ <listitem>
+ <para>JAXB</para>
+
+ <para><programlisting>TODO</programlisting></para>
+
+ <para></para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </itemizedlist>
+
+ <para></para>
+</section>
Property changes on: labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-RetractCommand.xml
___________________________________________________________________
Name: svn:eol-style
+ native
Added: labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-SetGlobalCommand.xml
===================================================================
--- labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-SetGlobalCommand.xml (rev 0)
+++ labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-SetGlobalCommand.xml 2010-06-09 01:14:05 UTC (rev 33413)
@@ -0,0 +1,124 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<section version="5.0" xmlns="http://docbook.org/ns/docbook"
+ xmlns:xlink="http://www.w3.org/1999/xlink"
+ xmlns:xi="http://www.w3.org/2001/XInclude"
+ xmlns:svg="http://www.w3.org/2000/svg"
+ xmlns:m="http://www.w3.org/1998/Math/MathML"
+ xmlns:html="http://www.w3.org/1999/xhtml"
+ xmlns:db="http://docbook.org/ns/docbook">
+ <title>SetGlobalCommand</title>
+
+ <para></para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Description: Allow to set a global.</para>
+ </listitem>
+
+ <listitem>
+ <para>Attributes</para>
+
+ <table>
+ <title>SetGlobalCommand attributes</title>
+
+ <tgroup cols="3">
+ <colspec align="center" />
+
+ <thead>
+ <row>
+ <entry align="center">Name</entry>
+
+ <entry align="center">Description</entry>
+
+ <entry align="center">required</entry>
+ </row>
+ </thead>
+
+ <tbody>
+ <row>
+ <entry>identifier</entry>
+
+ <entry>The identifier of the global defined in the knowledge
+ base</entry>
+
+ <entry>true</entry>
+ </row>
+
+ <row>
+ <entry>object</entry>
+
+ <entry>The object to be setted into the global</entry>
+
+ <entry>false</entry>
+ </row>
+
+ <row>
+ <entry>out</entry>
+
+ <entry>A boolean to add, or not, the set global result into the
+ execution results</entry>
+
+ <entry>false</entry>
+ </row>
+
+ <row>
+ <entry>outIdentifier</entry>
+
+ <entry>The identifier of the global execution result</entry>
+
+ <entry>false</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </listitem>
+
+ <listitem>
+ <para>Command creation<programlisting>BatchExecutionCommand command = new BatchExecutionCommand();
+command.setLookup("ksession1");
+SetGlobalCommand setGlobalCommand = new SetGlobalCommand();
+setGlobalCommand.setIdentifier("helper");
+setGlobalCommand.setObject(new Object());
+command.getCommands().add(setGlobalCommand);
+String xml = BatchExecutionHelper.newXStreamMarshaller().toXML(command);</programlisting></para>
+
+ <para></para>
+ </listitem>
+
+ <listitem>
+ <para>XML output</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>XStream</para>
+
+ <para><programlisting><batch-execution lookup="ksession1">
+ <set-global identifier="helper">
+ <object/>
+ </set-global>
+</batch-execution></programlisting></para>
+
+ <para></para>
+ </listitem>
+
+ <listitem>
+ <para>JSON</para>
+
+ <para><programlisting>{"batch-execution":{"lookup":"ksession1","commands":{"set-global":{"identifier":"helper","object":{"object":""}}}}} </programlisting></para>
+
+ <para></para>
+ </listitem>
+
+ <listitem>
+ <para>JAXB</para>
+
+ <para><programlisting>TODO</programlisting></para>
+
+ <para></para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </itemizedlist>
+
+ <para></para>
+</section>
Property changes on: labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-SetGlobalCommand.xml
___________________________________________________________________
Name: svn:eol-style
+ native
Added: labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-SignalEventCommand.xml
===================================================================
--- labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-SignalEventCommand.xml (rev 0)
+++ labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-SignalEventCommand.xml 2010-06-09 01:14:05 UTC (rev 33413)
@@ -0,0 +1,117 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<section version="5.0" xmlns="http://docbook.org/ns/docbook"
+ xmlns:xlink="http://www.w3.org/1999/xlink"
+ xmlns:xi="http://www.w3.org/2001/XInclude"
+ xmlns:svg="http://www.w3.org/2000/svg"
+ xmlns:m="http://www.w3.org/1998/Math/MathML"
+ xmlns:html="http://www.w3.org/1999/xhtml"
+ xmlns:db="http://docbook.org/ns/docbook">
+ <title>SignalEventCommand</title>
+
+ <para></para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Description: Send a signal event.</para>
+ </listitem>
+
+ <listitem>
+ <para>Attributes</para>
+
+ <table>
+ <title>SignalEventCommand attributes</title>
+
+ <tgroup cols="3">
+ <colspec align="center" />
+
+ <thead>
+ <row>
+ <entry align="center">Name</entry>
+
+ <entry align="center">Description</entry>
+
+ <entry align="center">required</entry>
+ </row>
+ </thead>
+
+ <tbody>
+ <row>
+ <entry>event-type</entry>
+
+ <entry></entry>
+
+ <entry>true</entry>
+ </row>
+
+ <row>
+ <entry>processInstanceId</entry>
+
+ <entry></entry>
+
+ <entry>false</entry>
+ </row>
+
+ <row>
+ <entry>event</entry>
+
+ <entry></entry>
+
+ <entry>false</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </listitem>
+
+ <listitem>
+ <para>Command creation<programlisting>BatchExecutionCommand command = new BatchExecutionCommand();
+command.setLookup("ksession1");
+SignalEventCommand signalEventCommand = new SignalEventCommand();
+signalEventCommand.setEventType("start");
+signalEventCommand.setEvent(new Person("john", 25));
+command.getCommands().add(signalEventCommand);
+String xml = BatchExecutionHelper.newXStreamMarshaller().toXML(command);</programlisting></para>
+
+ <para></para>
+ </listitem>
+
+ <listitem>
+ <para>XML output</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>XStream</para>
+
+ <para><programlisting><batch-execution lookup="ksession1">
+ <signal-event event-type="start">
+ <org.drools.test.Person>
+ <name>john</name>
+ <age>25</age>
+ </org.drools.test.Person>
+ </signal-event>
+</batch-execution></programlisting></para>
+
+ <para></para>
+ </listitem>
+
+ <listitem>
+ <para>JSON</para>
+
+ <para><programlisting>{"batch-execution":{"lookup":"ksession1","commands":{"signal-event":{"@event-type":"start","event-type":"start","object":{"org.drools.test.Person":{"name":"john","age":25}}}}}} </programlisting></para>
+
+ <para></para>
+ </listitem>
+
+ <listitem>
+ <para>JAXB</para>
+
+ <para><programlisting>TODO</programlisting></para>
+
+ <para></para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </itemizedlist>
+
+ <para></para>
+</section>
Property changes on: labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-SignalEventCommand.xml
___________________________________________________________________
Name: svn:eol-style
+ native
Added: labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-StartProcessCommand.xml
===================================================================
--- labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-StartProcessCommand.xml (rev 0)
+++ labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-StartProcessCommand.xml 2010-06-09 01:14:05 UTC (rev 33413)
@@ -0,0 +1,114 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<section version="5.0" xmlns="http://docbook.org/ns/docbook"
+ xmlns:xlink="http://www.w3.org/1999/xlink"
+ xmlns:xi="http://www.w3.org/2001/XInclude"
+ xmlns:svg="http://www.w3.org/2000/svg"
+ xmlns:m="http://www.w3.org/1998/Math/MathML"
+ xmlns:html="http://www.w3.org/1999/xhtml"
+ xmlns:db="http://docbook.org/ns/docbook">
+ <title>StartProcessCommand</title>
+
+ <para></para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Description: Allow to start a process using the ID. Also you can
+ pass parameters and initial data to be inserted.</para>
+ </listitem>
+
+ <listitem>
+ <para>Attributes</para>
+
+ <table>
+ <title>StartProcessCommand attributes</title>
+
+ <tgroup cols="3">
+ <colspec align="center" />
+
+ <thead>
+ <row>
+ <entry align="center">Name</entry>
+
+ <entry align="center">Description</entry>
+
+ <entry align="center">required</entry>
+ </row>
+ </thead>
+
+ <tbody>
+ <row>
+ <entry>processId</entry>
+
+ <entry>The ID of the process to be started</entry>
+
+ <entry>true</entry>
+ </row>
+
+ <row>
+ <entry>parameters</entry>
+
+ <entry>A Map<String, Object> to pass parameters in the
+ process startup</entry>
+
+ <entry>false</entry>
+ </row>
+
+ <row>
+ <entry>data</entry>
+
+ <entry>A list of objects to be inserted in the knowledge session
+ before the process startup</entry>
+
+ <entry>false</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </listitem>
+
+ <listitem>
+ <para>Command creation<programlisting>BatchExecutionCommand command = new BatchExecutionCommand();
+command.setLookup("ksession1");
+StartProcessCommand startProcessCommand = new StartProcessCommand();
+startProcessCommand.setProcessId("org.drools.task.processOne");
+command.getCommands().add(startProcessCommand);
+String xml = BatchExecutionHelper.newXStreamMarshaller().toXML(command);</programlisting></para>
+
+ <para></para>
+ </listitem>
+
+ <listitem>
+ <para>XML output</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>XStream</para>
+
+ <para><programlisting><batch-execution lookup="ksession1">
+ <start-process processId="org.drools.task.processOne"/>
+</batch-execution></programlisting></para>
+
+ <para></para>
+ </listitem>
+
+ <listitem>
+ <para>JSON</para>
+
+ <para><programlisting>{"batch-execution":{"lookup":"ksession1","commands":{"start-process":{"process-id":"org.drools.task.processOne"}}}} </programlisting></para>
+
+ <para></para>
+ </listitem>
+
+ <listitem>
+ <para>JAXB</para>
+
+ <para><programlisting>TODO</programlisting></para>
+
+ <para></para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </itemizedlist>
+
+ <para></para>
+</section>
Property changes on: labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/Chapter-Commands/Section-Commands/Section-StartProcessCommand.xml
___________________________________________________________________
Name: svn:eol-style
+ native
Modified: labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/master.xml
===================================================================
--- labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/master.xml 2010-06-08 22:20:14 UTC (rev 33412)
+++ labs/jbossrules/trunk/drools-docs/drools-docs-integration/src/main/docbook/en-US/master.xml 2010-06-09 01:14:05 UTC (rev 33413)
@@ -23,6 +23,8 @@
<xi:include href="Chapter-Server/Chapter-Server.xml" />
+ <xi:include href="Chapter-Commands/Chapter-Commands.xml" />
+
<xi:include href="Chapter-OSGI/Chapter-OSGI.xml" />
<index/>
More information about the jboss-svn-commits
mailing list