Module spring.data.mongodb

Package org.springframework.data.mongodb.core

Interface ExecutableFindOperation

All Known Subinterfaces:

FluentMongoOperations, MongoOperations

All Known Implementing Classes:

MongoTemplate

public interface ExecutableFindOperation

ExecutableFindOperation allows creation and execution of MongoDB find operations in a fluent API style.
The starting domainType is used for mapping the Query provided via matching into the MongoDB specific representation. By default, the originating domainType is also used for mapping back the result from the Document. However, it is possible to define an different returnType via as to mapping the result.
The collection to operate on is by default derived from the initial domainType and can be defined there via Document. Using inCollection allows to override the collection name for the execution.

     
         query(Human.class)
             .inCollection("star-wars")
             .as(Jedi.class)
             .matching(where("firstname").is("luke"))
             .all();
     
 

Since:

2.0

Author:

Christoph Strobl, Mark Paluch

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ExecutableFindOperation.DistinctWithProjection	Result type override.
static interface	ExecutableFindOperation.DistinctWithQuery<T>	Result restrictions.
static interface	ExecutableFindOperation.ExecutableFind<T>	ExecutableFindOperation.ExecutableFind provides methods for constructing lookup operations in a fluent way.
static interface	ExecutableFindOperation.FindDistinct	Distinct Find support.
static interface	ExecutableFindOperation.FindWithCollection<T>	Collection override (Optional).
static interface	ExecutableFindOperation.FindWithProjection<T>	Result type override (Optional).
static interface	ExecutableFindOperation.FindWithQuery<T>	Terminating operations invoking the actual query execution.
static interface	ExecutableFindOperation.TerminatingDistinct<T>	Terminating distinct find operations.
static interface	ExecutableFindOperation.TerminatingFind<T>	Trigger find execution by calling one of the terminating methods.
static interface	ExecutableFindOperation.TerminatingFindNear<T>	Trigger geonear execution by calling one of the terminating methods.

Method Summary

Modifier and Type	Method	Description
<T> ExecutableFindOperation.ExecutableFind<T>	query(Class<T> domainType)	Start creating a find operation for the given domainType.

Method Details

query

<T> ExecutableFindOperation.ExecutableFind<T> query(Class<T> domainType)

Start creating a find operation for the given domainType.

Parameters:

domainType - must not be null.

Returns:

new instance of ExecutableFindOperation.ExecutableFind.

Throws:

IllegalArgumentException - if domainType is null.