pylucene 3.5.0-3
[pylucene.git] / lucene-java-3.5.0 / lucene / contrib / spatial / src / java / overview.html
diff --git a/lucene-java-3.5.0/lucene/contrib/spatial/src/java/overview.html b/lucene-java-3.5.0/lucene/contrib/spatial/src/java/overview.html
new file mode 100644 (file)
index 0000000..3910933
--- /dev/null
@@ -0,0 +1,47 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<html>
+  <head>
+    <title>
+      Geographical filtering & sorting with Lucene
+    </title>
+  </head>
+  <body>
+
+<p>This package makes it possible to filter and sort according to
+geographical constraints.  For example, filter to include only
+restaurants within 2 miles of a specified latitude/longitude, sorting
+by distance ascending.</p>
+
+<p>See <a href="http://www.nsshutdown.com/projects/lucene/whitepaper/locallucene_v2.html">here</a>
+for details on the technical approach.</p>
+
+<p>Unfortunately, this package is still very new, and has little to no
+documentation.  It's best to ask for pointers on
+java-user@lucene.apache.org, and look at the unit tests included in
+the source distribution.</p>
+
+<p>There are also known issues, eg at
+least <a href="https://issues.apache.org/jira/browse/LUCENE-1815">LUCENE-1781</a>
+and <a href="https://issues.apache.org/jira/browse/LUCENE-1815">LUCENE-1815</a>.</p>
+
+<p><font color="red"><b>NOTE:</b> This package is still in flux and
+might change in incompatible ways in the next release.</font>
+
+  </body>
+</html>
+