blob: d6e6187eca2aed6b350a638098ecf94fbee88ec4 [file] [log] [blame]
Silvio Heubergerb95c5832008-12-29 15:59:17 +01001java code for geohashes
Silvio Heuberger86a8e9f2010-04-06 10:46:49 +02002=======================
Silvio Heubergerb95c5832008-12-29 15:59:17 +01003
Silvio Heubergere7f555d2010-03-29 10:30:10 +02004An implementation of Geohashes in pure Java.
5The produced hashes, when using character precision (multiples of 5 bits) are compatible
6to the reference implementation geohash.org.
Silvio Heubergerb95c5832008-12-29 15:59:17 +01007
Silvio Heuberger9dd0da72010-04-06 09:36:28 +02008You can however also encode Geohashes down to the full available precision of a long i.e. 64 bits.
9
Silvio Heubergerb95c5832008-12-29 15:59:17 +010010
Silvio Heuberger86a8e9f2010-04-06 10:46:49 +020011Building/Testing the code
12-------------------------
13
Silvio Heuberger890565f2011-01-08 11:28:44 +010014The geohash-java code can be built using Apache Ant or Apache Maven.
15Ant targets that are available:
Silvio Heuberger86a8e9f2010-04-06 10:46:49 +020016
17 - clean # wash dishes.
18 - compile # compile the main source code.
19 - test # (default) run the unit tests.
20 - jar # pack a jar archive with the compiled class files.
21 - zip # pack a zip archive with the compiled binaries, source code and all other files.
22
Silvio Heuberger890565f2011-01-08 11:28:44 +010023Maven targets are the usual suspects.
24
25 - compile
26 - test
27 - package
Silvio Heuberger86a8e9f2010-04-06 10:46:49 +020028
Silvio Heubergere7f555d2010-03-29 10:30:10 +020029TODO
30----
31
32Current development involves getting the following things to run:
33
34- a method to find the n closest hashes to any given point.
Silvio Heubergere7f555d2010-03-29 10:30:10 +020035
36
37Last important changes
38----------------------
39
Silvio Heuberger890565f2011-01-08 11:28:44 +010040Version 1.0.2
41-------------
42
43- Merged Kevins [ktcorby] code that yields all the geohashes in a bounding box, at a given resolution.
44- Merged Chris' [cchandler] code to encode and decode geohashes from a binary string.
45
46Version 1.0.1
47-------------
48
49- Fixed issue #2 from Github:
Silvio Heubergere7f555d2010-03-29 10:30:10 +020050 - Neighbouring hashes can be calculated by using the getAdjacent() method, which yields a hashes 8 neighbors.
51 - northern, eastern, western and southern neighbours can be determined using the respective methods.
52
Silvio Heuberger890565f2011-01-08 11:28:44 +010053- Fixed issue #1 from Github:
Silvio Heuberger9dd0da72010-04-06 09:36:28 +020054 - A bug caused different hashes to be yielded sometimes.
55
56
57License
58-------
59
60This code has been placed under the LGPL. See the LICENSE file for more information.
61Please contribute improvements and bug fixes back via github.