-
Notifications
You must be signed in to change notification settings - Fork 24.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Allow using distance measure in the geo context precision #29273
Merged
imotov
merged 5 commits into
elastic:master
from
imotov:issue-24807-fix-precision-parsing-in-suggestions
Apr 4, 2018
Merged
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
c594fa5
Allow using distance measure in the geo context precision
imotov 13c3b16
Address @cbuescher's review comments
imotov 271768f
Add javadoc
imotov 1a4e51b
Address @jpountz's review comments
imotov cbef977
Merge remote-tracking branch 'elastic/master' into issue-24807-fix-pr…
imotov File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -24,10 +24,10 @@ | |
import org.apache.lucene.spatial.prefix.tree.QuadPrefixTree; | ||
import org.apache.lucene.util.SloppyMath; | ||
import org.elasticsearch.ElasticsearchParseException; | ||
import org.elasticsearch.common.Strings; | ||
import org.elasticsearch.common.unit.DistanceUnit; | ||
import org.elasticsearch.common.xcontent.XContentParser; | ||
import org.elasticsearch.common.xcontent.XContentParser.Token; | ||
import org.elasticsearch.common.xcontent.support.XContentMapValues; | ||
import org.elasticsearch.index.fielddata.FieldData; | ||
import org.elasticsearch.index.fielddata.GeoPointValues; | ||
import org.elasticsearch.index.fielddata.MultiGeoPointValues; | ||
|
@@ -459,6 +459,51 @@ public static GeoPoint parseGeoPoint(XContentParser parser, GeoPoint point, fina | |
} | ||
} | ||
|
||
/** | ||
* Parse a precision that can be expressed as an integer or a distance measure like "1km", "10m". | ||
* | ||
* The precision is expressed as a number between 1 and 12 and indicates the length of geohash | ||
* used to represent geo points. | ||
* | ||
* @param parser {@link XContentParser} to parse the value from | ||
* @return int representing precision | ||
*/ | ||
public static int parsePrecision(XContentParser parser) throws IOException, ElasticsearchParseException { | ||
XContentParser.Token token = parser.currentToken(); | ||
if (token.equals(XContentParser.Token.VALUE_NUMBER)) { | ||
return XContentMapValues.nodeIntegerValue(parser.intValue()); | ||
} else { | ||
String precision = parser.text(); | ||
try { | ||
// we want to treat simple integer strings as precision levels, not distances | ||
return XContentMapValues.nodeIntegerValue(precision); | ||
} catch (NumberFormatException e) { | ||
// try to parse as a distance value | ||
final int parsedPrecision = GeoUtils.geoHashLevelsForPrecision(precision); | ||
try { | ||
return checkPrecisionRange(parsedPrecision); | ||
} catch (IllegalArgumentException e2) { | ||
// this happens when distance too small, so precision > 12. We'd like to see the original string | ||
throw new IllegalArgumentException("precision too high [" + precision + "]", e2); | ||
} | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. should we catch separately the call to checkPrecisionRange and geoHashLevelsForPrecision? |
||
} | ||
} | ||
} | ||
|
||
/** | ||
* Checks that the precision is within range supported by elasticsearch - between 1 and 12 | ||
* | ||
* Returns the precision value if it is in the range and throws an IllegalArgumentException if it | ||
* is outside the range. | ||
*/ | ||
public static int checkPrecisionRange(int precision) { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can you add a short javadoc? |
||
if ((precision < 1) || (precision > 12)) { | ||
throw new IllegalArgumentException("Invalid geohash aggregation precision of " + precision | ||
+ ". Must be between 1 and 12."); | ||
} | ||
return precision; | ||
} | ||
|
||
/** Returns the maximum distance/radius (in meters) from the point 'center' before overlapping */ | ||
public static double maxRadialDistanceMeters(final double centerLat, final double centerLon) { | ||
if (Math.abs(centerLat) == MAX_LAT) { | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
71 changes: 71 additions & 0 deletions
71
server/src/test/java/org/elasticsearch/common/geo/GeoUtilTests.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
/* | ||
* Licensed to Elasticsearch under one or more contributor | ||
* license agreements. See the NOTICE file distributed with | ||
* this work for additional information regarding copyright | ||
* ownership. Elasticsearch licenses this file to you under | ||
* the Apache License, Version 2.0 (the "License"); you may | ||
* not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, | ||
* software distributed under the License is distributed on an | ||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
* KIND, either express or implied. See the License for the | ||
* specific language governing permissions and limitations | ||
* under the License. | ||
*/ | ||
package org.elasticsearch.common.geo; | ||
|
||
import org.elasticsearch.common.CheckedConsumer; | ||
import org.elasticsearch.common.bytes.BytesReference; | ||
import org.elasticsearch.common.xcontent.XContentBuilder; | ||
import org.elasticsearch.common.xcontent.XContentParser; | ||
import org.elasticsearch.common.xcontent.json.JsonXContent; | ||
import org.elasticsearch.test.ESTestCase; | ||
|
||
import java.io.IOException; | ||
|
||
import static org.elasticsearch.common.xcontent.XContentFactory.jsonBuilder; | ||
|
||
public class GeoUtilTests extends ESTestCase { | ||
|
||
public void testPrecisionParser() throws IOException { | ||
assertEquals(10, parsePrecision(builder -> builder.field("test", 10))); | ||
assertEquals(10, parsePrecision(builder -> builder.field("test", 10.2))); | ||
assertEquals(6, parsePrecision(builder -> builder.field("test", "6"))); | ||
assertEquals(7, parsePrecision(builder -> builder.field("test", "1km"))); | ||
assertEquals(7, parsePrecision(builder -> builder.field("test", "1.1km"))); | ||
} | ||
|
||
public void testIncorrectPrecisionParser() { | ||
expectThrows(NumberFormatException.class, () -> parsePrecision(builder -> builder.field("test", "10.1.1.1"))); | ||
expectThrows(NumberFormatException.class, () -> parsePrecision(builder -> builder.field("test", "364.4smoots"))); | ||
assertEquals( | ||
"precision too high [0.01mm]", | ||
expectThrows(IllegalArgumentException.class, () -> parsePrecision(builder -> builder.field("test", "0.01mm"))).getMessage() | ||
); | ||
} | ||
|
||
/** | ||
* Invokes GeoUtils.parsePrecision parser on the value generated by tokenGenerator | ||
* <p> | ||
* The supplied tokenGenerator should generate a single field that contains the precision in | ||
* one of the supported formats or malformed precision value if error handling is tested. The | ||
* method return the parsed value or throws an exception, if precision value is malformed. | ||
*/ | ||
private int parsePrecision(CheckedConsumer<XContentBuilder, IOException> tokenGenerator) throws IOException { | ||
XContentBuilder builder = jsonBuilder().startObject(); | ||
tokenGenerator.accept(builder); | ||
builder.endObject(); | ||
XContentParser parser = createParser(JsonXContent.jsonXContent, BytesReference.bytes(builder)); | ||
assertEquals(XContentParser.Token.START_OBJECT, parser.nextToken()); // { | ||
assertEquals(XContentParser.Token.FIELD_NAME, parser.nextToken()); // field name | ||
assertTrue(parser.nextToken().isValue()); // field value | ||
int precision = GeoUtils.parsePrecision(parser); | ||
assertEquals(XContentParser.Token.END_OBJECT, parser.nextToken()); // } | ||
assertNull(parser.nextToken()); // no more tokens | ||
return precision; | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe mention that this "precision" is the geohash length?