svn commit: r652370 - /forrest/trunk/plugins/org.apache.forrest.plugin.output.inputModule/src/java/org/apache/forrest/generation/ModuleGenerator.java

[thorsten]

Author: thorsten
Date: Wed Apr 30 05:38:05 2008
New Revision: 652370

URL: http://svn.apache.org/viewvc?rev=652370&view=rev
Log:
Adding javadocs.

Modified:
    
forrest/trunk/plugins/org.apache.forrest.plugin.output.inputModule/src/java/org/apache/forrest/generation/ModuleGenerator.java

Modified: 
forrest/trunk/plugins/org.apache.forrest.plugin.output.inputModule/src/java/org/apache/forrest/generation/ModuleGenerator.java
URL: 
http://svn.apache.org/viewvc/forrest/trunk/plugins/org.apache.forrest.plugin.output.inputModule/src/java/org/apache/forrest/generation/ModuleGenerator.java?rev=652370&r1=652369&r2=652370&view=diff
==============================================================================
--- 
forrest/trunk/plugins/org.apache.forrest.plugin.output.inputModule/src/java/org/apache/forrest/generation/ModuleGenerator.java
 (original)
+++ 
forrest/trunk/plugins/org.apache.forrest.plugin.output.inputModule/src/java/org/apache/forrest/generation/ModuleGenerator.java
 Wed Apr 30 05:38:05 2008
@@ -38,6 +38,28 @@
 import org.apache.excalibur.source.impl.validity.NOPValidity;
 import org.xml.sax.SAXException;
 
+/**
+ * The module generator will connect to the input module
+ * specified by the [EMAIL PROTECTED] #MODULE_PARAM}.
+ * The generator will then create a property file out of the 
+ * iteration of the [EMAIL PROTECTED] InputModule#getAttributeNames()} method.
+ *  <p>
+ *  The result will look like:<br>
+ *  <code>
+ *  &lt;properties&gt;<br>
+ *  &nbsp;&lt;property value="InputModuleValue" name="InputModuleKey"/><br>
+ *  &lt;/properties&gt;
+ *  <p>
+ *  Use it from the sitemap like:<br>
+ *  <code>
+ *  &lt;map:match pattern="module.*.properties"&gt;<br>
+ *    &nbsp;&lt;map:generate type="module"&gt;<br>
+ *     &nbsp;&nbsp; &lt;map:parameter name="input-module" value="{1}"/&gt;<br>
+ *   &nbsp; &lt;/map:generate&gt;<br>
+ *   &nbsp; &lt;map:serialize type="xml"/&gt;<br>
+ *  &lt;/map:match&gt;
+ *
+ */
 public class ModuleGenerator extends AbstractGenerator implements Serviceable,
         CacheableProcessingComponent {
     private ServiceSelector selector;