Class MongoParameters

java.lang.Object

org.springframework.data.repository.query.Parameters<MongoParameters, MongoParameters.MongoParameter>

org.springframework.data.mongodb.repository.query.MongoParameters

All Implemented Interfaces:

Iterable<MongoParameters.MongoParameter>, Supplier<Stream<MongoParameters.MongoParameter>>, Streamable<MongoParameters.MongoParameter>

public class MongoParameters
extends Parameters<MongoParameters, MongoParameters.MongoParameter>

Custom extension of Parameters discovering additional

Author:

Oliver Gierke, Christoph Strobl, Mark Paluch, Thomas Darimont

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MongoParameters.MongoParameter	Custom Parameter implementation adding parameters of type Distance to the special ones.

Field Summary

Fields inherited from class Parameters

TYPES

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MongoParameters()
	MongoParameters(ParametersSource parametersSource)	Creates a new MongoParameters instance from the given Method and MongoQueryMethod.
	MongoParameters(ParametersSource parametersSource, boolean isGeoNearMethod)	Creates a new MongoParameters instance from the given Method and MongoQueryMethod.

Method Summary

Modifier and Type	Method	Description
protected MongoParameters	createFrom(List<MongoParameters.MongoParameter> parameters)
int	getCollationParameterIndex()	Returns the index of the Collation parameter or -1 if not present.
int	getFullTextParameterIndex()	Returns the index of the parameter to be used as a text query param
int	getMaxDistanceIndex()	Returns the index of the Distance parameter to be used for max distance in geo queries.
int	getNearIndex()	Returns the index of the parameter to be used to start a geo-near query from.
int	getRangeIndex()
int	getUpdateIndex()	Returns the index of the UpdateDefinition parameter or -1 if not present.
boolean	hasFullTextParameter()

Methods inherited from class Parameters

getBindableParameter, getBindableParameters, getDynamicProjectionIndex, getLimitIndex, getNumberOfParameters, getPageableIndex, getParameter, getScoreIndex, getScoreRangeIndex, getScrollPositionIndex, getSortIndex, getVectorIndex, hasDynamicProjection, hasLimitParameter, hasPageableParameter, hasParameterAt, hasScoreParameter, hasScoreRangeParameter, hasScrollPositionParameter, hasSortParameter, hasSpecialParameter, hasVectorParameter, isBindable, iterator, potentiallySortsDynamically

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 Streamable

and, and, and, and, filter, flatMap, get, isEmpty, map, stream, toList, toSet

Constructor Details

MongoParameters

public MongoParameters(ParametersSource parametersSource)

Creates a new MongoParameters instance from the given Method and MongoQueryMethod.

Parameters:

parametersSource - must not be null.

Since:

4.5

MongoParameters

public MongoParameters(ParametersSource parametersSource,
 boolean isGeoNearMethod)

Creates a new MongoParameters instance from the given Method and MongoQueryMethod.

Parameters:

parametersSource - must not be null.

isGeoNearMethod - indicate if this is a geo-spatial query method

MongoParameters

protected MongoParameters()

Method Details

getMaxDistanceIndex

public int getMaxDistanceIndex()

Returns the index of the Distance parameter to be used for max distance in geo queries.

Returns:

Since:

1.7

getNearIndex

public int getNearIndex()

Returns the index of the parameter to be used to start a geo-near query from.

Returns:

getFullTextParameterIndex

public int getFullTextParameterIndex()

Returns the index of the parameter to be used as a text query param

Returns:

Since:

1.6

hasFullTextParameter

public boolean hasFullTextParameter()

Returns:

Since:

1.6

getRangeIndex

public int getRangeIndex()

Returns:

Since:

1.7

getCollationParameterIndex

public int getCollationParameterIndex()

Returns the index of the Collation parameter or -1 if not present.

Returns:

-1 if not set.

Since:

2.2

getUpdateIndex

public int getUpdateIndex()

Returns the index of the UpdateDefinition parameter or -1 if not present.

Returns:

-1 if not present.

Since:

3.4

createFrom

protected MongoParameters createFrom(List<MongoParameters.MongoParameter> parameters)

Specified by:

createFrom in class Parameters<MongoParameters, MongoParameters.MongoParameter>