Package com.googlecode.cqengine.persistence.support.sqlite

Class SQLiteDiskIdentityIndex<A extends Comparable<A>,O>

java.lang.Object

com.googlecode.cqengine.index.sqlite.SQLiteIdentityIndex<A,O>

com.googlecode.cqengine.persistence.support.sqlite.SQLiteDiskIdentityIndex<A,O>

All Implemented Interfaces:

ModificationListener<O>, AttributeIndex<A,O>, Index<O>, IdentityAttributeIndex<A,O>, DiskTypeIndex, NonHeapTypeIndex, KeyStatisticsAttributeIndex<A,O>, KeyStatisticsIndex<A,O>, SortedKeyStatisticsAttributeIndex<A,O>, SortedKeyStatisticsIndex<A,O>

public class SQLiteDiskIdentityIndex<A extends Comparable<A>,O>
extends SQLiteIdentityIndex<A,O>
implements DiskTypeIndex

A subclass of SQLiteIdentityIndex intended for use with disk persistence. This subclass does not override any behaviour, and exists only so that CQEngine can distinguish between disk-based and off-heap configurations of the superclass index.

Author:

niall.gallagher

Constructor Summary

Constructors

Constructor	Description
SQLiteDiskIdentityIndex(SimpleAttribute<O,A> primaryKeyAttribute)

Method Summary

Modifier and Type	Method	Description
Index<O>	getEffectiveIndex()	Returns the effective index, which Persistence objects will use to determine the identity of the index making persistence requests.
static <A extends Comparable<A>,O> SQLiteDiskIdentityIndex<A,O>	onAttribute(SimpleAttribute<O,A> primaryKeyAttribute)	Creates a new SQLiteDiskIdentityIndex for the given primary key attribute.

Methods inherited from class com.googlecode.cqengine.index.sqlite.SQLiteIdentityIndex

addAll, clear, equals, getAttribute, getCountForKey, getCountOfDistinctKeys, getDistinctKeys, getDistinctKeys, getDistinctKeysDescending, getDistinctKeysDescending, getForeignKeyAttribute, getKeysAndValues, getKeysAndValues, getKeysAndValuesDescending, getKeysAndValuesDescending, getStatisticsForDistinctKeys, getStatisticsForDistinctKeysDescending, hashCode, init, isMutable, isQuantized, removeAll, retrieve, supportsQuery

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SQLiteDiskIdentityIndex

public SQLiteDiskIdentityIndex(SimpleAttribute<O,A> primaryKeyAttribute)

Method Detail

getEffectiveIndex

public Index<O> getEffectiveIndex()

Description copied from interface: Index

Returns the effective index, which Persistence objects will use to determine the identity of the index making persistence requests. Most Index implementations will typically return a reference to themselves ('this'). However in advanced cases when one index delegates to another, the implementation of the wrapping index will create a subclass the delegate index, and override this method in the delegate index so that when the delegate index interacts with the persistence, it will identify itself as the outer or "effective" index.

Specified by:

getEffectiveIndex in interface Index<A extends Comparable<A>>

Overrides:

getEffectiveIndex in class SQLiteIdentityIndex<A extends Comparable<A>,O>

Returns:

The effective index, in the case that this index is wrapped by another index.

onAttribute

public static <A extends Comparable<A>,O> SQLiteDiskIdentityIndex<A,O> onAttribute(SimpleAttribute<O,A> primaryKeyAttribute)

Creates a new SQLiteDiskIdentityIndex for the given primary key attribute.

Type Parameters:

A - The type of the attribute.

O - The type of the object containing the attributes.

Parameters:

primaryKeyAttribute - The SimpleAttribute representing a primary key on which the index will be built.

Returns:

a new instance of SQLiteDiskIdentityIndex