com.bigdata.btree.data

Class MockLeafData

java.lang.Object

com.bigdata.btree.data.MockLeafData

All Implemented Interfaces:

IAbstractNodeData, IKeysData, ILeafData, IDataRecordAccess

Direct Known Subclasses:

MockBucketData

public class MockLeafData
extends Object
implements ILeafData

Mock object for ILeafData used for unit tests.

Version:

$Id$

Author:

Bryan Thompson

Constructor Summary

Constructors

Constructor and Description
MockLeafData(IRaba keys, IRaba vals, boolean[] deleteMarkers, long[] versionTimestamps, boolean[] rawRecords)

Method Summary

Methods

Modifier and Type	Method and Description
void	copyKey(int index, OutputStream os)
AbstractFixedByteArrayBuffer	data() The coded (aka compressed) data.
boolean	getDeleteMarker(int index) Return true iff the entry at the specified index is marked as deleted.
byte[]	getKey(int index)
int	getKeyCount()
IRaba	getKeys()
long	getMaximumVersionTimestamp() The most recent tuple revision timestamp associated with any tuple spanned by this node or leaf.
long	getMinimumVersionTimestamp() The earliest tuple revision timestamp associated with any tuple spanned by this node or leaf.
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.
byte[]	getValue(int index)
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	isCoded() No.
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.
boolean	isLeaf() True iff this is a leaf node.
boolean	isReadOnly() True iff this is an immutable data structure.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.bigdata.btree.data.IKeysData

getKeyCount, getKeys

Constructor Detail

MockLeafData

public MockLeafData(IRaba keys,
            IRaba vals,
            boolean[] deleteMarkers,
            long[] versionTimestamps,
            boolean[] rawRecords)

Method Detail

getValues

public final IRaba getValues()

Description copied from interface: ILeafData

Return the object storing the logical byte[][] containing the values for the leaf. When the leaf maintains delete markers you MUST check whether or not the tuple is deleted before requesting its value.

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.

Specified by:

getValues in interface ILeafData

See Also:

ILeafData.hasDeleteMarkers(), ILeafData.getDeleteMarker(int)

getValue

public final byte[] getValue(int index)

getValueCount

public final int getValueCount()

Description copied from interface: ILeafData

The #of values in the leaf (this MUST be equal to the #of keys for a leaf).

Specified by:

getValueCount in interface ILeafData

Returns:

The #of values in the leaf.

isLeaf

public final boolean isLeaf()

Description copied from interface: IAbstractNodeData

True iff this is a leaf node.

Specified by:

isLeaf in interface IAbstractNodeData

isReadOnly

public final boolean isReadOnly()

Description copied from interface: IAbstractNodeData

True iff this is an immutable data structure.

Specified by:

isReadOnly in interface IAbstractNodeData

isCoded

public final boolean isCoded()

No.

Specified by:

isCoded in interface IAbstractNodeData

data

public final AbstractFixedByteArrayBuffer data()

Description copied from interface: IAbstractNodeData

The coded (aka compressed) data.

Specified by:

data in interface IAbstractNodeData

Specified by:

data in interface IDataRecordAccess

getDeleteMarker

public final boolean getDeleteMarker(int index)

Description copied from interface: ILeafData

Return true iff the entry at the specified index is marked as deleted.

Specified by:

getDeleteMarker in interface ILeafData

getVersionTimestamp

public final long getVersionTimestamp(int index)

Description copied from interface: ILeafData

The version timestamp for the entry at the specified index.

Specified by:

getVersionTimestamp in interface ILeafData

Returns:

The version timestamp for the index entry.

getRawRecord

public final long getRawRecord(int index)

Description copied from interface: ILeafData

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. 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.

Specified by:

getRawRecord in interface ILeafData

Returns:

The address of the raw record -or- IAddressManager.NULL

hasDeleteMarkers

public final boolean hasDeleteMarkers()

Description copied from interface: ILeafData

Return true iff the leaf maintains delete markers.

Specified by:

hasDeleteMarkers in interface ILeafData

hasVersionTimestamps

public final boolean hasVersionTimestamps()

Description copied from interface: ILeafData

Return true iff the leaf maintains version timestamps.

Specified by:

hasVersionTimestamps in interface IAbstractNodeData

Specified by:

hasVersionTimestamps in interface ILeafData

hasRawRecords

public boolean hasRawRecords()

Description copied from interface: ILeafData

Return true iff the leaf promotes large byte[] values to raw records on the backing store.

Specified by:

hasRawRecords in interface ILeafData

isDoubleLinked

public boolean isDoubleLinked()

Description copied from interface: ILeafData

Return true if the leaf data record supports encoding of the address of the previous and next leaf in the B+Tree order.

Specified by:

isDoubleLinked in interface ILeafData

getNextAddr

public long getNextAddr()

Description copied from interface: ILeafData

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.

Specified by:

getNextAddr in interface ILeafData

getPriorAddr

public long getPriorAddr()

Description copied from interface: ILeafData

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.

Specified by:

getPriorAddr in interface ILeafData

getMaximumVersionTimestamp

public long getMaximumVersionTimestamp()

Description copied from interface: IAbstractNodeData

The most recent tuple revision timestamp associated with any tuple spanned by this node or leaf. If there are NO tuples for the leaf, then this MUST return Long.MIN_VALUE since the initial value of the maximum version timestamp is always the smallest possible long integer.

Specified by:

getMaximumVersionTimestamp in interface IAbstractNodeData

getMinimumVersionTimestamp

public long getMinimumVersionTimestamp()

Description copied from interface: IAbstractNodeData

The earliest tuple revision timestamp associated with any tuple spanned by this node or leaf. If there are NO tuples for the leaf, then this MUST return Long.MAX_VALUE since the initial value of the minimum version timestamp is always the largest possible long integer.

Specified by:

getMinimumVersionTimestamp in interface IAbstractNodeData

toString

public String toString()

Overrides:

toString in class Object

getKeyCount

public final int getKeyCount()

getKeys

public final IRaba getKeys()

getKey

public final byte[] getKey(int index)

copyKey

public final void copyKey(int index,
           OutputStream os)