Class MongoParametersParameterAccessor

java.lang.Object

org.springframework.data.repository.query.ParametersParameterAccessor

org.springframework.data.mongodb.repository.query.MongoParametersParameterAccessor

All Implemented Interfaces:

Iterable<Object>, MongoParameterAccessor, ParameterAccessor

public class MongoParametersParameterAccessor
extends ParametersParameterAccessor
implements MongoParameterAccessor

Mongo-specific ParametersParameterAccessor to allow access to the Distance parameter.

Author:

Oliver Gierke, Christoph Strobl, Thomas Darimont, Mark Paluch

Constructor Summary

Constructors

Constructor	Description
MongoParametersParameterAccessor(MongoParameters parameters, Object[] values)	Creates a new MongoParametersParameterAccessor.
MongoParametersParameterAccessor(MongoQueryMethod method, Object[] values)	Creates a new MongoParametersParameterAccessor.

Method Summary

Modifier and Type	Method	Description
@Nullable Collation	getCollation()	Returns the Collation to be used for the query.
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.
Range<Score>	getScoreRange()
@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.
protected TextCriteria	potentiallyConvertFullText(@Nullable Object fullText)

Methods inherited from class ParametersParameterAccessor

findDynamicProjection, getBindableValue, getLimit, getPageable, getParameters, getScore, getScrollPosition, getSort, getValue, getVector, hasBindableNullValue, iterator

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Iterable

forEach, spliterator

Methods inherited from interface ParameterAccessor

findDynamicProjection, getBindableValue, getLimit, getPageable, getScore, getScrollPosition, getSort, getVector, hasBindableNullValue, iterator

Constructor Details

MongoParametersParameterAccessor

public MongoParametersParameterAccessor(MongoQueryMethod method,
 Object[] values)

Creates a new MongoParametersParameterAccessor.

Parameters:

method - must not be null.

values - must not be null.

MongoParametersParameterAccessor

public MongoParametersParameterAccessor(MongoParameters parameters,
 Object[] values)

Creates a new MongoParametersParameterAccessor.

Parameters:

parameters - must not be null.

values - must not be null.

Since:

5.0

Method Details

getScoreRange

public Range<Score> getScoreRange()

Specified by:

getScoreRange in interface ParameterAccessor

Overrides:

getScoreRange in class ParametersParameterAccessor

getDistanceRange

public Range<Distance> getDistanceRange()

Description copied from interface: MongoParameterAccessor

Returns a Distance to be applied to Mongo geo queries.

Specified by:

getDistanceRange in interface MongoParameterAccessor

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

public @Nullable Point getGeoNearLocation()

Description copied from interface: MongoParameterAccessor

Returns the Point to use for a geo-near query.

Specified by:

getGeoNearLocation in interface MongoParameterAccessor

Returns:

getFullText

public @Nullable TextCriteria getFullText()

Description copied from interface: MongoParameterAccessor

Returns the TextCriteria to be used for full text query.

Specified by:

getFullText in interface MongoParameterAccessor

Returns:

null if not set.

potentiallyConvertFullText

@Contract("null -> fail")
protected TextCriteria potentiallyConvertFullText(@Nullable Object fullText)

getCollation

public @Nullable Collation getCollation()

Description copied from interface: MongoParameterAccessor

Returns the Collation to be used for the query.

Specified by:

getCollation in interface MongoParameterAccessor

Returns:

null if not set.

getValues

public Object @Nullable [] getValues()

Description copied from interface: MongoParameterAccessor

Returns the raw parameter values of the underlying query method.

Specified by:

getValues in interface MongoParameterAccessor

Overrides:

getValues in class ParametersParameterAccessor

Returns:

getUpdate

public @Nullable UpdateDefinition getUpdate()

Description copied from interface: MongoParameterAccessor

Returns the Update to be used for an update execution.

Specified by:

getUpdate in interface MongoParameterAccessor

Returns:

null if not present.