Class QueryMapper

java.lang.Object
org.springframework.data.mongodb.core.convert.QueryMapper
Direct Known Subclasses:
UpdateMapper
public class QueryMapper extends Object
A helper class to encapsulate any modifications of a Query object before it gets submitted to the database.
Author:
Jon Brisbin, Oliver Gierke, Patryk Wasik, Thomas Darimont, Christoph Strobl, Mark Paluch, David Julia, Divya Srivastava, Gyungrai Wang, Ross Lawley

  • Field Details

    • LOGGER

      protected static final org.apache.commons.logging.Log LOGGER

  • Constructor Details

  • Method Details

    • getMappedObject

      public org.bson.Document getMappedObject(org.bson.conversions.Bson query, Optional<? extends MongoPersistentEntity<?>> entity)

    • getMappedObject

      public org.bson.Document getMappedObject(org.bson.conversions.Bson query, @Nullable MongoPersistentEntity<?> entity)
      Replaces the property keys used in the given Document with the appropriate keys by using the PersistentEntity metadata.
      Parameters:
      query - must not be null.
      entity - can be null.
      Returns:

    • getMappedSort

      public org.bson.Document getMappedSort(org.bson.Document sortObject, @Nullable MongoPersistentEntity<?> entity)
      Maps fields used for sorting to the MongoPersistentEntitys properties.
      Also converts properties to their $meta representation if present.
      Parameters:
      sortObject -
      entity -
      Returns:
      Since:
      1.6

    • getMappedFields

      public org.bson.Document getMappedFields(org.bson.Document fieldsObject, @Nullable MongoPersistentEntity<?> entity)
      Maps fields to retrieve to the MongoPersistentEntitys properties.
      Also converts and potentially adds missing property $meta representation.
      Parameters:
      fieldsObject - must not be null.
      entity - can be null.
      Returns:
      Since:
      1.6

    • addMetaAttributes

      public org.bson.Document addMetaAttributes(org.bson.Document source, @Nullable MongoPersistentEntity<?> entity)
      Adds missing $meta representation if required.
      Parameters:
      source - must not be null.
      entity - can be null.
      Returns:
      never null.
      Since:
      3.4

    • getMappedObjectForField

      protected Map.Entry<String, @Nullable Object> getMappedObjectForField(QueryMapper.Field field, @Nullable Object rawValue)
      Extracts the mapped object value for given field out of rawValue taking nested QueryMapper.Keywords into account
      Parameters:
      field -
      rawValue -
      Returns:

    • createPropertyField

      protected QueryMapper.Field createPropertyField(@Nullable MongoPersistentEntity<?> entity, String key, MappingContext<? extends MongoPersistentEntity<?>, MongoPersistentProperty> mappingContext)
      Parameters:
      entity -
      key -
      mappingContext -
      Returns:

    • getMappedKeyword

      protected org.bson.Document getMappedKeyword(org.springframework.data.mongodb.core.convert.QueryMapper.Keyword keyword, @Nullable MongoPersistentEntity<?> entity)
      Returns the given Document representing a keyword by mapping the keyword's value.
      Parameters:
      keyword - the Document representing a keyword (e.g. $ne : … )
      entity -
      Returns:

    • getMappedKeyword

      protected org.bson.Document getMappedKeyword(QueryMapper.Field property, org.springframework.data.mongodb.core.convert.QueryMapper.Keyword keyword)
      Returns the mapped keyword considered defining a criteria for the given property.
      Parameters:
      property -
      keyword -
      Returns:

    • getMappedValue

      protected @Nullable Object getMappedValue(QueryMapper.Field documentField, @Nullable Object sourceValue)
      Returns the mapped value for the given source object assuming it's a value for the given MongoPersistentProperty.
      Parameters:
      documentField - the key the value will be bound to eventually
      sourceValue - the source object to be mapped
      Returns:

    • isAssociationConversionNecessary

      protected boolean isAssociationConversionNecessary(QueryMapper.Field documentField, @Nullable Object value)
      Returns whether the given QueryMapper.Field represents an association reference that together with the given value requires conversion to a DBRef object. We check whether the type of the given value is compatible with the type of the given document field in order to deal with potential query field exclusions, since MongoDB uses the int 0 as an indicator for an excluded field.
      Parameters:
      documentField - must not be null.
      value -
      Returns:

    • convertSimpleOrDocument

      protected @Nullable Object convertSimpleOrDocument(Object source, @Nullable MongoPersistentEntity<?> entity)
      Retriggers mapping if the given source is a Document or simply invokes the
      Parameters:
      source -
      entity -
      Returns:

    • delegateConvertToMongoType

      protected @Nullable Object delegateConvertToMongoType(Object source, @Nullable MongoPersistentEntity<?> entity)
      Converts the given source Object to a mongo type with the type information of the original source type omitted. Subclasses may overwrite this method to retain the type information of the source type on the resulting mongo type.
      Parameters:
      source -
      entity -
      Returns:
      the converted mongo type or null if source is null

    • convertAssociation

      protected @Nullable Object convertAssociation(Object source, QueryMapper.Field field)

    • convertAssociation

      protected @Nullable Object convertAssociation(@Nullable Object source, @Nullable MongoPersistentProperty property)
      Converts the given source assuming it's actually an association to another object.
      Parameters:
      source -
      property -
      Returns:

    • convertValueWithConversionContext

      protected @Nullable Object convertValueWithConversionContext(QueryMapper.Field documentField, @Nullable Object sourceValue, @Nullable Object value, PropertyValueConverter<Object, Object, ValueConversionContext<MongoPersistentProperty>> valueConverter, MongoConversionContext conversionContext)

    • isDocument

      protected final boolean isDocument(@Nullable Object value)
      Checks whether the given value is a Document.
      Parameters:
      value - can be null.
      Returns:

    • isDBObject

      protected final boolean isDBObject(@Nullable Object value)
      Checks whether the given value is a DBObject.
      Parameters:
      value - can be null.
      Returns:

    • createMapEntry

      protected final Map.Entry<String,Object> createMapEntry(QueryMapper.Field field, @Nullable Object value)
      Creates a new Map.Entry for the given QueryMapper.Field with the given value.
      Parameters:
      field - must not be null.
      value - can be null.
      Returns:

    • convertId

      public @Nullable Object convertId(@Nullable Object id)
      Converts the given raw id value into either ObjectId or String.
      Parameters:
      id -
      Returns:
      Since:
      2.2

    • convertId

      public @Nullable Object convertId(@Nullable Object id, Class<?> targetType)
      Converts the given raw id value into either ObjectId or targetType.
      Parameters:
      id - can be null.
      targetType -
      Returns:
      the converted id or null if the source was already null.
      Since:
      2.2

    • isNestedKeyword

      @Contract("null -> false") protected boolean isNestedKeyword(@Nullable Object candidate)
      Returns whether the given Object is a keyword, i.e. if it's a Document with a keyword key.
      Parameters:
      candidate -
      Returns:

    • isTypeKey

      protected boolean isTypeKey(String key)
      Returns whether the given String is the type key.
      Parameters:
      key -
      Returns:
      Since:
      2.2
      See Also:

    • isKeyword

      protected boolean isKeyword(@Nullable String candidate)
      Returns whether the given String is a MongoDB keyword. The default implementation will check against the set of registered keywords.
      Parameters:
      candidate -
      Returns:

    • getMappingContext

      public MappingContext<? extends MongoPersistentEntity<?>, MongoPersistentProperty> getMappingContext()

    • getConverter

      public MongoConverter getConverter()