MapReduceOptions (mongo-java-driver 3.0.0-beta1 API)

java.lang.Object
- com.mongodb.client.model.MapReduceOptions

```
public class MapReduceOptions
extends Object
```
The options to apply to a map reduce operation

Since:

3.0

MongoDB documentation

mapReduce Command

mapReduce Overview

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class MapReduceOptions.Action
This option is only available when passing out a collection that already exists.

Nested Classes
Modifier and Type	Class and Description
`static class`	`MapReduceOptions.Action` This option is only available when passing out a collection that already exists.

Constructor Summary

Constructors
Constructor and Description
`MapReduceOptions()` Constructs a new instance Sets the options for an inline map-reduce
`MapReduceOptions(String collectionName)` Constructs a new instance

Method Summary

Methods
Modifier and Type	Method and Description
`MapReduceOptions`	`action(MapReduceOptions.Action action)` Specify the `Action` to be used when writing to a collection.
`MapReduceOptions`	`databaseName(String databaseName)` Sets the name of the database to output into.
`MapReduceOptions`	`filter(Object filter)` Sets the query filter to apply to the query.
`MapReduceOptions`	`finalizeFunction(String finalizeFunction)` Sets the JavaScript function that follows the reduce method and modifies the output.
`MapReduceOptions.Action`	`getAction()` Gets the `Action` to be used when writing to a collection.
`String`	`getCollectionName()` Gets the name of the collection to output the results to or null if `isInline()`.
`String`	`getDatabaseName()` Gets the name of the database to output into.
`Object`	`getFilter()` Gets the query filter.
`String`	`getFinalizeFunction()` Gets the JavaScript function that follows the reduce method and modifies the output.
`int`	`getLimit()` Gets the limit to apply.
`long`	`getMaxTime(TimeUnit timeUnit)` Gets the maximum execution time on the server for this operation.
`Object`	`getScope()` Gets the global variables that are accessible in the map, reduce and finalize functions.
`Object`	`getSort()` Gets the sort criteria to apply to the query.
`boolean`	`isInline()` Is the output of the map reduce is inline
`boolean`	`isJsMode()` Gets the flag that specifies whether to convert intermediate data into BSON format between the execution of the map and reduce functions.
`boolean`	`isNonAtomic()` True if the post-processing step will prevent MongoDB from locking the database.
`boolean`	`isSharded()` True if the output database is sharded
`boolean`	`isVerbose()` Gets whether to include the timing information in the result information.
`MapReduceOptions`	`jsMode(boolean jsMode)` Sets the flag that specifies whether to convert intermediate data into BSON format between the execution of the map and reduce functions.
`MapReduceOptions`	`limit(int limit)` Sets the limit to apply.
`MapReduceOptions`	`maxTime(long maxTime, TimeUnit timeUnit)` Sets the maximum execution time on the server for this operation.
`MapReduceOptions`	`nonAtomic(boolean nonAtomic)` Sets if the post-processing step will prevent MongoDB from locking the database.
`MapReduceOptions`	`scope(Object scope)` Sets the global variables that are accessible in the map, reduce and finalize functions.
`MapReduceOptions`	`sharded(boolean sharded)` Sets if the output database is sharded
`MapReduceOptions`	`sort(Object sort)` Sets the sort criteria to apply to the query.
`MapReduceOptions`	`verbose(boolean verbose)` Sets whether to include the timing information in the result information.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MapReduceOptions
```
public MapReduceOptions()
```
    Constructs a new instance Sets the options for an inline map-reduce
  - MapReduceOptions
```
public MapReduceOptions(String collectionName)
```
    Constructs a new instance
    The default action is replace the collection if it exists, to change this use action.
    
    Parameters:
    collectionName - the name of the collection that you want the map-reduce operation to write its output.
- Method Detail
  - isInline
```
public boolean isInline()
```
    Is the output of the map reduce is inline
    
    Returns:
    if the output of the map reduce is inline
  - getCollectionName
```
public String getCollectionName()
```
    Gets the name of the collection to output the results to or null if isInline().
    
    Returns:
    the name of the collection to output the results to or null if isInline().
  - getFinalizeFunction
```
public String getFinalizeFunction()
```
    Gets the JavaScript function that follows the reduce method and modifies the output. Default is null
    
    Returns:
    the JavaScript function that follows the reduce method and modifies the output.
    
    MongoDB documentation
    
    Requirements for the finalize Function
  - finalizeFunction
```
public MapReduceOptions finalizeFunction(String finalizeFunction)
```
    Sets the JavaScript function that follows the reduce method and modifies the output.
    
    Parameters:
    finalizeFunction - the JavaScript function that follows the reduce method and modifies the output.
    
    Returns:
    this
    
    MongoDB documentation
    
    Requirements for the finalize Function
  - getScope
```
public Object getScope()
```
    Gets the global variables that are accessible in the map, reduce and finalize functions.
    
    Returns:
    the global variables that are accessible in the map, reduce and finalize functions.
    
    MongoDB documentation
    
    Scope
  - scope
```
public MapReduceOptions scope(Object scope)
```
    Sets the global variables that are accessible in the map, reduce and finalize functions.
    
    Parameters:
    scope - the global variables that are accessible in the map, reduce and finalize functions.
    
    Returns:
    this
    
    MongoDB documentation
    
    mapReduce
  - getSort
```
public Object getSort()
```
    Gets the sort criteria to apply to the query. The default is null, which means that the documents will be returned in an undefined order.
    
    Returns:
    a document describing the sort criteria
    
    MongoDB documentation
    
    Sort
  - sort
```
public MapReduceOptions sort(Object sort)
```
    Sets the sort criteria to apply to the query.
    
    Parameters:
    sort - the sort criteria, which may be null.
    
    Returns:
    this
    
    MongoDB documentation
    
    Sort
  - filter
```
public MapReduceOptions filter(Object filter)
```
    Sets the query filter to apply to the query.
    
    Parameters:
    filter - the filter to apply to the query.
    
    Returns:
    this
    
    MongoDB documentation
    
    Filter
  - getFilter
```
public Object getFilter()
```
    Gets the query filter.
    
    Returns:
    the query filter
    
    MongoDB documentation
    
    Filter
  - getLimit
```
public int getLimit()
```
    Gets the limit to apply. The default is null.
    
    Returns:
    the limit
    
    MongoDB documentation
    
    Limit
  - limit
```
public MapReduceOptions limit(int limit)
```
    Sets the limit to apply.
    
    Parameters:
    limit - the limit, which may be null
    
    Returns:
    this
    
    MongoDB documentation
    
    Limit
  - isJsMode
```
public boolean isJsMode()
```
    Gets the flag that specifies whether to convert intermediate data into BSON format between the execution of the map and reduce functions. Defaults to false.
    
    Returns:
    jsMode
    
    MongoDB documentation
    
    mapReduce
  - jsMode
```
public MapReduceOptions jsMode(boolean jsMode)
```
    Sets the flag that specifies whether to convert intermediate data into BSON format between the execution of the map and reduce functions. Defaults to false.
    
    Parameters:
    jsMode - the flag that specifies whether to convert intermediate data into BSON format between the execution of the map and reduce functions
    
    Returns:
    jsMode
    
    MongoDB documentation
    
    mapReduce
  - isVerbose
```
public boolean isVerbose()
```
    Gets whether to include the timing information in the result information. Defaults to true.
    
    Returns:
    whether to include the timing information in the result information
  - verbose
```
public MapReduceOptions verbose(boolean verbose)
```
    Sets whether to include the timing information in the result information.
    
    Parameters:
    verbose - whether to include the timing information in the result information.
    
    Returns:
    this
  - getMaxTime
```
public long getMaxTime(TimeUnit timeUnit)
```
    Gets the maximum execution time on the server for this operation. The default is 0, which places no limit on the execution time.
    
    Parameters:
    timeUnit - the time unit to return the result in
    
    Returns:
    the maximum execution time in the given time unit
    
    MongoDB documentation
    
    Max Time
  - maxTime
```
public MapReduceOptions maxTime(long maxTime,
                       TimeUnit timeUnit)
```
    Sets the maximum execution time on the server for this operation.
    
    Parameters:
    maxTime - the max time
    timeUnit - the time unit, which may not be null
    
    Returns:
    this
    
    MongoDB documentation
    
    Max Time
  - getAction
```
public MapReduceOptions.Action getAction()
```
    Gets the Action to be used when writing to a collection.
    The default action is replace the collection if it exists, to change this use action.
    
    Returns:
    the Action to be used when writing to a collection.
  - action
```
public MapReduceOptions action(MapReduceOptions.Action action)
```
    Specify the Action to be used when writing to a collection.
    
    Parameters:
    action - an MapReduceOptions.Action to perform on the collection
    
    Returns:
    this
  - getDatabaseName
```
public String getDatabaseName()
```
    Gets the name of the database to output into.
    
    Returns:
    the name of the database to output into.
  - databaseName
```
public MapReduceOptions databaseName(String databaseName)
```
    Sets the name of the database to output into.
    
    Parameters:
    databaseName - the name of the database to output into.
    
    Returns:
    this
    
    MongoDB documentation
    
    output with an action
  - isSharded
```
public boolean isSharded()
```
    True if the output database is sharded
    
    Returns:
    true if the output database is sharded
    
    MongoDB documentation
    
    output with an action
  - sharded
```
public MapReduceOptions sharded(boolean sharded)
```
    Sets if the output database is sharded
    
    Parameters:
    sharded - if the output database is sharded
    
    Returns:
    this
    
    MongoDB documentation
    
    output with an action
  - isNonAtomic
```
public boolean isNonAtomic()
```
    True if the post-processing step will prevent MongoDB from locking the database.
    
    Returns:
    if true the post-processing step will prevent MongoDB from locking the database.
    
    MongoDB documentation
    
    output with an action
  - nonAtomic
```
public MapReduceOptions nonAtomic(boolean nonAtomic)
```
    Sets if the post-processing step will prevent MongoDB from locking the database. Valid only with the Action.MERGE or Action.REDUCE actions.
    
    Parameters:
    nonAtomic - if the post-processing step will prevent MongoDB from locking the database.
    
    Returns:
    this
    
    MongoDB documentation
    
    output with an action

Class MapReduceOptions

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MapReduceOptions

MapReduceOptions

Method Detail

isInline

getCollectionName

getFinalizeFunction

finalizeFunction

getScope

scope

getSort

sort

filter

getFilter

getLimit

limit

isJsMode

jsMode

isVerbose

verbose

getMaxTime

maxTime

getAction

action

getDatabaseName

databaseName

isSharded

sharded

isNonAtomic

nonAtomic