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

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

Revision: 2433
          http://openutils.svn.sourceforge.net/openutils/?rev=2433&view=rev
Author:   diego_schivo
Date:     2010-05-13 05:51:27 +0000 (Thu, 13 May 2010)

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

Modified Paths:
--------------
    trunk/openutils-mgnlcriteria/src/main/java/net/sourceforge/openutils/mgnlcriteria/advanced/impl/AdvancedCriteriaImpl.java
    trunk/openutils-mgnlcriteria/src/main/java/net/sourceforge/openutils/mgnlcriteria/advanced/impl/AdvancedResultImpl.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/ExecutableQuery.java
    trunk/openutils-mgnlcriteria/src/main/java/net/sourceforge/openutils/mgnlcriteria/jcr/query/JCRCriteriaFactory.java

Modified: trunk/openutils-mgnlcriteria/src/main/java/net/sourceforge/openutils/mgnlcriteria/advanced/impl/AdvancedCriteriaImpl.java
===================================================================
--- trunk/openutils-mgnlcriteria/src/main/java/net/sourceforge/openutils/mgnlcriteria/advanced/impl/AdvancedCriteriaImpl.java	2010-05-12 17:49:11 UTC (rev 2432)
+++ trunk/openutils-mgnlcriteria/src/main/java/net/sourceforge/openutils/mgnlcriteria/advanced/impl/AdvancedCriteriaImpl.java	2010-05-13 05:51:27 UTC (rev 2433)
@@ -33,11 +33,6 @@
 public class AdvancedCriteriaImpl extends AbstractCriteriaImpl implements Criteria
 {
 
-    public AdvancedCriteriaImpl()
-    {
-        // empty
-    }
-
     /**
      * {@inheritDoc}
      */

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:49:11 UTC (rev 2432)
+++ trunk/openutils-mgnlcriteria/src/main/java/net/sourceforge/openutils/mgnlcriteria/advanced/impl/AdvancedResultImpl.java	2010-05-13 05:51:27 UTC (rev 2433)
@@ -65,7 +65,12 @@
     private Logger log = LoggerFactory.getLogger(AdvancedResultImpl.class);
 
     /**
-     * @param execute
+     * @param jcrQueryResult
+     * @param itemsPerPage
+     * @param pageNumberStartingFromOne
+     * @param statement
+     * @param hm
+     * @param spellCheckerQuery
      */
     public AdvancedResultImpl(
         QueryResultImpl jcrQueryResult,

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:49:11 UTC (rev 2432)
+++ trunk/openutils-mgnlcriteria/src/main/java/net/sourceforge/openutils/mgnlcriteria/jcr/query/AdvancedResult.java	2010-05-13 05:51:27 UTC (rev 2433)
@@ -53,7 +53,7 @@
     int getNumberOfPages();
 
     /**
-     * 
+     * Gets the suggestion from the spell checker
      * @return
      */
     String getSpellCheckerSuggestion();

Modified: trunk/openutils-mgnlcriteria/src/main/java/net/sourceforge/openutils/mgnlcriteria/jcr/query/ExecutableQuery.java
===================================================================
--- trunk/openutils-mgnlcriteria/src/main/java/net/sourceforge/openutils/mgnlcriteria/jcr/query/ExecutableQuery.java	2010-05-12 17:49:11 UTC (rev 2432)
+++ trunk/openutils-mgnlcriteria/src/main/java/net/sourceforge/openutils/mgnlcriteria/jcr/query/ExecutableQuery.java	2010-05-13 05:51:27 UTC (rev 2433)
@@ -27,5 +27,9 @@
 public interface ExecutableQuery
 {
 
+    /**
+     * Executes the query
+     * @return the search result
+     */
     AdvancedResult execute();
 }

Modified: trunk/openutils-mgnlcriteria/src/main/java/net/sourceforge/openutils/mgnlcriteria/jcr/query/JCRCriteriaFactory.java
===================================================================
--- trunk/openutils-mgnlcriteria/src/main/java/net/sourceforge/openutils/mgnlcriteria/jcr/query/JCRCriteriaFactory.java	2010-05-12 17:49:11 UTC (rev 2432)
+++ trunk/openutils-mgnlcriteria/src/main/java/net/sourceforge/openutils/mgnlcriteria/jcr/query/JCRCriteriaFactory.java	2010-05-13 05:51:27 UTC (rev 2433)
@@ -37,11 +37,22 @@
     {
     }
 
+    /**
+     * Creates a query criteria for dynamic query composition.
+     * @return an AdvancedCriteriaImpl
+     */
     public static Criteria createCriteria()
     {
         return new AdvancedCriteriaImpl();
     }
 
+    /**
+     * Creates a jcr query using the specified statement.
+     * @param hm the HierarchyManager
+     * @param query the statement of the query
+     * @param language the language of the query
+     * @return a DirectJcrQuery
+     */
     public static DirectJcrQuery createDirectJcrQuery(HierarchyManager hm, String query, String language)
     {
         return new DirectJcrQuery(hm, query, language);


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