Module spring.data.mongodb

Package org.springframework.data.mongodb.core.aggregation

Class TypeBasedAggregationOperationContext

java.lang.Object

org.springframework.data.mongodb.core.aggregation.TypeBasedAggregationOperationContext

All Implemented Interfaces:

CodecRegistryProvider, AggregationOperationContext

Direct Known Subclasses:

RelaxedTypeBasedAggregationOperationContext

public class TypeBasedAggregationOperationContext
extends Object
implements AggregationOperationContext

AggregationOperationContext aware of a particular type and a MappingContext to potentially translate property references into document field names.

Since:

1.3

Author:

Oliver Gierke, Christoph Strobl, Mark Paluch

Constructor Summary

Constructors

Constructor	Description
TypeBasedAggregationOperationContext(Class<?> type, MappingContext<? extends MongoPersistentEntity<?>,MongoPersistentProperty> mappingContext, QueryMapper mapper)	Creates a new TypeBasedAggregationOperationContext for the given type, MappingContext and QueryMapper.
TypeBasedAggregationOperationContext(Class<?> type, MappingContext<? extends MongoPersistentEntity<?>,MongoPersistentProperty> mappingContext, QueryMapper mapper, FieldLookupPolicy lookupPolicy)	Creates a new TypeBasedAggregationOperationContext for the given type, MappingContext and QueryMapper.

Method Summary

Modifier and Type	Method	Description
AggregationOperationContext	continueOnMissingFieldReference()	Deprecated, for removal: This API element is subject to removal in a future version.
AggregationOperationContext	continueOnMissingFieldReference(Class<?> type)	This toggle allows the context to use any given field name without checking for its existence.
AggregationOperationContext	expose(ExposedFields fields)	Create a nested AggregationOperationContext from this context that exposes fields.
org.bson.codecs.configuration.CodecRegistry	getCodecRegistry()	Get the underlying CodecRegistry used by the MongoDB Java driver.
Fields	getFields(Class<?> type)	Returns the Fields exposed by the type.
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(String name)	Returns the ExposedFields.FieldReference for the field with the given name.
ExposedFields.FieldReference	getReference(Field field)	Returns a ExposedFields.FieldReference for the given field.
protected ExposedFields.FieldReference	getReferenceFor(Field field)
Class<?>	getType()
AggregationOperationContext	inheritAndExpose(ExposedFields fields)	Create a nested AggregationOperationContext from this context that inherits exposed fields from this context and exposes fields.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.data.mongodb.CodecRegistryProvider

getCodecFor, hasCodecFor

Constructor Details

TypeBasedAggregationOperationContext

public TypeBasedAggregationOperationContext(Class<?> type,
 MappingContext<? extends MongoPersistentEntity<?>,MongoPersistentProperty> mappingContext,
 QueryMapper mapper)

Creates a new TypeBasedAggregationOperationContext for the given type, MappingContext and QueryMapper.

Parameters:

type - must not be null.

mappingContext - must not be null.

mapper - must not be null.

TypeBasedAggregationOperationContext

public TypeBasedAggregationOperationContext(Class<?> type,
 MappingContext<? extends MongoPersistentEntity<?>,MongoPersistentProperty> mappingContext,
 QueryMapper mapper,
 FieldLookupPolicy lookupPolicy)

Creates a new TypeBasedAggregationOperationContext for the given type, MappingContext and QueryMapper.

Parameters:

type - must not be null.

mappingContext - must not be null.

mapper - must not be null.

lookupPolicy - must not be null.

Since:

4.3.1

Method Details

getMappedObject

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

Description copied from interface: AggregationOperationContext

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

Specified by:

getMappedObject in interface AggregationOperationContext

Parameters:

document - will never be null.

Returns:

must not be null.

getMappedObject

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

Description copied from interface: AggregationOperationContext

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

Specified by:

getMappedObject in interface AggregationOperationContext

Parameters:

document - will never be null.

type - can be null.

Returns:

must not be null.

getReference

public ExposedFields.FieldReference getReference(Field field)

Description copied from interface: AggregationOperationContext

Returns a ExposedFields.FieldReference for the given field.

Specified by:

getReference in interface AggregationOperationContext

Parameters:

field - must not be null.

Returns:

the ExposedFields.FieldReference for the given Field.

getReference

public ExposedFields.FieldReference getReference(String name)

Description copied from interface: AggregationOperationContext

Returns the ExposedFields.FieldReference for the field with the given name.

Specified by:

getReference in interface AggregationOperationContext

Parameters:

name - must not be null or empty.

Returns:

the ExposedFields.FieldReference for the field with given name.

getFields

public Fields getFields(Class<?> type)

Description copied from interface: AggregationOperationContext

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.

Specified by:

getFields in interface AggregationOperationContext

Parameters:

type - must not be null.

Returns:

never null.

See Also:

• BeanUtils.getPropertyDescriptor(Class, String)

continueOnMissingFieldReference

@Deprecated(since="4.3.1",
            forRemoval=true)
public AggregationOperationContext continueOnMissingFieldReference()

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

Description copied from interface: AggregationOperationContext

This toggle allows the context to use any given field name without checking for its existence. Typically, the AggregationOperationContext fails when referencing unknown fields, those that are not present in one of the previous stages or the input source, throughout the pipeline.

Specified by:

continueOnMissingFieldReference in interface AggregationOperationContext

Returns:

a more relaxed AggregationOperationContext.

continueOnMissingFieldReference

public AggregationOperationContext continueOnMissingFieldReference(Class<?> type)

This toggle allows the context to use any given field name without checking for its existence. Typically, the AggregationOperationContext fails when referencing unknown fields, those that are not present in one of the previous stages or the input source, throughout the pipeline.

Parameters:

type - The domain type to map fields to.

Returns:

a more relaxed AggregationOperationContext.

Since:

3.1

See Also:

• RelaxedTypeBasedAggregationOperationContext

expose

public AggregationOperationContext expose(ExposedFields fields)

Description copied from interface: AggregationOperationContext

Create a nested AggregationOperationContext from this context that exposes fields.

Implementations of AggregationOperationContext retain their FieldLookupPolicy. If no policy is specified, then lookup defaults to FieldLookupPolicy.strict().

Specified by:

expose in interface AggregationOperationContext

Parameters:

fields - the fields to expose, must not be null.

Returns:

the new AggregationOperationContext exposing fields.

inheritAndExpose

public AggregationOperationContext inheritAndExpose(ExposedFields fields)

Description copied from interface: AggregationOperationContext

Create a nested AggregationOperationContext from this context that inherits exposed fields from this context and exposes fields.

Implementations of AggregationOperationContext retain their FieldLookupPolicy. If no policy is specified, then lookup defaults to FieldLookupPolicy.strict().

Specified by:

inheritAndExpose in interface AggregationOperationContext

Parameters:

fields - the fields to expose, must not be null.

Returns:

the new AggregationOperationContext exposing fields.

getReferenceFor

protected ExposedFields.FieldReference getReferenceFor(Field field)

getType

public Class<?> getType()

getCodecRegistry

public org.bson.codecs.configuration.CodecRegistry getCodecRegistry()

Description copied from interface: CodecRegistryProvider

Get the underlying CodecRegistry used by the MongoDB Java driver.

Specified by:

getCodecRegistry in interface AggregationOperationContext

Specified by:

getCodecRegistry in interface CodecRegistryProvider

Returns:

never null.