Class DefaultDbRefResolver

java.lang.Object

org.springframework.data.mongodb.core.convert.DefaultReferenceResolver

org.springframework.data.mongodb.core.convert.DefaultDbRefResolver

All Implemented Interfaces:

DbRefResolver, ReferenceResolver

public class DefaultDbRefResolver
extends DefaultReferenceResolver
implements DbRefResolver, ReferenceResolver

A DbRefResolver that resolves DBRefs by delegating to a DbRefResolverCallback than is able to generate lazy loading proxies.

Since:

1.4

Author:

Thomas Darimont, Oliver Gierke, Christoph Strobl, Mark Paluch

Nested Class Summary

Nested classes/interfaces inherited from interface ReferenceResolver

ReferenceResolver.MongoEntityReader, ReferenceResolver.ReferenceCollection

Constructor Summary

Constructors

Constructor	Description
DefaultDbRefResolver(MongoDatabaseFactory mongoDbFactory)	Creates a new DefaultDbRefResolver with the given MongoDatabaseFactory.

Method Summary

Modifier and Type	Method	Description
List<org.bson.Document>	bulkFetch(List<com.mongodb.DBRef> refs)	Loads a given List of DBRefs from the datasource in one batch.
@Nullable org.bson.Document	fetch(com.mongodb.DBRef dbRef)	Actually loads the DBRef from the datasource.
protected com.mongodb.client.MongoCollection<org.bson.Document>	getCollection(com.mongodb.DBRef dbref)	Customization hook for obtaining the MongoCollection for a given DBRef.
protected com.mongodb.client.MongoCollection<org.bson.Document>	getCollection(ReferenceResolver.ReferenceCollection context)
@Nullable Object	resolveDbRef(MongoPersistentProperty property, @Nullable com.mongodb.DBRef dbref, DbRefResolverCallback callback, DbRefProxyHandler handler)	Resolves the given DBRef into an object of the given MongoPersistentProperty's type.

Methods inherited from class DefaultReferenceResolver

getReferenceLoader, isLazyReference, resolveReference

Methods inherited from class Object

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

Methods inherited from interface DbRefResolver

createDbRef

Methods inherited from interface ReferenceResolver

resolveReference

Constructor Details

DefaultDbRefResolver

public DefaultDbRefResolver(MongoDatabaseFactory mongoDbFactory)

Creates a new DefaultDbRefResolver with the given MongoDatabaseFactory.

Parameters:

mongoDbFactory - must not be null.

Method Details

resolveDbRef

public @Nullable Object resolveDbRef(MongoPersistentProperty property,
 @Nullable com.mongodb.DBRef dbref,
 DbRefResolverCallback callback,
 DbRefProxyHandler handler)

Description copied from interface: DbRefResolver

Resolves the given DBRef into an object of the given MongoPersistentProperty's type. The method might return a proxy object for the DBRef or resolve it immediately. In both cases the DbRefResolverCallback will be used to obtain the actual backing object.

Specified by:

resolveDbRef in interface DbRefResolver

Parameters:

property - will never be null.

dbref - the DBRef to resolve.

callback - will never be null.

Returns:

can be null.

fetch

public @Nullable org.bson.Document fetch(com.mongodb.DBRef dbRef)

Description copied from interface: DbRefResolver

Actually loads the DBRef from the datasource.

Specified by:

fetch in interface DbRefResolver

Parameters:

dbRef - must not be null.

Returns:

can be null.

bulkFetch

public List<org.bson.Document> bulkFetch(List<com.mongodb.DBRef> refs)

Description copied from interface: DbRefResolver

Loads a given List of DBRefs from the datasource in one batch. The resulting List of Document will reflect the ordering of the DBRef passed in.
The DBRef elements in the list must not reference different collections.

Specified by:

bulkFetch in interface DbRefResolver

Parameters:

refs - must not be null.

Returns:

never null.

getCollection

protected com.mongodb.client.MongoCollection<org.bson.Document> getCollection(com.mongodb.DBRef dbref)

Customization hook for obtaining the MongoCollection for a given DBRef.

Parameters:

dbref - must not be null.

Returns:

the MongoCollection the given DBRef points to.

Since:

2.1

getCollection

protected com.mongodb.client.MongoCollection<org.bson.Document> getCollection(ReferenceResolver.ReferenceCollection context)