org.springframework.data.mongodb.core.aggregation

Interface AggregationOperationContext

All Known Implementing Classes:

PrefixingDelegatingAggregationOperationContext, TypeBasedAggregationOperationContext

public interface AggregationOperationContext

The context for an AggregationOperation.

Since:

1.3

Author:

Oliver Gierke, Christoph Strobl

Method Summary

Modifier and Type	Method and Description
default Fields	getFields(Class<?> type) Returns the Fields exposed by the type.
default org.bson.Document	getMappedObject(org.bson.Document document) Returns the mapped Document, potentially converting the source considering mapping metadata etc.
org.bson.Document	getMappedObject(org.bson.Document document, Class<?> type) Returns the mapped Document, potentially converting the source considering mapping metadata for the given type.
ExposedFields.FieldReference	getReference(Field field) Returns a ExposedFields.FieldReference for the given field or null if the context does not expose the given field.
ExposedFields.FieldReference	getReference(String name) Returns the ExposedFields.FieldReference for the field with the given name or null if the context does not expose a field with the given name.

Method Detail

getMappedObject

default org.bson.Document getMappedObject(org.bson.Document document)

Returns the mapped Document, potentially converting the source considering mapping metadata etc.

Parameters:

document - will never be null.

Returns:

must not be null.

getMappedObject

org.bson.Document getMappedObject(org.bson.Document document,
                                  @Nullable
                                  Class<?> type)

Returns the mapped Document, potentially converting the source considering mapping metadata for the given type.

Parameters:

document - will never be null.

type - can be null.

Returns:

must not be null.

Since:

2.2

getReference

ExposedFields.FieldReference getReference(Field field)

Returns a ExposedFields.FieldReference for the given field or null if the context does not expose the given field.

Parameters:

field - must not be null.

Returns:

getReference

ExposedFields.FieldReference getReference(String name)

Returns the ExposedFields.FieldReference for the field with the given name or null if the context does not expose a field with the given name.

Parameters:

name - must not be null or empty.

Returns:

getFields

default Fields getFields(Class<?> type)

Returns the Fields exposed by the type. May be a class or an interface. The default implementation uses property descriptors discover fields from a Class.

Parameters:

type - must not be null.

Returns:

never null.

Since:

2.2

See Also:

BeanUtils.getPropertyDescriptor(Class, String)