Package com.googlecode.cqengine.index.disk

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

java.lang.Object

com.googlecode.cqengine.index.support.PartialIndex<A,O,SortedKeyStatisticsAttributeIndex<A,O>>

com.googlecode.cqengine.index.support.PartialSortedKeyStatisticsAttributeIndex<A,O>

com.googlecode.cqengine.index.disk.PartialDiskIndex<A,O>

All Implemented Interfaces:

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

public class PartialDiskIndex<A extends Comparable<A>,O>
extends PartialSortedKeyStatisticsAttributeIndex<A,O>
implements DiskTypeIndex

A PartialIndex which uses DiskPersistence.

Author:

niall.gallagher

Field Summary

Fields inherited from class com.googlecode.cqengine.index.support.PartialIndex

attribute, backingIndex, filterQuery

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PartialDiskIndex(Attribute<O,A> attribute, Query<O> filterQuery)	Protected constructor, called by subclasses.

Method Summary

Modifier and Type	Method	Description
protected SortedKeyStatisticsAttributeIndex<A,O>	createBackingIndex()
static <A extends Comparable<A>,O> PartialDiskIndex<A,O>	onAttributeWithFilterQuery(Attribute<O,A> attribute, Query<O> filterQuery)	Creates a new PartialDiskIndex.

Methods inherited from class com.googlecode.cqengine.index.support.PartialSortedKeyStatisticsAttributeIndex

getCountForKey, getCountOfDistinctKeys, getDistinctKeys, getDistinctKeys, getDistinctKeysDescending, getDistinctKeysDescending, getKeysAndValues, getKeysAndValues, getKeysAndValuesDescending, getKeysAndValuesDescending, getStatisticsForDistinctKeys, getStatisticsForDistinctKeysDescending

Methods inherited from class com.googlecode.cqengine.index.support.PartialIndex

addAll, backingIndex, clear, destroy, equals, filter, getAttribute, getBackingIndex, getEffectiveIndex, getFilterQuery, hashCode, init, isMutable, isQuantized, removeAll, retrieve, supportsQuery

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.googlecode.cqengine.index.AttributeIndex

getAttribute

Methods inherited from interface com.googlecode.cqengine.index.Index

getEffectiveIndex, isMutable, isQuantized, retrieve, supportsQuery

Methods inherited from interface com.googlecode.cqengine.engine.ModificationListener

addAll, clear, destroy, init, removeAll

Constructor Detail

PartialDiskIndex

protected PartialDiskIndex(Attribute<O,A> attribute,
                           Query<O> filterQuery)

Protected constructor, called by subclasses.

Parameters:

filterQuery - The filter query which matches the subset of objects to be stored in this index.

Method Detail

createBackingIndex

protected SortedKeyStatisticsAttributeIndex<A,O> createBackingIndex()

Specified by:

createBackingIndex in class PartialIndex<A extends Comparable<A>,O,SortedKeyStatisticsAttributeIndex<A extends Comparable<A>,O>>

onAttributeWithFilterQuery

public static <A extends Comparable<A>,O> PartialDiskIndex<A,O> onAttributeWithFilterQuery(Attribute<O,A> attribute,
                                                                                                       Query<O> filterQuery)

Creates a new PartialDiskIndex. This will obtain details of the DiskPersistence to use from the IndexedCollection, throwing an exception if the IndexedCollection has not been configured with a suitable DiskPersistence.

Type Parameters:

A - The type of the attribute to be indexed.

O - The type of the object containing the attribute.

Parameters:

attribute - The Attribute on which the index will be built.

filterQuery - The filter query which matches the subset of objects to be stored in this index.

Returns:

A DiskIndex on the given attribute.