Package com.hazelcast.config

Class BitmapIndexOptions

java.lang.Object

com.hazelcast.config.BitmapIndexOptions

public class BitmapIndexOptions
extends Object

Configures indexing options specific to bitmap indexes.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	BitmapIndexOptions.UniqueKeyTransformation	Defines an assortment of transformations which can be applied to unique key values.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_UNIQUE_KEY	The default for unique key.
static final BitmapIndexOptions.UniqueKeyTransformation	DEFAULT_UNIQUE_KEY_TRANSFORMATION	The default for unique key transformation.

Constructor Summary

Constructors

Constructor	Description
BitmapIndexOptions()	Constructs a new bitmap index options instance with all options set to default values.
BitmapIndexOptions(BitmapIndexOptions bitmapIndexOptions)	Constructs a new bitmap index options instance by copying the passed bitmap index options.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getUniqueKey()	Returns the unique key attribute configured in this index config.
BitmapIndexOptions.UniqueKeyTransformation	getUniqueKeyTransformation()	Returns the unique key transformation configured in this index.
int	hashCode()
BitmapIndexOptions	setUniqueKey(String uniqueKey)	Sets unique key attribute in this index config.
BitmapIndexOptions	setUniqueKeyTransformation(BitmapIndexOptions.UniqueKeyTransformation uniqueKeyTransformation)	Sets unique key transformation in this index config.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_UNIQUE_KEY

public static final String DEFAULT_UNIQUE_KEY

The default for unique key.

DEFAULT_UNIQUE_KEY_TRANSFORMATION

public static final BitmapIndexOptions.UniqueKeyTransformation DEFAULT_UNIQUE_KEY_TRANSFORMATION

The default for unique key transformation.

Constructor Details

BitmapIndexOptions

public BitmapIndexOptions()

Constructs a new bitmap index options instance with all options set to default values.

BitmapIndexOptions

public BitmapIndexOptions(BitmapIndexOptions bitmapIndexOptions)

Constructs a new bitmap index options instance by copying the passed bitmap index options.

Method Details

getUniqueKey

public String getUniqueKey()

Returns the unique key attribute configured in this index config. Defaults to __key. The unique key attribute is used as a source of values which uniquely identify each entry being inserted into an index.

Returns:

the configured unique key attribute.

setUniqueKey

public BitmapIndexOptions setUniqueKey(@Nonnull
 String uniqueKey)

Sets unique key attribute in this index config.

Parameters:

uniqueKey - a unique key attribute to configure.

getUniqueKeyTransformation

public BitmapIndexOptions.UniqueKeyTransformation getUniqueKeyTransformation()

Returns the unique key transformation configured in this index. Defaults to OBJECT. The transformation is applied to every value extracted from unique key attribue.

Returns:

the configured unique key transformation.

setUniqueKeyTransformation

public BitmapIndexOptions setUniqueKeyTransformation(@Nonnull
 BitmapIndexOptions.UniqueKeyTransformation uniqueKeyTransformation)

Sets unique key transformation in this index config.

Parameters:

uniqueKeyTransformation - a unique key transformation to configure.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object