Module spring.data.mongodb

Package org.springframework.data.mongodb.core.convert

Interface ReferenceLoader

All Known Implementing Classes:

MongoDatabaseFactoryReferenceLoader

public interface ReferenceLoader

The ReferenceLoader obtains raw documents for linked entities via a ReferenceLoader.DocumentReferenceQuery.

Since:

3.3

Author:

Christoph Strobl

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ReferenceLoader.DocumentReferenceQuery	The ReferenceLoader.DocumentReferenceQuery defines the criteria by which documents should be matched applying potentially given order criteria.
static enum	ReferenceLoader.NoResultsFilter	A dedicated ReferenceLoader.DocumentReferenceQuery that will not match any documents.

Method Summary

Modifier and Type	Method	Description
Iterable<org.bson.Document>	fetchMany(ReferenceLoader.DocumentReferenceQuery referenceQuery, ReferenceResolver.ReferenceCollection context)	Obtain multiple Document matching the given referenceQuery in the context.
default org.bson.Document	fetchOne(ReferenceLoader.DocumentReferenceQuery referenceQuery, ReferenceResolver.ReferenceCollection context)	Obtain a single Document matching the given referenceQuery in the context.

Method Details

fetchOne

@Nullable
default org.bson.Document fetchOne(ReferenceLoader.DocumentReferenceQuery referenceQuery,
 ReferenceResolver.ReferenceCollection context)

Obtain a single Document matching the given referenceQuery in the context.

Parameters:

referenceQuery - must not be null.

context - must not be null.

Returns:

the matching Document or null if none found.

fetchMany

Iterable<org.bson.Document> fetchMany(ReferenceLoader.DocumentReferenceQuery referenceQuery,
 ReferenceResolver.ReferenceCollection context)

Obtain multiple Document matching the given referenceQuery in the context.

Parameters:

referenceQuery - must not be null.

context - must not be null.

Returns:

the matching Document or null if none found.