org.apache.derby.impl.store.raw.data
Class UpdateOperation

java.lang.Object
  extended byorg.apache.derby.impl.store.raw.data.PageBasicOperation
      extended byorg.apache.derby.impl.store.raw.data.PhysicalPageOperation
          extended byorg.apache.derby.impl.store.raw.data.UpdateOperation
All Implemented Interfaces:
java.io.Externalizable, Formatable, Loggable, RePreparable, java.io.Serializable, TypedFormat, Undoable

public final class UpdateOperation
extends PhysicalPageOperation

Represents the update of a particular row on a page.

See Also:
Serialized Form
Format IDLOGOP_UPDATE the formatId is written by FormatIdOutputStream when this object is written out by writeObject
Purposeupdate a record on the page
Upgrade
Disk LayoutPhysicalPageOperation the super class doMeSlot(CompressedInt) the slot the updated record is in recordId(CompressedInt) the recordId of the updated record OptionalData The new image of the record (length included), follow by the old image of the record (length included)

Field Summary
protected  int doMeSlot
           
protected  int nextColumn
           
protected  ByteArray preparedLog
           
protected  int recordId
           
 
Fields inherited from class org.apache.derby.impl.store.raw.data.PageBasicOperation
containerHdl, foundHere, page
 
Fields inherited from interface org.apache.derby.iapi.store.raw.Loggable
ABORT, BI_LOG, CHECKSUM, COMMIT, COMPENSATION, FILE_RESOURCE, FIRST, LAST, PREPARE, RAWSTORE, XA_NEEDLOCK
 
Constructor Summary
UpdateOperation()
           
UpdateOperation(RawTransaction t, BasePage page, int slot, int recordId, java.lang.Object[] row, FormatableBitSet validColumns, int realStartColumn, DynamicByteArrayOutputStream logBuffer, int realSpaceOnPage, RecordHandle headRowHandle)
           
 
Method Summary
 void doMe(Transaction xact, LogInstant instant, LimitObjectInput in)
          Store the new record directly over the old record, the implementation of storeRecord is responsible for removing any old data.
 int getNextStartColumn()
          Return the last column of the row this operation logged
 ByteArray getPreparedLog()
          The log operations are responsible to create the ByteArray, and the log operations should write out any optional data for the change to the ByteArray.
 int getTypeFormatId()
          Return my format identifier.
 void readExternal(java.io.ObjectInput in)
          Read this in
 void restoreMe(Transaction xact, BasePage undoPage, LogInstant CLRInstant, LimitObjectInput in)
          restore the before image of the page
 java.lang.String toString()
           
 void undoMe(Transaction xact, BasePage undoPage, LogInstant CLRInstant, LimitObjectInput in)
          Store the old record directly over the new record, the implementation of storeRecord is responsible for removing any new data.
 void writeExternal(java.io.ObjectOutput out)
           
private  void writeOptionalDataToBuffer(RawTransaction t, DynamicByteArrayOutputStream logBuffer, java.lang.Object[] row, FormatableBitSet validColumns, int realStartColumn, int realSpaceOnPage, RecordHandle headRowHandle)
          Write out the changed colums of new record (from the row) followed by changed columns of the old record (from the page).
 
Methods inherited from class org.apache.derby.impl.store.raw.data.PhysicalPageOperation
generateUndo
 
Methods inherited from class org.apache.derby.impl.store.raw.data.PageBasicOperation
findpage, getPage, getPageForLoadTran, getPageId, getPageVersion, group, needsRedo, reclaimPrepareLocks, releaseResource, resetPageNumber
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.apache.derby.iapi.store.raw.Loggable
group, needsRedo, releaseResource
 

Field Detail

doMeSlot

protected int doMeSlot

recordId

protected int recordId

nextColumn

protected transient int nextColumn

preparedLog

protected transient ByteArray preparedLog
Constructor Detail

UpdateOperation

public UpdateOperation(RawTransaction t,
                       BasePage page,
                       int slot,
                       int recordId,
                       java.lang.Object[] row,
                       FormatableBitSet validColumns,
                       int realStartColumn,
                       DynamicByteArrayOutputStream logBuffer,
                       int realSpaceOnPage,
                       RecordHandle headRowHandle)
                throws StandardException

UpdateOperation

public UpdateOperation()
Method Detail

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
Specified by:
writeExternal in interface java.io.Externalizable
Overrides:
writeExternal in class PageBasicOperation
Throws:
java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
Read this in

Specified by:
readExternal in interface java.io.Externalizable
Overrides:
readExternal in class PageBasicOperation
Throws:
java.io.IOException - error reading from log stream
java.lang.ClassNotFoundException - log stream corrupted

getTypeFormatId

public int getTypeFormatId()
Return my format identifier.

Returns:
The identifier. (A UUID stuffed in an array of 16 bytes).

getNextStartColumn

public int getNextStartColumn()
Return the last column of the row this operation logged


doMe

public void doMe(Transaction xact,
                 LogInstant instant,
                 LimitObjectInput in)
          throws StandardException,
                 java.io.IOException
Store the new record directly over the old record, the implementation of storeRecord is responsible for removing any old data.

Parameters:
xact - the Transaction
instant - the log instant of this operation
in - optional data
Throws:
StandardException - Thrown by methods I call
java.io.IOException - Thrown by methods I call
See Also:
BasePage.storeRecord(org.apache.derby.iapi.store.raw.log.LogInstant, int, boolean, java.io.ObjectInput), Loggable.doMe(org.apache.derby.iapi.store.raw.Transaction, org.apache.derby.iapi.store.raw.log.LogInstant, org.apache.derby.iapi.services.io.LimitObjectInput)

undoMe

public void undoMe(Transaction xact,
                   BasePage undoPage,
                   LogInstant CLRInstant,
                   LimitObjectInput in)
            throws StandardException,
                   java.io.IOException
Store the old record directly over the new record, the implementation of storeRecord is responsible for removing any new data.

Specified by:
undoMe in class PhysicalPageOperation
Parameters:
xact - the Transaction doing the rollback
undoPage - the page to rollback changes on
CLRInstant - the log instant of this (PageUndo) operation
in - optional data for the rollback operation
Throws:
StandardException - Thrown by methods I call
java.io.IOException - Thrown by methods I call
See Also:
BasePage.storeRecord(org.apache.derby.iapi.store.raw.log.LogInstant, int, boolean, java.io.ObjectInput), PhysicalPageOperation.undoMe(org.apache.derby.iapi.store.raw.Transaction, org.apache.derby.impl.store.raw.data.BasePage, org.apache.derby.iapi.store.raw.log.LogInstant, org.apache.derby.iapi.services.io.LimitObjectInput)

getPreparedLog

public ByteArray getPreparedLog()
Description copied from interface: Loggable
The log operations are responsible to create the ByteArray, and the log operations should write out any optional data for the change to the ByteArray. The ByteArray can be prepared when the log operation is constructed, or it can be prepared when getPreparedLog() is called. 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.

Specified by:
getPreparedLog in interface Loggable
Overrides:
getPreparedLog in class PageBasicOperation

writeOptionalDataToBuffer

private void writeOptionalDataToBuffer(RawTransaction t,
                                       DynamicByteArrayOutputStream logBuffer,
                                       java.lang.Object[] row,
                                       FormatableBitSet validColumns,
                                       int realStartColumn,
                                       int realSpaceOnPage,
                                       RecordHandle headRowHandle)
                                throws StandardException,
                                       java.io.IOException
Write out the changed colums of new record (from the row) followed by changed columns of the old record (from the page).

Throws:
StandardException - Thrown by methods I call
java.io.IOException - Thrown by methods I call

restoreMe

public void restoreMe(Transaction xact,
                      BasePage undoPage,
                      LogInstant CLRInstant,
                      LimitObjectInput in)
               throws StandardException,
                      java.io.IOException
restore the before image of the page

Specified by:
restoreMe in class PageBasicOperation
Parameters:
xact - the Transaction doing the rollback
undoPage - the page to rollback changes on
CLRInstant - the log instant of this (PageUndo) operation
in - optional data for the rollback operation
Throws:
StandardException - Standard Cloudscape Error Policy
java.io.IOException - problem reading the complete log record from the input stream

toString

public java.lang.String toString()
Overrides:
toString in class PageBasicOperation

Built on Mon 2007-06-04 09:58:47+0400, from revision ???

Apache Derby V10.1 Engine Documentation - Copyright © 1997,2005 The Apache Software Foundation or its licensors, as applicable.