Package org.springframework.data.mongodb.repository.query

Interface MongoParameterAccessor

All Superinterfaces:
Iterable<Object>, org.springframework.data.repository.query.ParameterAccessor
All Known Implementing Classes:
ConvertingParameterAccessor, MongoParametersParameterAccessor
public interface MongoParameterAccessor extends org.springframework.data.repository.query.ParameterAccessor
Mongo-specific ParameterAccessor exposing a maximum distance parameter.
Author:
Oliver Gierke, Christoph Strobl, Thomas Darimont, Mark Paluch

  • Method Summary

    Modifier and Type
    Method
    Description
    Collation
    getCollation()
    Returns the Collation to be used for the query.
    org.springframework.data.domain.Range<org.springframework.data.geo.Distance>
    getDistanceRange()
    Returns a Distance to be applied to Mongo geo queries.
    TextCriteria
    getFullText()
    Returns the TextCriteria to be used for full text query.
    org.springframework.data.geo.Point
    getGeoNearLocation()
    Returns the Point to use for a geo-near query.
    UpdateDefinition
    getUpdate()
    Returns the Update to be used for an update execution.
    Object[]
    getValues()
    Returns the raw parameter values of the underlying query method.

    Methods inherited from interface java.lang.Iterable

    forEach, spliterator

    Methods inherited from interface org.springframework.data.repository.query.ParameterAccessor

    findDynamicProjection, getBindableValue, getPageable, getScrollPosition, getSort, hasBindableNullValue, iterator

  • Method Details

    • getDistanceRange

      org.springframework.data.domain.Range<org.springframework.data.geo.Distance> getDistanceRange()
      Returns a Distance to be applied to Mongo geo queries.
      Returns:
      the maximum distance to apply to the geo query or null if there's no Distance parameter at all or the given value for it was null.

    • getGeoNearLocation

      @Nullable org.springframework.data.geo.Point getGeoNearLocation()
      Returns the Point to use for a geo-near query.
      Returns:

    • getFullText

      @Nullable TextCriteria getFullText()
      Returns the TextCriteria to be used for full text query.
      Returns:
      null if not set.
      Since:
      1.6

    • getCollation

      @Nullable Collation getCollation()
      Returns the Collation to be used for the query.
      Returns:
      null if not set.
      Since:
      2.2

    • getValues

      Object[] getValues()
      Returns the raw parameter values of the underlying query method.
      Returns:
      Since:
      1.8

    • getUpdate

      @Nullable UpdateDefinition getUpdate()
      Returns the Update to be used for an update execution.
      Returns:
      null if not present.
      Since:
      3.4