Pelias Android SDK

Android SDK for Pelias modular open-source geocoder.

License

License

GroupId

GroupId

com.mapzen.android
ArtifactId

ArtifactId

pelias-android-sdk
Last Version

Last Version

1.2.1
Release Date

Release Date

Type

Type

jar
Description

Description

Pelias Android SDK
Android SDK for Pelias modular open-source geocoder.
Project URL

Project URL

http://github.com/mapzen/pelias-android-sdk
Source Code Management

Source Code Management

http://github.com/mapzen/pelias-android-sdk

Download pelias-android-sdk

How to add to project

<!-- https://jarcasting.com/artifacts/com.mapzen.android/pelias-android-sdk/ -->
<dependency>
    <groupId>com.mapzen.android</groupId>
    <artifactId>pelias-android-sdk</artifactId>
    <version>1.2.1</version>
</dependency>
// https://jarcasting.com/artifacts/com.mapzen.android/pelias-android-sdk/
implementation 'com.mapzen.android:pelias-android-sdk:1.2.1'
// https://jarcasting.com/artifacts/com.mapzen.android/pelias-android-sdk/
implementation ("com.mapzen.android:pelias-android-sdk:1.2.1")
'com.mapzen.android:pelias-android-sdk:jar:1.2.1'
<dependency org="com.mapzen.android" name="pelias-android-sdk" rev="1.2.1">
  <artifact name="pelias-android-sdk" type="jar" />
</dependency>
@Grapes(
@Grab(group='com.mapzen.android', module='pelias-android-sdk', version='1.2.1')
)
libraryDependencies += "com.mapzen.android" % "pelias-android-sdk" % "1.2.1"
[com.mapzen.android/pelias-android-sdk "1.2.1"]

Dependencies

compile (7)

Group / Artifact Type Version
com.android.support » appcompat-v7 jar 25.1.0
com.android.support » support-v4 jar 25.1.0
com.squareup.okhttp3 : logging-interceptor jar 3.8.0
com.squareup.retrofit2 : retrofit jar 2.3.0
com.squareup.retrofit2 : converter-gson jar 2.3.0
javax.annotation : javax.annotation-api jar 1.2
com.github.frankiesardo : auto-parcel jar 0.3.1

Project Modules

There are no modules declared in this project.

Pelias Android SDK

Android SDK for Pelias

Circle CI

Usage

Pelias Android SDK is a client-side Java wrapper for Pelias plus Android specific integrations.

Initialization

The Pelias class provides a simple interface to the Pelias geocoder which can be included in your application.

Pelias pelias = new Pelias();

Suggest

The suggest endpoint provides fast type-ahead autocomplete results.

pelias.suggest("term to search", lat, lon, Callback<Result>);

Search

The search endpoint provides locally and globally relevant full-text search results for addresses and POIs.

pelias.search("term to search", lat, lon, Callback<Result>);

Custom Endpoint

If you have deployed your own instance of Pelias you can set it on the class before initializing.

Pelias pelias = new Pelias("https://your-pelias-domain.com");

Testing

The current strategy for testing involves mocking the service instance using a Retrofit interface which describes the paths to the API.

package com.mapzen.android;

import org.mockito.Mockito;

public class TestPelias extends Pelias {
  public TestPelias(PeliasService service) {
    super(service);
  }
  
  private class TestPeliasService implements PeliasService {
    @Override public Call<Result> getSuggest(@Query("text") String query,
        @Query("focus.point.lat") double lat, @Query("focus.point.lon") double lon) {
      return new TestCall();
    }
    ..
  }
  
  private class TestCall implements Call<Result> {
    @Override public Response<Result> execute() throws IOException {
      return Response.success(new Result());
    }

    @Override public void enqueue(Callback<Result> callback) {
      callback.onResponse(null, Response.success(new Result()));
    }
  }
}

Install

Download Jar

Download the latest AAR.

Maven

Include dependency using Maven.

<dependency>
  <groupId>com.mapzen.android</groupId>
  <artifactId>pelias-android-sdk</artifactId>
  <version>1.3.1</version>
</dependency>

Gradle

Include dependency using Gradle.

compile 'com.mapzen.android:pelias-android-sdk:1.3.1'
com.mapzen.android

Mapzen

Versions

Version
1.2.1
1.2.0
1.1.0
1.1.0-rc1
1.0.0
0.7.2
0.7.1
0.7
0.3.1
0.3
0.1