Module spring.data.mongodb
Package org.springframework.data.mongodb.core.convert

Class QueryMapper.Field

java.lang.Object
org.springframework.data.mongodb.core.convert.QueryMapper.Field
Direct Known Subclasses:
QueryMapper.MetadataBackedField
Enclosing class:
QueryMapper
protected static class QueryMapper.Field extends Object
Value object to represent a field and its meta-information.
Author:
Oliver Gierke

  • Field Details

    • POSITIONAL_OPERATOR

      protected static final Pattern POSITIONAL_OPERATOR

    • name

      protected final String name

  • Constructor Details

    • Field

      public Field(String name)
      Creates a new QueryMapper.Field without meta-information but the given name.
      Parameters:
      name - must not be null or empty.

  • Method Details

    • with

      public QueryMapper.Field with(String name)
      Returns a new QueryMapper.Field with the given name.
      Parameters:
      name - must not be null or empty.
      Returns:

    • isIdField

      public boolean isIdField()
      Returns whether the current field is the id field.
      Returns:

    • getProperty

      @Nullable public MongoPersistentProperty getProperty()
      Returns the underlying MongoPersistentProperty backing the field. For path traversals this will be the property that represents the value to handle. This means it'll be the leaf property for plain paths or the association property in case we refer to an association somewhere in the path.
      Returns:
      can be null.

    • getPropertyEntity

      @Nullable public MongoPersistentEntity<?> getPropertyEntity()
      Returns the MongoPersistentEntity that field is conatined in.
      Returns:
      can be null.

    • isAssociation

      public boolean isAssociation()
      Returns whether the field represents an association.
      Returns:

    • getMappedKey

      public String getMappedKey()
      Returns the key to be used in the mapped document eventually.
      Returns:

    • containsAssociation

      public boolean containsAssociation()
      Returns whether the field references an association in case it refers to a nested field.
      Returns:

    • getAssociation

      @Nullable public Association<MongoPersistentProperty> getAssociation()

    • isMap

      public boolean isMap()
      Returns whether the field references a Map.
      Returns:
      true if property information is available and references a Map.
      See Also:

    • getTypeHint

      public TypeInformation<?> getTypeHint()

    • getFieldType

      public Class<?> getFieldType()