com.bigdata.btree

Class IndexSegment.ImmutableNodeFactory.ImmutableLeaf

java.lang.Object

com.bigdata.btree.PO

com.bigdata.btree.AbstractNode<Leaf>

com.bigdata.btree.Leaf

com.bigdata.btree.IndexSegment.ImmutableNodeFactory.ImmutableLeaf

All Implemented Interfaces:

IAbstractNodeData, IKeysData, ILeafData, IAbstractNode, IDirty, IIdentityAccess, IRawRecordAccess, IDataRecordAccess

Enclosing class:

IndexSegment.ImmutableNodeFactory

public static class IndexSegment.ImmutableNodeFactory.ImmutableLeaf
extends Leaf

Immutable leaf throws UnsupportedOperationException for the public mutator API but does not try to override all low-level mutation behaviors.

Version:

$Id$

Author:

Bryan Thompson

Nested Class Summary

Nested classes/interfaces inherited from class com.bigdata.btree.Leaf

Leaf.ILeafListener

Field Summary

Fields inherited from class com.bigdata.btree.AbstractNode

btree, DEBUG, log, parent, referenceCount, self

Fields inherited from class com.bigdata.btree.PO

deleted, dirty, identity

Fields inherited from interface com.bigdata.btree.IIdentityAccess

NULL

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IndexSegment.ImmutableNodeFactory.ImmutableLeaf(AbstractBTree btree) Ctor used when the IndexSegment is empty (no tuples) to create an empty (and immutable) root leaf.
protected	IndexSegment.ImmutableNodeFactory.ImmutableLeaf(AbstractBTree btree, long addr, ILeafData data)

Method Summary

Methods

Modifier and Type	Method and Description
void	delete() Deletes the persistence capable object.
Tuple	insert(byte[] key, byte[] val, boolean deleted, boolean putIfAbsent, long timestamp, Tuple tuple) Insert or update an entry in the leaf as appropriate.
IndexSegment.ImmutableNodeFactory.ImmutableLeaf	nextLeaf()
IndexSegment.ImmutableNodeFactory.ImmutableLeaf	priorLeaf()
Tuple	remove(byte[] key, Tuple tuple) Recursive search locates the appropriate leaf and removes the entry for the key.

Methods inherited from class com.bigdata.btree.Leaf

addLeafListener, copyDown, data, dump, entryIterator, fireInvalidateLeafEvent, getDelegate, getDeleteMarker, getKeyCount, getKeys, getMaximumVersionTimestamp, getMinimumVersionTimestamp, getNextAddr, getPriorAddr, getRawRecord, getValue, getValueCount, getValues, getVersionTimestamp, hasDeleteMarkers, hasRawRecords, hasVersionTimestamps, indexOf, isCoded, isDoubleLinked, isLeaf, isReadOnly, keyAt, lookup, maxKeys, merge, minKeys, postOrderIterator, postOrderNodeIterator, rangeCheck, rangeCheck2, readRawRecord, redistributeKeys, split, toString, valueAt

Methods inherited from class com.bigdata.btree.AbstractNode

assertInvariants, assertKeysMonotonic, copyKey, copyOnWrite, copyOnWrite, dump, dump, getBranchingFactor, getParent, isLeftMostNode, isRightMostNode, join, keyAsString, postOrderNodeIterator, postOrderNodeIterator, rangeIterator

Methods inherited from class com.bigdata.btree.PO

getIdentity, indent, isDeleted, isDirty, isPersistent, setDirty, setIdentity, toShortString

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexSegment.ImmutableNodeFactory.ImmutableLeaf

protected IndexSegment.ImmutableNodeFactory.ImmutableLeaf(AbstractBTree btree)

Ctor used when the IndexSegment is empty (no tuples) to create an empty (and immutable) root leaf.

Parameters:

btree -

IndexSegment.ImmutableNodeFactory.ImmutableLeaf

protected IndexSegment.ImmutableNodeFactory.ImmutableLeaf(AbstractBTree btree,
                                               long addr,
                                               ILeafData data)

Parameters:

btree -

addr -

keys -

values -

Method Detail

delete

public void delete()

Description copied from interface: IIdentityAccess

Deletes the persistence capable object. Both transient and persistent objects may be logically deleted. If the object is persistent then its space on the store is deallocated.

Specified by:

delete in interface IIdentityAccess

Overrides:

delete in class Leaf

insert

public Tuple insert(byte[] key,
           byte[] val,
           boolean deleted,
           boolean putIfAbsent,
           long timestamp,
           Tuple tuple)

Description copied from class: Leaf

Insert or update an entry in the leaf as appropriate. The caller MUST ensure by appropriate navigation of parent nodes that the key for the next tuple either exists in or belongs in this leaf. If the leaf overflows then it is split after the insert. FIXME maintain min/max version timestamps.

Overrides:

insert in class Leaf

Parameters:

key - The key (non-null).

val - The value (may be null).

deleted - true iff the entry is to marked as deleted (delete markers must be supported for if this is true).

putIfAbsent - When true, a pre-existing entry for the key will NOT be replaced (unless it is a deleted tuple, which is the same as if there was no entry under the key). This should ONLY be true when the top-level method is putIfAbsent. Historical code paths should specify false for an unconditional mutation. See BLZG-1539.

timestamp - The timestamp associated with the version (the value is ignored unless version metadata is being maintained).

tuple - A tuple that may be used to obtain the data and metadata for the pre-existing index entry overwritten by the insert operation (optional).

Returns:

The tuple iff there was a pre-existing entry under that key and null otherwise.

remove

public Tuple remove(byte[] key,
           Tuple tuple)

Description copied from class: AbstractNode

Recursive search locates the appropriate leaf and removes the entry for the key.

Note: It is an error to call this method if delete markers are in use.

Overrides:

remove in class Leaf

Parameters:

key - The search key.

tuple - A tuple that may be used to obtain the data and metadata for the pre-existing index entry that was either removed by the remove operation (optional).

Returns:

The tuple iff there was a pre-existing entry under that key and null otherwise.

nextLeaf

public IndexSegment.ImmutableNodeFactory.ImmutableLeaf nextLeaf()

priorLeaf

public IndexSegment.ImmutableNodeFactory.ImmutableLeaf priorLeaf()