You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by ds...@apache.org on 2012/07/23 22:21:04 UTC
svn commit: r1364785 - in /lucene/dev/branches/branch_4x: ./ lucene/
lucene/spatial/ lucene/spatial/src/java/
lucene/spatial/src/java/org/apache/lucene/spatial/
lucene/spatial/src/test/org/apache/lucene/spatial/
Author: dsmiley
Date: Mon Jul 23 20:21:04 2012
New Revision: 1364785
URL: http://svn.apache.org/viewvc?rev=1364785&view=rev
Log:
LUCENE-4223 spatial docs: overview.html, SpatialStrategy, and added SpatialExample.java sample
Added:
lucene/dev/branches/branch_4x/lucene/spatial/src/test/org/apache/lucene/spatial/SpatialExample.java
- copied unchanged from r1364782, lucene/dev/trunk/lucene/spatial/src/test/org/apache/lucene/spatial/SpatialExample.java
Modified:
lucene/dev/branches/branch_4x/ (props changed)
lucene/dev/branches/branch_4x/lucene/ (props changed)
lucene/dev/branches/branch_4x/lucene/spatial/ (props changed)
lucene/dev/branches/branch_4x/lucene/spatial/src/java/org/apache/lucene/spatial/SpatialStrategy.java
lucene/dev/branches/branch_4x/lucene/spatial/src/java/overview.html
Modified: lucene/dev/branches/branch_4x/lucene/spatial/src/java/org/apache/lucene/spatial/SpatialStrategy.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/spatial/src/java/org/apache/lucene/spatial/SpatialStrategy.java?rev=1364785&r1=1364784&r2=1364785&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/spatial/src/java/org/apache/lucene/spatial/SpatialStrategy.java (original)
+++ lucene/dev/branches/branch_4x/lucene/spatial/src/java/org/apache/lucene/spatial/SpatialStrategy.java Mon Jul 23 20:21:04 2012
@@ -28,10 +28,26 @@ import org.apache.lucene.search.Query;
import org.apache.lucene.spatial.query.SpatialArgs;
/**
- * The SpatialStrategy encapsulates an approach to indexing and searching based on shapes.
+ * The SpatialStrategy encapsulates an approach to indexing and searching based
+ * on shapes.
* <p/>
- * Note that a SpatialStrategy is not involved with the Lucene stored field values of shapes, which is
- * immaterial to indexing & search.
+ * Different implementations will support different features. A strategy should
+ * document these common elements:
+ * <ul>
+ * <li>Can it index more than one shape per field?</li>
+ * <li>What types of shapes can be indexed?</li>
+ * <li>What types of query shapes can be used?</li>
+ * <li>What types of query operations are supported?
+ * This might vary per shape.</li>
+ * <li>Are there caches? Under what circumstances are they used?
+ * Roughly how big are they? Is it segmented by Lucene segments, such as is
+ * done by the Lucene {@link org.apache.lucene.search.FieldCache} and
+ * {@link org.apache.lucene.index.DocValues} (ideal) or is it for the entire
+ * index?
+ * </ul>
+ * <p/>
+ * Note that a SpatialStrategy is not involved with the Lucene stored field
+ * values of shapes, which is immaterial to indexing & search.
* <p/>
* Thread-safe.
*
Modified: lucene/dev/branches/branch_4x/lucene/spatial/src/java/overview.html
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/spatial/src/java/overview.html?rev=1364785&r1=1364784&r2=1364785&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/spatial/src/java/overview.html (original)
+++ lucene/dev/branches/branch_4x/lucene/spatial/src/java/overview.html Mon Jul 23 20:21:04 2012
@@ -16,8 +16,49 @@
-->
<html>
<head>
- <title>Apache Lucene Spatial Strategies</title>
+ <title>Apache Lucene Spatial Module</title>
</head>
<body>
+
+ <h1>The Spatial Module for Apache Lucene</h1>
+
+ <p>
+ The spatial module is new is Lucene 4, replacing the old contrib module
+ that came before it. The principle interface to the module is
+ a {@link org.apache.lucene.spatial.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 class level.
+ </p>
+ <p>
+ For some sample code showing how to use the API, see SpatialExample.java in
+ the tests.
+ </p>
+ <p>
+ The spatial module uses
+ <a href="https://github.com/spatial4j/spatial4j">Spatial4j</a>
+ heavily. Spatial4j is an ASL licensed library with these capabilities:
+ <ul>
+ <li>Provides shape implementations, namely point, rectangle,
+ and circle. Both geospatial contexts and plain 2D Euclidean/Cartesian contexts
+ are supported.
+ With an additional dependency, it adds polygon and other geometry shape
+ support via integration with
+ <a href="http://sourceforge.net/projects/jts-topo-suite/">JTS Topology Suite</a>.
+ This includes dateline wrap support.</li>
+ <li>Shape parsing and serialization, including
+ <a href="http://en.wikipedia.org/wiki/Well-known_text">Well-Known Text (WKT)</a>
+ (via JTS).</li>
+ <li>Distance and other spatial related math calculations.</li>
+ </ul>
+ </p>
+ <p>
+ 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.
+ </p>
+
</body>
</html>
\ No newline at end of file