MapReduceCommand (mongo-java-driver 3.3.0-query-log-max-size API)

java.lang.Object
- com.mongodb.MapReduceCommand

```
public class MapReduceCommand
extends java.lang.Object
```
This class groups the argument for a map/reduce operation and can build the underlying command object

MongoDB documentation

Map-Reduce

嵌套类概要

嵌套类
限定符和类型类和说明

static class MapReduceCommand.OutputType
Represents the different options available for outputting the results of a map-reduce operation.

嵌套类
限定符和类型	类和说明
`static class`	`MapReduceCommand.OutputType` Represents the different options available for outputting the results of a map-reduce operation.

构造器概要

构造器
构造器和说明
`MapReduceCommand(DBCollection inputCollection, java.lang.String map, java.lang.String reduce, java.lang.String outputCollection, MapReduceCommand.OutputType type, DBObject query)` Represents the command for a map reduce operation Runs the command in REPLACE output type to a named collection

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`java.lang.Boolean`	`getBypassDocumentValidation()` Gets whether to bypass document validation, or null if unspecified.
`java.lang.String`	`getFinalize()` Gets the Finalize JS Function
`java.lang.String`	`getInput()` Get the name of the collection the MapReduce will read from
`java.lang.Boolean`	`getJsMode()` Gets the (optional) JavaScript mode
`int`	`getLimit()` Gets the (optional) limit on input
`java.lang.String`	`getMap()` Get the map function, as a JS String
`long`	`getMaxTime(java.util.concurrent.TimeUnit timeUnit)` Gets the max execution time for this command, in the given time unit.
`java.lang.String`	`getOutputDB()` Gets the (optional) database name where the output collection should reside
`java.lang.String`	`getOutputTarget()` Gets the output target (name of collection to save to) This value is nullable only if OutputType is set to INLINE
`MapReduceCommand.OutputType`	`getOutputType()` Gets the OutputType for this instance.
`DBObject`	`getQuery()` Gets the query to run for this MapReduce job
`ReadPreference`	`getReadPreference()` Gets the read preference
`java.lang.String`	`getReduce()` Gets the reduce function, as a JS String
`java.util.Map<java.lang.String,java.lang.Object>`	`getScope()` Gets the (optional) JavaScript scope
`DBObject`	`getSort()` Gets the (optional) sort specification object
`java.lang.Boolean`	`isVerbose()` Gets the verbosity of the MapReduce job.
`void`	`setBypassDocumentValidation(java.lang.Boolean bypassDocumentValidation)` Sets whether to bypass document validation.
`void`	`setFinalize(java.lang.String finalize)` Sets the Finalize JS Function
`void`	`setJsMode(java.lang.Boolean jsMode)` Sets the (optional) JavaScript Mode
`void`	`setLimit(int limit)` Sets the (optional) limit on input
`void`	`setMaxTime(long maxTime, java.util.concurrent.TimeUnit timeUnit)` Sets the max execution time for this command, in the given time unit.
`void`	`setOutputDB(java.lang.String outputDB)` Sets the (optional) database name where the output collection should reside
`void`	`setReadPreference(ReadPreference preference)` Sets the read preference for this command.
`void`	`setScope(java.util.Map<java.lang.String,java.lang.Object> scope)` Sets the (optional) JavaScript scope
`void`	`setSort(DBObject sort)` Sets the (optional) sort specification object
`void`	`setVerbose(java.lang.Boolean verbose)` Sets the verbosity of the MapReduce job, defaults to 'true'
`DBObject`	`toDBObject()` Turns this command into a DBObject representation of this map reduce command.
`java.lang.String`	`toString()`

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 构造器详细资料
  - MapReduceCommand
```
public MapReduceCommand(DBCollection inputCollection,
                        java.lang.String map,
                        java.lang.String reduce,
                        java.lang.String outputCollection,
                        MapReduceCommand.OutputType type,
                        DBObject query)
```
    Represents the command for a map reduce operation Runs the command in REPLACE output type to a named collection
    
    参数:
    
    inputCollection - collection to use as the source documents to perform the map reduce operation.
    
    map - a JavaScript function that associates or "maps" a value with a key and emits the key and value pair.
    
    reduce - a JavaScript function that "reduces" to a single object all the values associated with a particular key.
    
    outputCollection - optional - leave null if want to get the result inline
    
    type - the type of output
    
    query - specifies the selection criteria using query operators for determining the documents input to the map function.
    
    MongoDB documentation
    
    Map Reduce Command
- 方法详细资料
  - setVerbose
```
public void setVerbose(java.lang.Boolean verbose)
```
    Sets the verbosity of the MapReduce job, defaults to 'true'
    
    参数:
    
    verbose - The verbosity level.
  - isVerbose
```
public java.lang.Boolean isVerbose()
```
    Gets the verbosity of the MapReduce job.
    
    返回:
    
    the verbosity level.
  - getInput
```
public java.lang.String getInput()
```
    Get the name of the collection the MapReduce will read from
    
    返回:
    
    name of the collection the MapReduce will read from
  - getMap
```
public java.lang.String getMap()
```
    Get the map function, as a JS String
    
    返回:
    
    the map function (as a JS String)
  - getReduce
```
public java.lang.String getReduce()
```
    Gets the reduce function, as a JS String
    
    返回:
    
    the reduce function (as a JS String)
  - getOutputTarget
```
public java.lang.String getOutputTarget()
```
    Gets the output target (name of collection to save to) This value is nullable only if OutputType is set to INLINE
    
    返回:
    
    The outputCollection
  - getOutputType
```
public MapReduceCommand.OutputType getOutputType()
```
    Gets the OutputType for this instance.
    
    返回:
    
    The outputType.
  - getFinalize
```
public java.lang.String getFinalize()
```
    Gets the Finalize JS Function
    
    返回:
    
    The finalize function (as a JS String).
  - setFinalize
```
public void setFinalize(java.lang.String finalize)
```
    Sets the Finalize JS Function
    
    参数:
    
    finalize - The finalize function (as a JS String)
  - getQuery
```
public DBObject getQuery()
```
    Gets the query to run for this MapReduce job
    
    返回:
    
    The query object
  - getSort
```
public DBObject getSort()
```
    Gets the (optional) sort specification object
    
    返回:
    
    the Sort DBObject
  - setSort
```
public void setSort(DBObject sort)
```
    Sets the (optional) sort specification object
    
    参数:
    
    sort - The sort specification object
  - getLimit
```
public int getLimit()
```
    Gets the (optional) limit on input
    
    返回:
    
    The limit specification object
  - setLimit
```
public void setLimit(int limit)
```
    Sets the (optional) limit on input
    
    参数:
    
    limit - The limit specification object
  - getMaxTime
```
public long getMaxTime(java.util.concurrent.TimeUnit timeUnit)
```
    Gets the max execution time for this command, in the given time unit.
    
    参数:
    
    timeUnit - the time unit to return the value in.
    
    返回:
    
    the maximum execution time
    
    从以下版本开始:
    
    2.12.0
    
    Since server release
    
    2.6
  - setMaxTime
```
public void setMaxTime(long maxTime,
                       java.util.concurrent.TimeUnit timeUnit)
```
    Sets the max execution time for this command, in the given time unit.
    
    参数:
    
    maxTime - the maximum execution time. A non-zero value requires a server version >= 2.6
    
    timeUnit - the time unit that maxTime is specified in
    
    从以下版本开始:
    
    2.12.0
    
    Since server release
    
    2.6
  - getScope
```
public java.util.Map<java.lang.String,java.lang.Object> getScope()
```
    Gets the (optional) JavaScript scope
    
    返回:
    
    The JavaScript scope
  - setScope
```
public void setScope(java.util.Map<java.lang.String,java.lang.Object> scope)
```
    Sets the (optional) JavaScript scope
    
    参数:
    
    scope - The JavaScript scope
  - getJsMode
```
public java.lang.Boolean getJsMode()
```
    Gets the (optional) JavaScript mode
    
    返回:
    
    The JavaScript mode
    
    从以下版本开始:
    
    2.13
  - setJsMode
```
public void setJsMode(java.lang.Boolean jsMode)
```
    Sets the (optional) JavaScript Mode
    
    参数:
    
    jsMode - Specifies whether to convert intermediate data into BSON format between the execution of the map and reduce functions
    
    从以下版本开始:
    
    2.13
  - getOutputDB
```
public java.lang.String getOutputDB()
```
    Gets the (optional) database name where the output collection should reside
    
    返回:
    
    the name of the database the result is stored in, or null.
  - setOutputDB
```
public void setOutputDB(java.lang.String outputDB)
```
    Sets the (optional) database name where the output collection should reside
    
    参数:
    
    outputDB - the name of the database to send the Map Reduce output to
  - getBypassDocumentValidation
```
public java.lang.Boolean getBypassDocumentValidation()
```
    Gets whether to bypass document validation, or null if unspecified. The default is null.
    
    返回:
    
    whether to bypass document validation, or null if unspecified.
    
    从以下版本开始:
    
    2.14
    
    Since server release
    
    3.2
  - setBypassDocumentValidation
```
public void setBypassDocumentValidation(java.lang.Boolean bypassDocumentValidation)
```
    Sets whether to bypass document validation.
    
    参数:
    
    bypassDocumentValidation - whether to bypass document validation, or null if unspecified
    
    从以下版本开始:
    
    2.14
    
    Since server release
    
    3.2
  - toDBObject
```
public DBObject toDBObject()
```
    Turns this command into a DBObject representation of this map reduce command.
    
    返回:
    
    a DBObject that contains the MongoDB document representation of this command.
  - setReadPreference
```
public void setReadPreference(ReadPreference preference)
```
    Sets the read preference for this command. See the * documentation for ReadPreference for more information.
    
    参数:
    
    preference - Read Preference to use
  - getReadPreference
```
public ReadPreference getReadPreference()
```
    Gets the read preference
    
    返回:
    
    the readPreference
  - toString
```
public java.lang.String toString()
```
    覆盖:
    
    toString 在类中 java.lang.Object

类 MapReduceCommand

嵌套类概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

MapReduceCommand

方法详细资料

setVerbose

isVerbose

getInput

getMap

getReduce

getOutputTarget

getOutputType

getFinalize

setFinalize

getQuery

getSort

setSort

getLimit

setLimit

getMaxTime

setMaxTime

getScope

setScope

getJsMode

setJsMode

getOutputDB

setOutputDB

getBypassDocumentValidation

setBypassDocumentValidation

toDBObject

setReadPreference

getReadPreference

toString