db-derby-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mi...@apache.org
Subject svn commit: r168421 - in /incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/access: BackingStoreHashtable.java ConglomerateController.java DiskHashtable.java FileResource.java GenericScanController.java Qualifier.java RowUtil.java StoreCostController.java TransactionController.java
Date Thu, 05 May 2005 21:32:23 GMT
Author: mikem
Date: Thu May  5 14:32:22 2005
New Revision: 168421

URL: http://svn.apache.org/viewcvs?rev=168421&view=rev
Log:
javadoc fixes to the store interface directory.


Modified:
    incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/access/BackingStoreHashtable.java
    incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/access/ConglomerateController.java
    incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/access/DiskHashtable.java
    incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/access/FileResource.java
    incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/access/GenericScanController.java
    incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/access/Qualifier.java
    incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/access/RowUtil.java
    incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/access/StoreCostController.java
    incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/access/TransactionController.java

Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/access/BackingStoreHashtable.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/access/BackingStoreHashtable.java?rev=168421&r1=168420&r2=168421&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/access/BackingStoreHashtable.java
(original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/access/BackingStoreHashtable.java
Thu May  5 14:32:22 2005
@@ -156,8 +156,6 @@
      * be all placed in some sort of Access temporary file on disk.  This 
      * case requires a valid TransactionController.
      *
-	 * @return The identifier to be used to open the conglomerate later.
-     *
      * @param tc                An open TransactionController to be used if the
      *                          hash table needs to overflow to disk.
      *

Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/access/ConglomerateController.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/access/ConglomerateController.java?rev=168421&r1=168420&r2=168421&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/access/ConglomerateController.java
(original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/access/ConglomerateController.java
Thu May  5 14:32:22 2005
@@ -118,7 +118,7 @@
      * RESOLVE (mikem) - move this call to ConglomerateManager so it is
      * obvious that non-access clients should not call this.
      *
-     * @param closeHeldController     If true, means to close controller even if
+     * @param closeHeldScan           If true, means to close controller even if
      *                                it has been opened to be kept opened 
      *                                across commit.  This is
      *                                used to close these controllers on abort.
@@ -369,9 +369,18 @@
      *
 	 * @return true if lock was granted, only can be false if wait was false.
      *
-	 * @param loc           The "RowLocation" of the exact row to lock.
-     * @param forUpdate     Lock the record for read or write.
-     * @param forInsert     Lock the record for insert?
+     * @param page_num      page number of record to lock.
+     * @param record_id     record id of record to lock.
+     * @param lock_oper     For what operation are we requesting the lock, this
+     *                      should be one of the following 4 options:
+     *                      LOCK_READ [read lock], 
+     *                      (LOCK_INS | LOCK_UPD) [ lock for insert], 
+     *                      (LOCK_INSERT_PREVKEY | LOCK_UPD) [lock for 
+     *                      previous key to insert],
+     *                      (LOCK_UPD) [lock for delete or replace]
+     *                      (LOCK_UPD | LOCK_UPDATE_LOCKS) [lock scan for 
+     *                          update, will upgrade lock later if actual update
+     *                          is take place]
      * @param wait          Should the lock call wait to be granted?
      * @param lock_duration If set to TransactionManager.LOCK_INSTANT_DURATION,
      *                      then lock will be released immediately after being

Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/access/DiskHashtable.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/access/DiskHashtable.java?rev=168421&r1=168420&r2=168421&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/access/DiskHashtable.java
(original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/access/DiskHashtable.java
Thu May  5 14:32:22 2005
@@ -133,7 +133,6 @@
      * Put a new row in the overflow structure.
      *
      * @param row The row to be inserted.
-     * @param hashCode The row's hash code.
      *
      * @return true if the row was added,
      *         false if it was not added (because it was a duplicate and we are eliminating
duplicates).

Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/access/FileResource.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/access/FileResource.java?rev=168421&r1=168420&r2=168421&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/access/FileResource.java
(original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/access/FileResource.java
Thu May  5 14:32:22 2005
@@ -65,7 +65,6 @@
 	  @param name the name of the file resource.
 	  @param source an input stream for reading the content of
 	         the file resource.
-	  @param name the name of the fileResource
 	  @return the generationId for the file resource. This
 	  quantity increases when you replace the file resource.
 

Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/access/GenericScanController.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/access/GenericScanController.java?rev=168421&r1=168420&r2=168421&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/access/GenericScanController.java
(original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/access/GenericScanController.java
Thu May  5 14:32:22 2005
@@ -144,9 +144,9 @@
 	the scan.  If null, the starting position of the scan
 	is the first row of the conglomerate.
 	
-	@param startSearchOperation an operator which defines
+	@param startSearchOperator an operator which defines
 	how the startKeyValue is to be searched for.  If 
-    startSearchOperation is ScanController.GE, the scan starts on
+    startSearchOperator is ScanController.GE, the scan starts on
 	the first row which is greater than or equal to the 
 	startKeyValue.  If startSearchOperation is ScanController.GT,
 	the scan starts on the first row whose key is greater than
@@ -164,7 +164,7 @@
 	the scan.  If null, the ending position of the scan
 	is the last row of the conglomerate.
 	
-	@param stopSearchOperation an operator which defines
+	@param stopSearchOperator an operator which defines
 	how the stopKeyValue is used to determine the scan stopping
 	position. If stopSearchOperation is ScanController.GE, the scan 
 	stops just before the first row which is greater than or

Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/access/Qualifier.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/access/Qualifier.java?rev=168421&r1=168420&r2=168421&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/access/Qualifier.java
(original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/access/Qualifier.java
Thu May  5 14:32:22 2005
@@ -210,8 +210,8 @@
      **/
 	int getOperator();
 
-	/** Should the result from the compare operation be negated?  If true
-     *  then only rows which fail the compare operation will qualify.
+	/** Determine if the result from the compare operation should be negated.  
+     *  If true then only rows which fail the compare operation will qualify.
      *
      *  @see DataValueDescriptor#compare
      **/

Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/access/RowUtil.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/access/RowUtil.java?rev=168421&r1=168420&r2=168421&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/access/RowUtil.java
(original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/access/RowUtil.java
Thu May  5 14:32:22 2005
@@ -514,7 +514,6 @@
      *
 	 * @return The string version of row.
      *
-     * @param row The row.
      *
      **/
 

Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/access/StoreCostController.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/access/StoreCostController.java?rev=168421&r1=168420&r2=168421&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/access/StoreCostController.java
(original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/access/StoreCostController.java
Thu May  5 14:32:22 2005
@@ -315,7 +315,7 @@
      *                        conglomerate.  The startKeyValue must only
      *                        reference columns included in the scanColumnList.
      *
-	 * @param startSearchOperation 
+	 * @param startSearchOperator 
      *                        an operator which defines how the startKeyValue
      *                        is to be searched for.  If startSearchOperation 
      *                        is ScanController.GE, the scan starts on the 
@@ -334,7 +334,7 @@
      *                        stopKeyValue must only reference columns included
      *                        in the scanColumnList.
      *
-	 * @param stopSearchOperation
+	 * @param stopSearchOperator
      *                        an operator which defines how the stopKeyValue
      *                        is used to determine the scan stopping position. 
      *                        If stopSearchOperation is ScanController.GE, the

Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/access/TransactionController.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/access/TransactionController.java?rev=168421&r1=168420&r2=168421&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/access/TransactionController.java
(original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/access/TransactionController.java
Thu May  5 14:32:22 2005
@@ -154,7 +154,7 @@
 
     /**
      * Read and write locks are held until end of transaction, but no
-     * phantom protection is performed (ie. no previous key locking).
+     * phantom protection is performed (ie no previous key locking).
      * Writes only visible when committed. 
      *
      * Note this constant is currently mapped to ISOLATION_SERIALIZABLE.  
@@ -498,7 +498,7 @@
 
 	@param properties Implementation-specific properties of the conglomerate.  
 
-    @param  temporary  If true, the conglomerate is temporary.
+    @param  temporaryFlag  If true, the conglomerate is temporary.
 	Temporary conglomerates are only visible through the transaction
 	controller that created them.  Otherwise, they are opened,
 	scanned, and dropped in the same way as permanent conglomerates.
@@ -806,7 +806,7 @@
      * @param scanColumnList        see openScan()
      * @param startKeyValue         see openScan()
      * @param startSearchOperator   see openScan()
-     * @param qualifier[]           see openScan()
+     * @param qualifier             see openScan()
      * @param stopKeyValue          see openScan()
      * @param stopSearchOperator    see openScan()
      *
@@ -851,7 +851,7 @@
     int                     open_mode,
     int                     lock_level,
     int                     isolation_level,
-    FormatableBitSet                 scanColumnList,
+    FormatableBitSet        scanColumnList,
     DataValueDescriptor[]   startKeyValue,
     int                     startSearchOperator,
     Qualifier               qualifier[][],
@@ -1019,11 +1019,6 @@
                              ISOLATION_REPEATABLE_READ or 
                              ISOLATION_SERIALIZABLE).
 
-    @param isolation_level   The isolation level to lock the conglomerate at.
-                             One of (ISOLATION_READ_COMMITTED, 
-                             ISOLATION_REPEATABLE_READ or 
-                             ISOLATION_SERIALIZABLE).
-
 	@param scanColumnList A description of which columns to return from 
     every fetch in the scan.  template, and scanColumnList
     work together to describe the row to be returned by the scan - see RowUtil
@@ -1038,7 +1033,7 @@
     The startKeyValue must only reference columns included
     in the scanColumnList.
 	
-	@param startSearchOperation an operator which defines
+	@param startSearchOperator an operator which defines
 	how the startKeyValue is to be searched for.  If 
     startSearchOperation is ScanController.GE, the scan starts on
 	the first row which is greater than or equal to the 
@@ -1067,7 +1062,7 @@
     The stopKeyValue must only reference columns included
     in the scanColumnList.
 	
-	@param stopSearchOperation an operator which defines
+	@param stopSearchOperator an operator which defines
 	how the stopKeyValue is used to determine the scan stopping
 	position. If stopSearchOperation is ScanController.GE, the scan 
 	stops just before the first row which is greater than or
@@ -1090,7 +1085,7 @@
 		int                             open_mode,
         int                             lock_level,
         int                             isolation_level,
-		FormatableBitSet                         scanColumnList,
+		FormatableBitSet                scanColumnList,
 		DataValueDescriptor[]           startKeyValue,
 		int                             startSearchOperator,
 		Qualifier                       qualifier[][],
@@ -1118,14 +1113,13 @@
      *
 	 * @return The identifier to be used to open the conglomerate later.
      *
-	 * @param conglomId             see openScan()
      * @param open_mode             see openScan()
      * @param lock_level            see openScan()
      * @param isolation_level       see openScan()
      * @param scanColumnList        see openScan()
      * @param startKeyValue         see openScan()
      * @param startSearchOperator   see openScan()
-     * @param qualifier[]           see openScan()
+     * @param qualifier             see openScan()
      * @param stopKeyValue          see openScan()
      * @param stopSearchOperator    see openScan()
      * @param static_info       object returned from 
@@ -1140,7 +1134,7 @@
 		int                             open_mode,
         int                             lock_level,
         int                             isolation_level,
-		FormatableBitSet                         scanColumnList,
+		FormatableBitSet                scanColumnList,
 		DataValueDescriptor[]           startKeyValue,
 		int                             startSearchOperator,
 		Qualifier                       qualifier[][],
@@ -1168,7 +1162,7 @@
      * @param scanColumnList        see openScan()
      * @param startKeyValue         see openScan()
      * @param startSearchOperator   see openScan()
-     * @param qualifier[]           see openScan()
+     * @param qualifier             see openScan()
      * @param stopKeyValue          see openScan()
      * @param stopSearchOperator    see openScan()
      *
@@ -1192,7 +1186,7 @@
 			throws StandardException;
 
     /**
-     * Compress table in place
+     * Compress table in place.
      * <p>
      * Returns a GroupFetchScanController which can be used to move rows
      * around in a table, creating a block of free pages at the end of the



Mime
View raw message