[jboss-svn-commits] JBL Code SVN: r24002 - in labs/jbossrules/trunk/drools-api: src/main/java/org/drools and 14 other directories.
jboss-svn-commits at lists.jboss.org
jboss-svn-commits at lists.jboss.org
Thu Nov 20 13:59:14 EST 2008
Author: mark.proctor at jboss.com
Date: 2008-11-20 13:59:13 -0500 (Thu, 20 Nov 2008)
New Revision: 24002
Added:
labs/jbossrules/trunk/drools-api/src/main/java/org/drools/agent/package.html
labs/jbossrules/trunk/drools-api/src/main/java/org/drools/builder/package.html
labs/jbossrules/trunk/drools-api/src/main/java/org/drools/definition/package.html
labs/jbossrules/trunk/drools-api/src/main/java/org/drools/definition/process/package.html
labs/jbossrules/trunk/drools-api/src/main/java/org/drools/definition/rule/package.html
labs/jbossrules/trunk/drools-api/src/main/java/org/drools/event/knowledgebase/package.html
labs/jbossrules/trunk/drools-api/src/main/java/org/drools/event/package.html
labs/jbossrules/trunk/drools-api/src/main/java/org/drools/event/process/package.html
labs/jbossrules/trunk/drools-api/src/main/java/org/drools/event/rule/package.html
labs/jbossrules/trunk/drools-api/src/main/java/org/drools/package.html
labs/jbossrules/trunk/drools-api/src/main/java/org/drools/runtime/package.html
labs/jbossrules/trunk/drools-api/src/main/java/org/drools/runtime/process/package.html
labs/jbossrules/trunk/drools-api/src/main/java/org/drools/runtime/rule/package.html
labs/jbossrules/trunk/drools-api/src/main/java/org/drools/time/package.html
labs/jbossrules/trunk/drools-api/src/main/resources/overview.html
Modified:
labs/jbossrules/trunk/drools-api/.classpath
labs/jbossrules/trunk/drools-api/.project
Log:
-more javadoc
Modified: labs/jbossrules/trunk/drools-api/.classpath
===================================================================
--- labs/jbossrules/trunk/drools-api/.classpath 2008-11-20 18:34:08 UTC (rev 24001)
+++ labs/jbossrules/trunk/drools-api/.classpath 2008-11-20 18:59:13 UTC (rev 24002)
@@ -1,12 +1,12 @@
-<classpath>
- <classpathentry kind="src" path="src/main/java"/>
- <classpathentry kind="src" path="src/main/resources" excluding="**/*.java"/>
- <classpathentry kind="src" path="src/test/java" output="target/test-classes"/>
- <classpathentry kind="src" path="src/test/resources" output="target/test-classes" including="**" excluding="**/*.java"/>
- <classpathentry kind="output" path="target/classes"/>
- <classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER"/>
- <classpathentry kind="var" path="M2_REPO/junit/junit/3.8.1/junit-3.8.1.jar"/>
- <classpathentry kind="var" path="M2_REPO/org/jmock/jmock/2.5.0.1/jmock-2.5.0.1.jar"/>
- <classpathentry kind="var" path="M2_REPO/org/hamcrest/hamcrest-core/1.1/hamcrest-core-1.1.jar"/>
- <classpathentry kind="var" path="M2_REPO/org/hamcrest/hamcrest-library/1.1/hamcrest-library-1.1.jar"/>
+<classpath>
+ <classpathentry kind="src" path="src/main/java"/>
+ <classpathentry kind="src" path="src/main/resources" excluding="**/*.java"/>
+ <classpathentry kind="src" path="src/test/java" output="target/test-classes"/>
+ <classpathentry kind="src" path="src/test/resources" output="target/test-classes" including="**" excluding="**/*.java"/>
+ <classpathentry kind="output" path="target/classes"/>
+ <classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER"/>
+ <classpathentry kind="var" path="M2_REPO/org/hamcrest/hamcrest-core/1.1/hamcrest-core-1.1.jar"/>
+ <classpathentry kind="var" path="M2_REPO/org/hamcrest/hamcrest-library/1.1/hamcrest-library-1.1.jar"/>
+ <classpathentry kind="var" path="M2_REPO/org/jmock/jmock/2.5.0.1/jmock-2.5.0.1.jar"/>
+ <classpathentry kind="var" path="M2_REPO/junit/junit/3.8.1/junit-3.8.1.jar"/>
</classpath>
\ No newline at end of file
Modified: labs/jbossrules/trunk/drools-api/.project
===================================================================
--- labs/jbossrules/trunk/drools-api/.project 2008-11-20 18:34:08 UTC (rev 24001)
+++ labs/jbossrules/trunk/drools-api/.project 2008-11-20 18:59:13 UTC (rev 24002)
@@ -1,20 +1,20 @@
-<projectDescription>
- <name>drools-api</name>
- <comment>A rule production system</comment>
- <projects/>
- <buildSpec>
- <buildCommand>
- <name>org.eclipse.jdt.core.javabuilder</name>
- </buildCommand>
- <buildCommand>
- <name>org.drools.eclipse.droolsbuilder</name>
- </buildCommand>
- <buildCommand>
- <name>org.devzuz.q.maven.jdt.core.mavenIncrementalBuilder</name>
- </buildCommand>
- </buildSpec>
- <natures>
- <nature>org.eclipse.jdt.core.javanature</nature>
- <nature>org.devzuz.q.maven.jdt.core.mavenNature</nature>
- </natures>
+<projectDescription>
+ <name>drools-api</name>
+ <comment>A rule production system</comment>
+ <projects/>
+ <buildSpec>
+ <buildCommand>
+ <name>org.eclipse.jdt.core.javabuilder</name>
+ </buildCommand>
+ <buildCommand>
+ <name>org.drools.eclipse.droolsbuilder</name>
+ </buildCommand>
+ <buildCommand>
+ <name>org.devzuz.q.maven.jdt.core.mavenIncrementalBuilder</name>
+ </buildCommand>
+ </buildSpec>
+ <natures>
+ <nature>org.eclipse.jdt.core.javanature</nature>
+ <nature>org.devzuz.q.maven.jdt.core.mavenNature</nature>
+ </natures>
</projectDescription>
\ No newline at end of file
Added: labs/jbossrules/trunk/drools-api/src/main/java/org/drools/agent/package.html
===================================================================
--- labs/jbossrules/trunk/drools-api/src/main/java/org/drools/agent/package.html (rev 0)
+++ labs/jbossrules/trunk/drools-api/src/main/java/org/drools/agent/package.html 2008-11-20 18:59:13 UTC (rev 24002)
@@ -0,0 +1,3 @@
+<body>
+ The Agent api provide automatic loading, and re-loading, of artifacts and is configured from a properties files.
+</body>
\ No newline at end of file
Added: labs/jbossrules/trunk/drools-api/src/main/java/org/drools/builder/package.html
===================================================================
--- labs/jbossrules/trunk/drools-api/src/main/java/org/drools/builder/package.html (rev 0)
+++ labs/jbossrules/trunk/drools-api/src/main/java/org/drools/builder/package.html 2008-11-20 18:59:13 UTC (rev 24002)
@@ -0,0 +1,3 @@
+<body>
+ The builder package is responsible for building knowledge difinitions from artifact resources.
+</body>
\ No newline at end of file
Added: labs/jbossrules/trunk/drools-api/src/main/java/org/drools/definition/package.html
===================================================================
--- labs/jbossrules/trunk/drools-api/src/main/java/org/drools/definition/package.html (rev 0)
+++ labs/jbossrules/trunk/drools-api/src/main/java/org/drools/definition/package.html 2008-11-20 18:59:13 UTC (rev 24002)
@@ -0,0 +1,3 @@
+<body>
+ All classes to create definitions, as built by the KnowledgeBuilder from artifact resources, can be found here.
+</body>
\ No newline at end of file
Added: labs/jbossrules/trunk/drools-api/src/main/java/org/drools/definition/process/package.html
===================================================================
--- labs/jbossrules/trunk/drools-api/src/main/java/org/drools/definition/process/package.html (rev 0)
+++ labs/jbossrules/trunk/drools-api/src/main/java/org/drools/definition/process/package.html 2008-11-20 18:59:13 UTC (rev 24002)
@@ -0,0 +1,3 @@
+<body>
+ The classes that make up a Process definition.
+</body>
\ No newline at end of file
Added: labs/jbossrules/trunk/drools-api/src/main/java/org/drools/definition/rule/package.html
===================================================================
--- labs/jbossrules/trunk/drools-api/src/main/java/org/drools/definition/rule/package.html (rev 0)
+++ labs/jbossrules/trunk/drools-api/src/main/java/org/drools/definition/rule/package.html 2008-11-20 18:59:13 UTC (rev 24002)
@@ -0,0 +1,3 @@
+<body>
+ The classes that make up a Rule definition.
+</body>
\ No newline at end of file
Added: labs/jbossrules/trunk/drools-api/src/main/java/org/drools/event/knowledgebase/package.html
===================================================================
--- labs/jbossrules/trunk/drools-api/src/main/java/org/drools/event/knowledgebase/package.html (rev 0)
+++ labs/jbossrules/trunk/drools-api/src/main/java/org/drools/event/knowledgebase/package.html 2008-11-20 18:59:13 UTC (rev 24002)
@@ -0,0 +1,3 @@
+<body>
+ Events emitted while updating the definitions in the KnowledgeBase.
+</body>
\ No newline at end of file
Added: labs/jbossrules/trunk/drools-api/src/main/java/org/drools/event/package.html
===================================================================
--- labs/jbossrules/trunk/drools-api/src/main/java/org/drools/event/package.html (rev 0)
+++ labs/jbossrules/trunk/drools-api/src/main/java/org/drools/event/package.html 2008-11-20 18:59:13 UTC (rev 24002)
@@ -0,0 +1,3 @@
+<body>
+ Drools has a comprehensive event api for all parts of the platform.
+</body>
\ No newline at end of file
Added: labs/jbossrules/trunk/drools-api/src/main/java/org/drools/event/process/package.html
===================================================================
--- labs/jbossrules/trunk/drools-api/src/main/java/org/drools/event/process/package.html (rev 0)
+++ labs/jbossrules/trunk/drools-api/src/main/java/org/drools/event/process/package.html 2008-11-20 18:59:13 UTC (rev 24002)
@@ -0,0 +1,3 @@
+<body>
+ Events emitted while Processes are executing.
+</body>
\ No newline at end of file
Added: labs/jbossrules/trunk/drools-api/src/main/java/org/drools/event/rule/package.html
===================================================================
--- labs/jbossrules/trunk/drools-api/src/main/java/org/drools/event/rule/package.html (rev 0)
+++ labs/jbossrules/trunk/drools-api/src/main/java/org/drools/event/rule/package.html 2008-11-20 18:59:13 UTC (rev 24002)
@@ -0,0 +1,3 @@
+<body>
+ Events emitted while Rules are executing.
+</body>
\ No newline at end of file
Added: labs/jbossrules/trunk/drools-api/src/main/java/org/drools/package.html
===================================================================
--- labs/jbossrules/trunk/drools-api/src/main/java/org/drools/package.html (rev 0)
+++ labs/jbossrules/trunk/drools-api/src/main/java/org/drools/package.html 2008-11-20 18:59:13 UTC (rev 24002)
@@ -0,0 +1,3 @@
+<body>
+ The KnowledgeBase and its factory.
+</body>
\ No newline at end of file
Added: labs/jbossrules/trunk/drools-api/src/main/java/org/drools/runtime/package.html
===================================================================
--- labs/jbossrules/trunk/drools-api/src/main/java/org/drools/runtime/package.html (rev 0)
+++ labs/jbossrules/trunk/drools-api/src/main/java/org/drools/runtime/package.html 2008-11-20 18:59:13 UTC (rev 24002)
@@ -0,0 +1,3 @@
+<body>
+ The runtime engine classes, including StatefulKnowledgeSession and StatelessKnowledgeSession.
+</body>
\ No newline at end of file
Added: labs/jbossrules/trunk/drools-api/src/main/java/org/drools/runtime/process/package.html
===================================================================
--- labs/jbossrules/trunk/drools-api/src/main/java/org/drools/runtime/process/package.html (rev 0)
+++ labs/jbossrules/trunk/drools-api/src/main/java/org/drools/runtime/process/package.html 2008-11-20 18:59:13 UTC (rev 24002)
@@ -0,0 +1,3 @@
+<body>
+ The process runtime classes.
+</body>
\ No newline at end of file
Added: labs/jbossrules/trunk/drools-api/src/main/java/org/drools/runtime/rule/package.html
===================================================================
--- labs/jbossrules/trunk/drools-api/src/main/java/org/drools/runtime/rule/package.html (rev 0)
+++ labs/jbossrules/trunk/drools-api/src/main/java/org/drools/runtime/rule/package.html 2008-11-20 18:59:13 UTC (rev 24002)
@@ -0,0 +1,3 @@
+<body>
+ The rule runtime classes.
+</body>
\ No newline at end of file
Added: labs/jbossrules/trunk/drools-api/src/main/java/org/drools/time/package.html
===================================================================
--- labs/jbossrules/trunk/drools-api/src/main/java/org/drools/time/package.html (rev 0)
+++ labs/jbossrules/trunk/drools-api/src/main/java/org/drools/time/package.html 2008-11-20 18:59:13 UTC (rev 24002)
@@ -0,0 +1,3 @@
+<body>
+ Classes related to Time in Drools.
+</body>
\ No newline at end of file
Added: labs/jbossrules/trunk/drools-api/src/main/resources/overview.html
===================================================================
--- labs/jbossrules/trunk/drools-api/src/main/resources/overview.html (rev 0)
+++ labs/jbossrules/trunk/drools-api/src/main/resources/overview.html 2008-11-20 18:59:13 UTC (rev 24002)
@@ -0,0 +1,76 @@
+<body>
+
+<p>
+Drools the Business Logic Integration Platform provides an knowledge centric api, where rules and processes are first class citizens.
+</p>
+
+<p>
+The most common interfaces you will use are:
+<ul>
+<li><tt>org.drools.builder.KnowledgeBuilder</tt></li>
+<li><tt>org.drools.KnowledgeBase</tt></li>
+<li><tt>org.drools.agent.KnowledgeAgent</tt></li>
+<li><tt>org.drools.runtime.StatefulKnowledgeSession</tt></li>
+<li><tt>org.drools.runtime.StatelessKnowledgeSession</tt></li>
+</ul>
+</p>
+
+<p>
+Factory classes, with static methods, provide instances of the above interfaces. A pluggable provider approach is used to allow provider implementations to
+be wired up to the factories at runtime. The Factories you will most commonly used are:
+<ul>
+<li><tt>org.drools.builder.KnowledgeBuilderFactory</tt></li>
+<li><tt>org.drools.KnowledgeBaseFactory</tt></li>
+<li><tt>org.drools.agent.KnowledgeAgentFactory</tt></li>
+</ul>
+</p>
+
+<p>
+A Typical example to load a rule resource.
+<pre>
+KnowledgeBuilder kbuilder = KnowledgeBuilderFactory.newKnowledgeBuilder();
+kbuilder.addResource( url,
+ KnowledgeType.DRL );
+if ( kbuilder.hasErrors() ) {
+ System.err.println( builder.getErrors().toString() );
+}
+
+KnowledgeBase kbase = KnowledgeBaseFactory.newKnowledgeBase();
+kbase.addKnowledgePackages( builder.getKnowledgePackages() );
+
+StatefulKnowledgeSession ksession = knowledgeBase.newStatefulKnowledgeSession();
+ksession.insert( new Fibonacci( 10 ) );
+ksession.fireAllRules();
+
+ksession.dispose();
+</pre>
+</p>
+
+<p>
+A Typical example to load a process resource. Notice the KnowledgeType is changed, in accordance with the Resource type.
+<pre>
+KnowledgeBuilder kbuilder = KnowledgeBuilderFactory.newKnowledgeBuilder();
+kbuilder.addResource( url,
+ KnowledgeType.DRF );
+if ( kbuilder.hasErrors() ) {
+ System.err.println( builder.getErrors().toString() );
+}
+
+KnowledgeBase kbase = KnowledgeBaseFactory.newKnowledgeBase();
+kbase.addKnowledgePackages( builder.getKnowledgePackages() );
+
+StatefulKnowledgeSession ksession = knowledgeBase.newStatefulKnowledgeSession();
+ksession.startProcess( "Buy Order Process" );
+
+ksession.dispose();
+</pre>
+</p>
+
+<p>
+'kbuilder', 'kbase', 'ksession' are the variable identifiers often used, the k prefix is for 'knowledge'.
+</p>
+
+<p>
+The majority of Drools API is considered stable and should not change, experimental classes and apis will be marked as such.
+</p>
+</body>
\ No newline at end of file
More information about the jboss-svn-commits
mailing list