[Openutils-svn] SF.net SVN: openutils:[2432] trunk/openutils-mgnlcriteria/src/main/java/net /sourceforge/openutils/mgnlcriteria

[<die...@us...>]

Revision: 2432
          http://openutils.svn.sourceforge.net/openutils/?rev=2432&view=rev
Author:   diego_schivo
Date:     2010-05-12 17:49:11 +0000 (Wed, 12 May 2010)

Log Message:
-----------
CRIT-11 javadocs

Modified Paths:
--------------
    trunk/openutils-mgnlcriteria/src/main/java/net/sourceforge/openutils/mgnlcriteria/advanced/impl/AdvancedResultImpl.java
    trunk/openutils-mgnlcriteria/src/main/java/net/sourceforge/openutils/mgnlcriteria/advanced/impl/AdvancedResultItemImpl.java
    trunk/openutils-mgnlcriteria/src/main/java/net/sourceforge/openutils/mgnlcriteria/advanced/impl/QueryExecutorHelper.java
    trunk/openutils-mgnlcriteria/src/main/java/net/sourceforge/openutils/mgnlcriteria/jcr/query/AdvancedResult.java
    trunk/openutils-mgnlcriteria/src/main/java/net/sourceforge/openutils/mgnlcriteria/jcr/query/AdvancedResultItem.java

Modified: trunk/openutils-mgnlcriteria/src/main/java/net/sourceforge/openutils/mgnlcriteria/advanced/impl/AdvancedResultImpl.java
===================================================================
--- trunk/openutils-mgnlcriteria/src/main/java/net/sourceforge/openutils/mgnlcriteria/advanced/impl/AdvancedResultImpl.java	2010-05-12 17:17:07 UTC (rev 2431)
+++ trunk/openutils-mgnlcriteria/src/main/java/net/sourceforge/openutils/mgnlcriteria/advanced/impl/AdvancedResultImpl.java	2010-05-12 17:49:11 UTC (rev 2432)
@@ -117,6 +117,9 @@
             .ceil(((float) jcrQueryResult.getTotalSize() / (float) itemsPerPage))) : 1;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     public ResultIterator<AdvancedResultItem> getItems()
     {
 

Modified: trunk/openutils-mgnlcriteria/src/main/java/net/sourceforge/openutils/mgnlcriteria/advanced/impl/AdvancedResultItemImpl.java
===================================================================
--- trunk/openutils-mgnlcriteria/src/main/java/net/sourceforge/openutils/mgnlcriteria/advanced/impl/AdvancedResultItemImpl.java	2010-05-12 17:17:07 UTC (rev 2431)
+++ trunk/openutils-mgnlcriteria/src/main/java/net/sourceforge/openutils/mgnlcriteria/advanced/impl/AdvancedResultItemImpl.java	2010-05-12 17:49:11 UTC (rev 2432)
@@ -63,8 +63,7 @@
     }
 
     /**
-     * Returns the excerpt.
-     * @return the excerpt
+     * {@inheritDoc}
      */
     public String getExcerpt()
     {
@@ -73,8 +72,7 @@
     }
 
     /**
-     * Returns the excerpt.
-     * @return the excerpt
+     * {@inheritDoc}
      */
     public String getExcerpt(String selector)
     {
@@ -107,8 +105,7 @@
     }
 
     /**
-     * Returns the score.
-     * @return the score
+     * {@inheritDoc}
      */
     public double getScore()
     {
@@ -116,8 +113,7 @@
     }
 
     /**
-     * Returns the score.
-     * @return the score
+     * {@inheritDoc}
      */
     public double getScore(String selector)
     {

Modified: trunk/openutils-mgnlcriteria/src/main/java/net/sourceforge/openutils/mgnlcriteria/advanced/impl/QueryExecutorHelper.java
===================================================================
--- trunk/openutils-mgnlcriteria/src/main/java/net/sourceforge/openutils/mgnlcriteria/advanced/impl/QueryExecutorHelper.java	2010-05-12 17:17:07 UTC (rev 2431)
+++ trunk/openutils-mgnlcriteria/src/main/java/net/sourceforge/openutils/mgnlcriteria/advanced/impl/QueryExecutorHelper.java	2010-05-12 17:49:11 UTC (rev 2432)
@@ -49,6 +49,16 @@
      */
     private static Logger log = LoggerFactory.getLogger(QueryExecutorHelper.class);
 
+    /**
+     * Executes a jcr query.
+     * @param stmt the statement of the jcr query
+     * @param language the language of the jcr query
+     * @param hm the HirarchyManager for obtaining the QueryManager
+     * @param maxResults maximun number of results to retrieve
+     * @param offset the index of the first result to retrieve (0, 1, 2, ...)
+     * @param spellCheckString
+     * @return
+     */
     public static AdvancedResultImpl execute(String stmt, String language, HierarchyManager hm, int maxResults,
         int offset, String spellCheckString)
     {

Modified: trunk/openutils-mgnlcriteria/src/main/java/net/sourceforge/openutils/mgnlcriteria/jcr/query/AdvancedResult.java
===================================================================
--- trunk/openutils-mgnlcriteria/src/main/java/net/sourceforge/openutils/mgnlcriteria/jcr/query/AdvancedResult.java	2010-05-12 17:17:07 UTC (rev 2431)
+++ trunk/openutils-mgnlcriteria/src/main/java/net/sourceforge/openutils/mgnlcriteria/jcr/query/AdvancedResult.java	2010-05-12 17:49:11 UTC (rev 2432)
@@ -21,22 +21,47 @@
 
 
 /**
+ * The result of an advanced jcr query. 
  * @author fgiust
  * @version $Id$
  */
 public interface AdvancedResult
 {
 
+    /**
+     * Gets the maximum number of results per page
+     * @return
+     */
     int getItemsPerPage();
 
+    /**
+     * Gets the page number (1, 2, 3...)
+     * @return
+     */
     int getPage();
 
+    /**
+     * Gets the total number of results that would be retrieved without pagination
+     * @return
+     */
     int getTotalSize();
 
+    /**
+     * Gets the total number of pages
+     * @return
+     */
     int getNumberOfPages();
 
+    /**
+     * 
+     * @return
+     */
     String getSpellCheckerSuggestion();
 
+    /**
+     * Gets an iterator over the results
+     * @return
+     */
     ResultIterator<AdvancedResultItem> getItems();
 
     public static AdvancedResult EMPTY_RESULT = new AdvancedResult()

Modified: trunk/openutils-mgnlcriteria/src/main/java/net/sourceforge/openutils/mgnlcriteria/jcr/query/AdvancedResultItem.java
===================================================================
--- trunk/openutils-mgnlcriteria/src/main/java/net/sourceforge/openutils/mgnlcriteria/jcr/query/AdvancedResultItem.java	2010-05-12 17:17:07 UTC (rev 2431)
+++ trunk/openutils-mgnlcriteria/src/main/java/net/sourceforge/openutils/mgnlcriteria/jcr/query/AdvancedResultItem.java	2010-05-12 17:49:11 UTC (rev 2432)
@@ -29,11 +29,27 @@
 public interface AdvancedResultItem extends Content
 {
 
+    /**
+     * Returns the excerpt.
+     * @return the excerpt
+     */
     String getExcerpt();
 
+    /**
+     * Returns the excerpt.
+     * @return the excerpt
+     */
     String getExcerpt(String selector);
 
+    /**
+     * Returns the score.
+     * @return the score
+     */
     double getScore();
 
+    /**
+     * Returns the score.
+     * @return the score
+     */
     double getScore(String selector);
 }


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.