Module spring.data.mongodb

Package org.springframework.data.mongodb.core.index

Class MongoPersistentEntityIndexResolver.IndexDefinitionHolder

java.lang.Object

org.springframework.data.mongodb.core.index.MongoPersistentEntityIndexResolver.IndexDefinitionHolder

All Implemented Interfaces:

IndexDefinition

Enclosing class:

MongoPersistentEntityIndexResolver

public static class MongoPersistentEntityIndexResolver.IndexDefinitionHolder
extends Object
implements IndexDefinition

Implementation of IndexDefinition holding additional (property)path information used for creating the index. The path itself is the properties "dot" path representation from its root document.

Since:

1.5

Author:

Christoph Strobl

Constructor Summary

Constructors

Constructor	Description
IndexDefinitionHolder(String path, IndexDefinition definition, String collection)	Create

Method Summary

Modifier and Type	Method	Description
String	getCollection()
IndexDefinition	getIndexDefinition()	Get the raw IndexDefinition.
org.bson.Document	getIndexKeys()	Get the Document containing properties covered by the index.
org.bson.Document	getIndexOptions()	Get the index properties such as unique,...
String	getPath()	Get the "dot" path used to create the index.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

IndexDefinitionHolder

public IndexDefinitionHolder(String path,
 IndexDefinition definition,
 String collection)

Create

Parameters:

path -

Method Details

getCollection

public String getCollection()

getPath

public String getPath()

Get the "dot" path used to create the index.

Returns:

getIndexDefinition

public IndexDefinition getIndexDefinition()

Get the raw IndexDefinition.

Returns:

getIndexKeys

public org.bson.Document getIndexKeys()

Description copied from interface: IndexDefinition

Get the Document containing properties covered by the index.

Specified by:

getIndexKeys in interface IndexDefinition

Returns:

never null.

getIndexOptions

public org.bson.Document getIndexOptions()

Description copied from interface: IndexDefinition

Get the index properties such as unique,...

Specified by:

getIndexOptions in interface IndexDefinition

Returns:

never null.

toString

public String toString()

Overrides:

toString in class Object