Return-Path: Delivered-To: apmail-db-derby-commits-archive@www.apache.org Received: (qmail 9959 invoked from network); 5 May 2005 21:32:28 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (209.237.227.199) by minotaur.apache.org with SMTP; 5 May 2005 21:32:28 -0000 Received: (qmail 34538 invoked by uid 500); 5 May 2005 21:34:56 -0000 Delivered-To: apmail-db-derby-commits-archive@db.apache.org Received: (qmail 34484 invoked by uid 500); 5 May 2005 21:34:55 -0000 Mailing-List: contact derby-commits-help@db.apache.org; run by ezmlm Precedence: bulk list-help: list-unsubscribe: List-Post: Reply-To: "Derby Development" Delivered-To: mailing list derby-commits@db.apache.org Received: (qmail 34469 invoked by uid 500); 5 May 2005 21:34:55 -0000 Delivered-To: apmail-incubator-derby-cvs@incubator.apache.org Received: (qmail 34465 invoked by uid 99); 5 May 2005 21:34:55 -0000 X-ASF-Spam-Status: No, hits=0.2 required=10.0 tests=NO_REAL_NAME X-Spam-Check-By: apache.org Received: from minotaur.apache.org (HELO minotaur.apache.org) (209.237.227.194) by apache.org (qpsmtpd/0.28) with SMTP; Thu, 05 May 2005 14:34:55 -0700 Received: (qmail 9937 invoked by uid 65534); 5 May 2005 21:32:25 -0000 Message-ID: <20050505213225.9936.qmail@minotaur.apache.org> Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable 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 -0000 To: derby-cvs@incubator.apache.org From: mikem@apache.org X-Mailer: svnmailer-1.0.0-dev X-Virus-Checked: Checked X-Spam-Rating: minotaur.apache.org 1.6.2 0/1000/N Author: mikem Date: Thu May 5 14:32:22 2005 New Revision: 168421 URL: http://svn.apache.org/viewcvs?rev=3D168421&view=3Drev Log: javadoc fixes to the store interface directory. Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/acce= ss/BackingStoreHashtable.java incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/acce= ss/ConglomerateController.java incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/acce= ss/DiskHashtable.java incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/acce= ss/FileResource.java incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/acce= ss/GenericScanController.java incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/acce= ss/Qualifier.java incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/acce= ss/RowUtil.java incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/acce= ss/StoreCostController.java incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/acce= ss/TransactionController.java Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/stor= e/access/BackingStoreHashtable.java URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/o= rg/apache/derby/iapi/store/access/BackingStoreHashtable.java?rev=3D168421&r= 1=3D168420&r2=3D168421&view=3Ddiff =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D --- incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/acce= ss/BackingStoreHashtable.java (original) +++ incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/acce= ss/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=20 * case requires a valid TransactionController. * - * @return The identifier to be used to open the conglomerate later. - * * @param tc An open TransactionController to be used i= f the * hash table needs to overflow to disk. * Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/stor= e/access/ConglomerateController.java URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/o= rg/apache/derby/iapi/store/access/ConglomerateController.java?rev=3D168421&= r1=3D168420&r2=3D168421&view=3Ddiff =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D --- incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/acce= ss/ConglomerateController.java (original) +++ incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/acce= ss/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 e= ven if + * @param closeHeldScan If true, means to close controller e= ven if * it has been opened to be kept opened=20 * across commit. This is * used to close these controllers on a= bort. @@ -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],=20 + * (LOCK_INS | LOCK_UPD) [ lock for insert],=20 + * (LOCK_INSERT_PREVKEY | LOCK_UPD) [lock for=20 + * previous key to insert], + * (LOCK_UPD) [lock for delete or replace] + * (LOCK_UPD | LOCK_UPDATE_LOCKS) [lock scan for=20 + * 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_DURA= TION, * then lock will be released immediately after b= eing Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/stor= e/access/DiskHashtable.java URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/o= rg/apache/derby/iapi/store/access/DiskHashtable.java?rev=3D168421&r1=3D1684= 20&r2=3D168421&view=3Ddiff =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D --- incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/acce= ss/DiskHashtable.java (original) +++ incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/acce= ss/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 w= e are eliminating duplicates). Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/stor= e/access/FileResource.java URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/o= rg/apache/derby/iapi/store/access/FileResource.java?rev=3D168421&r1=3D16842= 0&r2=3D168421&view=3Ddiff =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D --- incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/acce= ss/FileResource.java (original) +++ incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/acce= ss/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. =20 Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/stor= e/access/GenericScanController.java URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/o= rg/apache/derby/iapi/store/access/GenericScanController.java?rev=3D168421&r= 1=3D168420&r2=3D168421&view=3Ddiff =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D --- incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/acce= ss/GenericScanController.java (original) +++ incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/acce= ss/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. =09 - @param startSearchOperation an operator which defines + @param startSearchOperator an operator which defines how the startKeyValue is to be searched for. If=20 - 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=20 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. =09 - @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=20 stops just before the first row which is greater than or Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/stor= e/access/Qualifier.java URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/o= rg/apache/derby/iapi/store/access/Qualifier.java?rev=3D168421&r1=3D168420&r= 2=3D168421&view=3Ddiff =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D --- incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/acce= ss/Qualifier.java (original) +++ incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/acce= ss/Qualifier.java Thu May 5 14:32:22 2005 @@ -210,8 +210,8 @@ **/ int getOperator(); =20 - /** 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.= =20 + * If true then only rows which fail the compare operation will quali= fy. * * @see DataValueDescriptor#compare **/ Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/stor= e/access/RowUtil.java URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/o= rg/apache/derby/iapi/store/access/RowUtil.java?rev=3D168421&r1=3D168420&r2= =3D168421&view=3Ddiff =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D --- incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/acce= ss/RowUtil.java (original) +++ incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/acce= ss/RowUtil.java Thu May 5 14:32:22 2005 @@ -514,7 +514,6 @@ * * @return The string version of row. * - * @param row The row. * **/ =20 Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/stor= e/access/StoreCostController.java URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/o= rg/apache/derby/iapi/store/access/StoreCostController.java?rev=3D168421&r1= =3D168420&r2=3D168421&view=3Ddiff =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D --- incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/acce= ss/StoreCostController.java (original) +++ incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/acce= ss/StoreCostController.java Thu May 5 14:32:22 2005 @@ -315,7 +315,7 @@ * conglomerate. The startKeyValue must only * reference columns included in the scanColumn= List. * - * @param startSearchOperation=20 + * @param startSearchOperator=20 * an operator which defines how the startKeyVa= lue * is to be searched for. If startSearchOperat= ion=20 * is ScanController.GE, the scan starts on the=20 @@ -334,7 +334,7 @@ * stopKeyValue must only reference columns inc= luded * in the scanColumnList. * - * @param stopSearchOperation + * @param stopSearchOperator * an operator which defines how the stopKeyVal= ue * is used to determine the scan stopping posit= ion.=20 * If stopSearchOperation is ScanController.GE,= the Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/stor= e/access/TransactionController.java URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/o= rg/apache/derby/iapi/store/access/TransactionController.java?rev=3D168421&r= 1=3D168420&r2=3D168421&view=3Ddiff =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D --- incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/acce= ss/TransactionController.java (original) +++ incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/acce= ss/TransactionController.java Thu May 5 14:32:22 2005 @@ -154,7 +154,7 @@ =20 /** * 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.=20 * * Note this constant is currently mapped to ISOLATION_SERIALIZABLE. =20 @@ -498,7 +498,7 @@ =20 @param properties Implementation-specific properties of the conglomerate.= =20 =20 - @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=20 ISOLATION_SERIALIZABLE). =20 - @param isolation_level The isolation level to lock the conglomerate = at. - One of (ISOLATION_READ_COMMITTED,=20 - ISOLATION_REPEATABLE_READ or=20 - ISOLATION_SERIALIZABLE). - @param scanColumnList A description of which columns to return from=20 every fetch in the scan. template, and scanColumnList work together to describe the row to be returned by the scan - see Row= Util @@ -1038,7 +1033,7 @@ The startKeyValue must only reference columns included in the scanColumnList. =09 - @param startSearchOperation an operator which defines + @param startSearchOperator an operator which defines how the startKeyValue is to be searched for. If=20 startSearchOperation is ScanController.GE, the scan starts on the first row which is greater than or equal to the=20 @@ -1067,7 +1062,7 @@ The stopKeyValue must only reference columns included in the scanColumnList. =09 - @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=20 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=20 @@ -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; =20 /** - * Compress table in place + * Compress table in place. *

* 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