|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface ILeafData
Interface for low-level data access for the leaves of a B+-Tree.
| Method Summary | |
|---|---|
boolean |
getDeleteMarker(int index)
Return true iff the entry at the specified index is marked
as deleted. |
long |
getNextAddr()
The address of the next leaf in key order, 0L if it is known
that there is no next leaf, and -1L if either: (a) it is not
known whether there is a next leaf; or (b) it is known but the address of
that leaf is not known to the caller. |
long |
getPriorAddr()
The address of the previous leaf in key order, 0L if it is
known that there is no previous leaf, and -1L if either: (a)
it is not known whether there is a previous leaf; or (b) it is known but
the address of that leaf is not known to the caller. |
long |
getRawRecord(int index)
Return the address of the raw record on the backing store of the value stored in the tuple having the given index -or- IAddressManager.NULL if
the value is the actual byte[] value associated with the key
in the leaf. |
int |
getValueCount()
The #of values in the leaf (this MUST be equal to the #of keys for a leaf). |
IRaba |
getValues()
Return the object storing the logical byte[][] containing the values for the leaf. |
long |
getVersionTimestamp(int index)
The version timestamp for the entry at the specified index. |
boolean |
hasDeleteMarkers()
Return true iff the leaf maintains delete markers. |
boolean |
hasRawRecords()
Return true iff the leaf promotes large byte[]
values to raw records on the backing store. |
boolean |
hasVersionTimestamps()
Return true iff the leaf maintains version timestamps. |
boolean |
isDoubleLinked()
Return true if the leaf data record supports encoding of the
address of the previous and next leaf in the B+Tree order. |
| Methods inherited from interface com.bigdata.btree.data.IAbstractNodeData |
|---|
data, getMaximumVersionTimestamp, getMinimumVersionTimestamp, isCoded, isLeaf, isReadOnly |
| Methods inherited from interface com.bigdata.btree.data.IKeysData |
|---|
getKeyCount, getKeys |
| Method Detail |
|---|
int getValueCount()
IRaba getValues()
Note: When the leaf maintains raw records you MUST check whether or not
the value was written onto a raw record before interpreting the data
returned by IRaba.get(int). If the length of the value exceeded
the configured maximum record length for the index, then the value was
written onto a raw record on the backing store and IRaba.get(int)
will return the encoded address of that record rather than its data.
hasDeleteMarkers(),
getDeleteMarker(int)long getVersionTimestamp(int index)
IndexOutOfBoundsException - unless index is in [0:ntuples-1].
UnsupportedOperationException - if version timestamps are not being maintained (they are only
required for indices on which transaction processing will be
used).boolean getDeleteMarker(int index)
true iff the entry at the specified index is marked
as deleted.
IndexOutOfBoundsException - unless index is in [0:ntuples-1].
UnsupportedOperationException - if delete markers are not being maintained.long getRawRecord(int index)
IAddressManager.NULL if
the value is the actual byte[] value associated with the key
in the leaf. When the value is the address of a raw record, the actual
byte[] value should be read from the backing store using the
decoded address.
Raw record addresses are created transparently when a large
byte[] is associated with a key in the leaf. They are
materialized transparently when the tuple associated with the leaf is
read. They are deleted when the tuple associated with the leaf is
deleted.
Note: Raw records are managed at the leaf, rather than the IRaba
level, because there is not always a backing store associated with an
IRaba object. This is similar to how deleted tuples are handled.
However, IRabaCoders are responsible for coding the
long address stored in the values raba.
Raw records are only used for large byte[] values. Highly specialized
IRabaCoders can avoid the potential for a conflict with their own
coding scheme by ensuring that the index either will not promote large
values to raw records or by refraining from inserting large values into
the index.
IAddressManager.NULL
UnsupportedOperationException - if raw record markers are not being maintained.boolean hasVersionTimestamps()
true iff the leaf maintains version timestamps.
hasVersionTimestamps in interface IAbstractNodeDataboolean hasDeleteMarkers()
true iff the leaf maintains delete markers.
boolean hasRawRecords()
true iff the leaf promotes large byte[]
values to raw records on the backing store.
boolean isDoubleLinked()
true if the leaf data record supports encoding of the
address of the previous and next leaf in the B+Tree order.
long getPriorAddr()
0L if it is
known that there is no previous leaf, and -1L if either: (a)
it is not known whether there is a previous leaf; or (b) it is known but
the address of that leaf is not known to the caller.
UnsupportedOperationException - if the leaf data record is not double-linked.long getNextAddr()
0L if it is known
that there is no next leaf, and -1L if either: (a) it is not
known whether there is a next leaf; or (b) it is known but the address of
that leaf is not known to the caller.
UnsupportedOperationException - if the leaf data record is not double-linked.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||