old python needs __main__ to call a module
[pylucene.git] / lucene-java-3.5.0 / lucene / contrib / spatial / src / java / overview.html
1 <!--
2  Licensed to the Apache Software Foundation (ASF) under one or more
3  contributor license agreements.  See the NOTICE file distributed with
4  this work for additional information regarding copyright ownership.
5  The ASF licenses this file to You under the Apache License, Version 2.0
6  (the "License"); you may not use this file except in compliance with
7  the License.  You may obtain a copy of the License at
8
9      http://www.apache.org/licenses/LICENSE-2.0
10
11  Unless required by applicable law or agreed to in writing, software
12  distributed under the License is distributed on an "AS IS" BASIS,
13  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  See the License for the specific language governing permissions and
15  limitations under the License.
16 -->
17 <html>
18   <head>
19     <title>
20       Geographical filtering & sorting with Lucene
21     </title>
22   </head>
23   <body>
24
25 <p>This package makes it possible to filter and sort according to
26 geographical constraints.  For example, filter to include only
27 restaurants within 2 miles of a specified latitude/longitude, sorting
28 by distance ascending.</p>
29
30 <p>See <a href="http://www.nsshutdown.com/projects/lucene/whitepaper/locallucene_v2.html">here</a>
31 for details on the technical approach.</p>
32
33 <p>Unfortunately, this package is still very new, and has little to no
34 documentation.  It's best to ask for pointers on
35 java-user@lucene.apache.org, and look at the unit tests included in
36 the source distribution.</p>
37
38 <p>There are also known issues, eg at
39 least <a href="https://issues.apache.org/jira/browse/LUCENE-1815">LUCENE-1781</a>
40 and <a href="https://issues.apache.org/jira/browse/LUCENE-1815">LUCENE-1815</a>.</p>
41
42 <p><font color="red"><b>NOTE:</b> This package is still in flux and
43 might change in incompatible ways in the next release.</font>
44
45   </body>
46 </html>
47