com.sleepycat.je.log.entry

Class SingleItemEntry<T extends Loggable>

java.lang.Object

com.sleepycat.je.log.entry.SingleItemEntry<T>

Type Parameters:

T - the type of the Loggable item

All Implemented Interfaces:

LogEntry, Cloneable

Direct Known Subclasses:

AbortLogEntry, CommitLogEntry, FileHeaderEntry, MatchpointLogEntry, OldBINDeltaLogEntry, TraceLogEntry

public class SingleItemEntry<T extends Loggable>
extends Object
implements LogEntry

This class embodies log entries that have a single loggable item. On disk, an entry contains:

     the Loggable item
 

Constructor Summary

Constructors

Constructor and Description
SingleItemEntry(LogEntryType entryType, T item) Construct a log entry for writing.

Method Summary

Modifier and Type	Method and Description
LogEntry	clone()
static <T extends Loggable> SingleItemEntry<T>	create(Class<T> logClass) Construct a log entry for reading.
static <T extends Loggable> SingleItemEntry<T>	create(LogEntryType entryType, T item) Construct a log entry for writing.
StringBuilder	dumpEntry(StringBuilder sb, boolean verbose) Print out the contents of an entry.
void	dumpRep(StringBuilder sb) Dump the contents of the log entry that are interesting for replication.
DatabaseId	getDbId()
Class<T>	getLogClass() Returns the class of the contained loggable item or items, or null if the instance was created to write an entry.
LogEntryType	getLogType()
T	getMainItem()
Object	getResolvedItem(DatabaseImpl dbImpl) By default, this log entry is complete and does not require fetching additional entries.
int	getSize()
long	getTransactionId()
boolean	isDeleted() Returns whether this is a deleted LN.
boolean	isImmediatelyObsolete(DatabaseImpl dbImpl) Returns true if this item should be counted as obsolete when logged.
boolean	logicalEquals(LogEntry other)
void	postFetchInit(DatabaseImpl dbImpl)
void	postLogWork(LogEntryHeader header, long justLoggedLsn, VLSN vlsn) Do any processing we need to do after logging, while under the logging latch.
void	readEntry(EnvironmentImpl envImpl, LogEntryHeader header, ByteBuffer entryBuffer) Read in a log entry.
void	setLogType(LogEntryType entryType) Inform a BaseEntry instance of its corresponding LogEntryType.
String	toString()
void	writeEntry(ByteBuffer destBuffer) Serialize this object into the buffer.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sleepycat.je.log.entry.LogEntry

clone, getLogType, getResolvedItem, isDeleted, isImmediatelyObsolete, postLogWork, setLogType

Constructor Detail

SingleItemEntry

public SingleItemEntry(LogEntryType entryType,
                       T item)

Construct a log entry for writing.

Method Detail

create

public static <T extends Loggable> SingleItemEntry<T> create(Class<T> logClass)

Construct a log entry for reading.

create

public static <T extends Loggable> SingleItemEntry<T> create(LogEntryType entryType,
                                                             T item)

Construct a log entry for writing.

readEntry

public void readEntry(EnvironmentImpl envImpl,
                      LogEntryHeader header,
                      ByteBuffer entryBuffer)

Description copied from interface: LogEntry

Read in a log entry.

Specified by:

readEntry in interface LogEntry

dumpEntry

public StringBuilder dumpEntry(StringBuilder sb,
                               boolean verbose)

Description copied from interface: LogEntry

Print out the contents of an entry.

Specified by:

dumpEntry in interface LogEntry

dumpRep

public void dumpRep(StringBuilder sb)

Description copied from interface: LogEntry

Dump the contents of the log entry that are interesting for replication.

Specified by:

dumpRep in interface LogEntry

getMainItem

public T getMainItem()

Specified by:

getMainItem in interface LogEntry

Returns:

the first item of the log entry

getTransactionId

public long getTransactionId()

Specified by:

getTransactionId in interface LogEntry

Returns:

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

getDbId

public DatabaseId getDbId()

Specified by:

getDbId in interface LogEntry

Returns:

the ID of the database containing this entry, or null if this entry type is not part of a database.

getSize

public int getSize()

Specified by:

getSize in interface LogEntry

Returns:

size of byte buffer needed to store this entry.

writeEntry

public void writeEntry(ByteBuffer destBuffer)

Description copied from interface: LogEntry

Serialize this object into the buffer.

Specified by:

writeEntry in interface LogEntry

Parameters:

destBuffer - is the destination buffer

logicalEquals

public boolean logicalEquals(LogEntry other)

Specified by:

logicalEquals in interface LogEntry

Returns:

true if these two log entries are logically the same. Used for replication.

getLogClass

public Class<T> getLogClass()

Returns the class of the contained loggable item or items, or null if the instance was created to write an entry.

Returns:

the loggable class or null

setLogType

public void setLogType(LogEntryType entryType)

Inform a BaseEntry instance of its corresponding LogEntryType.

Specified by:

setLogType in interface LogEntry

getLogType

public LogEntryType getLogType()

Specified by:

getLogType in interface LogEntry

Returns:

the type of log entry

getResolvedItem

public Object getResolvedItem(DatabaseImpl dbImpl)

By default, this log entry is complete and does not require fetching additional entries. This method is overridden by BINDeltaLogEntry.

Specified by:

getResolvedItem in interface LogEntry

isImmediatelyObsolete

public boolean isImmediatelyObsolete(DatabaseImpl dbImpl)

Description copied from interface: LogEntry

Returns true if this item should be counted as obsolete when logged.

Specified by:

isImmediatelyObsolete in interface LogEntry

isDeleted

public boolean isDeleted()

Description copied from interface: LogEntry

Returns whether this is a deleted LN.

Specified by:

isDeleted in interface LogEntry

postLogWork

public void postLogWork(LogEntryHeader header,
                        long justLoggedLsn,
                        VLSN vlsn)

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

Specified by:

postLogWork in interface LogEntry

Throws:

DatabaseException - from subclasses.

postFetchInit

public void postFetchInit(DatabaseImpl dbImpl)

clone

public LogEntry clone()

Specified by:

clone in interface LogEntry

Overrides:

clone in class Object

Returns:

a shallow clone.

toString

public String toString()

Overrides:

toString in class Object