Package com.hazelcast.config

Class BitmapIndexOptions

java.lang.Object
com.hazelcast.config.BitmapIndexOptions
All Implemented Interfaces:
DataSerializable, IdentifiedDataSerializable
public class BitmapIndexOptions extends Object implements IdentifiedDataSerializable
Configures indexing options specific to bitmap indexes.

  • Field Details

  • 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.

    • writeData

      public void writeData(ObjectDataOutput out) throws IOException
      Description copied from interface: DataSerializable
      Writes object fields to output stream
      Specified by:
      writeData in interface DataSerializable
      Parameters:
      out - output
      Throws:
      IOException - if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.

    • readData

      public void readData(ObjectDataInput in) throws IOException
      Description copied from interface: DataSerializable
      Reads fields from the input stream
      Specified by:
      readData in interface DataSerializable
      Parameters:
      in - input
      Throws:
      IOException - if an I/O error occurs. In particular, an IOException may be thrown if the input stream has been closed.

    • getFactoryId

      public int getFactoryId()
      Description copied from interface: IdentifiedDataSerializable
      Returns DataSerializableFactory factory ID for this class.
      Specified by:
      getFactoryId in interface IdentifiedDataSerializable
      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 interface IdentifiedDataSerializable
      Returns:
      type ID

    • 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