Return-Path: Delivered-To: apmail-db-derby-commits-archive@www.apache.org Received: (qmail 95574 invoked from network); 12 May 2005 18:50:32 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (209.237.227.199) by minotaur.apache.org with SMTP; 12 May 2005 18:50:32 -0000 Received: (qmail 6687 invoked by uid 500); 12 May 2005 18:54:40 -0000 Delivered-To: apmail-db-derby-commits-archive@db.apache.org Received: (qmail 6658 invoked by uid 500); 12 May 2005 18:54:40 -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" List-Id: Delivered-To: mailing list derby-commits@db.apache.org Received: (qmail 6642 invoked by uid 500); 12 May 2005 18:54:40 -0000 Delivered-To: apmail-incubator-derby-cvs@incubator.apache.org Received: (qmail 6635 invoked by uid 99); 12 May 2005 18:54:40 -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, 12 May 2005 11:54:39 -0700 Received: (qmail 95560 invoked by uid 65534); 12 May 2005 18:50:29 -0000 Message-ID: <20050512185029.95557.qmail@minotaur.apache.org> Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Subject: svn commit: r169872 - in /incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store: access/conglomerate/Conglomerate.java access/conglomerate/ScanManager.java access/conglomerate/TransactionManager.java raw/LockingPolicy.java raw/Loggable.java raw/Page.java raw/RawStoreFactory.java raw/Transaction.java Date: Thu, 12 May 2005 18:50:28 -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 12 11:50:27 2005 New Revision: 169872 URL: http://svn.apache.org/viewcvs?rev=3D169872&view=3Drev Log: fixes to derby storage public interface javadoc. Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/acce= ss/conglomerate/Conglomerate.java incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/acce= ss/conglomerate/ScanManager.java incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/acce= ss/conglomerate/TransactionManager.java incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/raw/= LockingPolicy.java incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/raw/= Loggable.java incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/raw/= Page.java incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/raw/= RawStoreFactory.java incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/raw/= Transaction.java Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/stor= e/access/conglomerate/Conglomerate.java URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/o= rg/apache/derby/iapi/store/access/conglomerate/Conglomerate.java?rev=3D1698= 72&r1=3D169871&r2=3D169872&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/conglomerate/Conglomerate.java (original) +++ incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/acce= ss/conglomerate/Conglomerate.java Thu May 12 11:50:27 2005 @@ -349,7 +349,6 @@ * * @return The GroupFetchScanController to be used to fetch the rows. * - * @param conglomId see openScan() * @param hold see openScan() * @param open_mode see openScan() * @param lock_level see openScan() Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/stor= e/access/conglomerate/ScanManager.java URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/o= rg/apache/derby/iapi/store/access/conglomerate/ScanManager.java?rev=3D16987= 2&r1=3D169871&r2=3D169872&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/conglomerate/ScanManager.java (original) +++ incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/acce= ss/conglomerate/ScanManager.java Thu May 12 11:50:27 2005 @@ -183,7 +183,7 @@ * For some conglomerates this may be a no-op. *

* - * @param conlgom Conglomerate object of the conglomerate being chan= ged. + * @param conglom Conglomerate object of the conglomerate being chan= ged. * @param page Page in the conglomerate being changed. * * @exception StandardException Standard exception policy. Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/stor= e/access/conglomerate/TransactionManager.java URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/o= rg/apache/derby/iapi/store/access/conglomerate/TransactionManager.java?rev= =3D169872&r1=3D169871&r2=3D169872&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/conglomerate/TransactionManager.java (original) +++ incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/acce= ss/conglomerate/TransactionManager.java Thu May 12 11:50:27 2005 @@ -167,7 +167,7 @@ * For some conglomerates this may be a no-op. *

* - * @param conlgom Conglomerate object of the conglomerate being chan= ged. + * @param conglom Conglomerate object of the conglomerate being chan= ged. * @param page Page in the conglomerate being changed. * * @exception StandardException Standard exception policy. Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/stor= e/raw/LockingPolicy.java URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/o= rg/apache/derby/iapi/store/raw/LockingPolicy.java?rev=3D169872&r1=3D169871&= r2=3D169872&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/raw/= LockingPolicy.java (original) +++ incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/raw/= LockingPolicy.java Thu May 12 11:50:27 2005 @@ -159,7 +159,7 @@ =20 @param t Transaction to associate lock with. @param record Record to lock. - @param lockForInsertPreviouskey Lock is for a previous key of a in= sert. + @param lockForPreviousKey Lock is for a previous key of a in= sert. @param waitForLock Should lock request wait until gra= nted? =20 @return true if the lock was obtained, false if it wasn't.=20 Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/stor= e/raw/Loggable.java URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/o= rg/apache/derby/iapi/store/raw/Loggable.java?rev=3D169872&r1=3D169871&r2=3D= 169872&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/raw/= Loggable.java (original) +++ incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/raw/= Loggable.java Thu May 12 11:50:27 2005 @@ -71,14 +71,14 @@ =20 /** The log operations are responsible to create the ByteArray, and the log - operations should write out any optional data for the change to the Byte= Array. + operations should write out any optional data for the change to the=20 + ByteArray. The ByteArray can be prepared when the log operation is constructed, or it can be prepared when getPreparedLog() is called. =20 Called by the log manager to allow the log operation to pass the buffer - which contains optional data that will be available in to doMe() methods. - - @param out Where and how to write to optional data. + which contains optional data that will be available in to doMe()=20 + methods. =20 @exception StandardException Standard Cloudscape policy. =09 Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/stor= e/raw/Page.java URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/o= rg/apache/derby/iapi/store/raw/Page.java?rev=3D169872&r1=3D169871&r2=3D1698= 72&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/raw/= Page.java (original) +++ incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/raw/= Page.java Thu May 12 11:50:27 2005 @@ -421,12 +421,13 @@ *
* A page latch on the new page will be requested and released. * + * @param slot Slot of row to move. + * @param row A template to read the current row into as pa= rt + * of moving it. * @param old_handle An array to be filled in by the call with the=20 * old handles of all rows moved. * @param new_handle An array to be filled in by the call with the=20 * new handles of all rows moved. - * @param new_pageno An array to be filled in by the call with the=20 - * new page number of all rows moved. * * @return the number of rows processed. * @@ -451,7 +452,7 @@ *
* MT - latched * - * @param record Handle to deleted or non-deleted record + * @param handle record handle to deleted or non-deleted record * * @return the number of fields in the record * @@ -622,7 +623,7 @@ =09 */ /** - * Values for insertFlag: + * Values for insertFlag. *

* * INSERT_INITIAL - flag initializer @@ -671,7 +672,7 @@ =20 =20 /** - * Fetch a record located in the passed in slot + * Fetch a record located in the passed in slot. *

* Fetch a record located in the passed in slot and fill-in the passed= in=20 * StorebleRow and the Object columns contained within. If row @@ -764,7 +765,8 @@

Locking Policy
- No locks are obtained. It is up to the caller to obtain the correct loc= ks. + No locks are obtained.=20 + It is up to the caller to obtain the correct locks.
=20 It is guaranteed that the page latch is not released by this method @@ -772,7 +774,6 @@ @param slot is the slot number @param fieldId is the column id @param column is to be filled in with information from the record. - @param forUpdate true if the intention is to update this record, false o= therwise. =20 @return the Handle to the record that is locked =20 @@ -784,8 +785,8 @@ @see LockingPolicy */ public RecordHandle fetchFieldFromSlot( - int slot,=20 - int fieldId,=20 + int slot,=20 + int fieldId,=20 Object column) throws StandardException; =20 @@ -967,31 +968,34 @@ * *
*NOTE : Data Logging for Purges
- * @param needDataLogged is used to specify whether data is required to be + * needDataLogged is used to specify whether data is required to be * logged for purge operatios. Data Logging is required=20 * Only if the row can be reused or required for key search if a purge is * rolled back;(rollback can occur if the system crashes in the middle of * purges or some unexpected error condiditions rolled back. * For example:=20 - * 1)Btree expects the data to be there if a purge is rolled back;needDat= aLogged=3Dtrue + * 1)Btree expects the data to be there if a purge is rolled back; + * needDataLogged=3Dtrue * 2)Heaps does not care if data exist because only operation that can oc= cur * on a row whose purge rolled back is purging again.(needDataLogged=3Dfa= lse) *=20 * MT - latched * * - * @param slot the starting slot number - * @param numpurges number of slots to purge.=20 - * If <=3D 0, just returns as a no-op. - * @param needDataLogged if set to true data is logged for purges else o= nly headers. + * @param slot the starting slot number + * @param numpurges number of slots to purge. If <=3D 0,=20 + * just returns as a no-op. + * @param needDataLogged if set to true data is logged for purges else=20 + * only headers. * * @exception StandardException Standard Cloudscape error policy * @see LockingPolicy **/ public void purgeAtSlot( - int slot,=20 - int n, - boolean needDataLogged) throws StandardException; + int slot,=20 + int numpurges, + boolean needDataLogged)=20 + throws StandardException; =20 =20 /** Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/stor= e/raw/RawStoreFactory.java URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/o= rg/apache/derby/iapi/store/raw/RawStoreFactory.java?rev=3D169872&r1=3D16987= 1&r2=3D169872&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/raw/= RawStoreFactory.java (original) +++ incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/raw/= RawStoreFactory.java Thu May 12 11:50:27 2005 @@ -413,7 +413,7 @@ @param format_id the format id part of the Xid - ie. Xid.getForma= tId(). @param global_id the global transaction identifier part of XID - = ie. Xid.getGlobalTransactionId(). - @param branch_id The branch qualifier of the Xid - ie.=20 + @param local_id The branch qualifier of the Xid - ie.=20 Xid.getBranchQaulifier() =20 @exception StandardException Standard Cloudscape error policy @@ -435,9 +435,10 @@ current context manager. If a user transaction does not already exist, then create one @see #startTransaction =20 - @param context is the context manager to use. An exception will be - thrown if context is not the current context. - @param transName If a new transaction is started, it will be give= n this name. + @param contextMgr the context manager to use. An exception will be=20 + thrown if context is not the current context. + @param transName If a new transaction is started, it will be give= n=20 + this name. The name is displayed in the transactiontable VTI. =20 @exception StandardException Standard Cloudscape error policy @@ -602,7 +603,6 @@ context is popped off the stack. =20 - @param compatibilitySpace compatibility space to use for locks. @param contextMgr is the context manager to use. An exception will be thrown if context is not the current context. @param transName is the name of the transaction. This name will be=20 Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/stor= e/raw/Transaction.java URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/o= rg/apache/derby/iapi/store/raw/Transaction.java?rev=3D169872&r1=3D169871&r2= =3D169872&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/raw/= Transaction.java (original) +++ incubator/derby/code/trunk/java/engine/org/apache/derby/iapi/store/raw/= Transaction.java Thu May 12 11:50:27 2005 @@ -105,7 +105,7 @@ =20 @param mode A constant of the form LockingPolicy.MODE_* @param isolation A constant of the form LockingPolicy.ISOLATION_* - @param stricterOK True if a stricter level of locking is acceptable,=20 + @param stricterOk True if a stricter level of locking is acceptable,=20 false if an exact match is required. =20 @return A object that can be used in an openContainer call,=20 @@ -322,8 +322,8 @@ requested with no wait time, and if lock is not granted a=20 SQLState.LOCK_TIMEOUT exception will be thrown. =20 - @param policy The lock policy to use, if null then then a no locking=20 - policy will be used. + @param locking The lock policy to use, if null then then a no locking=20 + policy will be used. =20 @return a valid ContainerHandle or null if the container does not exist. =20 @@ -331,8 +331,10 @@ =20 */ =20 - public ContainerHandle openContainer(ContainerKey containerId, - LockingPolicy locking, int mode)=20 + public ContainerHandle openContainer( + ContainerKey containerId, + LockingPolicy locking,=20 + int mode)=20 throws StandardException; =20 =20 @@ -540,7 +542,6 @@ * can be delivered on a non-1.2 vm system and not require the javax c= lasses * in the path. =20 * - * @param cm The context manager for the current context. * @param format_id the format id part of the Xid - ie. Xid.getFormatI= d(). * @param global_id the global transaction identifier part of XID - ie. * Xid.getGlobalTransactionId().