Skip navigation links

Lucene 5.5.5 spatial API

The Spatial Module for Apache Lucene

See: Description

Packages 
Package Description
org.apache.lucene.spatial
Lucene spatial search
org.apache.lucene.spatial.bbox
Bounding Box Spatial Strategy
org.apache.lucene.spatial.composite
Composite strategies.
org.apache.lucene.spatial.geopoint.document
Geospatial Field Implementations for Core Lucene
org.apache.lucene.spatial.geopoint.search
Geospatial Query Implementations for Core Lucene
org.apache.lucene.spatial.prefix
Prefix Tree Strategy.
org.apache.lucene.spatial.prefix.tree
This package is about SpatialPrefixTree and any supporting classes.
org.apache.lucene.spatial.query
Spatial Query options useful for client side requests
org.apache.lucene.spatial.serialized
Strategies that serialize the shape (non-indexed).
org.apache.lucene.spatial.spatial4j
Spatial4j stuff that ideally belongs in Spatial4j (isn't related to Lucene).
org.apache.lucene.spatial.util
Various spatial utilities.
org.apache.lucene.spatial.vector
Spatial strategy that uses two fields.

The Spatial Module for Apache Lucene

The spatial module is new to Lucene 4, replacing the old "contrib" module that came before it. The principle interface to the module is a SpatialStrategy which encapsulates an approach to indexing and searching based on shapes. Different Strategies have different features and performance profiles, which are documented at each Strategy implementation class level.

For some sample code showing how to use the API, see SpatialExample.java in the tests.

The spatial module uses Spatial4j heavily. Spatial4j is an ASL licensed library with these capabilities:

Historical note: The new spatial module was once known as Lucene Spatial Playground (LSP) as an external project. In ~March 2012, LSP split into this new module as part of Lucene and Spatial4j externally. A large chunk of the LSP implementation originated as SOLR-2155 which uses trie/prefix-tree algorithms with a geohash encoding. That approach is implemented in RecursivePrefixTreeStrategy today.

Skip navigation links

Copyright © 2000-2017 Apache Software Foundation. All Rights Reserved.