svn commit: r649082 - /cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/main/java/org/apache/cayenne/query/ProcedureQuery.java

[aa...@apache.org]

Author: aadamchik
Date: Thu Apr 17 06:08:11 2008
New Revision: 649082

URL: http://svn.apache.org/viewvc?rev=649082&view=rev
Log:
updating javadocs, take 2

Modified:
    cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/main/java/org/apache/cayenne/query/ProcedureQuery.java

Modified: cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/main/java/org/apache/cayenne/query/ProcedureQuery.java
URL: http://svn.apache.org/viewvc/cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/main/java/org/apache/cayenne/query/ProcedureQuery.java?rev=649082&r1=649081&r2=649082&view=diff
==============================================================================
--- cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/main/java/org/apache/cayenne/query/ProcedureQuery.java (original)
+++ cayenne/main/trunk/framework/cayenne-jdk1.5-unpublished/src/main/java/org/apache/cayenne/query/ProcedureQuery.java Thu Apr 17 06:08:11 2008
@@ -81,8 +81,11 @@
     protected List<ColumnDescriptor[]> resultDescriptors;
 
     /**
-     * Creates an empty procedure query. The query would fetch DataRows. Use
-     * {@link #setFetchingDataRows(boolean)} method to fetch objects.
+     * Creates an empty procedure query. The query would fetch DataRows. Fetching
+     * Persistent objects can be achieved either by using
+     * {@link #ProcedureQuery(String, Class)} constructor or by calling
+     * {@link #setFetchingDataRows(boolean)} and {@link #setResultEntityName(String)}
+     * methods.
      */
     public ProcedureQuery() {
         // for backwards compatibility we go against usual default...
@@ -91,7 +94,10 @@
 
     /**
      * Creates a ProcedureQuery based on a Procedure object. The query would fetch
-     * DataRows. Use {@link #setFetchingDataRows(boolean)} method to fetch objects.
+     * DataRows. Fetching Persistent objects can be achieved either by using
+     * {@link #ProcedureQuery(String, Class)} constructor or by calling
+     * {@link #setFetchingDataRows(boolean)} and {@link #setResultEntityName(String)}
+     * methods.
      */
     public ProcedureQuery(Procedure procedure) {
         // for backwards compatibility we go against usual default...
@@ -101,7 +107,10 @@
 
     /**
      * Creates a ProcedureQuery based on a stored procedure. The query would fetch
-     * DataRows. Use {@link #setFetchingDataRows(boolean)} method to fetch objects.
+     * DataRows. Fetching Persistent objects can be achieved either by using
+     * {@link #ProcedureQuery(String, Class)} constructor or by calling
+     * {@link #setFetchingDataRows(boolean)} and {@link #setResultEntityName(String)}
+     * methods.
      * 
      * @param procedureName A name of the stored procedure. For this query to work, a
      *            procedure with this name must be mapped in Cayenne.
@@ -123,14 +132,6 @@
     }
 
     /**
-     * <p>
-     * Performance Note: with current EntityResolver implementation it is preferable to
-     * use Procedure object instead of String as a query root. String root can cause
-     * unneeded EntityResolver reindexing on every call. See this mailing list thread: <a
-     * href="http://objectstyle.org/cayenne/lists/cayenne-user/2005/01/0109.html">
-     * http://objectstyle.org/cayenne/lists/cayenne-user/2005/01/0109.html</a>
-     * </p>
-     * 
      * @since 1.1
      */
     public ProcedureQuery(String procedureName, Class<?> resultType) {