com.hazelcast.query.impl

Class IndexDefinition

java.lang.Object

com.hazelcast.query.impl.IndexDefinition

public final class IndexDefinition
extends Object

Defines an index.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IndexDefinition.UniqueKeyTransform Defines an assortment of transforms applied to unique key values.

Method Summary

Modifier and Type	Method and Description
String[]	getComponents()
String	getName()
String	getUniqueKey()
IndexDefinition.UniqueKeyTransform	getUniqueKeyTransform()
boolean	isOrdered()
static IndexDefinition	parse(String definition, boolean ordered) Parses the given index definition.

Methods inherited from class java.lang.Object

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

Method Detail

parse

public static IndexDefinition parse(String definition,
                                    boolean ordered)

Parses the given index definition. The following definitions are recognized:

• Regular index definition: a single attribute path (attr).
• Composite index definition: multiple attribute paths separated by commas (attr1, attr2, attr3).
• Bitmap index definition: a single attribute path followed by a unique key path separated by "->" (attr -> uniqueKeyAttr).

Parameters:

definition - the definition to parse.

ordered - true if the given definition should define an ordered index, false for unordered.

Returns:

the parsed out index definition.

Throws:

IllegalArgumentException - if the given definition is considered invalid.

getName

public String getName()

Returns:

the canonical name of this index.

isOrdered

public boolean isOrdered()

Returns:

true if this index ordered, false if unordered.

getUniqueKey

public String getUniqueKey()

Returns:

the unique key attribute path, which may be used to extract a value that uniquely identifies an entry being indexed.

getUniqueKeyTransform

public IndexDefinition.UniqueKeyTransform getUniqueKeyTransform()

Returns:

the transform that should be applied to unique key values.

getComponents

public String[] getComponents()

Returns:

the components of this index, which are attributes being indexed by it. Regular and bitmap indexes have just a single component, while composite indexes have multiple components.