Package dev.morphia.aggregation.stages

Class Densify.Range

java.lang.Object

dev.morphia.aggregation.stages.Densify.Range

Enclosing class:

Densify

public static class Densify.Range
extends Object

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Range(Densify.RangeType type, Number step)

Method Summary

Modifier and Type	Method	Description
static Densify.Range	bounded(Object lowerBound, Object upperBound, Number step)	Creates a bounded range.
static Densify.Range	full(Number step)	Creates a "full" range with documents spanning the full range of values of the field being densified.
Object	lowerBound()
static Densify.Range	partition(Number step)	Creates a partitioned range and adds documents to each partition, similar to if you had run a full range densification on each partition individually.
Number	step()
Densify.RangeType	type()
TimeUnit	unit()
Densify.Range	unit(TimeUnit unit)	The unit to apply to the step field when incrementing date values in field.
Object	upperBound()

Methods inherited from class java.lang.Object

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

Constructor Detail

Range

protected Range(Densify.RangeType type,
                Number step)

Method Detail

bounded

public static Densify.Range bounded(Object lowerBound,
                                    Object upperBound,
                                    Number step)

Creates a bounded range.

Parameters:

lowerBound - the lower bound

upperBound - the upper bound

step -

Returns:

the Range to pass to Densify.densify(String, Range)

full

public static Densify.Range full(Number step)

Creates a "full" range with documents spanning the full range of values of the field being densified.

Parameters:

step - the step size to use

Returns:

the Range to pass to Densify.densify(String, Range)

partition

public static Densify.Range partition(Number step)

Creates a partitioned range and adds documents to each partition, similar to if you had run a full range densification on each partition individually.

Parameters:

step - the step size

Returns:

the Range to pass to Densify.densify(String, Range)

lowerBound

@MorphiaInternal
public Object lowerBound()

Returns:

this

Developer note.

This is an internal item. Its function and presence are subject to change without warning. Its use is highly discouraged.

step

@MorphiaInternal
public Number step()

Returns:

this

Developer note.

This is an internal item. Its function and presence are subject to change without warning. Its use is highly discouraged.

type

@MorphiaInternal
public Densify.RangeType type()

Returns:

this

Developer note.

This is an internal item. Its function and presence are subject to change without warning. Its use is highly discouraged.

unit

@MorphiaInternal
public TimeUnit unit()

Returns:

this

Developer note.

This is an internal item. Its function and presence are subject to change without warning. Its use is highly discouraged.

unit

public Densify.Range unit(TimeUnit unit)

The unit to apply to the step field when incrementing date values in field.

Parameters:

unit - the unit to use

Returns:

the Range itself

upperBound

@MorphiaInternal
public Object upperBound()

Returns:

this

Developer note.

This is an internal item. Its function and presence are subject to change without warning. Its use is highly discouraged.