Package com.hazelcast.config
Class IndexConfig
java.lang.Object
com.hazelcast.config.IndexConfig
- All Implemented Interfaces:
DataSerializable
,IdentifiedDataSerializable
,com.hazelcast.nio.serialization.impl.Versioned
public class IndexConfig
extends Object
implements IdentifiedDataSerializable, com.hazelcast.nio.serialization.impl.Versioned
Configuration of an index. Hazelcast support three types of indexes: sorted index, hash index
and bitmap index.
Sorted indexes could be used with equality and range predicates and have logarithmic search time.
Hash indexes could be used with equality predicates and have constant search time assuming the hash
function of the indexed field disperses the elements properly.
Bitmap indexes are similar to hash index. They are able to achieve a much higher memory efficiency
for low cardinality attributes at the cost of reduced query performance.
Index could be created on one or more attributes.
- See Also:
-
Field Summary
-
Constructor Summary
ConstructorDescriptionIndexConfig
(IndexConfig other) IndexConfig
(IndexType type) Creates an index configuration of the given type.IndexConfig
(IndexType type, String... attributes) Creates an index configuration of the given type with provided attributes. -
Method Summary
Modifier and TypeMethodDescriptionaddAttribute
(String attribute) Adds an index attribute with the given.void
addAttributeInternal
(String attribute) boolean
Gets index attributes.Provides access to index options specific to bitmap indexes.Provides access to index options specific to B-Tree indexes.int
Returns type identifier for this class.int
Returns DataSerializableFactory factory ID for this class.getName()
Gets name of the index.getType()
Gets type of the index.int
hashCode()
void
Reads fields from the input streamsetAttributes
(List<String> attributes) Sets index attributes.setBitmapIndexOptions
(BitmapIndexOptions bitmapIndexOptions) Sets bitmap index options of this index config to the given ones.setBTreeIndexConfig
(BTreeIndexConfig bTreeIndexConfig) Sets B-Tree config of this index to the specified configuration.Sets name of the index.Sets type of the index.toString()
void
Writes object fields to output stream
-
Field Details
-
DEFAULT_TYPE
Default index type.
-
-
Constructor Details
-
IndexConfig
public IndexConfig() -
IndexConfig
Creates an index configuration of the given type.- Parameters:
type
- Index type.
-
IndexConfig
Creates an index configuration of the given type with provided attributes.- Parameters:
type
- Index type.attributes
- Attributes to be indexed.
-
IndexConfig
-
-
Method Details
-
getName
Gets name of the index.- Returns:
- Name of the index or
null
if index name should be generated automatically.
-
setName
Sets name of the index.- Parameters:
name
- Name of the index ornull
if index name should be generated automatically.- Returns:
- This instance for chaining.
-
getType
Gets type of the index.Defaults to
IndexType.SORTED
.- Returns:
- Type of the index.
-
setType
Sets type of the index.Defaults to
IndexType.SORTED
.- Parameters:
type
- Type of the index.- Returns:
- This instance for chaining.
-
getAttributes
Gets index attributes.- Returns:
- Index attributes.
-
addAttribute
Adds an index attribute with the given.- Parameters:
attribute
- Attribute name.- Returns:
- This instance for chaining.
-
addAttributeInternal
-
setAttributes
Sets index attributes.- Parameters:
attributes
- Index attributes.- Returns:
- This instance for chaining.
-
getBitmapIndexOptions
Provides access to index options specific to bitmap indexes.- Returns:
- the bitmap index options associated with this index config.
-
setBitmapIndexOptions
Sets bitmap index options of this index config to the given ones.- Parameters:
bitmapIndexOptions
- the bitmap index options to set.- Returns:
- this index config instance.
-
getBTreeIndexConfig
Provides access to index options specific to B-Tree indexes.- Returns:
- the b-tree index configuration associated with this config.
-
setBTreeIndexConfig
Sets B-Tree config of this index to the specified configuration.- Parameters:
bTreeIndexConfig
- new b-tree index configuration to set.
-
getFactoryId
public int getFactoryId()Description copied from interface:IdentifiedDataSerializable
Returns DataSerializableFactory factory ID for this class.- Specified by:
getFactoryId
in interfaceIdentifiedDataSerializable
- Returns:
- factory ID
-
getClassId
public int getClassId()Description copied from interface:IdentifiedDataSerializable
Returns type identifier for this class. It should be unique per DataSerializableFactory.- Specified by:
getClassId
in interfaceIdentifiedDataSerializable
- Returns:
- type ID
-
writeData
Description copied from interface:DataSerializable
Writes object fields to output stream- Specified by:
writeData
in interfaceDataSerializable
- Parameters:
out
- output- Throws:
IOException
- if an I/O error occurs. In particular, anIOException
may be thrown if the output stream has been closed.
-
readData
Description copied from interface:DataSerializable
Reads fields from the input stream- Specified by:
readData
in interfaceDataSerializable
- Parameters:
in
- input- Throws:
IOException
- if an I/O error occurs. In particular, anIOException
may be thrown if the input stream has been closed.
-
equals
-
hashCode
public int hashCode() -
toString
-