Class Unwind
- java.lang.Object
-
- dev.morphia.aggregation.experimental.stages.Stage
-
- dev.morphia.aggregation.experimental.stages.Unwind
-
public class Unwind extends Stage
Deconstructs an array field from the input documents to output a document for each element. Each output document is the input document with the value of the array field replaced by the element.
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
Unwind()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getIncludeArrayIndex()
Expression
getPath()
Boolean
getPreserveNullAndEmptyArrays()
Unwind
includeArrayIndex(String name)
Optional.static Unwind
on(String name)
Creates a stage with the named array fieldboolean
optionsPresent()
Unwind
preserveNullAndEmptyArrays(Boolean preserveNullAndEmptyArrays)
Optional.-
Methods inherited from class dev.morphia.aggregation.experimental.stages.Stage
getStageName
-
-
-
-
Method Detail
-
on
public static Unwind on(String name)
Creates a stage with the named array field- Parameters:
name
- the array field- Returns:
- this
-
getIncludeArrayIndex
public String getIncludeArrayIndex()
- Returns:
- the value
Developer note.This is an internal item. Its function and presence are subject to change without warning. Its use is highly discouraged.
-
getPath
public Expression getPath()
- Returns:
- the value
Developer note.This is an internal item. Its function and presence are subject to change without warning. Its use is highly discouraged.
-
getPreserveNullAndEmptyArrays
public Boolean getPreserveNullAndEmptyArrays()
- Returns:
- the value
Developer note.This is an internal item. Its function and presence are subject to change without warning. Its use is highly discouraged.
-
includeArrayIndex
public Unwind includeArrayIndex(String name)
Optional. The name of a new field to hold the array index of the element. The name cannot start with a dollar sign $.- Parameters:
name
- the new name- Returns:
- this
-
optionsPresent
public boolean optionsPresent()
- Returns:
- the value
Developer note.This is an internal item. Its function and presence are subject to change without warning. Its use is highly discouraged.
-
preserveNullAndEmptyArrays
public Unwind preserveNullAndEmptyArrays(Boolean preserveNullAndEmptyArrays)
Optional.- If true, if the path is null, missing, or an empty array, $unwind outputs the document.
- If false, if path is null, missing, or an empty array, $unwind does not output a document.
- Parameters:
preserveNullAndEmptyArrays
- true to preserve- Returns:
- this
-
-