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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	getCollection()
com.mongodb.DBObject	getIndexKeysDBObject()
String	getIndexName()
com.mongodb.DBObject	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,
                        com.mongodb.DBObject options)

Constructor used for columns marked as unique.

MongoDBIndexSpec

public MongoDBIndexSpec(org.hibernate.mapping.UniqueKey uniqueKey,
                        com.mongodb.DBObject options)

Constructor used for UniqueKeys.

MongoDBIndexSpec

public MongoDBIndexSpec(org.hibernate.mapping.Index index,
                        com.mongodb.DBObject options)

Constructor used for Indexes.

Method Detail

getCollection

public String getCollection()

getIndexName

public String getIndexName()

isTextIndex

public boolean isTextIndex()

getOptions

public com.mongodb.DBObject getOptions()

getIndexKeysDBObject

public com.mongodb.DBObject getIndexKeysDBObject()

toString

public String toString()

Overrides:

toString in class Object