org.apache.lucene.spatial.prefix

Class RecursivePrefixTreeStrategy

java.lang.Object

org.apache.lucene.spatial.SpatialStrategy

org.apache.lucene.spatial.prefix.PrefixTreeStrategy

org.apache.lucene.spatial.prefix.RecursivePrefixTreeStrategy

Direct Known Subclasses:

NumberRangePrefixTreeStrategy

public class RecursivePrefixTreeStrategy
extends PrefixTreeStrategy

A PrefixTreeStrategy which uses AbstractVisitingPrefixTreeFilter. This strategy has support for searching non-point shapes (note: not tested). Even a query shape with distErrPct=0 (fully precise to the grid) should have good performance for typical data, unless there is a lot of indexed data coincident with the shape's edge.

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

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	multiOverlappingIndexedShapes
protected boolean	pointsOnly
protected int	prefixGridScanLevel
protected boolean	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
RecursivePrefixTreeStrategy(SpatialPrefixTree grid, String fieldName)

Method Summary

Methods

Modifier and Type	Method and Description
protected TokenStream	createTokenStream(com.spatial4j.core.shape.Shape shape, int detailLevel)
Filter	makeFilter(SpatialArgs args) Make a Filter based principally on SpatialOperation and Shape from the supplied args.
void	setMultiOverlappingIndexedShapes(boolean multiOverlappingIndexedShapes) See ContainsPrefixTreeFilter.multiOverlappingIndexedShapes.
void	setPointsOnly(boolean pointsOnly) True if only indexed points shall be supported.
void	setPrefixGridScanLevel(int prefixGridScanLevel) Sets the grid level [1-maxLevels] at which indexed terms are scanned brute-force instead of by grid decomposition.
void	setPruneLeafyBranches(boolean pruneLeafyBranches) An optional hint affecting non-point shapes: it will simplify/aggregate sets of complete leaves in a cell to its parent, resulting in ~20-25% fewer indexed cells.
String	toString()

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

createIndexableFields, createIndexableFields, getDistErrPct, getGrid, makeDistanceValueSource, 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

Field Detail

prefixGridScanLevel

protected int prefixGridScanLevel

pruneLeafyBranches

protected boolean pruneLeafyBranches

pointsOnly

protected boolean pointsOnly

multiOverlappingIndexedShapes

protected boolean multiOverlappingIndexedShapes

Constructor Detail

RecursivePrefixTreeStrategy

public RecursivePrefixTreeStrategy(SpatialPrefixTree grid,
                           String fieldName)

Method Detail

setPrefixGridScanLevel

public void setPrefixGridScanLevel(int prefixGridScanLevel)

Sets the grid level [1-maxLevels] at which indexed terms are scanned brute-force instead of by grid decomposition. By default this is maxLevels - 4. The final level, maxLevels, is always scanned.

Parameters:

prefixGridScanLevel - 1 to maxLevels

setPointsOnly

public void setPointsOnly(boolean pointsOnly)

True if only indexed points shall be supported. There are no "leafs" in such a case. See IntersectsPrefixTreeFilter.hasIndexedLeaves.

setMultiOverlappingIndexedShapes

public void setMultiOverlappingIndexedShapes(boolean multiOverlappingIndexedShapes)

See ContainsPrefixTreeFilter.multiOverlappingIndexedShapes.

setPruneLeafyBranches

public void setPruneLeafyBranches(boolean pruneLeafyBranches)

An optional hint affecting non-point shapes: it will simplify/aggregate sets of complete leaves in a cell to its parent, resulting in ~20-25% fewer indexed cells. However, it will likely be removed in the future. (default=true)

toString

public String toString()

Overrides:

toString in class SpatialStrategy

createTokenStream

protected TokenStream createTokenStream(com.spatial4j.core.shape.Shape shape,
                            int detailLevel)

Overrides:

createTokenStream in class PrefixTreeStrategy

makeFilter

public Filter makeFilter(SpatialArgs args)

Description copied from class: SpatialStrategy

Make a Filter based principally on SpatialOperation and Shape from the supplied args.

If a subclasses implements SpatialStrategy.makeQuery(org.apache.lucene.spatial.query.SpatialArgs) then this method could be simply:

return new QueryWrapperFilter(makeQuery(args).getQuery());

Specified by:

makeFilter in class SpatialStrategy