You are viewing a plain text version of this content. The canonical link for it is here.
Posted to derby-commits@db.apache.org by mi...@apache.org on 2005/04/21 19:29:54 UTC

svn commit: r164091 - in /incubator/derby/code/trunk/java/engine/org/apache/derby: catalog/IndexDescriptor.java catalog/TypeDescriptor.java iapi/services/classfile/ClassHolder.java impl/sql/compile/AggregateDefinition.java impl/sql/compile/FromTable.java

Author: mikem
Date: Thu Apr 21 10:29:53 2005
New Revision: 164091

URL: http://svn.apache.org/viewcvs?rev=164091&view=rev
Log:
more javadoc cleanup.

Modified:
    incubator/derby/code/trunk/java/engine/org/apache/derby/catalog/IndexDescriptor.java
    incubator/derby/code/trunk/java/engine/org/apache/derby/catalog/TypeDescriptor.java
    incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/services/classfile/ClassHolder.java
    incubator/derby/code/trunk/java/engine/org/apache/derby/impl/sql/compile/AggregateDefinition.java
    incubator/derby/code/trunk/java/engine/org/apache/derby/impl/sql/compile/FromTable.java

Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/catalog/IndexDescriptor.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/catalog/IndexDescriptor.java?rev=164091&r1=164090&r2=164091&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/catalog/IndexDescriptor.java (original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/catalog/IndexDescriptor.java Thu Apr 21 10:29:53 2005
@@ -48,12 +48,16 @@
 	public int[]	baseColumnPositions();
 
 	/**
+     * Returns the postion of a column.
+     * <p>
 	 * Returns the position of a column within the key (1-based).
 	 * 0 means that the column is not in the key.
 	 */
 	public Integer getKeyColumnPosition(Integer heapColumnPosition);
 
 	/**
+     * Returns the postion of a column.
+     * <p>
 	 * Returns the position of a column within the key (1-based).
 	 * 0 means that the column is not in the key.  Same as the above
 	 * method, but it uses int instead of Integer.
@@ -61,7 +65,9 @@
 	public int getKeyColumnPosition(int heapColumnPosition);
 
 	/**
-	 * Returns the number of ordered columns.  In the future, it will be
+	 * Returns the number of ordered columns.  
+     * <p>
+	 * In the future, it will be
 	 * possible to store non-ordered columns in an index.  These will be
 	 * useful for covered queries.  The ordered columns will be at the
 	 * beginning of the index row, and they will be followed by the

Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/catalog/TypeDescriptor.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/catalog/TypeDescriptor.java?rev=164091&r1=164090&r2=164091&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/catalog/TypeDescriptor.java (original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/catalog/TypeDescriptor.java Thu Apr 21 10:29:53 2005
@@ -58,7 +58,7 @@
 	 *
 	 * @return	a jdbc type, e.g. java.sql.Types.DECIMAL 
 	 *
-	 * @see Types
+	 * @see java.sql.Types
 	 */
 	public int getJDBCTypeId();
 

Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/services/classfile/ClassHolder.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/services/classfile/ClassHolder.java?rev=164091&r1=164090&r2=164091&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/services/classfile/ClassHolder.java (original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/services/classfile/ClassHolder.java Thu Apr 21 10:29:53 2005
@@ -309,22 +309,22 @@
 	}
 
 
-	/** @see ClassHolder#addInteger */
+	/** @see ClassHolder#addConstant */
 	public int addConstant(int value) {
 		return addDirectEntry(new CONSTANT_Integer_info(value));
 	}
 
-	/** @see ClassHolder#addFloat */
+	/** @see ClassHolder#addConstant */
 	public int addConstant(float value) {
 		return addDirectEntry(new CONSTANT_Float_info(value));
 	}
 
-	/** @see ClassHolder#addLong */
+	/** @see ClassHolder#addConstant */
 	public int addConstant(long value) {
 		return addDirectEntry(new CONSTANT_Long_info(value));
 	}
 
-	/** @see ClassHolder#addDouble */
+	/** @see ClassHolder#addConstant */
 	public int addConstant(double value) {
 		return addDirectEntry(new CONSTANT_Double_info(value));
 	}
@@ -597,7 +597,9 @@
 
 	/**
 		Find a name and type descriptor (section 4.4.6) and
-		return ita index. returns -1 if not found.
+		return it's index. 
+        <p>
+        returns -1 if not found.
 	*/
 	public int findNameAndType(String name, String descriptor) {
 

Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/impl/sql/compile/AggregateDefinition.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/impl/sql/compile/AggregateDefinition.java?rev=164091&r1=164090&r2=164091&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/impl/sql/compile/AggregateDefinition.java (original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/impl/sql/compile/AggregateDefinition.java Thu Apr 21 10:29:53 2005
@@ -46,10 +46,7 @@
  * <I> IBM Corp. reserves the right to change, rename, or
  * remove this interface at any time. </I>
  *
- * @see com.ibm.db2j.aggregates.Aggregator
  * @see org.apache.derby.catalog.TypeDescriptor
- * @see com.ibm.db2j.types.TypeFactory
- * @see org.apache.derby.iapi.db.Factory#getTypeFactory
  */
 interface AggregateDefinition
 {
@@ -85,8 +82,6 @@
 	 *		To construct a type descriptor see <i>com.ibm.db2j.types.TypeFactory</i>.
 	 *
 	 * @see org.apache.derby.catalog.TypeDescriptor
-	 * @see com.ibm.db2j.types.TypeFactory
-	 * @see com.ibm.db2j.aggregates.Aggregator
 	 *
 	 * @exception SQLException Thrown on error.
 	 */

Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/impl/sql/compile/FromTable.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/impl/sql/compile/FromTable.java?rev=164091&r1=164090&r2=164091&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/impl/sql/compile/FromTable.java (original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/impl/sql/compile/FromTable.java Thu Apr 21 10:29:53 2005
@@ -741,7 +741,7 @@
 								feasible(this, predList, optimizer);
 	}
 
-    /** @see Optimizable#considerMemoryUsageOK */
+    /** @see Optimizable#memoryUsageOK */
     public boolean memoryUsageOK( double rowCount, int maxMemoryPerTable)
 			throws StandardException
     {