com.hazelcast.query.impl

Class Indexes

java.lang.Object

com.hazelcast.query.impl.Indexes

public class Indexes
extends Object

Contains all indexes for a data-structure, e.g. an IMap.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Indexes.Builder Builder which is used to create a new Indexes object.

Method Summary

Modifier and Type	Method and Description
InternalIndex	addOrGetIndex(String attribute, boolean ordered) Obtains the existing index or creates a new one (if an index doesn't exist yet) for the given attribute in this indexes instance.
void	clearAll() Clears contents of indexes managed by this instance.
void	destroyIndexes() Destroys and then removes all the indexes from this indexes instance.
InternalIndex	getIndex(String attribute) Get index for a given attribute.
InternalIndex[]	getIndexes() Returns all the indexes known to this indexes instance.
IndexesStats	getIndexesStats() Returns the indexes stats of this indexes instance.
boolean	hasIndex() Returns true if this indexes instance contains at least one index, false otherwise.
boolean	isGlobal()
static Indexes.Builder	newBuilder(SerializationService ss, IndexCopyBehavior indexCopyBehavior)
Set<QueryableEntry>	query(Predicate predicate) Performs a query on this indexes instance using the given predicate.
void	removeEntryIndex(Data key, Object value, Index.OperationSource operationSource) Removes the entry from this indexes instance identified by the given key and value.
void	saveEntryIndex(QueryableEntry queryableEntry, Object oldValue, Index.OperationSource operationSource) Inserts a new queryable entry into this indexes instance or updates the existing one.

Methods inherited from class java.lang.Object

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

Method Detail

addOrGetIndex

public InternalIndex addOrGetIndex(String attribute,
                                   boolean ordered)

Obtains the existing index or creates a new one (if an index doesn't exist yet) for the given attribute in this indexes instance.

Parameters:

attribute - the attribute to index.

ordered - true if the new index should be ordered, false otherwise.

Returns:

the existing or created index.

getIndexes

public InternalIndex[] getIndexes()

Returns all the indexes known to this indexes instance.

destroyIndexes

public void destroyIndexes()

Destroys and then removes all the indexes from this indexes instance.

clearAll

public void clearAll()

Clears contents of indexes managed by this instance.

hasIndex

public boolean hasIndex()

Returns true if this indexes instance contains at least one index, false otherwise.

saveEntryIndex

public void saveEntryIndex(QueryableEntry queryableEntry,
                           Object oldValue,
                           Index.OperationSource operationSource)

Inserts a new queryable entry into this indexes instance or updates the existing one.

Parameters:

queryableEntry - the queryable entry to insert or update.

oldValue - the old entry value to update, null if inserting the new entry.

operationSource - the operation source.

removeEntryIndex

public void removeEntryIndex(Data key,
                             Object value,
                             Index.OperationSource operationSource)

Removes the entry from this indexes instance identified by the given key and value.

Parameters:

key - the key if the entry to remove.

value - the value of the entry to remove.

operationSource - the operation source.

isGlobal

public boolean isGlobal()

Returns:

true if the index is global-per map, meaning there is just a single instance of this object per map. Global indexes are used in on-heap maps, since they give a significant performance boost. The opposite of global indexes are partitioned-indexes which are stored locally per partition. In case of a partitioned-index, each query has to query the index in each partition separately, which all-together may be around 3 times slower than querying a single global index.

getIndex

public InternalIndex getIndex(String attribute)

Get index for a given attribute. If the index does not exist then returns null.

Parameters:

attribute - the attribute name to get the index of.

Returns:

Index for attribute or null if the index does not exist.

query

public Set<QueryableEntry> query(Predicate predicate)

Performs a query on this indexes instance using the given predicate.

Parameters:

predicate - the predicate to evaluate.

Returns:

the produced result set or null if the query can't be performed using the indexes known to this indexes instance.

getIndexesStats

public IndexesStats getIndexesStats()

Returns the indexes stats of this indexes instance.

newBuilder

public static Indexes.Builder newBuilder(SerializationService ss,
                                         IndexCopyBehavior indexCopyBehavior)

Parameters:

ss - the serializationService

indexCopyBehavior - the indexCopyBehavior

Returns:

new builder instance which will be used to create Indexes object.

See Also:

IndexCopyBehavior