svn commit: r791025 - in /lenya/contributions/2_0_X/modules/tagcloud/java/src/org/apache/lenya/modules/tagcloud: IndexTermsGenerator.java PathToUuidModule.java

Author: andreas
Date: Fri Jul  3 21:38:45 2009
New Revision: 791025

URL: http://svn.apache.org/viewvc?rev=791025&view=rev
Log:
[minor change] added javadocs

Modified:
    lenya/contributions/2_0_X/modules/tagcloud/java/src/org/apache/lenya/modules/tagcloud/IndexTermsGenerator.java
    lenya/contributions/2_0_X/modules/tagcloud/java/src/org/apache/lenya/modules/tagcloud/PathToUuidModule.java

Modified: lenya/contributions/2_0_X/modules/tagcloud/java/src/org/apache/lenya/modules/tagcloud/IndexTermsGenerator.java
URL: http://svn.apache.org/viewvc/lenya/contributions/2_0_X/modules/tagcloud/java/src/org/apache/lenya/modules/tagcloud/IndexTermsGenerator.java?rev=791025&r1=791024&r2=791025&view=diff
==============================================================================
--- lenya/contributions/2_0_X/modules/tagcloud/java/src/org/apache/lenya/modules/tagcloud/IndexTermsGenerator.java (original)
+++ lenya/contributions/2_0_X/modules/tagcloud/java/src/org/apache/lenya/modules/tagcloud/IndexTermsGenerator.java Fri Jul  3 21:38:45 2009
@@ -39,6 +39,31 @@
 import org.xml.sax.SAXException;
 import org.xml.sax.helpers.AttributesImpl;
 
+/**
+ * <p>
+ * Generate a list of terms for a particular index field.
+ * <p>
+ * <p>
+ * Example output:
+ * </p>
+ * <pre>
+ * &lt;terms xmlns="http://apache.org/lenya/search"
+ *     field="{http://purl.org/dc/elements/1.1/}subject"&gt;
+ *   &lt;term hits="1" relativeHits="2"&gt;foo&lt;/term&gt;
+ *   &lt;term hits="2" relativeHits="4"&gt;bar&lt;/term&gt;
+ *   &lt;term hits="1" relativeHits="2"&gt;baz&lt;/term&gt;
+ * &lt;/terms&gt;
+ * </pre>
+ * <p>
+ * Parameters:
+ * </p>
+ * <ul>
+ * <li><em>indexPath:</em> the path of the Lucene index</li>
+ * <li><em>field:</em> the name of the index field</li>
+ * <li><em>max:</em> the maximum reference to compute the relative hit numbers</li>
+ * <li><em>language:</em> the language (optional, if omitted all languages are considered)</li>
+ * </ul>
+ */
 public class IndexTermsGenerator extends AbstractGenerator {
 
     public static final String NAMESPACE = "http://apache.org/lenya/search";

Modified: lenya/contributions/2_0_X/modules/tagcloud/java/src/org/apache/lenya/modules/tagcloud/PathToUuidModule.java
URL: http://svn.apache.org/viewvc/lenya/contributions/2_0_X/modules/tagcloud/java/src/org/apache/lenya/modules/tagcloud/PathToUuidModule.java?rev=791025&r1=791024&r2=791025&view=diff
==============================================================================
--- lenya/contributions/2_0_X/modules/tagcloud/java/src/org/apache/lenya/modules/tagcloud/PathToUuidModule.java (original)
+++ lenya/contributions/2_0_X/modules/tagcloud/java/src/org/apache/lenya/modules/tagcloud/PathToUuidModule.java Fri Jul  3 21:38:45 2009
@@ -35,6 +35,17 @@
 import org.apache.lenya.cms.repository.RepositoryUtil;
 import org.apache.lenya.cms.repository.Session;
 
+/**
+ * <p>
+ * Lookup the UUID of a site structure node.
+ * </p>
+ * <p>
+ * Syntax: <code>{path2uuid:pub:area:/path/to/node}</code>
+ * </p>
+ * <p>
+ * Output: The UUID of the node.
+ * </p>
+ */
 public class PathToUuidModule extends AbstractInputModule implements Serviceable {
 
     private ServiceManager manager;