Skip to content

Commit e8f4288

Browse files
odrotbohmodrotbohm
committed
DATAMONGO-1110 - Polishing.
Moved to newly introduced Range type in Spring Data Commons to more safely bind minimum and maximum distances. Changed internal APIs to always use a Range<Distance> which gets populated based on the method signature's characteristics: if only one Distance parameter is found it's interpreted as a range with upper bound only. Original pull request: #277.
1 parent db12240 commit e8f4288

12 files changed

+111
-112
lines changed

‎spring-data-mongodb/src/main/java/org/springframework/data/mongodb/repository/query/AbstractMongoQuery.java

+6-2
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020

2121
import org.springframework.data.domain.PageImpl;
2222
import org.springframework.data.domain.Pageable;
23+
import org.springframework.data.domain.Range;
2324
import org.springframework.data.domain.Slice;
2425
import org.springframework.data.domain.SliceImpl;
2526
import org.springframework.data.geo.Distance;
@@ -361,12 +362,15 @@ private GeoResults<Object> doExecuteQuery(Query query) {
361362
nearQuery.query(query);
362363
}
363364

364-
Distance maxDistance = accessor.getMaxDistance();
365+
Range<Distance> distances = accessor.getDistanceRange();
366+
Distance maxDistance = distances.getUpperBound();
367+
365368
if (maxDistance != null) {
366369
nearQuery.maxDistance(maxDistance).in(maxDistance.getMetric());
367370
}
368371

369-
Distance minDistance = accessor.getMinDistance();
372+
Distance minDistance = distances.getLowerBound();
373+
370374
if (minDistance != null) {
371375
nearQuery.minDistance(minDistance).in(minDistance.getMetric());
372376
}

‎spring-data-mongodb/src/main/java/org/springframework/data/mongodb/repository/query/ConvertingParameterAccessor.java

+5-12
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
import java.util.List;
2323

2424
import org.springframework.data.domain.Pageable;
25+
import org.springframework.data.domain.Range;
2526
import org.springframework.data.domain.Sort;
2627
import org.springframework.data.geo.Distance;
2728
import org.springframework.data.geo.Point;
@@ -96,21 +97,13 @@ public Object getBindableValue(int index) {
9697
return getConvertedValue(delegate.getBindableValue(index), null);
9798
}
9899

99-
/*
100-
* (non-Javadoc)
101-
* @see org.springframework.data.mongodb.repository.MongoParameterAccessor#getMaxDistance()
102-
*/
103-
public Distance getMaxDistance() {
104-
return delegate.getMaxDistance();
105-
}
106-
107-
/*
100+
/*
108101
* (non-Javadoc)
109-
* @see org.springframework.data.mongodb.repository.query.MongoParameterAccessor#getMinDistance()
102+
* @see org.springframework.data.mongodb.repository.query.MongoParameterAccessor#getDistanceRange()
110103
*/
111104
@Override
112-
public Distance getMinDistance() {
113-
return delegate.getMinDistance();
105+
public Range<Distance> getDistanceRange() {
106+
return delegate.getDistanceRange();
114107
}
115108

116109
/*

‎spring-data-mongodb/src/main/java/org/springframework/data/mongodb/repository/query/MongoParameterAccessor.java

+2-9
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
*/
1616
package org.springframework.data.mongodb.repository.query;
1717

18+
import org.springframework.data.domain.Range;
1819
import org.springframework.data.geo.Distance;
1920
import org.springframework.data.geo.Point;
2021
import org.springframework.data.mongodb.core.query.TextCriteria;
@@ -34,7 +35,7 @@ public interface MongoParameterAccessor extends ParameterAccessor {
3435
* @return the maximum distance to apply to the geo query or {@literal null} if there's no {@link Distance} parameter
3536
* at all or the given value for it was {@literal null}.
3637
*/
37-
Distance getMaxDistance();
38+
Range<Distance> getDistanceRange();
3839

3940
/**
4041
* Returns the {@link Point} to use for a geo-near query.
@@ -50,12 +51,4 @@ public interface MongoParameterAccessor extends ParameterAccessor {
5051
* @since 1.6
5152
*/
5253
TextCriteria getFullText();
53-
54-
/**
55-
* Returns a {@link Distance} to be applied to {@literal $minDistance} for MongoDB geo queries.
56-
*
57-
* @return
58-
* @since 1.7
59-
*/
60-
Distance getMinDistance();
6154
}

‎spring-data-mongodb/src/main/java/org/springframework/data/mongodb/repository/query/MongoParameters.java

+37-33
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,16 @@
2020
import java.util.List;
2121

2222
import org.springframework.core.MethodParameter;
23+
import org.springframework.data.domain.Range;
2324
import org.springframework.data.geo.Distance;
2425
import org.springframework.data.geo.Point;
2526
import org.springframework.data.mongodb.core.query.TextCriteria;
2627
import org.springframework.data.mongodb.repository.Near;
2728
import org.springframework.data.mongodb.repository.query.MongoParameters.MongoParameter;
2829
import org.springframework.data.repository.query.Parameter;
2930
import org.springframework.data.repository.query.Parameters;
31+
import org.springframework.data.util.ClassTypeInformation;
32+
import org.springframework.data.util.TypeInformation;
3033

3134
/**
3235
* Custom extension of {@link Parameters} discovering additional
@@ -36,8 +39,8 @@
3639
*/
3740
public class MongoParameters extends Parameters<MongoParameters, MongoParameter> {
3841

39-
private final Integer minDistanceIndex;
40-
private final Integer maxDistanceIndex;
42+
private final int rangeIndex;
43+
private final int maxDistanceIndex;
4144
private final Integer fullTextIndex;
4245

4346
private Integer nearIndex;
@@ -55,9 +58,11 @@ public MongoParameters(Method method, boolean isGeoNearMethod) {
5558

5659
this.fullTextIndex = parameterTypes.indexOf(TextCriteria.class);
5760

58-
int[] distances = distances(parameterTypes);
59-
this.minDistanceIndex = distances[0];
60-
this.maxDistanceIndex = distances[1];
61+
ClassTypeInformation<?> declaringClassInfo = ClassTypeInformation.from(method.getDeclaringClass());
62+
List<TypeInformation<?>> parameterTypeInfo = declaringClassInfo.getParameterTypes(method);
63+
64+
this.rangeIndex = getTypeIndex(parameterTypeInfo, Range.class, Distance.class);
65+
this.maxDistanceIndex = this.rangeIndex == -1 ? getTypeIndex(parameterTypeInfo, Distance.class, null) : -1;
6166

6267
if (this.nearIndex == null && isGeoNearMethod) {
6368
this.nearIndex = getNearIndex(parameterTypes);
@@ -66,15 +71,15 @@ public MongoParameters(Method method, boolean isGeoNearMethod) {
6671
}
6772
}
6873

69-
private MongoParameters(List<MongoParameter> parameters, Integer distanceIndex, Integer nearIndex,
70-
Integer fullTextIndex, Integer minDistanceIndex) {
74+
private MongoParameters(List<MongoParameter> parameters, int maxDistanceIndex, Integer nearIndex,
75+
Integer fullTextIndex, int rangeIndex) {
7176

7277
super(parameters);
7378

74-
this.maxDistanceIndex = distanceIndex;
7579
this.nearIndex = nearIndex;
7680
this.fullTextIndex = fullTextIndex;
77-
this.minDistanceIndex = minDistanceIndex;
81+
this.maxDistanceIndex = maxDistanceIndex;
82+
this.rangeIndex = rangeIndex;
7883
}
7984

8085
private final int getNearIndex(List<Class<?>> parameterTypes) {
@@ -117,15 +122,19 @@ protected MongoParameter createParameter(MethodParameter parameter) {
117122
return mongoParameter;
118123
}
119124

125+
public int getDistanceRangeIndex() {
126+
return -1;
127+
}
128+
120129
/**
121130
* Returns the index of a {@link Distance} parameter to be used for geo queries.
122131
*
123132
* @return
124-
* @deprecated since 1.7. Please use {@link #getMaxDistanceParameterIndex()} instead.
133+
* @deprecated since 1.7. Please use {@link #getMaxDistanceIndex()} instead.
125134
*/
126135
@Deprecated
127136
public int getDistanceIndex() {
128-
return getMaxDistanceParameterIndex();
137+
return getMaxDistanceIndex();
129138
}
130139

131140
/**
@@ -134,7 +143,7 @@ public int getDistanceIndex() {
134143
* @return
135144
* @since 1.7
136145
*/
137-
public int getMaxDistanceParameterIndex() {
146+
public int getMaxDistanceIndex() {
138147
return maxDistanceIndex;
139148
}
140149

@@ -169,16 +178,8 @@ public boolean hasFullTextParameter() {
169178
* @return
170179
* @since 1.7
171180
*/
172-
public boolean hasMinDistanceParameter() {
173-
return minDistanceIndex != null && minDistanceIndex.intValue() >= 0;
174-
}
175-
176-
/**
177-
* @return
178-
* @since 1.7
179-
*/
180-
public int getMinDistanceParameterIndex() {
181-
return minDistanceIndex != null ? minDistanceIndex.intValue() : -1;
181+
public int getRangeIndex() {
182+
return rangeIndex;
182183
}
183184

184185
/*
@@ -187,23 +188,26 @@ public int getMinDistanceParameterIndex() {
187188
*/
188189
@Override
189190
protected MongoParameters createFrom(List<MongoParameter> parameters) {
190-
return new MongoParameters(parameters, this.maxDistanceIndex, this.nearIndex, this.fullTextIndex,
191-
this.minDistanceIndex);
191+
return new MongoParameters(parameters, this.maxDistanceIndex, this.nearIndex, this.fullTextIndex, this.rangeIndex);
192192
}
193193

194-
private int[] distances(List<Class<?>> paramTypes) {
194+
private int getTypeIndex(List<TypeInformation<?>> parameterTypes, Class<?> type, Class<?> componentType) {
195195

196-
int maxDistance = paramTypes.lastIndexOf(Distance.class);
197-
if (maxDistance == -1) {
198-
return new int[] { -1, -1 };
199-
}
196+
for (int i = 0; i < parameterTypes.size(); i++) {
197+
198+
TypeInformation<?> candidate = parameterTypes.get(i);
200199

201-
int minDistance = paramTypes.indexOf(Distance.class);
202-
if (minDistance == maxDistance) {
203-
return new int[] { -1, maxDistance };
200+
if (candidate.getType().equals(type)) {
201+
202+
if (componentType == null) {
203+
return i;
204+
} else if (componentType.equals(candidate.getComponentType().getType())) {
205+
return i;
206+
}
207+
}
204208
}
205209

206-
return new int[] { minDistance, maxDistance };
210+
return -1;
207211
}
208212

209213
/**

‎spring-data-mongodb/src/main/java/org/springframework/data/mongodb/repository/query/MongoParametersParameterAccessor.java

+14-16
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
*/
1616
package org.springframework.data.mongodb.repository.query;
1717

18+
import org.springframework.data.domain.Range;
1819
import org.springframework.data.geo.Distance;
1920
import org.springframework.data.geo.Point;
2021
import org.springframework.data.mongodb.core.query.Term;
@@ -44,23 +45,20 @@ public MongoParametersParameterAccessor(MongoQueryMethod method, Object[] values
4445
this.method = method;
4546
}
4647

47-
/*
48-
* (non-Javadoc)
49-
* @see org.springframework.data.mongodb.repository.MongoParameterAccessor#getMaxDistance()
50-
*/
51-
public Distance getMaxDistance() {
52-
int index = method.getParameters().getDistanceIndex();
53-
return index == -1 ? null : (Distance) getValue(index);
54-
}
48+
public Range<Distance> getDistanceRange() {
5549

56-
/*
57-
* (non-Javadoc)
58-
* @see org.springframework.data.mongodb.repository.query.MongoParameterAccessor#getMinDistance()
59-
*/
60-
@Override
61-
public Distance getMinDistance() {
62-
int index = method.getParameters().getMinDistanceParameterIndex();
63-
return index == -1 ? null : (Distance) getValue(index);
50+
MongoParameters mongoParameters = method.getParameters();
51+
52+
int rangeIndex = mongoParameters.getRangeIndex();
53+
54+
if (rangeIndex != -1) {
55+
return getValue(rangeIndex);
56+
}
57+
58+
int maxDistanceIndex = mongoParameters.getMaxDistanceIndex();
59+
Distance maxDistance = maxDistanceIndex == -1 ? null : (Distance) getValue(maxDistanceIndex);
60+
61+
return new Range<Distance>(null, maxDistance);
6462
}
6563

6664
/*

‎spring-data-mongodb/src/main/java/org/springframework/data/mongodb/repository/query/MongoQueryCreator.java

+5-2
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323

2424
import org.slf4j.Logger;
2525
import org.slf4j.LoggerFactory;
26+
import org.springframework.data.domain.Range;
2627
import org.springframework.data.domain.Sort;
2728
import org.springframework.data.geo.Distance;
2829
import org.springframework.data.geo.Metrics;
@@ -207,8 +208,10 @@ private Criteria from(Part part, MongoPersistentProperty property, Criteria crit
207208
return criteria.is(false);
208209
case NEAR:
209210

210-
Distance distance = accessor.getMaxDistance();
211-
Distance minDistance = accessor.getMinDistance();
211+
Range<Distance> range = accessor.getDistanceRange();
212+
Distance distance = range.getUpperBound();
213+
Distance minDistance = range.getLowerBound();
214+
212215
Point point = accessor.getGeoNearLocation();
213216
point = point == null ? nextAs(parameters, Point.class) : point;
214217

‎spring-data-mongodb/src/test/java/org/springframework/data/mongodb/repository/AbstractPersonRepositoryIntegrationTests.java

+5-2
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
import static java.util.Arrays.*;
1919
import static org.hamcrest.Matchers.*;
2020
import static org.junit.Assert.*;
21+
import static org.springframework.data.geo.Metrics.*;
2122

2223
import java.util.ArrayList;
2324
import java.util.Arrays;
@@ -35,6 +36,7 @@
3536
import org.springframework.dao.DuplicateKeyException;
3637
import org.springframework.data.domain.Page;
3738
import org.springframework.data.domain.PageRequest;
39+
import org.springframework.data.domain.Range;
3840
import org.springframework.data.domain.Slice;
3941
import org.springframework.data.domain.Sort;
4042
import org.springframework.data.domain.Sort.Direction;
@@ -1176,8 +1178,9 @@ public void executesGeoNearQueryForResultsCorrectlyWhenGivenMinAndMaxDistance()
11761178
dave.setLocation(point);
11771179
repository.save(dave);
11781180

1179-
GeoResults<Person> results = repository.findPersonByLocationNear(new Point(-73.99, 40.73), new Distance(0.01,
1180-
Metrics.KILOMETERS), new Distance(2000, Metrics.KILOMETERS));
1181+
Range<Distance> range = Distance.between(new Distance(0.01, KILOMETERS), new Distance(2000, KILOMETERS));
1182+
1183+
GeoResults<Person> results = repository.findPersonByLocationNear(new Point(-73.99, 40.73), range);
11811184
assertThat(results.getContent().isEmpty(), is(false));
11821185
}
11831186
}

‎spring-data-mongodb/src/test/java/org/springframework/data/mongodb/repository/PersonRepository.java

+5-2
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222

2323
import org.springframework.data.domain.Page;
2424
import org.springframework.data.domain.Pageable;
25+
import org.springframework.data.domain.Range;
2526
import org.springframework.data.domain.Slice;
2627
import org.springframework.data.domain.Sort;
2728
import org.springframework.data.geo.Box;
@@ -169,8 +170,10 @@ public interface PersonRepository extends MongoRepository<Person, String>, Query
169170

170171
GeoResults<Person> findByLocationNear(Point point, Distance maxDistance);
171172

172-
/** @see DATAMONGO-1110 */
173-
GeoResults<Person> findPersonByLocationNear(Point point, Distance maxDistance, Distance minDistance);
173+
/**
174+
* @see DATAMONGO-1110
175+
*/
176+
GeoResults<Person> findPersonByLocationNear(Point point, Range<Distance> distance);
174177

175178
GeoPage<Person> findByLocationNear(Point point, Distance maxDistance, Pageable pageable);
176179

0 commit comments

Comments
 (0)