com.here.mobility.sdk.map.geocoding

Class GeocodingRequest

java.lang.Object

com.here.mobility.sdk.map.geocoding.GeocodingRequest

All Implemented Interfaces:

Parcelable

public abstract class GeocodingRequest
extends Object
implements Parcelable

A request to the geocoding service. This actually bundles three separate services:

1. Forward geocoding: given a textual query, find a list of places and/or addresses around a given location that match that query.
2. Reverse geocoding: given a location, find the address at that location.
3. Places around: given a location, find places of interest near that location.

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

Parcelable.ClassLoaderCreator<T>, Parcelable.Creator<T>

Field Summary

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
GeocodingRequest()

Method Summary

Modifier and Type	Method and Description
abstract String	getCountryCode() An optional ISO 3166 alpha 3 country code used to filter results.
abstract String	getLanguageCode() The ISO 639-1 language code for the preferred language of the results.
abstract LatLng	getLocation() The location around which to search for results.
abstract String	getQuery() The search query.
abstract Collection<GeocodingResult.Type>	getResultTypes() The result types to obtain.
static GeocodingRequest	newForwardRequest(String query, LatLng location) Creates a new forward geocoding request with the given query, around the given location.
static GeocodingRequest	newForwardRequest(String query, LatLng location, String languageCode) Creates a new forward geocoding request with the given query, around the given location, in the given preferred language.
static GeocodingRequest	newForwardRequest(String query, LatLng location, String countryCode, String languageCode, Collection<GeocodingResult.Type> resultTypes) Creates a new forward geocoding request with the given query, around the given location, in the given country, requesting results of the given types.
static GeocodingRequest	newPlacesAroundRequest(LatLng location) Creates a request for places around the given location.
static GeocodingRequest	newPlacesAroundRequest(LatLng location, String languageCode) Creates a request for places around the given location, in the given preferred language.
static GeocodingRequest	newReverseRequest(LatLng location) Creates a reverse geocoding request for the address at the given location.
static GeocodingRequest	newReverseRequest(LatLng location, String languageCode) Creates a reverse geocoding request for the address at the given location, in the given preferred language.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface android.os.Parcelable

describeContents, writeToParcel

Constructor Detail

GeocodingRequest

public GeocodingRequest()

Method Detail

newForwardRequest

public static GeocodingRequest newForwardRequest(String query,
                                                 LatLng location,
                                                 String countryCode,
                                                 String languageCode,
                                                 Collection<GeocodingResult.Type> resultTypes)

Creates a new forward geocoding request with the given query, around the given location, in the given country, requesting results of the given types.

Parameters:

query - The search query itself; must not be null or empty.

location - The location around which to search for results

countryCode - ISO 3166-1 alpha 3 country to code used filter results

languageCode - ISO 639-1 language code for the preferred language of the results

resultTypes - The result types to obtain

newForwardRequest

public static GeocodingRequest newForwardRequest(String query,
                                                 LatLng location,
                                                 String languageCode)

Creates a new forward geocoding request with the given query, around the given location, in the given preferred language.

Parameters:

query - The search query itself; may not be null or empty.

location - The location around which to search for results

languageCode - ISO 639-1 language code for the preferred language of the results

newForwardRequest

public static GeocodingRequest newForwardRequest(String query,
                                                 LatLng location)

Creates a new forward geocoding request with the given query, around the given location.

Parameters:

query - The search query itself; must not be null or empty.

location - The location around which to search for results

newReverseRequest

public static GeocodingRequest newReverseRequest(LatLng location,
                                                 String languageCode)

Creates a reverse geocoding request for the address at the given location, in the given preferred language.

Parameters:

location - The location whose address to return

languageCode - ISO 639-1 language code for the preferred language of the results

newReverseRequest

public static GeocodingRequest newReverseRequest(LatLng location)

Creates a reverse geocoding request for the address at the given location.

newPlacesAroundRequest

public static GeocodingRequest newPlacesAroundRequest(LatLng location,
                                                      String languageCode)

Creates a request for places around the given location, in the given preferred language.

Parameters:

location - The location around which to look for places

languageCode - ISO 639-1 language code for the preferred language of the results

newPlacesAroundRequest

public static GeocodingRequest newPlacesAroundRequest(LatLng location)

Creates a request for places around the given location.

getQuery

public abstract String getQuery()

The search query. Only used for forward geocoding requests, and is mandatory for them.

getLocation

public abstract LatLng getLocation()

The location around which to search for results.

getCountryCode

public abstract String getCountryCode()

An optional ISO 3166 alpha 3 country code used to filter results.

getLanguageCode

public abstract String getLanguageCode()

The ISO 639-1 language code for the preferred language of the results.

getResultTypes

public abstract Collection<GeocodingResult.Type> getResultTypes()

The result types to obtain.