com.sleepycat.je.tree
Class IN

java.lang.Object
  extended by com.sleepycat.je.tree.Node
      extended by com.sleepycat.je.tree.IN
All Implemented Interfaces:
LoggableObject, LogReadable, LogWritable, Comparable
Direct Known Subclasses:
BIN, DIN

public class IN
extends Node
implements Comparable, LoggableObject, LogReadable

An IN represents an Internal Node in the JE tree.


Field Summary
static int ACCUMULATED_LIMIT
           
static int DBMAP_LEVEL
           
static int EXACT_MATCH
           
static int INSERT_SUCCESS
           
static int LEVEL_MASK
           
static int MAIN_LEVEL
           
static int MAX_LEVEL
           
static int MAY_EVICT_LNS
           
static int MAY_EVICT_NODE
           
static int MAY_NOT_EVICT
           
static int MIN_LEVEL
           
 
Constructor Summary
IN()
          Create an empty IN, with no node id, to be filled in from the log.
IN(DatabaseImpl db, byte[] identifierKey, int capacity, int level)
          Create a new IN.
 
Method Summary
(package private)  void accountForSubtreeRemoval(INList inList, UtilizationTracker tracker)
          Remove self and children from the in-memory IN list.
(package private)  void accumulateStats(TreeWalkerStatsAccumulator acc)
           
(package private)  void adjustCursors(IN newSibling, int newSiblingLow, int newSiblingHigh)
           
(package private)  void adjustCursorsForInsert(int insertIndex)
           
 String beginTag()
           
protected  boolean canBeAncestor(boolean targetContainsDuplicates)
           
(package private)  void clearKnownDeleted(int idx)
          Set knownDeleted to false.
 void clearPendingDeleted(int idx)
          Set pendingDeleted to false.
 int compareTo(Object o)
          Sort based on node id.
 boolean compress(BINReference binRef, boolean canFetch)
           
protected static long computeArraysOverhead(DbConfigManager configManager)
           
protected  long computeMemorySize()
          Count up the memory usage attributable to this node alone.
static long computeOverhead(DbConfigManager configManager)
           
protected  IN createNewInstance(byte[] identifierKey, int maxEntries, int level)
          Create a new IN.
(package private)  boolean deleteEntry(byte[] key, boolean maybeValidate)
          Deletes the ChildReference with the key arg from this IN.
 boolean deleteEntry(int index, boolean maybeValidate)
          Deletes the ChildReference at index from this IN.
protected  void descendOnParentSearch(SearchResult result, boolean targetContainsDuplicates, boolean targetIsRoot, long targetNodeId, Node child, boolean requireExactMatch)
           
(package private) static void dumpDeletedState(StringBuffer sb, byte state)
          Utility method for output of knownDeleted and pendingDelete.
(package private)  void dumpKeys()
           
 void dumpLog(StringBuffer sb, boolean verbose)
          Write the object into the string buffer for log dumping.
protected  void dumpLogAdditional(StringBuffer sb)
          Allows subclasses to add additional fields before the end tag.
 String dumpString(int nSpaces, boolean dumpTags)
          For unit test support:
 String endTag()
           
(package private)  boolean entryZeroKeyComparesLow()
          Indicates whether whether entry 0's key is "special" in that it always compares less than any other key.
 boolean equals(Object obj)
           
 Node fetchTarget(int idx)
          Returns the target of the idx'th entry or null if a pendingDeleted or knownDeleted entry has been cleaned.
 int findEntry(byte[] key, boolean indicateIfDuplicate, boolean exact)
          Find the entry in this IN for which key arg is >= the key.
(package private)  void findParent(Tree.SearchType searchType, long targetNodeId, boolean targetContainsDuplicates, boolean targetIsRoot, byte[] targetMainTreeKey, byte[] targetDupTreeKey, SearchResult result, boolean requireExactMatch, boolean updateGeneration, int targetLevel, List trackingList, boolean doFetch)
          See if you are the parent of this child.
(package private)  void flushProvisionalObsolete(LogManager logManager)
          Adds the provisional obsolete tracking information in this node to the live tracker.
protected  int generateLevel(DatabaseId dbId, int newLevel)
           
 int getAccumulatedDelta()
           
(package private)  int getChildEvictionType()
          Returns the eviction type based on the status of child nodes, irrespective of isEvictionProhibited.
 byte[] getChildKey(IN child)
          Get the key (dupe or identifier) in child that is used to locate it in 'this' node.
 DatabaseImpl getDatabase()
          Get the database for this IN.
 DatabaseId getDatabaseId()
           
 boolean getDirty()
           
 byte[] getDupKey()
          Return the key for this duplicate set.
 byte[] getDupTreeKey()
          Return the key for navigating through the duplicate tree.
protected  long getEntryInMemorySize(byte[] key, Node target)
           
(package private)  byte[] getEntryLsnByteArray()
           
(package private)  long[] getEntryLsnLongArray()
           
 int getEvictionType()
          Returns the eviction type for this IN, for use by the evictor.
 long getGeneration()
           
 byte[] getIdentifierKey()
           
 long getInMemorySize()
          Return the number of bytes used by this IN.
 byte[] getKey(int idx)
          Return the idx'th key.
 Comparator getKeyComparator()
          Return the relevant user defined comparison function for this type of node.
 long getLastFullVersion()
          Returns the last logged LSN, or null if never logged.
 int getLevel()
          Cover for LN's and just return 0 since they'll always be at the bottom of the tree.
 int getLogSize()
           
 LogEntryType getLogType()
          All objects that are reponsible for a generating a type of log entry must implement this.
 long getLsn(int idx)
          Return the idx'th LSN for this entry.
 byte[] getMainTreeKey()
          Return the key for navigating through the main tree.
(package private)  int getMaxEntries()
           
protected  long getMemoryOverhead(MemoryBudget mb)
           
 boolean getMigrate(int idx)
          Get the idx'th migrate status.
 int getNEntries()
           
 byte getState(int idx)
           
 Node getTarget(int idx)
          Return the idx'th target.
 long getTransactionId()
           
 int hashCode()
           
(package private)  boolean hasNonLNChildren()
          Returns whether any resident children are not LNs (are INs).
protected  void init(DatabaseImpl db, byte[] identifierKey, int initialCapacity, int level)
          Initialize IN object.
(package private)  void initEntryLsn(int capacity)
           
protected  void initMemorySize()
          Initialize the per-node memory count by computing its memory usage.
 boolean insertEntry(ChildReference entry)
          Inserts the argument ChildReference into this IN.
 int insertEntry1(ChildReference entry)
          Same as insertEntry except that it returns the index where the dup was found instead of false.
 boolean isCompressible()
           
 boolean isDbRoot()
           
(package private)  boolean isDirty(int idx)
           
 boolean isEntryKnownDeleted(int idx)
           
 boolean isEntryPendingDeleted(int idx)
           
 boolean isEvictable()
          Returns whether this node can itself be evicted.
(package private)  boolean isEvictionProhibited()
          Returns whether the node is not evictable, irrespective of the status of the children nodes.
 boolean isKeyInBounds(byte[] keyVal)
          Returns whether the given key is greater than or equal to the first key in the IN and less than or equal to the last key in the IN.
 boolean isLatchOwner()
           
 boolean isRoot()
           
protected  boolean isSoughtNode(long nid, boolean updateGeneration)
           
(package private) static boolean isStateKnownDeleted(byte state)
          Returns true if the given state is known deleted.
(package private) static boolean isStatePendingDeleted(byte state)
          Returns true if the given state is known deleted.
(package private)  boolean isValidForDelete()
          Check if this node fits the qualifications for being part of a deletable subtree.
 void latch()
          Latch this node and set the generation.
 void latch(boolean updateGeneration)
          Latch this node, optionally setting the generation.
 boolean latchNoWait()
          Latch this node if it is not latched by another thread, and set the generation if the latch succeeds.
 boolean latchNoWait(boolean updateGeneration)
          Latch this node if it is not latched by another thread, optionally setting the generation if the latch succeeds.
 long log(LogManager logManager)
          Log this IN and clear the dirty flag.
 long log(LogManager logManager, boolean allowDeltas, boolean allowMigration)
          Log this IN and clear the dirty flag.
 long log(LogManager logManager, boolean allowDeltas, boolean isProvisional, boolean allowMigration, IN parent)
          Log this node with all available options.
 boolean logEntryIsTransactional()
           
protected  long logInternal(LogManager logManager, boolean allowDeltas, boolean isProvisional, boolean allowMigration, IN parent)
          Decide how to log this node.
 long logProvisional(LogManager logManager, IN parent)
          Log this node provisionally and clear the dirty flag.
(package private) static String makeFetchErrorMsg(String msg, IN in, long lsn, byte state)
           
 boolean needsSplitting()
          Return true if this node needs splitting.
 void postFetchInit(DatabaseImpl db, long sourceLsn)
          Initialize a node that has been read in from the log.
 void postRecoveryInit(DatabaseImpl db, long sourceLsn)
          Initialize a node read in during recovery.
 void readFromLog(ByteBuffer itemBuffer, byte entryTypeVersion)
          Initialize this object from the data in itemBuf.
(package private)  void rebuildINList(INList inList)
          Add self and children to this in-memory IN list.
 void releaseLatch()
          Release the latch on this node.
 void releaseLatchIfOwner()
          Release the latch on this node.
 byte[] selectKey(byte[] mainTreeKey, byte[] dupTreeKey)
           
 void setCleanedSinceLastLog()
          Do nothing since INs don't support deltas.
protected  void setCompressedSinceLastLog()
          Do nothing since INs don't support deltas.
 void setDatabase(DatabaseImpl db)
          Set the database reference for this node.
 void setDirty(boolean dirty)
           
 void setEntry(int idx, Node target, byte[] keyVal, long lsn, byte state)
          Set the idx'th entry of this node.
 void setGeneration()
           
 void setGeneration(long newGeneration)
           
(package private)  void setIdentifierKey(byte[] key)
          Set the identifier key for this node.
 void setInListResident(boolean resident)
           
(package private)  void setIsRoot(boolean isRoot)
           
(package private)  void setKnownDeleted(int idx)
          Set knownDeleted to true.
(package private)  void setLastFullLsn(long lsn)
          Sets the last logged LSN.
 void setLsn(int idx, long lsn)
          Sets the idx'th target LSN.
(package private)  void setLsnElement(int idx, long value)
           
 void setMigrate(int idx, boolean migrate)
          Set the idx'th migrate status.
 void setPendingDeleted(int idx)
          Set pendingDeleted to true.
(package private)  void setTarget(int idx, Node target)
          Sets the idx'th target.
 String shortClassName()
           
(package private)  void split(IN parent, int childIndex, int maxEntries)
          Split this into two nodes.
protected  void splitInternal(IN parent, int childIndex, int maxEntries, int splitIndex)
           
(package private)  void splitSpecial(IN parent, int parentIndex, int maxEntriesPerNode, byte[] key, boolean leftSide)
          Called when we know we are about to split on behalf of a key that is the minimum (leftSide) or maximum (!leftSide) of this node.
 String toString()
          Default toString method at the root of the tree.
(package private)  void trackProvisionalObsolete(IN child, long obsoleteLsn1, long obsoleteLsn2)
          Adds the given obsolete LSNs and any tracked obsolete LSNs for the given child IN to this IN's tracking list.
 void updateEntry(int idx, long lsn)
          Update the idx'th entry of this node.
 void updateEntry(int idx, long lsn, byte state)
          Update the idx'th entry of this node.
 void updateEntry(int idx, long lsn, long oldLNSize, long newLNSize)
          Update the idx'th entry of this node.
 void updateEntry(int idx, Node node)
          Update the idx'th entry of this node.
 void updateEntry(int idx, Node node, long lsn)
          Update the idx'th entry of this node.
 void updateEntry(int idx, Node node, long lsn, byte[] key)
          Update the idx'th entry of this node.
protected  void updateMemorySize(ChildReference oldRef, ChildReference newRef)
           
protected  void updateMemorySize(long oldSize, long newSize)
           
(package private)  void updateMemorySize(Node oldNode, Node newNode)
           
(package private)  boolean validateSubtreeBeforeDelete(int index)
           
 void verify(byte[] maxKey)
          Check that the IN is in a valid state.
 boolean verifyMemorySize()
           
 void writeToLog(ByteBuffer logBuffer)
          Serialize this object into the buffer.
 
Methods inherited from class com.sleepycat.je.tree.Node
containsDuplicates, countAsObsoleteWhenLogged, dump, getLastId, getMemorySizeIncludedByParent, getNextNodeId, getNodeId, getType, marshallOutsideWriteLatch, matchLNByNodeId, postLogWork, setLastNodeId, setNodeId, shortDescription
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.sleepycat.je.log.LoggableObject
countAsObsoleteWhenLogged, marshallOutsideWriteLatch, postLogWork
 

Field Detail

DBMAP_LEVEL

public static final int DBMAP_LEVEL
See Also:
Constant Field Values

MAIN_LEVEL

public static final int MAIN_LEVEL
See Also:
Constant Field Values

LEVEL_MASK

public static final int LEVEL_MASK
See Also:
Constant Field Values

MIN_LEVEL

public static final int MIN_LEVEL
See Also:
Constant Field Values

MAX_LEVEL

public static final int MAX_LEVEL
See Also:
Constant Field Values

MAY_NOT_EVICT

public static final int MAY_NOT_EVICT
See Also:
Constant Field Values

MAY_EVICT_LNS

public static final int MAY_EVICT_LNS
See Also:
Constant Field Values

MAY_EVICT_NODE

public static final int MAY_EVICT_NODE
See Also:
Constant Field Values

EXACT_MATCH

public static final int EXACT_MATCH
See Also:
Constant Field Values

INSERT_SUCCESS

public static final int INSERT_SUCCESS
See Also:
Constant Field Values

ACCUMULATED_LIMIT

public static int ACCUMULATED_LIMIT
Constructor Detail

IN

public IN()
Create an empty IN, with no node id, to be filled in from the log.


IN

public IN(DatabaseImpl db,
          byte[] identifierKey,
          int capacity,
          int level)
Create a new IN.

Method Detail

init

protected void init(DatabaseImpl db,
                    byte[] identifierKey,
                    int initialCapacity,
                    int level)
Initialize IN object.


initMemorySize

protected void initMemorySize()
Initialize the per-node memory count by computing its memory usage.


equals

public boolean equals(Object obj)
Overrides:
equals in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object

compareTo

public int compareTo(Object o)
Sort based on node id.

Specified by:
compareTo in interface Comparable

createNewInstance

protected IN createNewInstance(byte[] identifierKey,
                               int maxEntries,
                               int level)
Create a new IN. Need this because we can't call newInstance() without getting a 0 for nodeid.


postFetchInit

public void postFetchInit(DatabaseImpl db,
                          long sourceLsn)
                   throws DatabaseException
Initialize a node that has been read in from the log.

Overrides:
postFetchInit in class Node
Throws:
DatabaseException

postRecoveryInit

public void postRecoveryInit(DatabaseImpl db,
                             long sourceLsn)
Initialize a node read in during recovery.


setLastFullLsn

void setLastFullLsn(long lsn)
Sets the last logged LSN.


getLastFullVersion

public long getLastFullVersion()
Returns the last logged LSN, or null if never logged. Is public for unit testing.


latch

public void latch(boolean updateGeneration)
           throws DatabaseException
Latch this node, optionally setting the generation.

Throws:
DatabaseException

latchNoWait

public boolean latchNoWait(boolean updateGeneration)
                    throws DatabaseException
Latch this node if it is not latched by another thread, optionally setting the generation if the latch succeeds.

Throws:
DatabaseException

latch

public void latch()
           throws DatabaseException
Latch this node and set the generation.

Throws:
DatabaseException

latchNoWait

public boolean latchNoWait()
                    throws DatabaseException
Latch this node if it is not latched by another thread, and set the generation if the latch succeeds.

Throws:
DatabaseException

releaseLatch

public void releaseLatch()
                  throws LatchNotHeldException
Release the latch on this node.

Throws:
LatchNotHeldException

releaseLatchIfOwner

public void releaseLatchIfOwner()
                         throws LatchNotHeldException
Release the latch on this node.

Throws:
LatchNotHeldException

isLatchOwner

public boolean isLatchOwner()
Returns:
true if this thread holds the IN's latch

getGeneration

public long getGeneration()

setGeneration

public void setGeneration()

setGeneration

public void setGeneration(long newGeneration)

getLevel

public int getLevel()
Description copied from class: Node
Cover for LN's and just return 0 since they'll always be at the bottom of the tree.

Overrides:
getLevel in class Node

generateLevel

protected int generateLevel(DatabaseId dbId,
                            int newLevel)

getDirty

public boolean getDirty()

setDirty

public void setDirty(boolean dirty)

isRoot

public boolean isRoot()

isDbRoot

public boolean isDbRoot()

setIsRoot

void setIsRoot(boolean isRoot)

getIdentifierKey

public byte[] getIdentifierKey()
Returns:
the identifier key for this node.

setIdentifierKey

void setIdentifierKey(byte[] key)
Set the identifier key for this node.

Parameters:
key - - the new identifier key for this node.

getChildKey

public byte[] getChildKey(IN child)
                   throws DatabaseException
Get the key (dupe or identifier) in child that is used to locate it in 'this' node.

Throws:
DatabaseException

selectKey

public byte[] selectKey(byte[] mainTreeKey,
                        byte[] dupTreeKey)

getDupKey

public byte[] getDupKey()
                 throws DatabaseException
Return the key for this duplicate set.

Throws:
DatabaseException

getDupTreeKey

public byte[] getDupTreeKey()
Return the key for navigating through the duplicate tree.


getMainTreeKey

public byte[] getMainTreeKey()
Return the key for navigating through the main tree.


getDatabase

public DatabaseImpl getDatabase()
Get the database for this IN.


setDatabase

public void setDatabase(DatabaseImpl db)
Set the database reference for this node.


getDatabaseId

public DatabaseId getDatabaseId()

getKey

public byte[] getKey(int idx)
Return the idx'th key.


getMigrate

public boolean getMigrate(int idx)
Get the idx'th migrate status.


setMigrate

public void setMigrate(int idx,
                       boolean migrate)
Set the idx'th migrate status.


getState

public byte getState(int idx)

getTarget

public Node getTarget(int idx)
Return the idx'th target.


setTarget

void setTarget(int idx,
               Node target)
Sets the idx'th target. No need to make dirty, that state only applies to key and LSN.

WARNING: This method does not update the memory budget. The caller must update the budget.


getLsn

public long getLsn(int idx)
Return the idx'th LSN for this entry.

Returns:
the idx'th LSN for this entry.

setLsn

public void setLsn(int idx,
                   long lsn)
Sets the idx'th target LSN.


getEntryLsnLongArray

long[] getEntryLsnLongArray()

getEntryLsnByteArray

byte[] getEntryLsnByteArray()

initEntryLsn

void initEntryLsn(int capacity)

setLsnElement

void setLsnElement(int idx,
                   long value)

isEntryPendingDeleted

public boolean isEntryPendingDeleted(int idx)
Returns:
true if the idx'th entry has been deleted, although the transaction the performed the deletion may not be committed.

setPendingDeleted

public void setPendingDeleted(int idx)
Set pendingDeleted to true.


clearPendingDeleted

public void clearPendingDeleted(int idx)
Set pendingDeleted to false.


isEntryKnownDeleted

public boolean isEntryKnownDeleted(int idx)
Returns:
true if the idx'th entry is deleted for sure. If a transaction performed the deletion, it has been committed.

setKnownDeleted

void setKnownDeleted(int idx)
Set knownDeleted to true.


clearKnownDeleted

void clearKnownDeleted(int idx)
Set knownDeleted to false.


isDirty

boolean isDirty(int idx)
Returns:
true if the object is dirty.

getNEntries

public int getNEntries()
Returns:
the number of entries in this node.

isStateKnownDeleted

static boolean isStateKnownDeleted(byte state)
Returns true if the given state is known deleted.


isStatePendingDeleted

static boolean isStatePendingDeleted(byte state)
Returns true if the given state is known deleted.


getMaxEntries

int getMaxEntries()
Returns:
the maximum number of entries in this node.

fetchTarget

public Node fetchTarget(int idx)
                 throws DatabaseException
Returns the target of the idx'th entry or null if a pendingDeleted or knownDeleted entry has been cleaned. Note that null can only be returned for a slot that could contain a deleted LN, not other node types and not a DupCountLN since DupCountLNs are never deleted. Null is also returned for a KnownDeleted slot with a NULL_LSN.

Returns:
the target node or null.
Throws:
DatabaseException

makeFetchErrorMsg

static String makeFetchErrorMsg(String msg,
                                IN in,
                                long lsn,
                                byte state)

setEntry

public void setEntry(int idx,
                     Node target,
                     byte[] keyVal,
                     long lsn,
                     byte state)
Set the idx'th entry of this node.


updateEntry

public void updateEntry(int idx,
                        Node node)
Update the idx'th entry of this node. Note: does not dirty the node.


updateEntry

public void updateEntry(int idx,
                        Node node,
                        long lsn)
Update the idx'th entry of this node.


updateEntry

public void updateEntry(int idx,
                        Node node,
                        long lsn,
                        byte[] key)
Update the idx'th entry of this node.


updateEntry

public void updateEntry(int idx,
                        long lsn)
Update the idx'th entry of this node.


updateEntry

public void updateEntry(int idx,
                        long lsn,
                        byte state)
Update the idx'th entry of this node.


updateEntry

public void updateEntry(int idx,
                        long lsn,
                        long oldLNSize,
                        long newLNSize)
Update the idx'th entry of this node. This flavor is used when the target LN is being modified, by an operation like a delete or update. We don't have to check whether the LSN has been nulled or not, because we know an LSN existed before. Also, the modification of the target is done in the caller, so instead of passing in the old and new nodes, we pass in the old and new node sizes.


verifyMemorySize

public boolean verifyMemorySize()

getInMemorySize

public long getInMemorySize()
Return the number of bytes used by this IN. Latching is up to the caller.


getEntryInMemorySize

protected long getEntryInMemorySize(byte[] key,
                                    Node target)

computeMemorySize

protected long computeMemorySize()
Count up the memory usage attributable to this node alone. LNs children are counted by their BIN/DIN parents, but INs are not counted by their parents because they are resident on the IN list.


computeOverhead

public static long computeOverhead(DbConfigManager configManager)
                            throws DatabaseException
Throws:
DatabaseException

computeArraysOverhead

protected static long computeArraysOverhead(DbConfigManager configManager)
                                     throws DatabaseException
Throws:
DatabaseException

getMemoryOverhead

protected long getMemoryOverhead(MemoryBudget mb)

updateMemorySize

protected void updateMemorySize(ChildReference oldRef,
                                ChildReference newRef)

updateMemorySize

protected void updateMemorySize(long oldSize,
                                long newSize)

updateMemorySize

void updateMemorySize(Node oldNode,
                      Node newNode)

getAccumulatedDelta

public int getAccumulatedDelta()

setInListResident

public void setInListResident(boolean resident)

isKeyInBounds

public boolean isKeyInBounds(byte[] keyVal)
Returns whether the given key is greater than or equal to the first key in the IN and less than or equal to the last key in the IN. This method is used to determine whether a key to be inserted belongs in this IN, without doing a tree search. If false is returned it is still possible that the key belongs in this IN, but a tree search must be performed to find out.


findEntry

public int findEntry(byte[] key,
                     boolean indicateIfDuplicate,
                     boolean exact)
Find the entry in this IN for which key arg is >= the key. Currently uses a binary search, but eventually, this may use binary or linear search depending on key size, number of entries, etc. Note that the 0'th entry's key is treated specially in an IN. It always compares lower than any other key. This is public so that DbCursorTest can access it.

Parameters:
key - - the key to search for.
indicateIfDuplicate - - true if EXACT_MATCH should be or'd onto the return value if key is already present in this node.
exact - - true if an exact match must be found.
Returns:
offset for the entry that has a key >= the arg. 0 if key is less than the 1st entry. -1 if exact is true and no exact match is found. If indicateIfDuplicate is true and an exact match was found then EXACT_MATCH is or'd onto the return value.

insertEntry

public boolean insertEntry(ChildReference entry)
                    throws DatabaseException
Inserts the argument ChildReference into this IN. Assumes this node is already latched by the caller.

Parameters:
entry - The ChildReference to insert into the IN.
Returns:
true if the entry was successfully inserted, false if it was a duplicate.
Throws:
InconsistentNodeException - if the node is full (it should have been split earlier).
DatabaseException

insertEntry1

public int insertEntry1(ChildReference entry)
                 throws DatabaseException
Same as insertEntry except that it returns the index where the dup was found instead of false. The return value is |'d with either INSERT_SUCCESS or EXACT_MATCH depending on whether the entry was inserted or it was a duplicate, resp. This returns a failure if there's a duplicate match. The caller must do the processing to check if the entry is actually deleted and can be overwritten. This is foisted upon the caller rather than handled in this object because there may be some latch releasing/retaking in order to check a child LN. Inserts the argument ChildReference into this IN. Assumes this node is already latched by the caller.

Parameters:
entry - The ChildReference to insert into the IN.
Returns:
either (1) the index of location in the IN where the entry was inserted |'d with INSERT_SUCCESS, or (2) the index of the duplicate in the IN |'d with EXACT_MATCH if the entry was found to be a duplicate.
Throws:
InconsistentNodeException - if the node is full (it should have been split earlier).
DatabaseException

deleteEntry

boolean deleteEntry(byte[] key,
                    boolean maybeValidate)
              throws DatabaseException
Deletes the ChildReference with the key arg from this IN. Assumes this node is already latched by the caller. This seems to only be used by INTest.

Parameters:
key - The key of the reference to delete from the IN.
maybeValidate - true if assert validation should occur prior to delete. Set this to false during recovery.
Returns:
true if the entry was successfully deleted, false if it was not found.
Throws:
DatabaseException

deleteEntry

public boolean deleteEntry(int index,
                           boolean maybeValidate)
                    throws DatabaseException
Deletes the ChildReference at index from this IN. Assumes this node is already latched by the caller.

Parameters:
index - The index of the entry to delete from the IN.
maybeValidate - true if asserts are enabled.
Returns:
true if the entry was successfully deleted, false if it was not found.
Throws:
DatabaseException

setCompressedSinceLastLog

protected void setCompressedSinceLastLog()
Do nothing since INs don't support deltas.


setCleanedSinceLastLog

public void setCleanedSinceLastLog()
Do nothing since INs don't support deltas.


compress

public boolean compress(BINReference binRef,
                        boolean canFetch)
                 throws DatabaseException
Throws:
DatabaseException

isCompressible

public boolean isCompressible()

validateSubtreeBeforeDelete

boolean validateSubtreeBeforeDelete(int index)
                              throws DatabaseException
Throws:
DatabaseException

needsSplitting

public boolean needsSplitting()
Return true if this node needs splitting. For the moment, needing to be split is defined by there being no free entries available.


entryZeroKeyComparesLow

boolean entryZeroKeyComparesLow()
Indicates whether whether entry 0's key is "special" in that it always compares less than any other key. BIN's don't have the special key, but IN's do.


split

void split(IN parent,
           int childIndex,
           int maxEntries)
     throws DatabaseException
Split this into two nodes. Parent IN is passed in parent and should be latched by the caller. childIndex is the index in parent of where "this" can be found.

Throws:
DatabaseException

splitInternal

protected void splitInternal(IN parent,
                             int childIndex,
                             int maxEntries,
                             int splitIndex)
                      throws DatabaseException
Throws:
DatabaseException

splitSpecial

void splitSpecial(IN parent,
                  int parentIndex,
                  int maxEntriesPerNode,
                  byte[] key,
                  boolean leftSide)
            throws DatabaseException
Called when we know we are about to split on behalf of a key that is the minimum (leftSide) or maximum (!leftSide) of this node. This is achieved by just forcing the split to occur either one element in from the left or the right (i.e. splitIndex is 1 or nEntries - 1).

Throws:
DatabaseException

adjustCursors

void adjustCursors(IN newSibling,
                   int newSiblingLow,
                   int newSiblingHigh)

adjustCursorsForInsert

void adjustCursorsForInsert(int insertIndex)

getKeyComparator

public Comparator getKeyComparator()
Return the relevant user defined comparison function for this type of node. For IN's and BIN's, this is the BTree Comparison function.


verify

public void verify(byte[] maxKey)
            throws DatabaseException
Check that the IN is in a valid state. For now, validity means that the keys are in sorted order and that there are more than 0 entries. maxKey, if non-null specifies that all keys in this node must be less than maxKey.

Overrides:
verify in class Node
Throws:
DatabaseException

rebuildINList

void rebuildINList(INList inList)
             throws DatabaseException
Add self and children to this in-memory IN list. Called by recovery, can run with no latching.

Specified by:
rebuildINList in class Node
Throws:
DatabaseException

accountForSubtreeRemoval

void accountForSubtreeRemoval(INList inList,
                              UtilizationTracker tracker)
                        throws DatabaseException
Remove self and children from the in-memory IN list. The INList latch is already held before this is called. Also count removed nodes as obsolete.

Specified by:
accountForSubtreeRemoval in class Node
Throws:
DatabaseException

isValidForDelete

boolean isValidForDelete()
                   throws DatabaseException
Check if this node fits the qualifications for being part of a deletable subtree. It can only have one IN child and no LN children.

Specified by:
isValidForDelete in class Node
Returns:
true if you're part of a deletable subtree.
Throws:
DatabaseException

findParent

void findParent(Tree.SearchType searchType,
                long targetNodeId,
                boolean targetContainsDuplicates,
                boolean targetIsRoot,
                byte[] targetMainTreeKey,
                byte[] targetDupTreeKey,
                SearchResult result,
                boolean requireExactMatch,
                boolean updateGeneration,
                int targetLevel,
                List trackingList,
                boolean doFetch)
          throws DatabaseException
See if you are the parent of this child. If not, find a child of your's that may be the parent, and return it. If there are no possiblities, return null. Note that the keys of the target are passed in so we don't have to latch the target to look at them. Also, this node is latched upon entry.

Parameters:
doFetch - If true, fetch the child in the pursuit of this search. If false, give up if the child is not resident. In that case, we have a potential ancestor, but are not sure if this is the parent.
Throws:
DatabaseException

descendOnParentSearch

protected void descendOnParentSearch(SearchResult result,
                                     boolean targetContainsDuplicates,
                                     boolean targetIsRoot,
                                     long targetNodeId,
                                     Node child,
                                     boolean requireExactMatch)
                              throws DatabaseException
Throws:
DatabaseException

isSoughtNode

protected boolean isSoughtNode(long nid,
                               boolean updateGeneration)
                        throws DatabaseException
Specified by:
isSoughtNode in class Node
Returns:
true if you're an IN in the search path
Throws:
DatabaseException

canBeAncestor

protected boolean canBeAncestor(boolean targetContainsDuplicates)
Specified by:
canBeAncestor in class Node
Returns:
true if you can be the ancestor of the target IN. Currently the determining factor is whether the target IN contains duplicates.

isEvictable

public boolean isEvictable()
Returns whether this node can itself be evicted. This is faster than (getEvictionType() == MAY_EVICT_NODE) and is used by the evictor after a node has been selected, to check that it is still evictable.


getEvictionType

public int getEvictionType()
Returns the eviction type for this IN, for use by the evictor. Uses the internal isEvictionProhibited and getChildEvictionType methods that may be overridden by subclasses.

Returns:
MAY_EVICT_LNS if evictable LNs may be stripped; otherwise, MAY_EVICT_NODE if the node itself may be evicted; otherwise, MAY_NOT_EVICT.

isEvictionProhibited

boolean isEvictionProhibited()
Returns whether the node is not evictable, irrespective of the status of the children nodes.


hasNonLNChildren

boolean hasNonLNChildren()
Returns whether any resident children are not LNs (are INs).


getChildEvictionType

int getChildEvictionType()
Returns the eviction type based on the status of child nodes, irrespective of isEvictionProhibited.


accumulateStats

void accumulateStats(TreeWalkerStatsAccumulator acc)

log

public long log(LogManager logManager)
         throws DatabaseException
Log this IN and clear the dirty flag.

Throws:
DatabaseException

log

public long log(LogManager logManager,
                boolean allowDeltas,
                boolean allowMigration)
         throws DatabaseException
Log this IN and clear the dirty flag.

Throws:
DatabaseException

logProvisional

public long logProvisional(LogManager logManager,
                           IN parent)
                    throws DatabaseException
Log this node provisionally and clear the dirty flag.

Parameters:
item - object to be logged
Returns:
LSN of the new log entry
Throws:
DatabaseException

log

public long log(LogManager logManager,
                boolean allowDeltas,
                boolean isProvisional,
                boolean allowMigration,
                IN parent)
         throws DatabaseException
Log this node with all available options.

Throws:
DatabaseException

logInternal

protected long logInternal(LogManager logManager,
                           boolean allowDeltas,
                           boolean isProvisional,
                           boolean allowMigration,
                           IN parent)
                    throws DatabaseException
Decide how to log this node. INs are always logged in full. Migration never performed since it only applies to BINs.

Throws:
DatabaseException

trackProvisionalObsolete

void trackProvisionalObsolete(IN child,
                              long obsoleteLsn1,
                              long obsoleteLsn2)
Adds the given obsolete LSNs and any tracked obsolete LSNs for the given child IN to this IN's tracking list. This method is called to track obsolete LSNs when a child IN is logged provisionally. Such LSNs cannot be considered obsolete until an ancestor IN is logged non-provisionally.


flushProvisionalObsolete

void flushProvisionalObsolete(LogManager logManager)
                        throws DatabaseException
Adds the provisional obsolete tracking information in this node to the live tracker. This method is called when this node is logged non-provisionally.

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
Specified by:
getLogType in class Node
Returns:
the type of log entry
See Also:
LoggableObject.getLogType()

getLogSize

public int getLogSize()
Specified by:
getLogSize in interface LogWritable
Overrides:
getLogSize in class Node
Returns:
number of bytes used to store this object.
See Also:
LogWritable.getLogSize()

writeToLog

public void writeToLog(ByteBuffer logBuffer)
Description copied from interface: LogWritable
Serialize this object into the buffer.

Specified by:
writeToLog in interface LogWritable
Overrides:
writeToLog in class Node
Parameters:
logBuffer - is the destination buffer
See Also:
LogWritable.writeToLog(java.nio.ByteBuffer)

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
Overrides:
readFromLog in class Node
Throws:
LogException
See Also:
LogReadable.readFromLog(java.nio.ByteBuffer, byte)

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
Overrides:
dumpLog in class Node
Parameters:
sb - destination string buffer
verbose - if true, dump the full, verbose version
See Also:
LogReadable.dumpLog(java.lang.StringBuffer, boolean)

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()

dumpLogAdditional

protected void dumpLogAdditional(StringBuffer sb)
Allows subclasses to add additional fields before the end tag. If they just overload dumpLog, the xml isn't nested.


beginTag

public String beginTag()

endTag

public String endTag()

dumpKeys

void dumpKeys()
        throws DatabaseException
Throws:
DatabaseException

dumpString

public String dumpString(int nSpaces,
                         boolean dumpTags)
For unit test support:

Overrides:
dumpString in class Node
Returns:
a string that dumps information about this IN, without

dumpDeletedState

static void dumpDeletedState(StringBuffer sb,
                             byte state)
Utility method for output of knownDeleted and pendingDelete.


toString

public String toString()
Description copied from class: Node
Default toString method at the root of the tree.

Overrides:
toString in class Node

shortClassName

public String shortClassName()


Copyright 2004-2005 Sleepycat, Inc. All Rights Reserved.