Package org.apache.solr.legacy

Class PointVectorStrategy

java.lang.Object

org.apache.lucene.spatial.SpatialStrategy

org.apache.solr.legacy.PointVectorStrategy

public class PointVectorStrategy
extends org.apache.lucene.spatial.SpatialStrategy

Simple SpatialStrategy which 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.Intersects and SpatialOperation.IsWithin is 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 on SpatialStrategy.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 org.apache.lucene.document.FieldType	DEFAULT_FIELDTYPE	pointValues, docValues, and nothing else.
static LegacyFieldType	LEGACY_FIELDTYPE	Deprecated.
static String	SUFFIX_X
static String	SUFFIX_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, org.apache.lucene.document.FieldType fieldType)	Create a new instance configured with the provided FieldType options.

Method Summary

Modifier and Type	Method	Description
org.apache.lucene.document.Field[]	createIndexableFields(org.locationtech.spatial4j.shape.Point point)
org.apache.lucene.document.Field[]	createIndexableFields(org.locationtech.spatial4j.shape.Shape shape)
org.apache.lucene.search.DoubleValuesSource	makeDistanceValueSource(org.locationtech.spatial4j.shape.Point queryPoint, double multiplier)
org.apache.lucene.search.ConstantScoreQuery	makeQuery(org.apache.lucene.spatial.query.SpatialArgs args)
static PointVectorStrategy	newInstance(org.locationtech.spatial4j.context.SpatialContext ctx, String fieldNamePrefix)	Create a new PointVectorStrategy instance that uses DoublePoint and DoublePoint.newRangeQuery(java.lang.String, double, double)
static PointVectorStrategy	newLegacyInstance(org.locationtech.spatial4j.context.SpatialContext ctx, String fieldNamePrefix)	Deprecated. LegacyNumerics will be removed

Methods inherited from class org.apache.lucene.spatial.SpatialStrategy

getFieldName, getSpatialContext, makeDistanceValueSource, makeRecipDistanceValueSource, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_FIELDTYPE

public static org.apache.lucene.document.FieldType DEFAULT_FIELDTYPE

pointValues, docValues, and nothing else.

LEGACY_FIELDTYPE

@Deprecated
public static LegacyFieldType LEGACY_FIELDTYPE

Deprecated.

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,
                           org.apache.lucene.document.FieldType fieldType)

Create a new instance configured with the provided FieldType options. See DEFAULT_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 new PointVectorStrategy instance that uses DoublePoint and DoublePoint.newRangeQuery(java.lang.String, double, double)

newLegacyInstance

@Deprecated
public static PointVectorStrategy newLegacyInstance(org.locationtech.spatial4j.context.SpatialContext ctx,
                                                    String fieldNamePrefix)

Deprecated.

LegacyNumerics will be removed

Create a new PointVectorStrategy instance that uses LegacyDoubleField for backwards compatibility. However, back-compat is limited; we don't support circle queries or makeDistanceValueSource(Point, double) since that requires docValues (the legacy config didn't have that).

createIndexableFields

public org.apache.lucene.document.Field[] createIndexableFields(org.locationtech.spatial4j.shape.Shape shape)

Specified by:

createIndexableFields in class org.apache.lucene.spatial.SpatialStrategy

createIndexableFields

public org.apache.lucene.document.Field[] createIndexableFields(org.locationtech.spatial4j.shape.Point point)

See Also:

createIndexableFields(org.locationtech.spatial4j.shape.Shape)

makeDistanceValueSource

public org.apache.lucene.search.DoubleValuesSource makeDistanceValueSource(org.locationtech.spatial4j.shape.Point queryPoint,
                                                                           double multiplier)

Specified by:

makeDistanceValueSource in class org.apache.lucene.spatial.SpatialStrategy

makeQuery

public org.apache.lucene.search.ConstantScoreQuery makeQuery(org.apache.lucene.spatial.query.SpatialArgs args)

Specified by:

makeQuery in class org.apache.lucene.spatial.SpatialStrategy