Top Description Fields Constructors Methods
org.apache.derby.impl.store.raw.data

public final Class PurgeOperation

extends PhysicalPageOperation
Class Inheritance
Imports
org.apache.derby.shared.common.reference.SQLState, org.apache.derby.iapi.services.io.StoredFormatIds, .CompressedNumber, .FormatableBitSet, .DynamicByteArrayOutputStream, .LimitObjectInput, org.apache.derby.iapi.store.raw.Page, .RecordHandle, .Transaction, org.apache.derby.iapi.store.raw.xact.RawTransaction, org.apache.derby.iapi.store.raw.log.LogInstant, org.apache.derby.shared.common.error.StandardException, org.apache.derby.shared.common.sanity.SanityManager, org.apache.derby.iapi.util.ByteArray, java.io.ObjectOutput, .ObjectInput, .IOException
USE WITH EXTREME Caution: Purge records from a Page. Represents purging of a range of rows from the page. 




See Also

Page#purgeAtSlot






Field Summary




Modifier and TypeField and Description

protected int
num_rows




protected transient ByteArray
preparedLog




protected int[]
recordIds




protected int
slot










Constructor Summary




AccessConstructor and Description

pack-priv
PurgeOperation(RawTransaction t, BasePage page, int slot, int num_rows, int[] recordIds, boolean needDataLogged)




public
PurgeOperation()










Method Summary




Modifier and TypeMethod and Description

public void
doMe(Transaction 
the Transaction
xact, LogInstant 
the log instant of this operation
instant, LimitObjectInput 
optional data
in)
Implements org.apache.derby.iapi.store.raw.Loggable.doMe.


Apply the purge operation to the page.



public ByteArray
getPreparedLog()
Overrides org.apache.derby.impl.store.raw.data.PageBasicOperation.getPreparedLog.


Implements org.apache.derby.iapi.store.raw.Loggable.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.



public int
getTypeFormatId()
Implements org.apache.derby.iapi.services.io.TypedFormat.getTypeFormatId.


Return my format identifier.



public void
readExternal(ObjectInput 
the stream to read data from in order to restore the object
in)
Overrides org.apache.derby.impl.store.raw.data.PageBasicOperation.readExternal.


Implements java.io.Externalizable.readExternal.


Read this in



public void
restoreMe(Transaction 
the Transaction doing the rollback
xact, BasePage 
the page to rollback changes on
undoPage, LogInstant 
the log instant of this (PageUndo) operation
CLRInstant, LimitObjectInput 
optional data for the rollback operation
in)
Implements abstract org.apache.derby.impl.store.raw.data.PageBasicOperation.restoreMe.


restore the before image of the page



public String
toString()
Overrides org.apache.derby.impl.store.raw.data.PageBasicOperation.toString.


DEBUG: Print self.



public void
undoMe(Transaction 
the Transaction doing the rollback
xact, BasePage 
the page to rollback changes on
undoPage, LogInstant 
the log instant of this (PageUndo) operation
CLRInstant, LimitObjectInput 
optional data for the rollback operation
in)
Implements abstract org.apache.derby.impl.store.raw.data.PhysicalPageOperation.undoMe.


Undo the purge operation on the page.



public void
writeExternal(ObjectOutput 
the stream to write the object to
out)
Overrides org.apache.derby.impl.store.raw.data.PageBasicOperation.writeExternal.


Implements java.io.Externalizable.writeExternal.


The object implements the writeExternal method to save its contents
by calling the methods of DataOutput for its primitive values or
calling the writeObject method of ObjectOutput for objects, strings,
and arrays.



private void
writeOptionalDataToBuffer(RawTransaction t, boolean needDataLogged)
Write out the purged record from the page.







Inherited from org.apache.derby.impl.store.raw.data.PhysicalPageOperation:


generateUndo







Field Detail




num_rowsback to summary

protected int num_rows






preparedLogback to summary

protected transient ByteArray preparedLog






recordIdsback to summary

protected int[] recordIds






slotback to summary

protected int slot








Constructor Detail




PurgeOperationback to summary

pack-priv PurgeOperation(RawTransaction t, BasePage page, int slot, int num_rows, int[] recordIds, boolean needDataLogged) throws StandardException






PurgeOperationback to summary

public PurgeOperation()








Method Detail




doMeback to summary

public void doMe(Transaction xact, LogInstant instant, LimitObjectInput in) throws StandardException, IOException
Implements org.apache.derby.iapi.store.raw.Loggable.doMe.

Apply the purge operation to the page.



Parameters



xact:Transaction
Doc from org.apache.derby.iapi.store.raw.Loggable.doMe.

the Transaction

instant:LogInstant
Doc from org.apache.derby.iapi.store.raw.Loggable.doMe.

the log instant of this operation

in:LimitObjectInput
Doc from org.apache.derby.iapi.store.raw.Loggable.doMe.

optional data



Exceptions



StandardException:
Standard Derby policy.

IOException:
Can be thrown by any of the methods of ObjectInput.



See Also

org.apache.derby.iapi.store.raw.Loggable#doMe








getPreparedLogback to summary

public ByteArray getPreparedLog()
Overrides org.apache.derby.impl.store.raw.data.PageBasicOperation.getPreparedLog.

Implements org.apache.derby.iapi.store.raw.Loggable.getPreparedLog.

Doc from org.apache.derby.iapi.store.raw.Loggable.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.
		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.






getTypeFormatIdback to summary

public int getTypeFormatId()
Implements org.apache.derby.iapi.services.io.TypedFormat.getTypeFormatId.

Return my format identifier.



Returns:int
Doc from org.apache.derby.iapi.services.io.TypedFormat.getTypeFormatId.

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








readExternalback to summary

public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException
Overrides org.apache.derby.impl.store.raw.data.PageBasicOperation.readExternal.

Implements java.io.Externalizable.readExternal.

Read this in



Parameters



in:ObjectInput
Doc from java.io.Externalizable.readExternal.

the stream to read data from in order to restore the object



Exceptions



IOException:
error reading from log stream

ClassNotFoundException:
log stream corrupted










restoreMeback to summary

public void restoreMe(Transaction xact, BasePage undoPage, LogInstant CLRInstant, LimitObjectInput in) throws StandardException, IOException
Implements abstract org.apache.derby.impl.store.raw.data.PageBasicOperation.restoreMe.

restore the before image of the page



Parameters



xact:Transaction
Doc from org.apache.derby.impl.store.raw.data.PageBasicOperation.restoreMe.

the Transaction doing the rollback

undoPage:BasePage
Doc from org.apache.derby.impl.store.raw.data.PageBasicOperation.restoreMe.

the page to rollback changes on

CLRInstant:LogInstant
Doc from org.apache.derby.impl.store.raw.data.PageBasicOperation.restoreMe.

the log instant of this (PageUndo) operation

in:LimitObjectInput
Doc from org.apache.derby.impl.store.raw.data.PageBasicOperation.restoreMe.

optional data for the rollback operation



Exceptions



StandardException:
Standard Derby Error Policy

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










toStringback to summary

public String toString()
Overrides org.apache.derby.impl.store.raw.data.PageBasicOperation.toString.

DEBUG: Print self.



Returns:String
Doc from java.lang.Object.toString.

a string representation of the object








undoMeback to summary

public void undoMe(Transaction xact, BasePage undoPage, LogInstant CLRInstant, LimitObjectInput in) throws StandardException, IOException
Implements abstract org.apache.derby.impl.store.raw.data.PhysicalPageOperation.undoMe.

Undo the purge operation on the page.



Parameters



xact:Transaction
Doc from org.apache.derby.impl.store.raw.data.PhysicalPageOperation.undoMe.

the Transaction doing the rollback

undoPage:BasePage
Doc from org.apache.derby.impl.store.raw.data.PhysicalPageOperation.undoMe.

the page to rollback changes on

CLRInstant:LogInstant
Doc from org.apache.derby.impl.store.raw.data.PhysicalPageOperation.undoMe.

the log instant of this (PageUndo) operation

in:LimitObjectInput
Doc from org.apache.derby.impl.store.raw.data.PhysicalPageOperation.undoMe.

optional data for the rollback operation



Exceptions



StandardException:
Standard Derby policy.

IOException:
Can be thrown by any of the methods of ObjectInput.



See Also

PhysicalPageOperation#undoMe








writeExternalback to summary

public void writeExternal(ObjectOutput out) throws IOException
Overrides org.apache.derby.impl.store.raw.data.PageBasicOperation.writeExternal.

Implements java.io.Externalizable.writeExternal.

Doc from java.io.Externalizable.writeExternal.

The object implements the writeExternal method to save its contents
by calling the methods of DataOutput for its primitive values or
calling the writeObject method of ObjectOutput for objects, strings,
and arrays.



Parameters



out:ObjectOutput
the stream to write the object to



Exceptions



IOException:
Includes any I/O exceptions that may occur










writeOptionalDataToBufferback to summary

private void writeOptionalDataToBuffer(RawTransaction t, boolean needDataLogged) throws StandardException, IOException
Write out the purged record from the page.  Used for undo only.



Exceptions



StandardException:
Standard Derby policy.

IOException:
Can be thrown by any of the methods of ObjectOutput.