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

Interface MongoParameterAccessor

All Superinterfaces:

Iterable<Object>, ParameterAccessor

All Known Implementing Classes:

ConvertingParameterAccessor, MongoParametersParameterAccessor

public interface MongoParameterAccessor
extends 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
@Nullable Collation	getCollation()	Returns the Collation to be used for the query.
@Nullable Range<Distance>	getDistanceRange()	Returns a Distance to be applied to Mongo geo queries.
@Nullable TextCriteria	getFullText()	Returns the TextCriteria to be used for full text query.
@Nullable Point	getGeoNearLocation()	Returns the Point to use for a geo-near query.
@Nullable UpdateDefinition	getUpdate()	Returns the Update to be used for an update execution.
Object @Nullable []	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, getLimit, getPageable, getScore, getScoreRange, getScrollPosition, getSort, getVector, hasBindableNullValue, iterator

Method Details

getDistanceRange

@Nullable Range<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 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 @Nullable [] 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