Package org.apache.lucene.spatial.vector
Class PointVectorStrategy
- java.lang.Object
-
- org.apache.lucene.spatial.SpatialStrategy
-
- org.apache.lucene.spatial.vector.PointVectorStrategy
-
public class PointVectorStrategy extends SpatialStrategy
SimpleSpatialStrategywhich represents Points in two numeric fields. The Strategy's best feature is decent distance sort.Characteristics:
- Only indexes points; just one per field value.
- Can query by a rectangle or circle.
SpatialOperation.IntersectsandSpatialOperation.IsWithinis supported.- Requires DocValues for
SpatialStrategy.makeDistanceValueSource(org.locationtech.spatial4j.shape.Point)and for searching with a Circle.
Implementation:
This is a simple Strategy. Search works with a pair of range queries on two
DoublePoints representing x & y fields. A Circle query does the same bbox query but adds a ValueSource filter onSpatialStrategy.makeDistanceValueSource(org.locationtech.spatial4j.shape.Point).One performance shortcoming with this strategy is that a scenario involving both a search using a Circle and sort will result in calculations for the spatial distance being done twice -- once for the filter and second for the sort.
- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
-
Field Summary
Fields Modifier and Type Field Description static FieldTypeDEFAULT_FIELDTYPEpointValues, docValues, and nothing else.static StringSUFFIX_Xstatic StringSUFFIX_Y-
Fields inherited from class org.apache.lucene.spatial.SpatialStrategy
ctx
-
-
Constructor Summary
Constructors Constructor Description PointVectorStrategy(org.locationtech.spatial4j.context.SpatialContext ctx, String fieldNamePrefix, FieldType fieldType)Create a new instance configured with the provided FieldType options.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Field[]createIndexableFields(org.locationtech.spatial4j.shape.Point point)Field[]createIndexableFields(org.locationtech.spatial4j.shape.Shape shape)Returns the IndexableField(s) from theshapethat are to be added to theDocument.DoubleValuesSourcemakeDistanceValueSource(org.locationtech.spatial4j.shape.Point queryPoint, double multiplier)Make a ValueSource returning the distance between the center of the indexed shape andqueryPoint.QuerymakeQuery(SpatialArgs args)static PointVectorStrategynewInstance(org.locationtech.spatial4j.context.SpatialContext ctx, String fieldNamePrefix)Create a newPointVectorStrategyinstance that usesDoublePointandDoublePoint.newRangeQuery(java.lang.String, double, double)-
Methods inherited from class org.apache.lucene.spatial.SpatialStrategy
getFieldName, getSpatialContext, makeDistanceValueSource, makeRecipDistanceValueSource, toString
-
-
-
-
Field Detail
-
DEFAULT_FIELDTYPE
public static FieldType DEFAULT_FIELDTYPE
pointValues, docValues, and nothing else.
-
SUFFIX_X
public static final String SUFFIX_X
- See Also:
- Constant Field Values
-
SUFFIX_Y
public static final String SUFFIX_Y
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
PointVectorStrategy
public PointVectorStrategy(org.locationtech.spatial4j.context.SpatialContext ctx, String fieldNamePrefix, FieldType fieldType)Create a new instance configured with the provided FieldType options. SeeDEFAULT_FIELDTYPE. a field type is used to articulate the desired options (namely pointValues, docValues, stored). Legacy numerics is configurable this way too.
-
-
Method Detail
-
newInstance
public static PointVectorStrategy newInstance(org.locationtech.spatial4j.context.SpatialContext ctx, String fieldNamePrefix)
Create a newPointVectorStrategyinstance that usesDoublePointandDoublePoint.newRangeQuery(java.lang.String, double, double)
-
createIndexableFields
public Field[] createIndexableFields(org.locationtech.spatial4j.shape.Shape shape)
Description copied from class:SpatialStrategyReturns the IndexableField(s) from theshapethat are to be added to theDocument. These fields are expected to be marked as indexed and not stored.Note: If you want to store the shape as a string for retrieval in search results, you could add it like this:
document.add(new StoredField(fieldName,ctx.toString(shape)));
The particular string representation used doesn't matter to the Strategy since it doesn't use it.- Specified by:
createIndexableFieldsin classSpatialStrategy- Returns:
- Not null nor will it have null elements.
-
createIndexableFields
public Field[] createIndexableFields(org.locationtech.spatial4j.shape.Point point)
-
makeDistanceValueSource
public DoubleValuesSource makeDistanceValueSource(org.locationtech.spatial4j.shape.Point queryPoint, double multiplier)
Description copied from class:SpatialStrategyMake a ValueSource returning the distance between the center of the indexed shape andqueryPoint. If there are multiple indexed shapes then the closest one is chosen. The result is multiplied bymultiplier, which conveniently is used to get the desired units.- Specified by:
makeDistanceValueSourcein classSpatialStrategy
-
makeQuery
public Query makeQuery(SpatialArgs args)
Description copied from class:SpatialStrategyMake a Query based principally onSpatialOperationandShapefrom the suppliedargs. It should be constant scoring of 1.- Specified by:
makeQueryin classSpatialStrategy
-
-