org.apache.lucene.spatial.prefix (Lucene 10.5.1 spatial-extras API)
Description: declaration: package: org.apache.lucene.spatial.prefix

# Package org.apache.lucene.spatial.prefix

package org.apache.lucene.spatial.prefix
Prefix Tree Strategy.

- Related Packages
  Package
  Description
  org.apache.lucene.spatial
  Lucene advanced spatial search
  org.apache.lucene.spatial.prefix.tree
  This package is about SpatialPrefixTree and any supporting classes.
- Classes
  Class
  Description
  AbstractPrefixTreeQuery
  Base class for Lucene Queries on SpatialPrefixTree fields.
  AbstractVisitingPrefixTreeQuery
  Traverses a `SpatialPrefixTree` indexed field, using the template and visitor design patterns for subclasses to guide the traversal and collect matching documents.
  AbstractVisitingPrefixTreeQuery.VNode
  A visitor node/cell found via the query shape for `AbstractVisitingPrefixTreeQuery.VisitorTemplate`.
  BytesRefIteratorTokenStream
  A TokenStream used internally by `PrefixTreeStrategy`.
  CellToBytesRefIterator
  A reset'able `BytesRefIterator` wrapper around an `Iterator` of `Cell`s.
  ContainsPrefixTreeQuery
  Finds docs where its indexed shape `CONTAINS` the query shape.
  HeatmapFacetCounter
  Computes spatial facets in two dimensions as a grid of numbers.
  HeatmapFacetCounter.Heatmap
  Response structure
  IntersectsPrefixTreeQuery
  A Query matching documents that have an `SpatialRelation.INTERSECTS` (i.e.
  NumberRangePrefixTreeStrategy
  A PrefixTree based on Number/Date ranges.
  NumberRangePrefixTreeStrategy.Facets
  Facet response information
  NumberRangePrefixTreeStrategy.Facets.FacetParentVal
  Holds a block of detailLevel counts aggregated to their parent level.
  PointPrefixTreeFieldCacheProvider
  Implementation of `ShapeFieldCacheProvider` designed for `PrefixTreeStrategy`s that index points (AND ONLY POINTS!).
  PrefixTreeFacetCounter
  Computes facets on cells for `PrefixTreeStrategy`.
  PrefixTreeFacetCounter.FacetVisitor
  A callback/visitor of facet counts.
  PrefixTreeStrategy
  An abstract SpatialStrategy based on `SpatialPrefixTree`.
  RecursivePrefixTreeStrategy
  A `PrefixTreeStrategy` which uses `AbstractVisitingPrefixTreeQuery`.
  TermQueryPrefixTreeStrategy
  A basic implementation of `PrefixTreeStrategy` using a large `TermInSetQuery` of all the cells from `SpatialPrefixTree.getTreeCellIterator(org.locationtech.spatial4j.shape.Shape, int)`.
  WithinPrefixTreeQuery
  Finds docs where its indexed shape is `WITHIN` the query shape.