Class LogRecord

java.lang.Object

org.apache.derby.impl.store.raw.log.LogRecord

All Implemented Interfaces:

Externalizable, Serializable, Formatable, TypedFormat

public class LogRecord
extends Object
implements Formatable

The log record written out to disk. This log record includes:

The is a holder object that may be setup using the setValue() and re-used rather than creating a new object for each actual log record.

The format of a log record is

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private static final int	formatLength
private int	group
(package private) ObjectInput	input
private Loggable	op
private TransactionId	xactId

Constructor Summary

Constructors

Constructor	Description
LogRecord()

Method Summary

Modifier and Type	Method	Description
static int	formatOverhead()
Loggable	getLoggable()
RePreparable	getRePreparable()
static int	getStoredSize(int group, TransactionId xactId)
TransactionId	getTransactionId()
int	getTypeFormatId()	Return my format identifier.
Undoable	getUndoable()
int	group()
boolean	isAbort()
boolean	isChecksum()
boolean	isCLR()
boolean	isCommit()
boolean	isComplete()
boolean	isFirst()
boolean	isPrepare()
static int	maxGroupStoredSize()
static int	maxTransactionIdStoredSize(TransactionId tranId)
void	readExternal(ObjectInput in)	Read this in
boolean	requiresPrepareLocks()
void	setValue(TransactionId xactId, Loggable op)
void	skipLoggable()	Skip over the loggable.
void	writeExternal(ObjectOutput out)	Write this out.

Methods inherited from class Object

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

Field Details

xactId

private TransactionId xactId

op

private Loggable op

group

private int group

input

transient ObjectInput input

formatLength

private static final int formatLength

Constructor Details

LogRecord

public LogRecord()

Method Details

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Write this out.

Specified by:

writeExternal in interface Externalizable

Throws:

IOException - error writing to log stream

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
ClassNotFoundException

Read this in

Specified by:

readExternal in interface Externalizable

Throws:

IOException - error reading from log stream

ClassNotFoundException - corrupted log stream

getTypeFormatId

public int getTypeFormatId()

Return my format identifier.

Specified by:

getTypeFormatId in interface TypedFormat

Returns:

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

setValue

public void setValue(TransactionId xactId,
 Loggable op)

formatOverhead

public static int formatOverhead()

maxGroupStoredSize

public static int maxGroupStoredSize()

maxTransactionIdStoredSize

public static int maxTransactionIdStoredSize(TransactionId tranId)

getStoredSize

public static int getStoredSize(int group,
 TransactionId xactId)

getTransactionId

public TransactionId getTransactionId()
                               throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

getLoggable

public Loggable getLoggable()
                     throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

getRePreparable

public RePreparable getRePreparable()
                             throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

skipLoggable

public void skipLoggable()
                  throws StandardException

Skip over the loggable. Set the input stream to point ot after the loggable as if the entire log record has been sucked in by the log record

Throws:

StandardException - if the loggable is not found, log is corrupt

getUndoable

public Undoable getUndoable()
                     throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

isCLR

public boolean isCLR()

isFirst

public boolean isFirst()

isComplete

public boolean isComplete()

isPrepare

public boolean isPrepare()

requiresPrepareLocks

public boolean requiresPrepareLocks()

isCommit

public boolean isCommit()

isAbort

public boolean isAbort()

group

public int group()

isChecksum

public boolean isChecksum()