Fluid Java interface to OpenStreetMap data through querying the Overpass API
Switch branches/tags
Nothing to show
Clone or download
Latest commit 0464d38 Apr 29, 2018

README.md

overpasser

Build Status

Fluid Java interface to OpenStreetMap data through querying the Overpass API. No more query string forging by hand!

Example code

An Overpass query like this:

["out":"json"]["timeout":"30"];
(
    node
        ["amenity"="parking"]
        ["access"!="private"]
        (47.48047027491862,19.039797484874725,47.51331674014172,19.07404761761427);
        <;
);
out body center qt 100;

...can be expressed like:

String query = new OverpassQuery()
        .format(JSON)
        .timeout(30)
        .filterQuery()
            .node()
            .amenity("parking")
            .tagNot("access", "private")
            .boundingBox(
                47.48047027491862, 19.039797484874725,
                47.51331674014172, 19.07404761761427
            )
        .end()
        .output(OutputVerbosity.BODY, OutputModificator.CENTER, OutputOrder.QT, 100)
        .build()
;

...or you can just use .output(100) at the end to use the defaults.

Language support

Modules

  • library: core functionality in a standalone module
    • only Java dependencies
    • its purpose is to generate the string you can query the overpass-api server with
  • library-retrofit-adapter: Retrofit adapter towards the overpass-api server
    • it will handle sending your generated query to the server and parsing the results
    • the results are returned in a simple POJO class
    • for further info regarding network communication and error handling, please refer to Retrofit documentation
    • uses Retrofit 2.1.0
  • library-retrofit-legacy-adapter: for Retrofit 1.9
  • sample: an Android sample application using both of the above modules to query for and display the public parking lots within the boundaries of the map

Download

The library and the retrofit adapter are available on Maven Central:

Library:

dependencies {
    compile 'hu.supercluster:overpasser:0.2.2'
}

Retrofit adapter (for version 2.1.0):

dependencies {
    compile 'hu.supercluster:overpasser-retrofit-adapter:0.2.2'
}

Retrofit legacy adapter (for version 1.9):

dependencies {
    compile 'hu.supercluster:overpasser-retrofit-legacy-adapter:0.2.2'
}

Please note: This is not a production ready library. Use it at your own risk.

Contributing

Contributions are welcome! Please check the Contribution Guidelines.

License

Copyright 2015 Zsolt Kocsi

Licensed 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.