Class UpdateOperation

java.lang.Object

org.apache.derby.impl.store.raw.data.PageBasicOperation

org.apache.derby.impl.store.raw.data.PhysicalPageOperation

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

All Implemented Interfaces:

Externalizable, Serializable, Formatable, TypedFormat, Loggable, RePreparable, Undoable

public final class UpdateOperation
extends PhysicalPageOperation

Represents the update of a particular row on a page.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected int	doMeSlot
protected int	nextColumn
protected ByteArray	preparedLog
protected int	recordId

Fields inherited from class PageBasicOperation

containerHdl, foundHere, page

Fields inherited from interface Loggable

ABORT, BI_LOG, CHECKSUM, COMMIT, COMPENSATION, FILE_RESOURCE, FIRST, LAST, PREPARE, RAWSTORE, XA_NEEDLOCK

Constructor Summary

Constructors

Constructor	Description
UpdateOperation()
UpdateOperation(RawTransaction t, BasePage page, int slot, int recordId, Object[] row, FormatableBitSet validColumns, int realStartColumn, DynamicByteArrayOutputStream logBuffer, int realSpaceOnPage, RecordHandle headRowHandle)

Method Summary

Modifier and Type	Method	Description
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 default for optional data is set to null.
private RecordHandle	getRecordHandle()	return RecordHandle of the update row.
int	getTypeFormatId()	Return my format identifier.
void	readExternal(ObjectInput in)	Read this in
void	reclaimPrepareLocks(Transaction t, LockingPolicy locking_policy)	reclaim locks associated with the changes in this log record.
void	restoreMe(Transaction xact, BasePage undoPage, LogInstant CLRInstant, LimitObjectInput in)	restore the before image of the page
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(ObjectOutput out)
private void	writeOptionalDataToBuffer(RawTransaction t, DynamicByteArrayOutputStream logBuffer, 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 PhysicalPageOperation

generateUndo

Methods inherited from class PageBasicOperation

findpage, getPage, getPageForRedoRecovery, getPageId, getPageVersion, group, needsRedo, releaseResource, resetPageNumber

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface Loggable

group, needsRedo, releaseResource

Field Details

doMeSlot

protected int doMeSlot

recordId

protected int recordId

nextColumn

protected transient int nextColumn

preparedLog

protected transient ByteArray preparedLog

Constructor Details

UpdateOperation

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

Throws:

StandardException

UpdateOperation

public UpdateOperation()

Method Details

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class PageBasicOperation

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
ClassNotFoundException

Read this in

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class PageBasicOperation

Throws:

IOException - error reading from log stream

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,
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

IOException - Thrown by methods I call

See Also:

• BasePage.storeRecord(LogInstant, int, boolean, ObjectInput)
• Loggable.doMe(Transaction, LogInstant, LimitObjectInput)

undoMe

public void undoMe(Transaction xact,
 BasePage undoPage,
 LogInstant CLRInstant,
 LimitObjectInput in)
            throws StandardException,
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

IOException - Thrown by methods I call

See Also:

• BasePage.storeRecord(LogInstant, int, boolean, ObjectInput)
• PhysicalPageOperation.undoMe(Transaction, BasePage, LogInstant, LimitObjectInput)

getPreparedLog

public ByteArray getPreparedLog()

Description copied from class: PageBasicOperation

the default for optional data is set to null. If an operation has optional data, the operation need to prepare the optional data for this method. WARNING: If a log operation extends this class, and the operation has optional data, it MUST overwrite this method to return a ByteArray that contains the optional data.

Specified by:

getPreparedLog in interface Loggable

Overrides:

getPreparedLog in class PageBasicOperation

writeOptionalDataToBuffer

private void writeOptionalDataToBuffer(RawTransaction t,
 DynamicByteArrayOutputStream logBuffer,
 Object[] row,
 FormatableBitSet validColumns,
 int realStartColumn,
 int realSpaceOnPage,
 RecordHandle headRowHandle)
                                throws StandardException,
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

IOException - Thrown by methods I call

restoreMe

public void restoreMe(Transaction xact,
 BasePage undoPage,
 LogInstant CLRInstant,
 LimitObjectInput in)
               throws StandardException,
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 Derby Error Policy

IOException - problem reading the complete log record from the input stream

getRecordHandle

private RecordHandle getRecordHandle()

return RecordHandle of the update row.

Return the RecordHandle that should be locked when updating the row in this UpdateOperation.

reclaimPrepareLocks

public void reclaimPrepareLocks(Transaction t,
 LockingPolicy locking_policy)
                         throws StandardException

reclaim locks associated with the changes in this log record.

Specified by:

reclaimPrepareLocks in interface RePreparable

Overrides:

reclaimPrepareLocks in class PageBasicOperation

Parameters:

locking_policy - The locking policy to use to claim the locks.

Throws:

StandardException - Standard exception policy.

toString

public String toString()

Overrides:

toString in class PageBasicOperation