[jboss-svn-commits] JBL Code SVN: r25437 - labs/jbossrules/trunk/drools-api/src/main/java/org/drools/builder.

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

Author: mark.proctor at jboss.com
Date: 2009-02-26 10:04:18 -0500 (Thu, 26 Feb 2009)
New Revision: 25437

Modified:
   labs/jbossrules/trunk/drools-api/src/main/java/org/drools/builder/KnowledgeBuilderConfiguration.java
   labs/jbossrules/trunk/drools-api/src/main/java/org/drools/builder/KnowledgeBuilderFactory.java
Log:
-updated javadocs.

Modified: labs/jbossrules/trunk/drools-api/src/main/java/org/drools/builder/KnowledgeBuilderConfiguration.java
===================================================================
--- labs/jbossrules/trunk/drools-api/src/main/java/org/drools/builder/KnowledgeBuilderConfiguration.java	2009-02-26 12:06:46 UTC (rev 25436)
+++ labs/jbossrules/trunk/drools-api/src/main/java/org/drools/builder/KnowledgeBuilderConfiguration.java	2009-02-26 15:04:18 UTC (rev 25437)
@@ -33,12 +33,39 @@
  * <li>drools.accumulate.function.&lt;function name&gt; = &lt;qualified class&gt;</li>
  * <li>drools.evaluator.<ident> = &lt;qualified class&gt;</li>
  * <li>drools.dump.dir = &lt;String&gt;</li>
- * <li>drools.parser.processStringEscapes = $lt;true|false&gt;</li>
+ * <li>drools.parser.processStringEscapes = &lt;true|false&gt;</li>
  * </ul>
  * </p>
  * 
  * <p>
- * default dialect is java.
+ * Two dialects are supported, Java and MVEL. Java is the default dialect.<br/>
+ * The Java dialect supports the following configurations:
+ * <ul>
+ * <li>drools.dialect.java.compiler = &lt;ECLIPSE|JANINO&gt;</li>
+ * <li>drools.dialect.java.lngLevel = &lt;1.5|1.6&gt;</li>
+ * </ul>
+ * 
+ * And MVEL supports the following configurations:
+ * <ul>
+ * <li>drools.dialect.mvel.strict = &lt;true|false&gt;</li>
+ * </ul>
+ * </p>
+ * 
+ * <p>
+ * So for example if we wanted to create a new KnowledgeBuilder that used Janino as the default compiler we would do the following:<br/>
+ * <pre>
+ * KnowledgeBuilderConfiguration config = KnowledgeBuilderFactory.newKnowledgeBuilderConfiguration();
+ * config.setProperty("drools.dialect.java.compiler", "JANINO");
+ * KnowledgeBuilder kbuilder = KnowledgeBuilderFactory.newKnowledgeBuilder( config );
+ * </pre>
+ * </p>
+ * 
+ * <p>
+ * Remember the KnowledgeBuilderConfiguration could have taken a Properties instance with that setting in it at constructor time,
+ * or it could also discover from a disk based properties file too.
+ * </p>
+ * 
+ * <p>
  * Available pre-configured Accumulate functions are:
  * <ul>
  * <li>drools.accumulate.function.average = org.drools.base.accumulators.AverageAccumulateFunction</li>

Modified: labs/jbossrules/trunk/drools-api/src/main/java/org/drools/builder/KnowledgeBuilderFactory.java
===================================================================
--- labs/jbossrules/trunk/drools-api/src/main/java/org/drools/builder/KnowledgeBuilderFactory.java	2009-02-26 12:06:46 UTC (rev 25436)
+++ labs/jbossrules/trunk/drools-api/src/main/java/org/drools/builder/KnowledgeBuilderFactory.java	2009-02-26 15:04:18 UTC (rev 25437)
@@ -9,7 +9,8 @@
  * This factory is used to build the knowledge base definitions that are held collectively in
  * KnowledgePackages. The KnowledgePackage also provides the role of 'namespacing'. An optional
  * KnowlegeBuilderConfiguration can be supplied. The KnowledgeBuilderConfiguration is itself
- * created from this factory.
+ * created from this factory. The KnowledgeBuilderConfiguration allows you to set the ClassLoader to be used
+ * along with other setting like the default dialect and compiler, as well as many other options.
  * 
  * <pre>
  * KnowledgeBuilder kbuilder = KnowlegeBuilderFactory.newKnowledgeBuilder();