[jboss-svn-commits] JBL Code SVN: r24004 - in labs/jbossrules/trunk/drools-api/src/main/java/org/drools: builder and 1 other directories.

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

Author: mark.proctor at jboss.com
Date: 2008-11-20 14:31:23 -0500 (Thu, 20 Nov 2008)
New Revision: 24004

Modified:
   labs/jbossrules/trunk/drools-api/src/main/java/org/drools/KnowledgeBaseConfiguration.java
   labs/jbossrules/trunk/drools-api/src/main/java/org/drools/builder/KnowledgeBuilderError.java
   labs/jbossrules/trunk/drools-api/src/main/java/org/drools/builder/KnowledgeBuilderErrors.java
   labs/jbossrules/trunk/drools-api/src/main/java/org/drools/builder/KnowledgeBuilderFactory.java
   labs/jbossrules/trunk/drools-api/src/main/java/org/drools/builder/KnowledgeBuilderProvider.java
   labs/jbossrules/trunk/drools-api/src/main/java/org/drools/builder/ResourceConfiguration.java
   labs/jbossrules/trunk/drools-api/src/main/java/org/drools/definition/KnowledgePackage.java
Log:
-some more javadocs

Modified: labs/jbossrules/trunk/drools-api/src/main/java/org/drools/KnowledgeBaseConfiguration.java
===================================================================
--- labs/jbossrules/trunk/drools-api/src/main/java/org/drools/KnowledgeBaseConfiguration.java	2008-11-20 19:21:48 UTC (rev 24003)
+++ labs/jbossrules/trunk/drools-api/src/main/java/org/drools/KnowledgeBaseConfiguration.java	2008-11-20 19:31:23 UTC (rev 24004)
@@ -43,6 +43,7 @@
  * </ul>
  * </p>
  * 
+ * 
  * <p>
  * The follow properties have not yet been migrated from the Drools 4.0 api:
  * <ul>

Modified: labs/jbossrules/trunk/drools-api/src/main/java/org/drools/builder/KnowledgeBuilderError.java
===================================================================
--- labs/jbossrules/trunk/drools-api/src/main/java/org/drools/builder/KnowledgeBuilderError.java	2008-11-20 19:21:48 UTC (rev 24003)
+++ labs/jbossrules/trunk/drools-api/src/main/java/org/drools/builder/KnowledgeBuilderError.java	2008-11-20 19:31:23 UTC (rev 24004)
@@ -1,5 +1,9 @@
 package org.drools.builder;
 
+/**
+ * A reported error during the build process.
+ *
+ */
 public interface KnowledgeBuilderError {
 
     /**

Modified: labs/jbossrules/trunk/drools-api/src/main/java/org/drools/builder/KnowledgeBuilderErrors.java
===================================================================
--- labs/jbossrules/trunk/drools-api/src/main/java/org/drools/builder/KnowledgeBuilderErrors.java	2008-11-20 19:21:48 UTC (rev 24003)
+++ labs/jbossrules/trunk/drools-api/src/main/java/org/drools/builder/KnowledgeBuilderErrors.java	2008-11-20 19:31:23 UTC (rev 24004)
@@ -2,6 +2,10 @@
 
 import java.util.Collection;
 
+/**
+ * A typed collection of errors.
+ *
+ */
 public interface KnowledgeBuilderErrors
     extends
     Collection<KnowledgeBuilderError> {

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	2008-11-20 19:21:48 UTC (rev 24003)
+++ labs/jbossrules/trunk/drools-api/src/main/java/org/drools/builder/KnowledgeBuilderFactory.java	2008-11-20 19:31:23 UTC (rev 24004)
@@ -63,15 +63,15 @@
      * can be determined. 
      * 
      * <pre>
-     * DecisionTableConfiguration dtConf = KnowledgeBuilderFactory.newDecisionTableConfiguration();
-     * dtConf.setInputType( DecisionTableInputType.XLS );
-     *
      * KnowledgeBuilder kbuilder = KnowledgeBuilderFactory.newKnowledgeBuilder();
-     * kbuilder.addResource( new InputStreamReader( getSpreadsheetStream(),
-     *                                             "windows-1252" ),
+     * DecisionTableConfiguration dtconf = KnowledgeBuilderFactory.newDecisionTableConfiguration();
+     * dtconf.setInputType( DecisionTableInputType.XLS );
+     * dtconf.setWorksheetName( "Tables_2" );
+     * kbuilder.addResource( new URL( "file://IntegrationExampleTest.xls" ),
      *                       KnowledgeType.DTABLE,
-     *                       dtConf );
-     *                      
+     *                       dtconf );
+     * assertFalse( kbuilder.hasErrors() );
+     * KnowledgeBase kbase = KnowledgeBaseFactory.newKnowledgeBase();
      * </pre>
      * 
      * @return

Modified: labs/jbossrules/trunk/drools-api/src/main/java/org/drools/builder/KnowledgeBuilderProvider.java
===================================================================
--- labs/jbossrules/trunk/drools-api/src/main/java/org/drools/builder/KnowledgeBuilderProvider.java	2008-11-20 19:21:48 UTC (rev 24003)
+++ labs/jbossrules/trunk/drools-api/src/main/java/org/drools/builder/KnowledgeBuilderProvider.java	2008-11-20 19:31:23 UTC (rev 24004)
@@ -2,6 +2,13 @@
 
 import java.util.Properties;
 
+/**
+ * KnowledgeBuilderProvider is used by the KnowledgeBuilderFacotry to "provide" it's concrete implementation.
+ * 
+ * This class is not considered stable and may change, the user is protected from this change by using 
+ * the Factory api, which is consiered stable.
+ *
+ */
 public interface KnowledgeBuilderProvider {
     /**
      * Instantiate and return a new KnowledgeBuilderConfiguration

Modified: labs/jbossrules/trunk/drools-api/src/main/java/org/drools/builder/ResourceConfiguration.java
===================================================================
--- labs/jbossrules/trunk/drools-api/src/main/java/org/drools/builder/ResourceConfiguration.java	2008-11-20 19:21:48 UTC (rev 24003)
+++ labs/jbossrules/trunk/drools-api/src/main/java/org/drools/builder/ResourceConfiguration.java	2008-11-20 19:31:23 UTC (rev 24004)
@@ -1,5 +1,11 @@
 package org.drools.builder;
 
+/**
+ * This interface is a marker interface and should be implemented by any class
+ * that will provide configurations to the KnowledgeBuilder - currently this is 
+ * only used by decision tables.
+ *
+ */
 public interface ResourceConfiguration {
 
 }

Modified: labs/jbossrules/trunk/drools-api/src/main/java/org/drools/definition/KnowledgePackage.java
===================================================================
--- labs/jbossrules/trunk/drools-api/src/main/java/org/drools/definition/KnowledgePackage.java	2008-11-20 19:21:48 UTC (rev 24003)
+++ labs/jbossrules/trunk/drools-api/src/main/java/org/drools/definition/KnowledgePackage.java	2008-11-20 19:31:23 UTC (rev 24004)
@@ -5,11 +5,33 @@
 import org.drools.definition.process.Process;
 import org.drools.definition.rule.Rule;
 
+/**
+ * This provides a collection of knowledge definitions that can be given to a KnowledgeBase.
+ * The name is used to provide "namespace" spearation of those defintions
+ * 
+ *
+ */
 public interface KnowledgePackage {
+    /**
+     * The namespace for this package
+     * @return
+     */
     String getName();
 
+    /**
+     * Return the rule definitions for this package.
+     * The collection is immutable.
+     * 
+     * @return
+     */   
     Collection<Rule> getRules();
 
+    /**
+     * Return the process definitions for this package.
+     * The collection is immutable.
+     * 
+     * @return
+     */
     Collection<Process> getProcesses();
 
 }