Module spring.data.mongodb

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

Class PrefixingDelegatingAggregationOperationContext

java.lang.Object

org.springframework.data.mongodb.core.aggregation.PrefixingDelegatingAggregationOperationContext

All Implemented Interfaces:

CodecRegistryProvider, AggregationOperationContext

public class PrefixingDelegatingAggregationOperationContext
extends Object
implements AggregationOperationContext

AggregationOperationContext implementation prefixing non-command keys on root level with the given prefix. Useful when mapping fields to domain specific types while having to prefix keys for query purpose.
Fields to be excluded from prefixing my be added to a denylist.

Since:

2.1

Author:

Christoph Strobl, Mark Paluch

Constructor Summary

Constructors

Constructor	Description
PrefixingDelegatingAggregationOperationContext(AggregationOperationContext delegate, String prefix)
PrefixingDelegatingAggregationOperationContext(AggregationOperationContext delegate, String prefix, Collection<String> denylist)

Method Summary

Modifier and Type	Method	Description
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.

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.core.aggregation.AggregationOperationContext

continueOnMissingFieldReference, expose, inheritAndExpose

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

getCodecFor, hasCodecFor

Constructor Details

PrefixingDelegatingAggregationOperationContext

public PrefixingDelegatingAggregationOperationContext(AggregationOperationContext delegate,
 String prefix)

PrefixingDelegatingAggregationOperationContext

public PrefixingDelegatingAggregationOperationContext(AggregationOperationContext delegate,
 String prefix,
 Collection<String> denylist)

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)

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.