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

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

Author: mark.proctor at jboss.com
Date: 2008-11-20 10:53:05 -0500 (Thu, 20 Nov 2008)
New Revision: 23998

Modified:
   labs/jbossrules/trunk/drools-api/src/main/java/org/drools/KnowledgeBaseFactory.java
   labs/jbossrules/trunk/drools-api/src/main/java/org/drools/KnowledgeBaseProvider.java
   labs/jbossrules/trunk/drools-api/src/main/java/org/drools/PropertiesConfiguration.java
   labs/jbossrules/trunk/drools-api/src/main/java/org/drools/ProviderInitializationException.java
   labs/jbossrules/trunk/drools-api/src/main/java/org/drools/agent/KnowledgeAgent.java
Log:
-more javadocs

Modified: labs/jbossrules/trunk/drools-api/src/main/java/org/drools/KnowledgeBaseFactory.java
===================================================================
--- labs/jbossrules/trunk/drools-api/src/main/java/org/drools/KnowledgeBaseFactory.java	2008-11-20 15:36:24 UTC (rev 23997)
+++ labs/jbossrules/trunk/drools-api/src/main/java/org/drools/KnowledgeBaseFactory.java	2008-11-20 15:53:05 UTC (rev 23998)
@@ -66,7 +66,7 @@
             Class<KnowledgeBaseProvider> cls = (Class<KnowledgeBaseProvider>) Class.forName( "org.drools.impl.KnowledgeBaseProviderImpl" );
             setKnowledgeBaseProvider( cls.newInstance() );
         } catch ( Exception e ) {
-            throw new ProviderInitializationException( "Provider org.drools.impl.KnowledgeBaseProviderImpl could not be set." );
+            throw new ProviderInitializationException( "Provider org.drools.impl.KnowledgeBaseProviderImpl could not be set.", e );
         }
     }
 }

Modified: labs/jbossrules/trunk/drools-api/src/main/java/org/drools/KnowledgeBaseProvider.java
===================================================================
--- labs/jbossrules/trunk/drools-api/src/main/java/org/drools/KnowledgeBaseProvider.java	2008-11-20 15:36:24 UTC (rev 23997)
+++ labs/jbossrules/trunk/drools-api/src/main/java/org/drools/KnowledgeBaseProvider.java	2008-11-20 15:53:05 UTC (rev 23998)
@@ -2,6 +2,13 @@
 
 import java.util.Properties;
 
+/**
+ * KnowledgeBaseProvider is used by the KnowledgeBaseFacotry 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 KnowledgeBaseProvider {
 
     /**

Modified: labs/jbossrules/trunk/drools-api/src/main/java/org/drools/PropertiesConfiguration.java
===================================================================
--- labs/jbossrules/trunk/drools-api/src/main/java/org/drools/PropertiesConfiguration.java	2008-11-20 15:36:24 UTC (rev 23997)
+++ labs/jbossrules/trunk/drools-api/src/main/java/org/drools/PropertiesConfiguration.java	2008-11-20 15:53:05 UTC (rev 23998)
@@ -1,8 +1,25 @@
 package org.drools;
 
+/**
+ * Base class for other Configuration classes.
+ *
+ */
 public interface PropertiesConfiguration {
+    
+    /**
+     * Sets a property value
+     * 
+     * @param name
+     * @param value
+     */
     public void setProperty(String name,
                             String value);
 
+    /**
+     * Gets a property value
+     * 
+     * @param name
+     * @return
+     */
     public String getProperty(String name);
 }

Modified: labs/jbossrules/trunk/drools-api/src/main/java/org/drools/ProviderInitializationException.java
===================================================================
--- labs/jbossrules/trunk/drools-api/src/main/java/org/drools/ProviderInitializationException.java	2008-11-20 15:36:24 UTC (rev 23997)
+++ labs/jbossrules/trunk/drools-api/src/main/java/org/drools/ProviderInitializationException.java	2008-11-20 15:53:05 UTC (rev 23998)
@@ -17,10 +17,11 @@
  */
 
 /**
- * The factory was unable to initialize a provider.
+ * If a provider is not set on a factory it will attempt to initialise one, typically using reflection.
+ * If an issue occured while doing this a ProviderInitializationException is created.
  * 
  * @see RuntimeException
-
+ *
  */
 public class ProviderInitializationException extends RuntimeException {
     /**

Modified: labs/jbossrules/trunk/drools-api/src/main/java/org/drools/agent/KnowledgeAgent.java
===================================================================
--- labs/jbossrules/trunk/drools-api/src/main/java/org/drools/agent/KnowledgeAgent.java	2008-11-20 15:36:24 UTC (rev 23997)
+++ labs/jbossrules/trunk/drools-api/src/main/java/org/drools/agent/KnowledgeAgent.java	2008-11-20 15:53:05 UTC (rev 23998)
@@ -3,7 +3,12 @@
 import org.drools.KnowledgeBase;
 
 /**
- * The KnowlegeAgent
+ * The KnowlegeAgent is created by the KnowlegeAgentFactory. It's roll is to provide a cached
+ * KnowlegeBase and to update or rebuild this KnowlegeBase as the resources it uses are changed.
+ * The strategy for this is determined by the configuration given to the factory, but it is 
+ * typically pull based using regular polling. We hope to add push based updates and rebuilds in future
+ * versions.
+ * 
  */
 public interface KnowledgeAgent {
     /**