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

Class MongoPersistentEntityIndexResolver

java.lang.Object

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

All Implemented Interfaces:

IndexResolver

public class MongoPersistentEntityIndexResolver
extends Object
implements IndexResolver

IndexResolver implementation inspecting MongoPersistentEntity for MongoPersistentEntity to be indexed.
All MongoPersistentProperty of the MongoPersistentEntity are inspected for potential indexes by scanning related annotations.

Since:

1.5

Author:

Christoph Strobl, Thomas Darimont, Martin Macko, Mark Paluch, Dave Perryman, Stefan Tirea

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MongoPersistentEntityIndexResolver.CyclicPropertyReferenceException
static class	MongoPersistentEntityIndexResolver.IndexDefinitionHolder	Implementation of IndexDefinition holding additional (property)path information used for creating the index.

Constructor Summary

Constructors

Constructor	Description
MongoPersistentEntityIndexResolver(MappingContext<? extends MongoPersistentEntity<?>,MongoPersistentProperty> mappingContext)	Create new MongoPersistentEntityIndexResolver.

Method Summary

Modifier and Type	Method	Description
protected MongoPersistentEntityIndexResolver.IndexDefinitionHolder	createCompoundIndexDefinition(String dotPath, String collection, CompoundIndex index, MongoPersistentEntity<?> entity)
protected List<MongoPersistentEntityIndexResolver.IndexDefinitionHolder>	createCompoundIndexDefinitions(String dotPath, String fallbackCollection, MongoPersistentEntity<?> entity)	Create IndexDefinition wrapped in MongoPersistentEntityIndexResolver.IndexDefinitionHolder for CompoundIndexes of a given type.
protected MongoPersistentEntityIndexResolver.IndexDefinitionHolder	createGeoSpatialIndexDefinition(String dotPath, String collection, MongoPersistentProperty persistentProperty)	Creates IndexDefinition wrapped in MongoPersistentEntityIndexResolver.IndexDefinitionHolder out of GeoSpatialIndexed for MongoPersistentProperty.
protected MongoPersistentEntityIndexResolver.IndexDefinitionHolder	createHashedIndexDefinition(String dotPath, String collection, MongoPersistentProperty persistentProperty)	Creates HashedIndex wrapped in MongoPersistentEntityIndexResolver.IndexDefinitionHolder out of HashIndexed for a given MongoPersistentProperty.
protected MongoPersistentEntityIndexResolver.IndexDefinitionHolder	createIndexDefinition(String dotPath, String collection, MongoPersistentProperty persistentProperty)	Creates IndexDefinition wrapped in MongoPersistentEntityIndexResolver.IndexDefinitionHolder out of Indexed for a given MongoPersistentProperty.
protected MongoPersistentEntityIndexResolver.IndexDefinitionHolder	createWildcardIndexDefinition(String dotPath, String collection, WildcardIndexed index, MongoPersistentEntity<?> entity)
protected EvaluationContext	getEvaluationContext()	Get the default EvaluationContext.
Iterable<? extends MongoPersistentEntityIndexResolver.IndexDefinitionHolder>	resolveIndexFor(TypeInformation<?> typeInformation)	Find and create IndexDefinitions for properties of given TypeInformation.
List<MongoPersistentEntityIndexResolver.IndexDefinitionHolder>	resolveIndexForEntity(MongoPersistentEntity<?> root)	Resolve the IndexDefinitions for a given root entity by traversing MongoPersistentProperty scanning for index annotations Indexed, CompoundIndex and GeospatialIndex.
void	setEvaluationContextProvider(EvaluationContextProvider evaluationContextProvider)	Set the EvaluationContextProvider used for obtaining the EvaluationContext used to compute expressions.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.data.mongodb.core.index.IndexResolver

resolveIndexFor

Constructor Details

MongoPersistentEntityIndexResolver

public MongoPersistentEntityIndexResolver(MappingContext<? extends MongoPersistentEntity<?>,MongoPersistentProperty> mappingContext)

Create new MongoPersistentEntityIndexResolver.

Parameters:

mappingContext - must not be null.

Method Details

resolveIndexFor

public Iterable<? extends MongoPersistentEntityIndexResolver.IndexDefinitionHolder> resolveIndexFor(TypeInformation<?> typeInformation)

Description copied from interface: IndexResolver

Find and create IndexDefinitions for properties of given TypeInformation. IndexDefinitions are created for properties and types with Indexed, CompoundIndexes or GeoSpatialIndexed.

Specified by:

resolveIndexFor in interface IndexResolver

Parameters:

typeInformation - must not be null.

Returns:

Empty Iterable in case no IndexDefinition could be resolved for type.

resolveIndexForEntity

public List<MongoPersistentEntityIndexResolver.IndexDefinitionHolder> resolveIndexForEntity(MongoPersistentEntity<?> root)

Resolve the IndexDefinitions for a given root entity by traversing MongoPersistentProperty scanning for index annotations Indexed, CompoundIndex and GeospatialIndex. The given root has therefore to be annotated with Document.

Parameters:

root - must not be null.

Returns:

List of MongoPersistentEntityIndexResolver.IndexDefinitionHolder. Will never be null.

Throws:

IllegalArgumentException - in case of missing Document annotation marking root entities.

createCompoundIndexDefinitions

protected List<MongoPersistentEntityIndexResolver.IndexDefinitionHolder> createCompoundIndexDefinitions(String dotPath,
 String fallbackCollection,
 MongoPersistentEntity<?> entity)

Create IndexDefinition wrapped in MongoPersistentEntityIndexResolver.IndexDefinitionHolder for CompoundIndexes of a given type.

Parameters:

dotPath - The properties "dot" path representation from its document root.

fallbackCollection -

entity -

Returns:

createCompoundIndexDefinition

protected MongoPersistentEntityIndexResolver.IndexDefinitionHolder createCompoundIndexDefinition(String dotPath,
 String collection,
 CompoundIndex index,
 MongoPersistentEntity<?> entity)

createWildcardIndexDefinition

protected MongoPersistentEntityIndexResolver.IndexDefinitionHolder createWildcardIndexDefinition(String dotPath,
 String collection,
 WildcardIndexed index,
 @Nullable
 MongoPersistentEntity<?> entity)

createIndexDefinition

@Nullable
protected MongoPersistentEntityIndexResolver.IndexDefinitionHolder createIndexDefinition(String dotPath,
 String collection,
 MongoPersistentProperty persistentProperty)

Creates IndexDefinition wrapped in MongoPersistentEntityIndexResolver.IndexDefinitionHolder out of Indexed for a given MongoPersistentProperty.

Parameters:

dotPath - The properties "dot" path representation from its document root.

collection -

persistentProperty -

Returns:

createHashedIndexDefinition

@Nullable
protected MongoPersistentEntityIndexResolver.IndexDefinitionHolder createHashedIndexDefinition(String dotPath,
 String collection,
 MongoPersistentProperty persistentProperty)

Creates HashedIndex wrapped in MongoPersistentEntityIndexResolver.IndexDefinitionHolder out of HashIndexed for a given MongoPersistentProperty.

Parameters:

dotPath - The properties "dot" path representation from its document root.

collection -

persistentProperty -

Returns:

Since:

2.2

getEvaluationContext

protected EvaluationContext getEvaluationContext()

Get the default EvaluationContext.

Returns:

never null.

Since:

2.2

setEvaluationContextProvider

public void setEvaluationContextProvider(EvaluationContextProvider evaluationContextProvider)

Set the EvaluationContextProvider used for obtaining the EvaluationContext used to compute expressions.

Parameters:

evaluationContextProvider - must not be null.

Since:

2.2

createGeoSpatialIndexDefinition

@Nullable
protected MongoPersistentEntityIndexResolver.IndexDefinitionHolder createGeoSpatialIndexDefinition(String dotPath,
 String collection,
 MongoPersistentProperty persistentProperty)

Creates IndexDefinition wrapped in MongoPersistentEntityIndexResolver.IndexDefinitionHolder out of GeoSpatialIndexed for MongoPersistentProperty.

Parameters:

dotPath - The properties "dot" path representation from its document root.

collection -

persistentProperty -

Returns: