db-derby-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mi...@apache.org
Subject svn commit: r165358 - /incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data
Date Fri, 29 Apr 2005 23:13:41 GMT
Author: mikem
Date: Fri Apr 29 16:13:40 2005
New Revision: 165358

URL: http://svn.apache.org/viewcvs?rev=165358&view=rev
Log:
javadoc cleanup for the store.raw.data module.


Modified:
    incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/AllocPage.java
    incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/AllocationActions.java
    incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/BaseContainerHandle.java
    incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/BasePage.java
    incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/ByteHolder.java
    incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/CachedPage.java
    incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/ContainerOperation.java
    incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/ContainerUndoOperation.java
    incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/D_DiagnosticUtil.java
    incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/D_StoredPage.java
    incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/DirectAllocActions.java
    incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/FileContainer.java
    incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/LoggableAllocActions.java
    incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/LogicalPageOperation.java
    incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/LogicalUndoOperation.java
    incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/MemByteHolder.java
    incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/PageActions.java
    incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/PageBasicOperation.java
    incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/PhysicalPageOperation.java
    incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/PhysicalUndoOperation.java
    incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/RAFContainer.java
    incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/ReclaimSpaceHelper.java
    incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/RecordId.java
    incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/StoredFieldHeader.java
    incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/StoredPage.java
    incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/StoredRecordHeader.java

Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/AllocPage.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/AllocPage.java?rev=165358&r1=165357&r2=165358&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/AllocPage.java
(original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/AllocPage.java
Fri Apr 29 16:13:40 2005
@@ -635,7 +635,7 @@
 
 		<BR> MT - thread aware (latched)
 
-		@param container (future) allows the alloc page to call back to the
+		@param mycontainer (future) allows the alloc page to call back to the
 			container to grow the container by creating and syncing multiple
 			pages at once
 		@param ntt the nested top action that is the allocation transaction.

Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/AllocationActions.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/AllocationActions.java?rev=165358&r1=165357&r2=165358&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/AllocationActions.java
(original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/AllocationActions.java
Fri Apr 29 16:13:40 2005
@@ -38,7 +38,7 @@
 		operation, set the allocation status of pageNumber to undoStatus
 		
 		@param t				The transaction
-		@param allocpage		the allocation page
+		@param allocPage		the allocation page
 		@param pageNumber		the page to allocation or deallocation
 		@param doStatus			set the allocation status of the page this value
 		@param undoStatus		on undo, set the allocation status of the page
@@ -54,7 +54,7 @@
 		Chain one allocation page to the next.
 
 		@param t				The transaction
-		@param allocpage		the allocation page whose next page chain needs
+		@param allocPage		the allocation page whose next page chain needs
 								to be changed
 		@param pageNumber		the next allocation page's number 
 		@param pageOffset		the next allocation page's page offset

Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/BaseContainerHandle.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/BaseContainerHandle.java?rev=165358&r1=165357&r2=165358&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/BaseContainerHandle.java
(original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/BaseContainerHandle.java
Fri Apr 29 16:13:40 2005
@@ -879,6 +879,7 @@
 
 	/**
 		Was I opened for updates?
+        <p>
 
 		<BR> MT - thread safe
 	*/

Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/BasePage.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/BasePage.java?rev=165358&r1=165357&r2=165358&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/BasePage.java
(original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/BasePage.java
Fri Apr 29 16:13:40 2005
@@ -136,6 +136,8 @@
 	protected boolean		inClean;	// is the page being cleaned
 
     /**
+     * Used to determine latch state of a page.
+     *
      * MT - mutable
      *
      * There are 3 latch states for a page:
@@ -224,8 +226,10 @@
 	}
 
 	/**
-		Initialize the object, ie. perform work normally perfomed in constructor.
-		Called by setIdentity() and createIdentity().
+        Initialized the BasePage.
+        <p>
+		Initialize the object, ie. perform work normally perfomed in 
+        constructor.  Called by setIdentity() and createIdentity().
 	*/
 	protected void initialize()
 	{
@@ -2140,6 +2144,8 @@
 	}
 
 	/**
+        Remove record at slot.
+        <p>
 		Remove the slot at the in-memory slot table, i.e.,
 		slots from 0 to deleteSlot-1 is untouched, deleteSlot is removed from
 		in memory slot table, deleteSlot+1 .. recordCount()-1 move to
@@ -2247,7 +2253,7 @@
 		page lock on the page, AND that the record has no uncommitted
 		updates.
 
-	  @param record Handle to deleted or non-deleted record
+	  @param handle Handle to deleted or non-deleted record
 	  @see ContainerHandle#compactRecord
 
 	  @exception StandardException	Standard Cloudscape error policy
@@ -2407,12 +2413,9 @@
      *
      * @param slot              the slot number
      * @param row (out)         filled in sparse row
-     * @param validColumns      A bit map indicating which columns to return, if
-     *                          null return all the columns.
-     * @param qualifier_list    An array of qualifiers to apply to the row, only
-     *                          return row if qualifiers are all true, if array
-     *                          is null always return the row.
-     * @param recordToLock      the record handle for the row at top level,
+     * @param fetchDesc         A set of information about the fetch: what
+     *                          columns to fetch, any qualifiers, ...
+     * @param rh                the record handle for the row at top level,
      *                          and is used in OverflowInputStream to lock the 
      *                          row for Blobs/Clobs.
      * @param isHeadRow         Is the head row portion of the row, false if
@@ -2426,7 +2429,7 @@
      **/
 	protected abstract boolean restoreRecordFromSlot(
     int                     slot, 
-    Object[]   row,
+    Object[]                row,
     FetchDescriptor         fetchDesc,
     RecordHandle            rh,
     StoredRecordHeader      recordHeader,
@@ -2439,8 +2442,6 @@
 
 		<BR> MT - latched, page is latched when this methods is called.
 
-		@param slot is the slot number
-		@param row filled in row
 
 		@exception StandardException	Standard Cloudscape error policy
 	*/

Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/ByteHolder.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/ByteHolder.java?rev=165358&r1=165357&r2=165358&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/ByteHolder.java
(original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/ByteHolder.java
Fri Apr 29 16:13:40 2005
@@ -106,6 +106,8 @@
 		 throws IOException;
 
 	/**
+      Read from the ByteHolder.
+      <p>
 	  Read up to 'len' bytes from this ByteHolder and write them to
 	  the OutputStream
 

Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/CachedPage.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/CachedPage.java?rev=165358&r1=165357&r2=165358&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/CachedPage.java
(original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/CachedPage.java
Fri Apr 29 16:13:40 2005
@@ -136,8 +136,10 @@
 	}
 
 	/**
-		Initialize the object, ie. perform work normally perfomed in constructor.
-		Called by setIdentity() and createIdentity().
+        Initialize a CachedPage.
+        <p>
+		Initialize the object, ie. perform work normally perfomed in 
+        constructor.  Called by setIdentity() and createIdentity().
 	*/
 	protected void initialize()
 	{

Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/ContainerOperation.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/ContainerOperation.java?rev=165358&r1=165357&r2=165358&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/ContainerOperation.java
(original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/ContainerOperation.java
Fri Apr 29 16:13:40 2005
@@ -144,6 +144,8 @@
 	 * override ContainerBasicOperation's findContainerForLoadTran
 	 */
 	/**
+        Find container for load tran.
+        <p>
 		If we are in load tran, and the operation is a create, the container
 		may not (should not?) exist yet.  We need to recreate it.
 
@@ -210,7 +212,6 @@
 		container.  Either case, release resource at the end is safe
 		@param CLRInstant the log instant of the CLR
 		@param in optional data
-		@param dataLength optional data length
 
 		@exception StandardException Standard Cloudscape error policy
 	*/

Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/ContainerUndoOperation.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/ContainerUndoOperation.java?rev=165358&r1=165357&r2=165358&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/ContainerUndoOperation.java
(original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/ContainerUndoOperation.java
Fri Apr 29 16:13:40 2005
@@ -114,7 +114,6 @@
 		@param xact			the Transaction that is doing the rollback
 		@param instant		the log instant of this compenstaion operation
 		@param in			optional data
-		@param dataLengt	optional data length
 
 		@exception IOException Can be thrown by any of the methods of ObjectInput.
 		@exception StandardException Standard Cloudscape policy.

Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/D_DiagnosticUtil.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/D_DiagnosticUtil.java?rev=165358&r1=165357&r2=165358&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/D_DiagnosticUtil.java
(original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/D_DiagnosticUtil.java
Fri Apr 29 16:13:40 2005
@@ -142,7 +142,7 @@
     }
     
     /**
-     * Given a Database name and conglomid, return diagnositic string
+     * Given a Database name and conglomid, return diagnositic string.
      * <p>
      * Return a string with diagnostic information about a particular
      * conglomerate, can be called for any type of conglomerate (some types
@@ -268,7 +268,7 @@
 	}
 
     /**
-     * Given a Database name and conglomid, return container id
+     * Given a Database name and conglomid, return container id.
      * <p>
      * Return the containerid of a given conglomerate id.
      * <p>
@@ -341,7 +341,7 @@
     }
 
     /**
-     * Given a Database name and containerid, return conglomerate id
+     * Given a Database name and containerid, return conglomerate id.
      * <p>
      * Return the conglomerate id of a given conainer id.
      * <p>

Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/D_StoredPage.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/D_StoredPage.java?rev=165358&r1=165357&r2=165358&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/D_StoredPage.java
(original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/D_StoredPage.java
Fri Apr 29 16:13:40 2005
@@ -248,6 +248,7 @@
 
 	/**
 		Checks the slot table.
+        <p>
 
 		1) checks the number of slot entries matches the record count
 		2) checks the slot table lengths match the field lengths

Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/DirectAllocActions.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/DirectAllocActions.java?rev=165358&r1=165357&r2=165358&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/DirectAllocActions.java
(original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/DirectAllocActions.java
Fri Apr 29 16:13:40 2005
@@ -42,7 +42,7 @@
 		operation, set the allocation status of pageNumber to undoStatus
 		
 		@param t				The transaction
-		@param allocpage		the allocation page
+		@param allocPage		the allocation page
 		@param pageNumber		the page to allocation or deallocation
 		@param doStatus			set the allocation status of the page this value
 		@param undoStatus		on undo, set the allocation status of the page
@@ -61,7 +61,7 @@
 		Chain one allocation page to the next.
 
 		@param t				The transaction
-		@param allocpage		the allocation page whose next page chain needs
+		@param allocPage		the allocation page whose next page chain needs
 								to be changed
 		@param pageNumber		the next allocation page's number 
 		@param pageOffset		the next allocation page's page offset

Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/FileContainer.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/FileContainer.java?rev=165358&r1=165357&r2=165358&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/FileContainer.java
(original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/FileContainer.java
Fri Apr 29 16:13:40 2005
@@ -2132,7 +2132,7 @@
 
 		@param allochandle the contianer handle to initialize the page with - the ntt
 		@param pkey the page number of the page to be initialized
-		@param createPageArgs the int array for page creation
+		@param createArgs the int array for page creation
 		@param reuse is true if we are reusing a page that has 
 				already been initialized once
 

Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/LoggableAllocActions.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/LoggableAllocActions.java?rev=165358&r1=165357&r2=165358&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/LoggableAllocActions.java
(original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/LoggableAllocActions.java
Fri Apr 29 16:13:40 2005
@@ -39,7 +39,7 @@
 		operation, set the allocation status of pageNumber to undoStatus
 		
 		@param t				The transaction
-		@param allocpage		the allocation page
+		@param allocPage		the allocation page
 		@param pageNumber		the page to allocation or deallocation
 		@param doStatus			set the allocation status of the page this value
 		@param undoStatus		on undo, set the allocation status of the page
@@ -65,7 +65,7 @@
 		Chain one allocation page to the next.
 
 		@param t				The transaction
-		@param allocpage		the allocation page whose next page chain needs
+		@param allocPage		the allocation page whose next page chain needs
 								to be changed
 		@param pageNumber		the next allocation page's number 
 		@param pageOffset		the next allocation page's page offset

Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/LogicalPageOperation.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/LogicalPageOperation.java?rev=165358&r1=165357&r2=165358&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/LogicalPageOperation.java
(original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/LogicalPageOperation.java
Fri Apr 29 16:13:40 2005
@@ -130,7 +130,6 @@
 		be rolled back (redo only), overwrite this function to return null.
 
 		@see LogicalUndo
-		@see #findLogicalPage
 		@exception StandardException Standard Cloudscape policy.
 		@exception IOException Method may read from ObjectInput
 	*/

Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/LogicalUndoOperation.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/LogicalUndoOperation.java?rev=165358&r1=165357&r2=165358&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/LogicalUndoOperation.java
(original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/LogicalUndoOperation.java
Fri Apr 29 16:13:40 2005
@@ -153,7 +153,6 @@
 		@param xact			the Transaction that is doing the rollback
 		@param instant		the log instant of this undo operation
 		@param in			optional data
-		@param dataLengt	optional data length
 
 		@exception IOException Can be thrown by any of the methods of ObjectInput.
 		@exception StandardException Standard Cloudscape policy.

Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/MemByteHolder.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/MemByteHolder.java?rev=165358&r1=165357&r2=165358&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/MemByteHolder.java
(original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/MemByteHolder.java
Fri Apr 29 16:13:40 2005
@@ -233,6 +233,10 @@
 		return (read(b, off, (OutputStream) null, len));
 	}
 
+	/**
+	  @see ByteHolder#read
+	  @exception IOException	Thrown on error
+	  */
 	public int read(OutputStream out,
 					int len)
 		throws IOException

Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/PageActions.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/PageActions.java?rev=165358&r1=165357&r2=165358&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/PageActions.java
(original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/PageActions.java
Fri Apr 29 16:13:40 2005
@@ -69,14 +69,14 @@
      * <p>
      * <BR> MT - latched, page is latched when this methods is called.
      *
-     * @param RawTransaction	The transaction
-     * @param page			the updated page
-     * @param slot			the slot number of the record 
-     * @param recordId		the recordID of the record 
-     * @param row			The new storable row
-     * @param validColumns	the columns that needs to be updated
+     * @param t         	    The transaction
+     * @param page			    the updated page
+     * @param slot			    the slot number of the record 
+     * @param recordId		    the recordID of the record 
+     * @param row			    The new storable row
+     * @param validColumns	    the columns that needs to be updated
      * @param realStartColumn	the first column that is updated
-     * @param logBuffer		where to prepare the log record
+     * @param logBuffer		    where to prepare the log record
      * @param realSpaceOnPage	??
      * @param headRowHandle	the record handle of the head row
      *
@@ -88,16 +88,16 @@
      * @see org.apache.derby.iapi.store.raw.Page#updateAtSlot
      **/
 	public int actionUpdate(
-    RawTransaction          t, 
-    BasePage                page, 
-    int                     slot, 
-    int                     recordId,
-    Object[]   row, 
-    FormatableBitSet                 validColumns,
-    int                     realStartColumn, 
-    DynamicByteArrayOutputStream  logBuffer, 
-    int                     realSpaceOnPage, 
-    RecordHandle            headRowHandle)
+    RawTransaction                  t, 
+    BasePage                        page, 
+    int                             slot, 
+    int                             recordId,
+    Object[]                        row, 
+    FormatableBitSet                validColumns,
+    int                             realStartColumn, 
+    DynamicByteArrayOutputStream    logBuffer, 
+    int                             realSpaceOnPage, 
+    RecordHandle                    headRowHandle)
 		throws StandardException;
 
     /**
@@ -132,11 +132,11 @@
      *
      * <BR> MT - latched, page is latched when this methods is called.
      *
-     * @param RawTransaction	The transaction
+     * @param t         	The transaction
      * @param slot			the slot number of the record 
      * @param recordId		the recordID of the record 
      * @param fieldId		the fieldId of the value
-     * @param value			the new value for the field
+     * @param newValue      the new value for the field
      * @param undo          if logical undo may be necessary, a function 
      *                      pointer to the access code where the logical undo 
      *                      logic resides.   Null if logical undo is not 
@@ -163,7 +163,7 @@
      *
      * <BR> MT - latched, page is latched when this methods is called.
      *
-     * @param RawTransaction	The transaction
+     * @param t             	The transaction
      * @param slot			    the slot number of the record 
      * @param recordId		    the recordID of the record 
      * @param row			    The storable row
@@ -195,11 +195,11 @@
 		throws StandardException;
 
     /**
-     * Copy num_rows from srcPage into deestpage
+     * Copy num_rows from srcPage into deestpage.
      * <p>
      * Longer descrption of routine.
      * <p>
-     * @param RawTransaction	The transaction
+     * @param t             	The transaction
      * @param destPage			the destination page
      * @param srcPage			the source page
      * @param destSlot			starting slot # of destination page to copy to
@@ -229,7 +229,7 @@
      * page.
      * <p>
      *
-     * @param RawTransaction	The transaction
+     * @param t             	The transaction
      * @param page				that page to be invalidated
      *
      * @exception StandardException Standard Cloudscape policy.  
@@ -246,7 +246,7 @@
      * it could be being re-allocated.
      * <p>
      *
-     * @param RawTransaction	The transaction
+     * @param t             	The transaction
      * @param page				that page to be initialized
      * @param initFlag			flags set to values in BasePage.INIT_PAGE_* 
      *                          which indicates how the new page is to be
@@ -268,7 +268,7 @@
      * <p>
      * Shrink the reserved space to the new value.  This action is not undoable.
      * <p>
-     * @param RawTransaction	The transaction
+     * @param t             	The transaction
      * @param page				that page to be initialized
      * @param slot				the slot number of the record 
      * @param recordId			the recordID of the record 

Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/PageBasicOperation.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/PageBasicOperation.java?rev=165358&r1=165357&r2=165358&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/PageBasicOperation.java
(original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/PageBasicOperation.java
Fri Apr 29 16:13:40 2005
@@ -392,7 +392,6 @@
 
 		@param xact			the Transaction doing the rollback
 		@param undoPage		the page to rollback changes on
-		@param undoRecordId	the recordId to rollback changes on
 		@param CLRinstant	the log instant of this (PageUndo) operation
 		@param in			optional data for the rollback operation
 

Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/PhysicalPageOperation.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/PhysicalPageOperation.java?rev=165358&r1=165357&r2=165358&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/PhysicalPageOperation.java
(original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/PhysicalPageOperation.java
Fri Apr 29 16:13:40 2005
@@ -93,7 +93,6 @@
 
 	  @param xact	the transaction doing the compensating
 	  @param in		optional input
-	  @param dataLength optional input length
 
 	  @return the compensation operation that will rollback this change 
 

Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/PhysicalUndoOperation.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/PhysicalUndoOperation.java?rev=165358&r1=165357&r2=165358&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/PhysicalUndoOperation.java
(original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/PhysicalUndoOperation.java
Fri Apr 29 16:13:40 2005
@@ -115,7 +115,6 @@
 		@param xact			the Transaction that is doing the rollback
 		@param instant		the log instant of this undo operation
 		@param in			optional data
-		@param dataLengt	optional data length
 
 		@exception IOException Can be thrown by any of the methods of InputStream.
 		@exception StandardException Standard Cloudscape policy.

Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/RAFContainer.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/RAFContainer.java?rev=165358&r1=165357&r2=165358&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/RAFContainer.java
(original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/RAFContainer.java
Fri Apr 29 16:13:40 2005
@@ -538,15 +538,13 @@
 	}
 
     /**
-     * Short one line description of routine.
+     * Truncate pages of a container.
      * <p>
-     * Longer descrption of routine.
+     * Truncate all pages from lastValidPagenum+1 through the end of the file.
      * <p>
      *
-	 * @return The identifier to be used to open the conglomerate later.
-     *
-     * @param param1 param1 does this.
-     * @param param2 param2 does this.
+     * @param lastValidPagenum  The page number of the last valid page of the
+     *                          file.  All pages after this one are truncated.
      *
 	 * @exception  StandardException  Standard exception policy.
      **/

Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/ReclaimSpaceHelper.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/ReclaimSpaceHelper.java?rev=165358&r1=165357&r2=165358&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/ReclaimSpaceHelper.java
(original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/ReclaimSpaceHelper.java
Fri Apr 29 16:13:40 2005
@@ -44,7 +44,7 @@
 
 
 /**
-	This class helps a BaseDataFactory reclaims unused space
+	This class helps a BaseDataFactory reclaims unused space.
 
 Space needs to be reclaimed in the following cases:
 <BR><NL>

Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/RecordId.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/RecordId.java?rev=165358&r1=165357&r2=165358&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/RecordId.java
(original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/RecordId.java
Fri Apr 29 16:13:40 2005
@@ -155,7 +155,10 @@
 
 
 	/**
-		Can this request be granted?
+		Determine if this request can be granted.
+        <p)
+        Implements the grant/wait lock logic for row locks.  See the
+        table in RowLock for more information.
 
 		<BR>
 		MT - Single thread required (methods of Lockable)
@@ -194,6 +197,9 @@
 
 	/**
 		Is a caller that holds a lock compatible with themselves?
+        <p>
+        Row locks held in the same transaction are always compatible with
+        themselves.
 
 		<BR>
 		MT - Single thread required (methods of Lockable)

Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/StoredFieldHeader.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/StoredFieldHeader.java?rev=165358&r1=165357&r2=165358&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/StoredFieldHeader.java
(original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/StoredFieldHeader.java
Fri Apr 29 16:13:40 2005
@@ -381,7 +381,7 @@
     }
 
     /**
-     * read the length of the field and hdr
+     * read the length of the field and hdr.
      * <p>
      * Optimized routine used to skip a field on a page.  It returns the
      * total length of the field including the header portion.  It operates

Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/StoredPage.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/StoredPage.java?rev=165358&r1=165357&r2=165358&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/StoredPage.java
(original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/StoredPage.java
Fri Apr 29 16:13:40 2005
@@ -356,7 +356,7 @@
 
 
     /**
-     * Constants used in call to logColumn
+     * Constants used in call to logColumn.
      * <p>
      * Action taken in this routine is determined by the kind of column as
      * specified in the columnFlag:
@@ -688,7 +688,7 @@
      */
 
     /**
-	 * use this passed in page buffer as this object's page data
+	 * use this passed in page buffer as this object's page data.
      * <p>
 	 * The page content may not have been read in from disk yet.
 	 * For pagesize smaller than 64K:
@@ -1411,16 +1411,8 @@
      *
      * @param slot              the slot number
      * @param row (out)         filled in sparse row
-     * @param validColumns      A bit map indicating which columns to return, if
-     *                          null return all the columns.
-     * @param qualifier_list    An array of qualifiers to apply to the row, only
-     *                          return row if qualifiers are all true, if array
-     *                          is null always return the row.
-     * @param materializedCols  If a non-null qualifier_list is provided, then 
-     *                          this array of int's will be used to track which
-     *                          cols have been materialized during the 
-     *                          qualification phase, so that they are not 
-     *                          materialized again during the fetch phase.
+     * @param fetchDesc         Information describing fetch, including what
+     *                          columns to fetch and qualifiers.
      * @param recordToLock      the record handle for the row at top level,
      *                          and is used in OverflowInputStream to lock the 
      *                          row for Blobs/Clobs.
@@ -4353,13 +4345,12 @@
      * @param in           the limit input stream
      * @param row          (IN/OUT) row that is to be restored 
      *                     (sparse representation)
-     * @param validColumns the columns of the row that we are interested in.
      *
 	 * @exception  StandardException  Standard exception policy.
      **/
 	public void restoreRecordFromStream(
-    LimitObjectInput        in, 
-    Object[]   row) 
+    LimitObjectInput    in, 
+    Object[]            row) 
 		throws StandardException, IOException
 	{
 
@@ -6848,18 +6839,17 @@
      * <BR>
      * A page latch on the new page will be requested and released.
      *
+     * @param slot           slot of original row to move.
+     * @param row            a row template to hold all columns of row.
      * @param old_handle     An array to be filled in by the call with the 
      *                       old handles of all rows moved.
      * @param new_handle     An array to be filled in by the call with the 
      *                       new handles of all rows moved.
-     * @param new_pageno     An array to be filled in by the call with the 
-     *                       new page number of all rows moved.
      *
      * @return the number of rows processed.
      *
      * @exception StandardException	Standard Cloudscape error policy
      *
-     * @see LockingPolicy
      **/
 	public int moveRecordForCompressAtSlot(
     int             slot,

Modified: incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/StoredRecordHeader.java
URL: http://svn.apache.org/viewcvs/incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/StoredRecordHeader.java?rev=165358&r1=165357&r2=165358&view=diff
==============================================================================
--- incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/StoredRecordHeader.java
(original)
+++ incubator/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/data/StoredRecordHeader.java
Fri Apr 29 16:13:40 2005
@@ -341,7 +341,7 @@
      */
 
     /**
-     * Set the deleted state of the record
+     * Set the deleted state of the record.
      * <p>
      * return	1, if delete status from not deleted to deleted
      * return  -1, if delete status from deleted to not deleted



Mime
View raw message