com.neeve.query.index

Interface IdxIndex.Stats<K>

Type Parameters:

K - The key type associated with the stats

Enclosing interface:

IdxIndex<T,ID>

public static interface IdxIndex.Stats<K>

Stats describe the size and composition of an IdxIndex.

Method Summary

Methods

Modifier and Type	Method and Description
int	getCardinality() The number of entries in the IdxIndex.
long	getCommitSequenceNumber() Gets the commitSequence number to which the index has been updated.
K	getHighKey() The highest key in the IdxIndex, provided that this index is against a Comparable field.
int	getKeyCardinality() The number of keys in the IdxIndex.
K	getLowKey() The lowest key in the IdxIndex, provided that this index is against a Comparable field.
boolean	isLive() An index is live if it is being updated as the repository is indexed.
boolean	isUnique() Whether the IdxIndex is unique.

Method Detail

isUnique

boolean isUnique()

Whether the IdxIndex is unique.

Returns:

Whether the IdxIndex is unique.

getKeyCardinality

int getKeyCardinality()

The number of keys in the IdxIndex.

Returns:

The number of keys in the IdxIndex.

getCardinality

int getCardinality()

The number of entries in the IdxIndex.

Returns:

The number of entries in the IdxIndex.

getLowKey

K getLowKey()

The lowest key in the IdxIndex, provided that this index is against a Comparable field. Null otherwise.

Returns:

The lowest key in the IdxIndex

getHighKey

K getHighKey()

The highest key in the IdxIndex, provided that this index is against a Comparable field. Null otherwise.

Returns:

The highest key in the IdxIndex

isLive

boolean isLive()

An index is live if it is being updated as the repository is indexed. It is not live if it is in the process of creation or re-indexing. A non-live index is "catching up" with the current state of the repository. A "live" index is caught up with the indexing of the repository itself. An important distinction is that during initial indexing of a new repository an index may be live even though the entire repository has not yet been indexed.

Returns:

True if this index is live.

getCommitSequenceNumber

long getCommitSequenceNumber()

Gets the commitSequence number to which the index has been updated. A value of -1 indicates that the Index isLive()

Returns:

The commitSequenceNumber to which the index has been indexed.

See Also:

isLive()