com.sleepycat.je.log

Class CleanerFileReader

java.lang.Object

com.sleepycat.je.log.FileReader

com.sleepycat.je.log.CleanerFileReader

public class CleanerFileReader
extends FileReader

CleanerFileReader scans log files for INs and LNs.

Field Summary

Fields inherited from class com.sleepycat.je.log.FileReader

anticipateChecksumErrors, cksumValidator, currentEntryHeader, currentEntryOffset, currentEntryPrevOffset, envImpl, eof, fileManager, nextEntryOffset, readBufferFileEnd, readBufferFileNum, readBufferFileStart, startLsn

Constructor Summary

Constructors

Constructor and Description
CleanerFileReader(EnvironmentImpl env, int readBufferSize, long startLsn, java.lang.Long fileNum) Create this reader to start at a given LSN.

Method Summary

Methods

Modifier and Type	Method and Description
DatabaseId	getDatabaseId() Get the last databaseId seen by the reader.
byte[]	getDupTreeKey() Get the last key seen by the reader.
FileHeader	getFileHeader()
IN	getIN() Get the last entry seen by the reader as an IN.
byte[]	getKey() Get the last key seen by the reader.
LN	getLN() Get the last LN seen by the reader.
protected void	initStartingPosition(long endOfFileLsn, java.lang.Long fileNum) Helper for determining the starting position and opening up a file at the desired location.
boolean	isFileHeader()
boolean	isIN()
boolean	isLN()
boolean	isRoot()
protected boolean	isTargetEntry()
protected boolean	processEntry(java.nio.ByteBuffer entryBuffer) This reader instantiates an LN and key for every LN entry.

Methods inherited from class com.sleepycat.je.log.FileReader

getAndResetNReads, getLastEntrySize, getLastLsn, getNRepeatIteratorReads, getNumRead, readNextEntry, resyncReader, setAlwaysValidateChecksum, threadSafeBufferPosition, threadSafeBufferPosition

Methods inherited from class java.lang.Object

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

Constructor Detail

CleanerFileReader

public CleanerFileReader(EnvironmentImpl env,
                 int readBufferSize,
                 long startLsn,
                 java.lang.Long fileNum)
                  throws java.io.IOException,
                         DatabaseException

Create this reader to start at a given LSN.

Parameters:

env - The relevant EnvironmentImpl.

readBufferSize - buffer size in bytes for reading in log.

startLsn - where to start in the log, or null for the beginning.

fileNum - single file number.

Throws:

java.io.IOException

DatabaseException

Method Detail

initStartingPosition

protected void initStartingPosition(long endOfFileLsn,
                        java.lang.Long fileNum)
                             throws java.io.IOException,
                                    DatabaseException

Helper for determining the starting position and opening up a file at the desired location.

Overrides:

initStartingPosition in class FileReader

Throws:

java.io.IOException

DatabaseException

isTargetEntry

protected boolean isTargetEntry()

Overrides:

isTargetEntry in class FileReader

Returns:

true if this is a type we're interested in.

processEntry

protected boolean processEntry(java.nio.ByteBuffer entryBuffer)
                        throws DatabaseException

This reader instantiates an LN and key for every LN entry.

Specified by:

processEntry in class FileReader

Returns:

true if this entry should be returned

Throws:

DatabaseException

isIN

public boolean isIN()

Returns:

true if the last entry was an IN.

isLN

public boolean isLN()

Returns:

true if the last entry was a LN.

isRoot

public boolean isRoot()

Returns:

true if the last entry was a root

isFileHeader

public boolean isFileHeader()

getLN

public LN getLN()

Get the last LN seen by the reader.

getIN

public IN getIN()
         throws DatabaseException

Get the last entry seen by the reader as an IN.

Throws:

DatabaseException

getFileHeader

public FileHeader getFileHeader()
                         throws DatabaseException

Throws:

DatabaseException

getDatabaseId

public DatabaseId getDatabaseId()

Get the last databaseId seen by the reader.

getKey

public byte[] getKey()

Get the last key seen by the reader.

getDupTreeKey

public byte[] getDupTreeKey()

Get the last key seen by the reader.