Package org.springframework.data.mongodb.core

Interface ExecutableMapReduceOperation

All Known Subinterfaces:

FluentMongoOperations, MongoOperations

All Known Implementing Classes:

MongoTemplate

public interface ExecutableMapReduceOperation

ExecutableMapReduceOperation allows creation and execution of MongoDB mapReduce operations in a fluent API style. The starting domainType is used for mapping an optional Query provided via matching into the MongoDB specific representation. By default, the originating domainType is also used for mapping back the results 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.

     
         mapReduce(Human.class)
             .map("function() { emit(this.id, this.firstname) }")
             .reduce("function(id, name) { return sum(id, name); }")
             .inCollection("star-wars")
             .as(Jedi.class)
             .matching(query(where("lastname").is("skywalker")))
             .all();
     
 

Since:

2.1

Author:

Christoph Strobl, Mark Paluch

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ExecutableMapReduceOperation.ExecutableMapReduce<T>	ExecutableMapReduceOperation.ExecutableMapReduce provides methods for constructing mapReduce operations in a fluent way.
static interface	ExecutableMapReduceOperation.MapReduceWithCollection<T>	Collection override (Optional).
static interface	ExecutableMapReduceOperation.MapReduceWithMapFunction<T>	Provide the Javascript function() used to map matching documents.
static interface	ExecutableMapReduceOperation.MapReduceWithOptions<T>	Deprecated. since 4.0 in favor of org.springframework.data.mongodb.core.aggregation.
static interface	ExecutableMapReduceOperation.MapReduceWithProjection<T>	Result type override (Optional).
static interface	ExecutableMapReduceOperation.MapReduceWithQuery<T>	Input document filter query (Optional).
static interface	ExecutableMapReduceOperation.MapReduceWithReduceFunction<T>	Provide the Javascript function() used to reduce matching documents.
static interface	ExecutableMapReduceOperation.TerminatingMapReduce<T>	Trigger mapReduce execution by calling one of the terminating methods.

Method Summary

Modifier and Type	Method	Description
<T> ExecutableMapReduceOperation.MapReduceWithMapFunction<T>	mapReduce(Class<T> domainType)	Start creating a mapReduce operation for the given domainType.

Method Details

mapReduce

<T>
ExecutableMapReduceOperation.MapReduceWithMapFunction<T> mapReduce(Class<T> domainType)

Start creating a mapReduce operation for the given domainType.

Parameters:

domainType - must not be null.

Returns:

new instance of ExecutableFindOperation.ExecutableFind.

Throws:

IllegalArgumentException - if domainType is null.