Package dev.morphia.query

Class BucketAutoOptions

java.lang.Object

dev.morphia.query.BucketAutoOptions

@Deprecated(since="2.0",
            forRemoval=true)
public class BucketAutoOptions
extends Object

Deprecated, for removal: This API element is subject to removal in a future version.

use AutoBucket instead

The options for a bucket auto stage of aggregation pipeline.

Author:

Roman Lapin

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BucketAutoOptions.Granularity	Deprecated, for removal: This API element is subject to removal in a future version. A value that specifies the preferred number series to use to ensure that the calculated boundary edges end on preferred round numbers or their powers of 10.
class	BucketAutoOptions.OutputOperation	Deprecated, for removal: This API element is subject to removal in a future version. Defines an output for bucketauto stage, that consists of the fieldname and the accumulator

Constructor Summary

Constructors

Constructor	Description
BucketAutoOptions()	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
Map<String,Accumulator>	getAccumulators()	Deprecated, for removal: This API element is subject to removal in a future version.
BucketAutoOptions.Granularity	getGranularity()	Deprecated, for removal: This API element is subject to removal in a future version.
BucketAutoOptions	granularity(BucketAutoOptions.Granularity granularity)	Deprecated, for removal: This API element is subject to removal in a future version. Define granularity field for the bucketauto stage
BucketAutoOptions.OutputOperation	output(String fieldName)	Deprecated, for removal: This API element is subject to removal in a future version. Define output field for the bucketauto stage
Document	toDocument()	Deprecated, for removal: This API element is subject to removal in a future version. Converts a BucketAutoOptions to a Document for use by the Java driver.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BucketAutoOptions

public BucketAutoOptions()

Deprecated, for removal: This API element is subject to removal in a future version.

Method Detail

toDocument

public Document toDocument()

Deprecated, for removal: This API element is subject to removal in a future version.

Converts a BucketAutoOptions to a Document for use by the Java driver.

Returns:

the Document

granularity

public BucketAutoOptions granularity(BucketAutoOptions.Granularity granularity)

Deprecated, for removal: This API element is subject to removal in a future version.

Define granularity field for the bucketauto stage

Parameters:

granularity - granularity BucketAutoOptions.Granularity

Returns:

this

output

public BucketAutoOptions.OutputOperation output(String fieldName)

Deprecated, for removal: This API element is subject to removal in a future version.

Define output field for the bucketauto stage

Parameters:

fieldName - name of the output field

Returns:

this

getGranularity

public BucketAutoOptions.Granularity getGranularity()

Deprecated, for removal: This API element is subject to removal in a future version.

Returns:

granurality for the current bucketauto stage

getAccumulators

public Map<String,Accumulator> getAccumulators()

Deprecated, for removal: This API element is subject to removal in a future version.

Returns:

output accumulators per output field