com.sleepycat.je.tree
Class BINDelta

java.lang.Object
  com.sleepycat.je.tree.BINDelta

All Implemented Interfaces:

LoggableObject, LogReadable, LogWritable

public class BINDelta
extends Object
implements LoggableObject, LogReadable

BINDelta contains the information needed to create a partial (delta) BIN log entry. It also knows how to combine a full BIN log entry and a delta to generate a new BIN.

Constructor Summary

BINDelta()
For instantiating from the log.

BINDelta(BIN bin)
Read a BIN and create the deltas.

Method Summary

boolean	countAsObsoleteWhenLogged() Returns true if this item should be counted as obsoleted when logged.
void	dumpLog(StringBuffer sb, boolean verbose) Write the object into the string buffer for log dumping.
DatabaseId	getDbId()
long	getLastFullLsn()
int	getLogSize()
LogEntryType	getLogType() All objects that are reponsible for a generating a type of log entry must implement this.
(package private) int	getNumDeltas()
long	getTransactionId()
boolean	logEntryIsTransactional()
boolean	marshallOutsideWriteLatch() Return true if this item can be marshalled outside the log write latch.
void	postLogWork(long justLoggedLsn) Do any processing we need to do after logging, while under the logging latch.
void	readFromLog(ByteBuffer itemBuffer, byte entryTypeVersion) Initialize this object from the data in itemBuf.
BIN	reconstituteBIN(EnvironmentImpl env) Create a BIN by starting with the full version and applying the deltas.
void	writeToLog(ByteBuffer logBuffer) Serialize this object into the buffer.

Methods inherited from class java.lang.Object

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

Constructor Detail

BINDelta

public BINDelta(BIN bin)

Read a BIN and create the deltas.

BINDelta

public BINDelta()

For instantiating from the log.

Method Detail

getNumDeltas

int getNumDeltas()

Returns:

a count of deltas for this BIN.

getDbId

public DatabaseId getDbId()

Returns:

the dbId for this BIN.

getLastFullLsn

public long getLastFullLsn()

Returns:

the last full version of this BIN

reconstituteBIN

public BIN reconstituteBIN(EnvironmentImpl env)
                    throws DatabaseException

Create a BIN by starting with the full version and applying the deltas.

Throws:

DatabaseException

getLogType

public LogEntryType getLogType()

Description copied from interface: LoggableObject

All objects that are reponsible for a generating a type of log entry must implement this.

Specified by:

getLogType in interface LoggableObject

Returns:

the type of log entry

marshallOutsideWriteLatch

public boolean marshallOutsideWriteLatch()

Description copied from interface: LoggableObject

Return true if this item can be marshalled outside the log write latch.

Specified by:

marshallOutsideWriteLatch in interface LoggableObject

See Also:

Can be marshalled outside the log write latch.

countAsObsoleteWhenLogged

public boolean countAsObsoleteWhenLogged()

Description copied from interface: LoggableObject

Returns true if this item should be counted as obsoleted when logged. This currently applies to deleted LNs only.

Specified by:

countAsObsoleteWhenLogged in interface LoggableObject

See Also:

LoggableObject.countAsObsoleteWhenLogged()

postLogWork

public void postLogWork(long justLoggedLsn)

Description copied from interface: LoggableObject

Do any processing we need to do after logging, while under the logging latch.

Specified by:

postLogWork in interface LoggableObject

readFromLog

public void readFromLog(ByteBuffer itemBuffer,
                        byte entryTypeVersion)
                 throws LogException

Description copied from interface: LogReadable

Initialize this object from the data in itemBuf.

Specified by:

readFromLog in interface LogReadable

Throws:

LogException

getLogSize

public int getLogSize()

Specified by:

getLogSize in interface LogWritable

Returns:

number of bytes used to store this object.

writeToLog

public void writeToLog(ByteBuffer logBuffer)

Description copied from interface: LogWritable

Serialize this object into the buffer.

Specified by:

writeToLog in interface LogWritable

Parameters:

logBuffer - is the destination buffer

dumpLog

public void dumpLog(StringBuffer sb,
                    boolean verbose)

Description copied from interface: LogReadable

Write the object into the string buffer for log dumping. Each object should be dumped without indentation or new lines and should be valid XML.

Specified by:

dumpLog in interface LogReadable

Parameters:

sb - destination string buffer

verbose - if true, dump the full, verbose version

logEntryIsTransactional

public boolean logEntryIsTransactional()

Specified by:

logEntryIsTransactional in interface LogReadable

Returns:

true if the LogEntry is a transactional log entry type.

See Also:

LogReadable.logEntryIsTransactional()

getTransactionId

public long getTransactionId()

Specified by:

getTransactionId in interface LogReadable

Returns:

return the transaction id if this log entry is transactional, 0 otherwise.

See Also:

LogReadable.getTransactionId()