Package dev.morphia.aggregation.stages

Class Fill

java.lang.Object

dev.morphia.aggregation.stages.Stage

dev.morphia.aggregation.stages.Fill

public class Fill
extends Stage

Populates null and missing field values within documents.

You can use $fill to populate missing data points:

• In a sequence based on surrounding values.
• With a fixed value.

Since:

2.3

Since server release

5.3

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Fill.Method	Possible methods for defining fill strategies.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Fill()

Method Summary

Modifier and Type	Method	Description
Fill	field(String name, dev.morphia.aggregation.expressions.impls.ValueExpression value)	Specifies an object indicating how to fill missing values in the target field.
Fill	field(String name, Fill.Method method)	Specifies an object indicating how to fill missing values in the target field.
Map<String,Object>	fields()
static Fill	fill()	Creates a new $fill stage
dev.morphia.aggregation.expressions.impls.Expression	partitionBy()
Fill	partitionBy(dev.morphia.aggregation.expressions.impls.Expression partitionBy)	Specifies an array of fields as the compound key to group the documents.
List<String>	partitionByFields()
Fill	partitionByFields(String... fields)	Specifies an array of fields as the compound key to group the documents.
Sort[]	sortBy()
Fill	sortBy(Sort... sorts)	Specifies the field or fields to sort the documents within each partition.

Methods inherited from class dev.morphia.aggregation.stages.Stage

aggregation, stageName

Methods inherited from class java.lang.Object

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

Constructor Detail

Fill

protected Fill()

Method Detail

fill

public static Fill fill()

Creates a new $fill stage

Returns:

the new stage

field

public Fill field(String name,
                  dev.morphia.aggregation.expressions.impls.ValueExpression value)

Specifies an object indicating how to fill missing values in the target field.

Parameters:

name - the field name

value - the value to fill with

Returns:

this

field

public Fill field(String name,
                  Fill.Method method)

Specifies an object indicating how to fill missing values in the target field.

Parameters:

name - the field name

method - the method to use when filling in missing values

Returns:

this

fields

@MorphiaInternal
public Map<String,Object> fields()

Returns:

this

Developer note.

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

partitionBy

public Fill partitionBy(dev.morphia.aggregation.expressions.impls.Expression partitionBy)

Specifies an array of fields as the compound key to group the documents.

Parameters:

partitionBy - the partition expression

Returns:

this

partitionBy

@Nullable
@MorphiaInternal
public dev.morphia.aggregation.expressions.impls.Expression partitionBy()

Returns:

this

Developer note.

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

partitionByFields

public Fill partitionByFields(String... fields)

Specifies an array of fields as the compound key to group the documents.

Parameters:

fields - the fields

Returns:

this

partitionByFields

@Nullable
@MorphiaInternal
public List<String> partitionByFields()

Returns:

this

Developer note.

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

sortBy

public Fill sortBy(Sort... sorts)

Specifies the field or fields to sort the documents within each partition.

Parameters:

sorts - the sorting values to apply

Returns:

this

sortBy

@Nullable
@MorphiaInternal
public Sort[] sortBy()

Returns:

this

Developer note.

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