LogEntry (starrocks-bdb-je 18.3.17 API)

All Superinterfaces:

Cloneable

All Known Subinterfaces:

ReplicableLogEntry

All Known Implementing Classes:

AbortLogEntry, BINDeltaLogEntry, CommitLogEntry, DeletedDupLNLogEntry, ErasedLogEntry, FileHeaderEntry, INLogEntry, LNLogEntry, MatchpointLogEntry, NameLNLogEntry, OldBINDeltaLogEntry, SingleItemEntry, TraceLogEntry
```
public interface LogEntry
extends Cloneable
```
A Log entry allows you to read, write and dump a database log entry. Each entry may be made up of one or more loggable items.
The log entry on disk consists of a log header defined by LogManager and the specific contents of the log entry.
Log entries that support replication are required to implement ReplicableLogEntry.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`LogEntry`	`clone()`
`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()`
`LogEntryType`	`getLogType()`
`Object`	`getMainItem()`
`Object`	`getResolvedItem(DatabaseImpl dbImpl)` Construct a complete item from a item entry, fetching additional log entries as needed to ensure that a usable main object is available.
`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`	`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 LogEntry instance of its corresponding LogEntryType.
`void`	`writeEntry(ByteBuffer logBuffer)` Serialize this object into the buffer.

- Method Detail
  - setLogType
```
void setLogType(LogEntryType entryType)
```
    Inform a LogEntry instance of its corresponding LogEntryType.
  - getLogType
```
LogEntryType getLogType()
```
    Returns:
    
    the type of log entry
  - readEntry
```
void readEntry(EnvironmentImpl envImpl,
               LogEntryHeader header,
               ByteBuffer entryBuffer)
```
    Read in a log entry.
  - dumpEntry
```
StringBuilder dumpEntry(StringBuilder sb,
                        boolean verbose)
```
    Print out the contents of an entry.
  - getMainItem
```
Object getMainItem()
```
    Returns:
    
    the first item of the log entry
  - getResolvedItem
```
Object getResolvedItem(DatabaseImpl dbImpl)
```
    Construct a complete item from a item entry, fetching additional log entries as needed to ensure that a usable main object is available. For an OldBINDeltaLogEntry, fetches the full BIN and merges the delta information. This is necessary to return a Node main object. However, for the new BINDeltaLogEntry, the full BIN is not fetched, since the partial BIN (the delta) is usable as a Node.
  - getDbId
```
DatabaseId getDbId()
```
    Returns:
    
    the ID of the database containing this entry, or null if this entry type is not part of a database.
  - getTransactionId
```
long getTransactionId()
```
    Returns:
    
    return the transaction id if this log entry is transactional, 0 otherwise.
  - getSize
```
int getSize()
```
    Returns:
    
    size of byte buffer needed to store this entry.
  - writeEntry
```
void writeEntry(ByteBuffer logBuffer)
```
    Serialize this object into the buffer.
    
    Parameters:
    
    logBuffer - is the destination buffer
  - isImmediatelyObsolete
```
boolean isImmediatelyObsolete(DatabaseImpl dbImpl)
```
    Returns true if this item should be counted as obsolete when logged.
  - isDeleted
```
boolean isDeleted()
```
    Returns whether this is a deleted LN.
  - postLogWork
```
void postLogWork(LogEntryHeader header,
                 long justLoggedLsn,
                 VLSN vlsn)
```
    Do any processing we need to do after logging, while under the logging latch.
  - clone
```
LogEntry clone()
```
    Returns:
    
    a shallow clone.
  - logicalEquals
```
boolean logicalEquals(LogEntry other)
```
    Returns:
    
    true if these two log entries are logically the same. Used for replication.
  - dumpRep
```
void dumpRep(StringBuilder sb)
```
    Dump the contents of the log entry that are interesting for replication.

Interface LogEntry

Method Summary

Method Detail

setLogType

getLogType

readEntry

dumpEntry

getMainItem

getResolvedItem

getDbId

getTransactionId

getSize

writeEntry

isImmediatelyObsolete

isDeleted

postLogWork

clone

logicalEquals

dumpRep