https://github.com/ziptastic/ziptastic-java
Offcial Java Library for Ziptastic.
https://github.com/ziptastic/ziptastic-java
forward forward-geocoding geocoding geodata geographical-information-system gis offcial-java-library postal-code reverse reverse-geocode reverse-geocoding zipcode zipcodes ziptastic ziptastic-java
Last synced: 7 months ago
JSON representation
Offcial Java Library for Ziptastic.
- Host: GitHub
- URL: https://github.com/ziptastic/ziptastic-java
- Owner: Ziptastic
- License: mit
- Created: 2016-03-18T21:10:31.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-06-20T16:09:07.000Z (over 9 years ago)
- Last Synced: 2025-01-19T18:09:33.354Z (9 months ago)
- Topics: forward, forward-geocoding, geocoding, geodata, geographical-information-system, gis, offcial-java-library, postal-code, reverse, reverse-geocode, reverse-geocoding, zipcode, zipcodes, ziptastic, ziptastic-java
- Language: Java
- Size: 26.4 KB
- Stars: 3
- Watchers: 5
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# **Offcial Ziptastic Java Library (ALPHA)**
## **Index**
1. -[ ] **Ziptastic Object**
- Introduction
- Documentation
- Usage Examples
_________________________________________________________________________________________________________________________________________
###Ziptastic Object
[](https://coveralls.io/github/bfranco94/ziptastic-java?branch=master) [](https://travis-ci.org/Ziptastic/ziptastic-java)
####Introduction
- The Ziptastic Object class is designed to offer a Java developer instant access to the Ziptastic API Service. This is done by encapsulating both Reverse and Forward Geocoding processes within the Ziptastic object and storing results from the request in an easy to access format.
####Documentation
#####Constructor Summary
Constructor | Description
-------|------------
**Ziptastic**(String apiKey) | Creates an empty Ziptastic object with the Ziptastic API Key value.
#####Method Summary
Method | Description
-------|------------
**GetFromLongLat**(double longitude, double latitude, int radius) | Creates a url based on reverse geocoding, passes the url to the HTTPRequest method, and returns the results of a ReverseGeocoding API request.
**GetFromZipcode**(int zipcode) | Creates a url based on forward geocoding, passes the url to the HTTPRequest method, and returns the results of a ForwardGeocoding API request.
####Usage Examples####
- **Forward Geocoding**
```
Ziptastic zipObj = new Ziptastic(apiKey);
String result = zipObj.GetFromZipcode(zipcode);
System.out.println(result);
```
- **Reverse Geocoding**
```
Ziptastic zipObj = new Ziptastic(apiKey);
String result = zipObj.GetFromLongLat(longitude, latitude, radius);
System.out.println(result);
```
####Sample Output####
- **Invalid Key Request**
{
"message": "API Key Invalid."
}
- **Valid Key Request**
[
{
"city": "Owosso",
"geohash": "dpshsfsytw8k",
"country": "US",
"county": "Shiawassee",
"state": "Michigan",
"state_short": "MI",
"postal_code": "48867",
"latitude": 42.9934,
"longitude": -84.1595,
"timezone": "America/Detroit"
}
]
####Maven Plugins####
- **Checkstyle** : http://checkstyle.sourceforge.net/
- **PMD** : https://pmd.github.io/
####Future Work####
- Add more tests.
- Expand on java implementation of Ziptastic object.
___________________________________________________________________________________________