com.bigdata.btree

Interface ISimpleIndexAccess

All Known Subinterfaces:

ICheckpointProtocol, ISimpleTreeIndexAccess, ISolutionSet

All Known Implementing Classes:

AbstractBTree, AbstractHTree, BTree, CommitRecordIndex, CommitTimeIndex, CounterSetBTree, EventReceiver.EventBTree, HTree, IndexSegment, IndexSegmentIndex, JournalIndex, MetadataIndex, Name2Addr, SolutionSetStream, Stream, TestMROWTransactions.MyBTree, TestRestartSafe.MyBTree, TxId2CommitTimeIndex

public interface ISimpleIndexAccess

Generic data access methods defined for all persistence capable data structures. TODO There should be a high level method to insert objects into the index (index "entries" not tuples - the index will need to compute the appropriate key, etc. in an implementation dependent manner).

Method Summary

Methods

Modifier and Type	Method and Description
IRawStore	getStore() The backing store.
long	rangeCount() Return the #of entries in the index.
void	removeAll() Remove all entries in the index.
ICloseableIterator<?>	scan() Visit all entries in the index in the natural order of the index (dereferencing visited tuples to the application objects stored within those tuples).

Method Detail

getStore

IRawStore getStore()

The backing store.

rangeCount

long rangeCount()

Return the #of entries in the index.

Note: If the index supports deletion markers then the range count will be an upper bound and may double count tuples which have been overwritten, including the special case where the overwrite is a delete.

Returns:

The #of tuples in the index.

See Also:

IRangeQuery.rangeCount()

scan

ICloseableIterator<?> scan()

Visit all entries in the index in the natural order of the index (dereferencing visited tuples to the application objects stored within those tuples).

removeAll

void removeAll()

Remove all entries in the index.