Index: lucene/spatial/src/test/org/apache/lucene/spatial/PortedSolr3Test.java
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
--- lucene/spatial/src/test/org/apache/lucene/spatial/PortedSolr3Test.java (revision 1384629)
+++ lucene/spatial/src/test/org/apache/lucene/spatial/PortedSolr3Test.java (revision )
@@ -24,10 +24,6 @@
import com.spatial4j.core.io.ShapeReadWriter;
import com.spatial4j.core.shape.Point;
import com.spatial4j.core.shape.Shape;
-import org.apache.lucene.document.Document;
-import org.apache.lucene.document.Field;
-import org.apache.lucene.document.StoredField;
-import org.apache.lucene.document.StringField;
import org.apache.lucene.search.FilteredQuery;
import org.apache.lucene.search.MatchAllDocsQuery;
import org.apache.lucene.search.Query;
@@ -157,51 +153,7 @@
checkHitsBBox("43.517030,-96.789603", 110, 1, 17);
}
- /**
- * This test is similar to a Solr 3 spatial test.
- */
- @Test
- public void testDistanceOrder() throws IOException {
- adoc("100","1,2");
- adoc("101","4,-1");
- commit();
- double km1000inDeg = DistanceUtils.dist2Degrees(1000, DistanceUtils.EARTH_MEAN_RADIUS_KM);
-
- //query closer to #100
- checkHitsOrdered("Intersects(Circle(3,4 d="+km1000inDeg+"))", "101", "100");
- //query closer to #101
- checkHitsOrdered("Intersects(Circle(4,0 d="+km1000inDeg+"))", "100", "101");
- }
-
- private void checkHitsOrdered(String spatialQ, String... ids) {
- SpatialArgs args = this.argsParser.parse(spatialQ,ctx);
- Query query = strategy.makeQuery(args);
- SearchResults results = executeQuery(query, 100);
- String[] resultIds = new String[results.numFound];
- int i = 0;
- for (SearchResult result : results.results) {
- resultIds[i++] = result.document.get("id");
- }
- assertArrayEquals("order matters",ids, resultIds);
- }
-
//---- these are similar to Solr test methods
-
- private void adoc(String idStr, String shapeStr) throws IOException {
- Shape shape = new ShapeReadWriter(ctx).readShape(shapeStr);
- addDocument(newDoc(idStr,shape));
- }
-
- private Document newDoc(String id, Shape shape) {
- Document doc = new Document();
- doc.add(new StringField("id", id, Field.Store.YES));
- for (Field f : strategy.createIndexableFields(shape)) {
- doc.add(f);
- }
- if (storeShape)
- doc.add(new StoredField(strategy.getFieldName(), ctx.toString(shape)));
- return doc;
- }
private void checkHitsCircle(String ptStr, double distKM, int assertNumFound, int... assertIds) {
_checkHits(false, ptStr, distKM, assertNumFound, assertIds);
Index: lucene/spatial/src/java/org/apache/lucene/spatial/vector/DistanceValueSource.java
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
--- lucene/spatial/src/java/org/apache/lucene/spatial/vector/DistanceValueSource.java (revision 1384629)
+++ lucene/spatial/src/java/org/apache/lucene/spatial/vector/DistanceValueSource.java (revision )
@@ -30,7 +30,7 @@
import java.util.Map;
/**
- * An implementation of the Lucene ValueSource model to support spatial relevance ranking.
+ * An implementation of the Lucene ValueSource model that returns the distance.
*
* @lucene.internal
*/
@@ -38,15 +38,13 @@
private TwoDoublesStrategy strategy;
private final Point from;
- private final DistanceCalculator calculator;
/**
* Constructor.
*/
- public DistanceValueSource(TwoDoublesStrategy strategy, Point from, DistanceCalculator calc) {
+ public DistanceValueSource(TwoDoublesStrategy strategy, Point from) {
this.strategy = strategy;
this.from = from;
- this.calculator = calc;
}
/**
@@ -54,10 +52,9 @@
*/
@Override
public String description() {
- return "DistanceValueSource("+calculator+")";
+ return "DistanceValueSource("+strategy+", "+from+")";
}
-
/**
* Returns the FunctionValues used by the function query.
*/
@@ -71,6 +68,11 @@
final Bits validY = FieldCache.DEFAULT.getDocsWithField(reader, strategy.getFieldNameY());
return new FunctionValues() {
+
+ private final Point from = DistanceValueSource.this.from;
+ private final DistanceCalculator calculator = strategy.getSpatialContext().getDistCalc();
+ private final double nullValue = (strategy.getSpatialContext().isGeo() ? 180 : Double.MAX_VALUE);
+
@Override
public float floatVal(int doc) {
return (float) doubleVal(doc);
@@ -79,10 +81,11 @@
@Override
public double doubleVal(int doc) {
// make sure it has minX and area
- if (validX.get(doc) && validY.get(doc)) {
+ if (validX.get(doc)) {
+ assert validY.get(doc);
return calculator.distance(from, ptX[doc], ptY[doc]);
}
- return 0;
+ return nullValue;
}
@Override
@@ -92,11 +95,6 @@
};
}
- /**
- * Determines if this ValueSource is equal to another.
- * @param o the ValueSource to compare
- * @return true if the two objects are based upon the same query envelope
- */
@Override
public boolean equals(Object o) {
if (this == o) return true;
@@ -104,18 +102,14 @@
DistanceValueSource that = (DistanceValueSource) o;
- if (calculator != null ? !calculator.equals(that.calculator) : that.calculator != null) return false;
- if (strategy != null ? !strategy.equals(that.strategy) : that.strategy != null) return false;
- if (from != null ? !from.equals(that.from) : that.from != null) return false;
+ if (!from.equals(that.from)) return false;
+ if (!strategy.equals(that.strategy)) return false;
return true;
}
@Override
public int hashCode() {
- int result = strategy != null ? strategy.hashCode() : 0;
- result = 31 * result + (calculator != null ? calculator.hashCode() : 0);
- result = 31 * result + (from != null ? from.hashCode() : 0);
- return result;
+ return from.hashCode();
}
}
Index: lucene/spatial/src/java/org/apache/lucene/spatial/prefix/PrefixTreeStrategy.java
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
--- lucene/spatial/src/java/org/apache/lucene/spatial/prefix/PrefixTreeStrategy.java (revision 1384629)
+++ lucene/spatial/src/java/org/apache/lucene/spatial/prefix/PrefixTreeStrategy.java (revision )
@@ -17,7 +17,6 @@
* limitations under the License.
*/
-import com.spatial4j.core.distance.DistanceCalculator;
import com.spatial4j.core.shape.Point;
import com.spatial4j.core.shape.Shape;
import org.apache.lucene.analysis.TokenStream;
@@ -141,12 +140,7 @@
}
@Override
- public ValueSource makeValueSource(SpatialArgs args) {
- DistanceCalculator calc = grid.getSpatialContext().getDistCalc();
- return makeValueSource(args, calc);
- }
-
- public ValueSource makeValueSource(SpatialArgs args, DistanceCalculator calc) {
+ public ValueSource makeDistanceValueSource(Point queryPoint) {
PointPrefixTreeFieldCacheProvider p = provider.get( getFieldName() );
if( p == null ) {
synchronized (this) {//double checked locking idiom is okay since provider is threadsafe
@@ -157,8 +151,8 @@
}
}
}
- Point point = args.getShape().getCenter();
- return new ShapeFieldCacheDistanceValueSource(point, calc, p);
+
+ return new ShapeFieldCacheDistanceValueSource(ctx, p, queryPoint);
}
public SpatialPrefixTree getGrid() {
Index: lucene/spatial/src/test/org/apache/lucene/spatial/SpatialExample.java
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
--- lucene/spatial/src/test/org/apache/lucene/spatial/SpatialExample.java (revision 1384629)
+++ lucene/spatial/src/test/org/apache/lucene/spatial/SpatialExample.java (revision )
@@ -20,6 +20,7 @@
import com.spatial4j.core.context.SpatialContext;
import com.spatial4j.core.distance.DistanceUtils;
import com.spatial4j.core.io.ShapeReadWriter;
+import com.spatial4j.core.shape.Point;
import com.spatial4j.core.shape.Shape;
import org.apache.lucene.document.Document;
import org.apache.lucene.document.Field;
@@ -45,7 +46,6 @@
import org.apache.lucene.store.Directory;
import org.apache.lucene.store.RAMDirectory;
import org.apache.lucene.util.LuceneTestCase;
-import org.apache.lucene.util.Version;
import java.io.IOException;
@@ -75,8 +75,9 @@
/**
* The Lucene spatial {@link SpatialStrategy} encapsulates an approach to
- * indexing and searching shapes, and providing relevancy scores for them.
- * It's a simple API to unify different approaches.
+ * indexing and searching shapes, and providing distance values for them.
+ * It's a simple API to unify different approaches. You might use more than
+ * one strategy for a shape as each strategy has its strengths and weaknesses.
*
* Note that these are initialized with a field name.
*/
@@ -85,13 +86,13 @@
private Directory directory;
protected void init() {
- //Typical geospatial context with kilometer units.
- // These can also be constructed from a factory: SpatialContextFactory
+ //Typical geospatial context
+ // These can also be constructed from SpatialContextFactory
this.ctx = SpatialContext.GEO;
- int maxLevels = 10;//results in sub-meter precision for geohash
+ int maxLevels = 11;//results in sub-meter precision for geohash
//TODO demo lookup by detail distance
- // This can also be constructed from a factory: SpatialPrefixTreeFactory
+ // This can also be constructed from SpatialPrefixTreeFactory
SpatialPrefixTree grid = new GeohashPrefixTree(ctx, maxLevels);
this.strategy = new RecursivePrefixTreeStrategy(grid, "myGeoField");
@@ -151,9 +152,8 @@
}
//--Match all, order by distance
{
- SpatialArgs args = new SpatialArgs(SpatialOperation.Intersects,//doesn't matter
- ctx.makePoint(60, -50));
- ValueSource valueSource = strategy.makeValueSource(args);//the distance (in degrees)
+ Point pt = ctx.makePoint(60, -50);
+ ValueSource valueSource = strategy.makeDistanceValueSource(pt);//the distance (in degrees)
Sort reverseDistSort = new Sort(valueSource.getSortField(false)).rewrite(indexSearcher);//true=asc dist
TopDocs docs = indexSearcher.search(new MatchAllDocsQuery(), 10, reverseDistSort);
assertDocMatchedIds(indexSearcher, docs, 4, 20, 2);
Index: lucene/spatial/src/test/org/apache/lucene/spatial/vector/TestTwoDoublesStrategy.java
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
--- lucene/spatial/src/test/org/apache/lucene/spatial/vector/TestTwoDoublesStrategy.java (revision 1384629)
+++ lucene/spatial/src/test/org/apache/lucene/spatial/vector/TestTwoDoublesStrategy.java (revision )
@@ -27,6 +27,7 @@
import org.apache.lucene.spatial.query.SpatialArgs;
import org.apache.lucene.spatial.query.SpatialOperation;
import org.junit.Before;
+import org.junit.Ignore;
import org.junit.Test;
import java.io.IOException;
@@ -41,7 +42,7 @@
this.strategy = new TwoDoublesStrategy(ctx, getClass().getSimpleName());
}
- @Test
+ @Test @Ignore
public void testCircleShapeSupport() {
Circle circle = ctx.makeCircle(ctx.makePoint(0, 0), 10);
SpatialArgs args = new SpatialArgs(SpatialOperation.Intersects, circle);
Index: lucene/spatial/src/java/org/apache/lucene/spatial/util/ShapeFieldCacheDistanceValueSource.java
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
--- lucene/spatial/src/java/org/apache/lucene/spatial/util/ShapeFieldCacheDistanceValueSource.java (revision 1384629)
+++ lucene/spatial/src/java/org/apache/lucene/spatial/util/ShapeFieldCacheDistanceValueSource.java (revision )
@@ -17,6 +17,7 @@
* limitations under the License.
*/
+import com.spatial4j.core.context.SpatialContext;
import com.spatial4j.core.distance.DistanceCalculator;
import com.spatial4j.core.shape.Point;
import org.apache.lucene.index.AtomicReaderContext;
@@ -38,26 +39,29 @@
public class ShapeFieldCacheDistanceValueSource extends ValueSource {
private final ShapeFieldCacheProvider provider;
- private final DistanceCalculator calculator;
+ private final SpatialContext ctx;
private final Point from;
- public ShapeFieldCacheDistanceValueSource(Point from, DistanceCalculator calc, ShapeFieldCacheProvider provider) {
+ public ShapeFieldCacheDistanceValueSource(SpatialContext ctx, ShapeFieldCacheProvider provider, Point from) {
+ this.ctx = ctx;
this.from = from;
this.provider = provider;
- this.calculator = calc;
}
@Override
public String description() {
- return getClass().getSimpleName()+"("+calculator+")";
+ return getClass().getSimpleName()+"("+provider+", "+from+")";
}
@Override
- public FunctionValues getValues(Map context, AtomicReaderContext readerContext) throws IOException {
- final ShapeFieldCache cache =
+ public FunctionValues getValues(Map context, final AtomicReaderContext readerContext) throws IOException {
+ return new FunctionValues() {
+ private final ShapeFieldCache cache =
- provider.getCache(readerContext.reader());
+ provider.getCache(readerContext.reader());
+ private final Point from = ShapeFieldCacheDistanceValueSource.this.from;
+ private final DistanceCalculator calculator = ctx.getDistCalc();
+ private final double nullValue = (ctx.isGeo() ? 180 : Double.MAX_VALUE);
- return new FunctionValues() {
@Override
public float floatVal(int doc) {
return (float) doubleVal(doc);
@@ -73,7 +77,7 @@
}
return v;
}
- return Double.NaN; // ?? maybe max?
+ return nullValue;
}
@Override
@@ -90,16 +94,15 @@
ShapeFieldCacheDistanceValueSource that = (ShapeFieldCacheDistanceValueSource) o;
- if (calculator != null ? !calculator.equals(that.calculator) : that.calculator != null) return false;
- if (from != null ? !from.equals(that.from) : that.from != null) return false;
+ if (!ctx.equals(that.ctx)) return false;
+ if (!from.equals(that.from)) return false;
+ if (!provider.equals(that.provider)) return false;
return true;
}
@Override
public int hashCode() {
- int result = calculator != null ? calculator.hashCode() : 0;
- result = 31 * result + (from != null ? from.hashCode() : 0);
- return result;
+ return from.hashCode();
}
}
Index: lucene/spatial/src/java/org/apache/lucene/spatial/SpatialStrategy.java
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
--- lucene/spatial/src/java/org/apache/lucene/spatial/SpatialStrategy.java (revision 1384629)
+++ lucene/spatial/src/java/org/apache/lucene/spatial/SpatialStrategy.java (revision )
@@ -18,13 +18,14 @@
*/
import com.spatial4j.core.context.SpatialContext;
+import com.spatial4j.core.shape.Point;
+import com.spatial4j.core.shape.Rectangle;
import com.spatial4j.core.shape.Shape;
import org.apache.lucene.document.Field;
-import org.apache.lucene.queries.function.FunctionQuery;
import org.apache.lucene.queries.function.ValueSource;
+import org.apache.lucene.queries.function.valuesource.ReciprocalFloatFunction;
+import org.apache.lucene.search.ConstantScoreQuery;
import org.apache.lucene.search.Filter;
-import org.apache.lucene.search.FilteredQuery;
-import org.apache.lucene.search.Query;
import org.apache.lucene.spatial.query.SpatialArgs;
/**
@@ -99,25 +100,48 @@
public abstract Field[] createIndexableFields(Shape shape);
/**
- * The value source yields a number that is proportional to the distance between the query shape and indexed data.
+ * Make a ValueSource returning the closest distance between the center of the
+ * indexed shape and {@code queryPoint}.
+ * @param queryPoint
*/
- public abstract ValueSource makeValueSource(SpatialArgs args);
+ public abstract ValueSource makeDistanceValueSource(Point queryPoint);
/**
- * Make a query which has a score based on the distance from the data to the query shape.
- * The default implementation constructs a {@link FilteredQuery} based on
- * {@link #makeFilter(org.apache.lucene.spatial.query.SpatialArgs)} and
- * {@link #makeValueSource(org.apache.lucene.spatial.query.SpatialArgs)}.
+ * Make a (ConstantScore) Query based principally on {@link org.apache.lucene.spatial.query.SpatialOperation}
+ * and {@link Shape} from the supplied {@code args}.
+ * The default implementation is
+ *
return new ConstantScoreQuery(makeFilter(args));
*/
- public Query makeQuery(SpatialArgs args) {
- Filter filter = makeFilter(args);
- ValueSource vs = makeValueSource(args);
- return new FilteredQuery(new FunctionQuery(vs), filter);
+ public ConstantScoreQuery makeQuery(SpatialArgs args) {
+ return new ConstantScoreQuery(makeFilter(args));
}
+
/**
- * Make a Filter
+ * Make a Filter based principally on {@link org.apache.lucene.spatial.query.SpatialOperation}
+ * and {@link Shape} from the supplied {@code args}.
+ *
+ * If a subclasses implements
+ * {@link #makeQuery(org.apache.lucene.spatial.query.SpatialArgs)}
+ * then this method could be simply:
+ *
return new QueryWrapperFilter(makeQuery(args).getQuery());
*/
public abstract Filter makeFilter(SpatialArgs args);
+
+ /**
+ * Returns a ValueSource useful as a score. It is c/(d + c) where 'd' is the
+ * distance retrieved from {@link #makeDistanceValueSource(com.spatial4j.core.shape.Point)}
+ * and 'c' is one tenth the distance to the farthest edge from the center.
+ * Thus the scores will be as high as 1 for matching points in the center of
+ * the query shape and as low as ~0.1 at its furthest edges.
+ */
+ public final ValueSource makeRecipDistanceValueSource(Shape queryShape) {
+ Rectangle bbox = queryShape.getBoundingBox();
+ double diagonalDist = ctx.getDistCalc().distance(
+ ctx.makePoint(bbox.getMinX(), bbox.getMinY()), bbox.getMaxX(), bbox.getMaxY());
+ double distToEdge = diagonalDist * 0.5;
+ float c = (float)distToEdge * 0.1f;//one tenth
+ return new ReciprocalFloatFunction(makeDistanceValueSource(queryShape.getCenter()), 1f, c, c);
+ }
@Override
public String toString() {
Index: lucene/spatial/src/test/org/apache/lucene/spatial/DistanceStrategyTest.java
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
--- lucene/spatial/src/test/org/apache/lucene/spatial/DistanceStrategyTest.java (revision )
+++ lucene/spatial/src/test/org/apache/lucene/spatial/DistanceStrategyTest.java (revision )
@@ -0,0 +1,129 @@
+package org.apache.lucene.spatial;
+
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF 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.
+ */
+
+import com.carrotsearch.randomizedtesting.annotations.Name;
+import com.carrotsearch.randomizedtesting.annotations.ParametersFactory;
+import com.spatial4j.core.context.SpatialContext;
+import com.spatial4j.core.shape.Point;
+import com.spatial4j.core.shape.Shape;
+import org.apache.lucene.document.Document;
+import org.apache.lucene.spatial.bbox.BBoxStrategy;
+import org.apache.lucene.spatial.prefix.RecursivePrefixTreeStrategy;
+import org.apache.lucene.spatial.prefix.TermQueryPrefixTreeStrategy;
+import org.apache.lucene.spatial.prefix.tree.GeohashPrefixTree;
+import org.apache.lucene.spatial.prefix.tree.QuadPrefixTree;
+import org.apache.lucene.spatial.prefix.tree.SpatialPrefixTree;
+import org.apache.lucene.spatial.vector.TwoDoublesStrategy;
+import org.junit.Test;
+
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * @author David Smiley - dsmiley@mitre.org
+ */
+public class DistanceStrategyTest extends StrategyTestCase {
+
+ @ParametersFactory
+ public static Iterable