org.hibernate.ogm.datastore.mongodb.index.impl

Class MongoDBIndexSpec

java.lang.Object

org.hibernate.ogm.datastore.mongodb.index.impl.MongoDBIndexSpec

public class MongoDBIndexSpec
extends Object

Definition of an index to be applied to a MongoDB collection

Author:

Guillaume Smet

See Also:

info about indexes in MongoDB Java Driver 3.4

Constructor Summary

Constructors

Constructor and Description
MongoDBIndexSpec(org.hibernate.mapping.Index index, org.bson.Document options) Constructor used for Indexes.
MongoDBIndexSpec(String collection, String columnName, String indexName, org.bson.Document options) Constructor used for columns marked as unique.
MongoDBIndexSpec(org.hibernate.mapping.UniqueKey uniqueKey, org.bson.Document options) Constructor used for UniqueKeys.

Method Summary

Modifier and Type	Method and Description
String	getCollection()
org.bson.Document	getIndexKeysDocument()
String	getIndexName()
com.mongodb.client.model.IndexOptions	getOptions()
boolean	isTextIndex()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

MongoDBIndexSpec

public MongoDBIndexSpec(String collection,
                        String columnName,
                        String indexName,
                        org.bson.Document options)

Constructor used for columns marked as unique.

MongoDBIndexSpec

public MongoDBIndexSpec(org.hibernate.mapping.UniqueKey uniqueKey,
                        org.bson.Document options)

Constructor used for UniqueKeys.

MongoDBIndexSpec

public MongoDBIndexSpec(org.hibernate.mapping.Index index,
                        org.bson.Document options)

Constructor used for Indexes.

Method Detail

getCollection

public String getCollection()

getIndexName

public String getIndexName()

isTextIndex

public boolean isTextIndex()

getOptions

public com.mongodb.client.model.IndexOptions getOptions()

getIndexKeysDocument

public org.bson.Document getIndexKeysDocument()

toString

public String toString()

Overrides:

toString in class Object