com.hazelcast.query.impl

Class IndexImpl

java.lang.Object

com.hazelcast.query.impl.IndexImpl

All Implemented Interfaces:

Index

public class IndexImpl
extends Object
implements Index

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IndexImpl.NullObject

Field Summary

Fields

Modifier and Type	Field and Description
protected IndexStore	indexStore
static IndexImpl.NullObject	NULL
protected InternalSerializationService	ss

Constructor Summary

Constructors

Constructor and Description
IndexImpl(String attributeName, boolean ordered, InternalSerializationService ss, Extractors extractors, IndexCopyBehavior copyQueryResultOn)

Method Summary

Modifier and Type	Method and Description
void	clear() Clears out all entries from this index.
IndexStore	createIndexStore(boolean ordered)
void	destroy() Releases all resources hold by this index, e.g.
String	getAttributeName()
TypeConverter	getConverter() Provides comparable null object.
Set<QueryableEntry>	getRecords(Comparable attributeValue) Produces a result set containing entries whose attribute values are equal to the given value.
Set<QueryableEntry>	getRecords(Comparable[] values) Produces a result set containing entries whose attribute values are equal to at least one of the given values.
Set<QueryableEntry>	getSubRecords(ComparisonType comparisonType, Comparable searchedAttributeValue) Produces a result set containing entries whose attribute values are satisfy the comparison of the given type with the given value.
Set<QueryableEntry>	getSubRecordsBetween(Comparable fromAttributeValue, Comparable toAttributeValue) Produces a result set by performing a range query on this index.
boolean	isOrdered() Tells whether this index is ordered or not.
void	removeEntryIndex(Data key, Object value) Removes the entry having the given key and the value from this index.
void	saveEntryIndex(QueryableEntry entry, Object oldRecordValue) Saves the given entry into this index.

Methods inherited from class java.lang.Object

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

Field Detail

NULL

public static final IndexImpl.NullObject NULL

ss

protected final InternalSerializationService ss

indexStore

protected final IndexStore indexStore

Constructor Detail

IndexImpl

public IndexImpl(String attributeName,
                 boolean ordered,
                 InternalSerializationService ss,
                 Extractors extractors,
                 IndexCopyBehavior copyQueryResultOn)

Method Detail

createIndexStore

public IndexStore createIndexStore(boolean ordered)

saveEntryIndex

public void saveEntryIndex(QueryableEntry entry,
                           Object oldRecordValue)
                    throws QueryException

Description copied from interface: Index

Saves the given entry into this index.

Specified by:

saveEntryIndex in interface Index

Parameters:

entry - the entry to save.

oldRecordValue - the previous old value associated with the entry or null if the entry is new.

Throws:

QueryException - if there were errors while extracting the attribute value from the entry.

removeEntryIndex

public void removeEntryIndex(Data key,
                             Object value)

Description copied from interface: Index

Removes the entry having the given key and the value from this index.

Specified by:

removeEntryIndex in interface Index

Parameters:

key - the key of the entry to remove.

value - the value of the entry to remove.

getRecords

public Set<QueryableEntry> getRecords(Comparable[] values)

Description copied from interface: Index

Produces a result set containing entries whose attribute values are equal to at least one of the given values.

Specified by:

getRecords in interface Index

Parameters:

values - the values to compare against.

Returns:

the produced result set.

getRecords

public Set<QueryableEntry> getRecords(Comparable attributeValue)

Description copied from interface: Index

Produces a result set containing entries whose attribute values are equal to the given value.

Specified by:

getRecords in interface Index

Parameters:

attributeValue - the value to compare against.

Returns:

the produced result set.

getSubRecords

public Set<QueryableEntry> getSubRecords(ComparisonType comparisonType,
                                         Comparable searchedAttributeValue)

Description copied from interface: Index

Produces a result set containing entries whose attribute values are satisfy the comparison of the given type with the given value.

Specified by:

getSubRecords in interface Index

Parameters:

comparisonType - the type of the comparison to perform.

searchedAttributeValue - the value to compare against.

Returns:

the produced result set.

getSubRecordsBetween

public Set<QueryableEntry> getSubRecordsBetween(Comparable fromAttributeValue,
                                                Comparable toAttributeValue)

Description copied from interface: Index

Produces a result set by performing a range query on this index.

More precisely, this method produces a result set containing entries whose attribute values are greater than or equal to the given from value and less than or equal to the given to value.

Specified by:

getSubRecordsBetween in interface Index

Parameters:

fromAttributeValue - the beginning of the range (inclusive).

toAttributeValue - the end of the range (inclusive).

Returns:

the produced result set.

getConverter

public TypeConverter getConverter()

Provides comparable null object.

Specified by:

getConverter in interface Index

Returns:

the converter associated with this index; or null if the converter is not known because there were no saves to this index and the attribute type is not inferred yet.

clear

public void clear()

Description copied from interface: Index

Clears out all entries from this index.

Specified by:

clear in interface Index

destroy

public void destroy()

Description copied from interface: Index

Releases all resources hold by this index, e.g. the allocated native memory for the HD index.

Specified by:

destroy in interface Index

getAttributeName

public String getAttributeName()

Specified by:

getAttributeName in interface Index

Returns:

the name of the attribute for which this index is built.

isOrdered

public boolean isOrdered()

Description copied from interface: Index

Tells whether this index is ordered or not.

Ordered indexes support the fast evaluation of range queries. Unordered indexes are still capable to execute range queries, but the performance would be about the same as the full scan performance.

Specified by:

isOrdered in interface Index

Returns:

true if this index is ordered, false otherwise.

See Also:

Index.getSubRecords(com.hazelcast.query.impl.ComparisonType, java.lang.Comparable), Index.getSubRecordsBetween(java.lang.Comparable, java.lang.Comparable)