org.apache.lucene.spatial.prefix

Class NumberRangePrefixTreeStrategy

java.lang.Object

org.apache.lucene.spatial.SpatialStrategy

org.apache.lucene.spatial.prefix.PrefixTreeStrategy

org.apache.lucene.spatial.prefix.RecursivePrefixTreeStrategy

org.apache.lucene.spatial.prefix.NumberRangePrefixTreeStrategy

public class NumberRangePrefixTreeStrategy
extends RecursivePrefixTreeStrategy

A PrefixTree based on Number/Date ranges. This isn't very "spatial" on the surface (to the user) but it's implemented using spatial so that's why it's here extending a SpatialStrategy. When using this class, you will use various utility methods on the prefix tree implementation to convert objects/strings to/from shapes. To use with dates, pass in DateRangePrefixTree.

WARNING: This API is experimental and might change in incompatible ways in the next release.

Field Summary

Fields inherited from class org.apache.lucene.spatial.prefix.RecursivePrefixTreeStrategy

multiOverlappingIndexedShapes, pointsOnly, prefixGridScanLevel, pruneLeafyBranches

Fields inherited from class org.apache.lucene.spatial.prefix.PrefixTreeStrategy

defaultFieldValuesArrayLen, distErrPct, FIELD_TYPE, grid

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

ctx

Constructor Summary

Constructors

Constructor and Description
NumberRangePrefixTreeStrategy(NumberRangePrefixTree prefixTree, String fieldName)

Method Summary

Methods

Modifier and Type	Method and Description
Field[]	createIndexableFields(com.spatial4j.core.shape.Shape shape) Returns the IndexableField(s) from the shape that are to be added to the Document.
NumberRangePrefixTree	getGrid()
ValueSource	makeDistanceValueSource(com.spatial4j.core.shape.Point queryPoint, double multiplier) Unsupported.

Methods inherited from class org.apache.lucene.spatial.prefix.RecursivePrefixTreeStrategy

createTokenStream, makeFilter, setMultiOverlappingIndexedShapes, setPointsOnly, setPrefixGridScanLevel, setPruneLeafyBranches, toString

Methods inherited from class org.apache.lucene.spatial.prefix.PrefixTreeStrategy

createIndexableFields, getDistErrPct, setDefaultFieldValuesArrayLen, setDistErrPct

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

getFieldName, getSpatialContext, makeDistanceValueSource, makeQuery, makeRecipDistanceValueSource

Methods inherited from class java.lang.Object

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

Constructor Detail

NumberRangePrefixTreeStrategy

public NumberRangePrefixTreeStrategy(NumberRangePrefixTree prefixTree,
                             String fieldName)

Method Detail

getGrid

public NumberRangePrefixTree getGrid()

Overrides:

getGrid in class PrefixTreeStrategy

createIndexableFields

public Field[] createIndexableFields(com.spatial4j.core.shape.Shape shape)

Description copied from class: SpatialStrategy

Returns the IndexableField(s) from the shape that are to be added to the Document. 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.

Overrides:

createIndexableFields in class PrefixTreeStrategy

Returns:

Not null nor will it have null elements.

makeDistanceValueSource

public ValueSource makeDistanceValueSource(com.spatial4j.core.shape.Point queryPoint,
                                  double multiplier)

Unsupported.

Overrides:

makeDistanceValueSource in class PrefixTreeStrategy