[jboss-svn-commits] JBL Code SVN: r26253 - labs/jbossrules/trunk/drools-templates/src/main/java/org/drools/template.

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

Author: laune
Date: 2009-04-25 04:40:45 -0400 (Sat, 25 Apr 2009)
New Revision: 26253

Modified:
   labs/jbossrules/trunk/drools-templates/src/main/java/org/drools/template/DataProviderCompiler.java
Log:
fix javadoc; make closeStream protected (subclass DataProviderCompiler for arbitrary objects

Modified: labs/jbossrules/trunk/drools-templates/src/main/java/org/drools/template/DataProviderCompiler.java
===================================================================
--- labs/jbossrules/trunk/drools-templates/src/main/java/org/drools/template/DataProviderCompiler.java	2009-04-25 02:32:50 UTC (rev 26252)
+++ labs/jbossrules/trunk/drools-templates/src/main/java/org/drools/template/DataProviderCompiler.java	2009-04-25 08:40:45 UTC (rev 26253)
@@ -26,20 +26,19 @@
 import org.drools.template.parser.TemplateContainer;
 import org.drools.template.parser.TemplateDataListener;
 
+/**
+ * An object of this class acts as a template compiler, inserting spreadsheet
+ * data into templates. Template data may come from a resource or an
+ * InputStream, or you may provide a TemplateDataListener.
+ */
 public class DataProviderCompiler {
 
-    /**
-     * Generates DRL from the input stream containing the spreadsheet.
-     * 
-     * @param xlsStream
-     *            The stream to the spreadsheet. Uses the first worksheet found
-     *            for the decision tables, ignores others.
-     * @param type
-     *            The type of the file - InputType.CSV or InputType.XLS
-     * @param listener
-     * @return DRL xml, ready for use in drools.
-     * @throws IOException
-     */
+	/**
+	 * Generates DRL from a data provider for the spreadsheet data and templates.
+	 * @param dataProvider the data provider for the spreadsheet data
+	 * @param template the string containing the template resource name
+	 * @return the generated DRL text as a String
+	 */
     public String compile(final DataProvider dataProvider,
                           final String template) {
         final InputStream templateStream = this.getClass().getResourceAsStream( template );
@@ -47,6 +46,12 @@
                         templateStream );
     }
 
+    /**
+	 * Generates DRL from a data provider for the spreadsheet data and templates.
+     * @param dataProvider the data provider for the spreadsheet data
+     * @param templateStream the InputStream for reading the templates
+     * @return the generated DRL text as a String
+     */
     public String compile(final DataProvider dataProvider,
                           final InputStream templateStream) {
         TemplateContainer tc = new DefaultTemplateContainer( templateStream );
@@ -55,6 +60,12 @@
                         new TemplateDataListener( tc ) );
     }
 
+    /**
+     * Generates DRL from a data provider for the spreadsheet data and templates.
+     * @param dataProvider the data provider for the spreadsheet data
+     * @param listener a template data listener
+     * @return the generated DRL text as a String
+     */
     public String compile(final DataProvider dataProvider,
                           final TemplateDataListener listener) {
         List<DataListener> listeners = new ArrayList<DataListener>();
@@ -112,7 +123,7 @@
         }
     }
 
-    private void closeStream(final InputStream stream) {
+    protected void closeStream(final InputStream stream) {
         try {
             stream.close();
         } catch ( final Exception e ) {