com.here.android.mpa.search

Class ReverseGeocodeRequest

java.lang.Object

com.here.android.mpa.search.Request<Location>

com.here.android.mpa.search.ReverseGeocodeRequest

public class ReverseGeocodeRequest
extends Request<Location>

The ReverseGeocodeRequest represents an extended Request used to retrieve Location data by way of Geocoder search services.

Note: the response to a ReverseGeocodeRequest is a single Location object.

Nested Class Summary

Nested classes/interfaces inherited from class com.here.android.mpa.search.Request

Request.Connectivity

Field Summary

Fields inherited from class com.here.android.mpa.search.Request

BUILDING_ID_REFERENCE_NAME, m_addressFilter, m_collectionSize, m_connectivityMode, m_locale, m_mapViewport, m_pimpl, m_referenceNames, m_requestConnectivity, m_richTextFormatting, m_userAuthToken, PLACE_CONTENT_WIKIPEDIA, PVID_ID_REFERENCE_NAME, VENUES_CONTENT_ID_REFERENCE_NAME, VENUES_DESTINATION_ID_REFERENCE_NAME, VENUES_ID_REFERENCE_NAME, VENUES_VENUE_ID_REFERENCE_NAME

Constructor Summary

Constructors

Constructor and Description
ReverseGeocodeRequest(GeoCoordinate location) Creates a reverse geocode request that resolves a GeoCoordinate into an Location.
ReverseGeocodeRequest(GeoCoordinate location, ReverseGeocodeMode mode, float bearing) Creates a reverse geocode request that resolves a GeoCoordinate into an Location.

Method Summary

Modifier and Type	Method and Description
ErrorCode	execute(ResultListener<Location> listener) Executes an asynchronous request.

Methods inherited from class com.here.android.mpa.search.Request

addCustomHeader, addReference, cancel, determineConnectivityMode, getCollectionSize, getConnectivity, getLocale, getReferences, setCollectionSize, setConnectivity, setLocale, setMapViewport, setUserAuthentication

Methods inherited from class java.lang.Object

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

Constructor Detail

ReverseGeocodeRequest

public ReverseGeocodeRequest(GeoCoordinate location)

Creates a reverse geocode request that resolves a GeoCoordinate into an Location.

Parameters:

location - A GeoCoordinate representing the query location context.

Throws:

java.lang.IllegalArgumentException - Upon a failure to handle a passed argument.

ReverseGeocodeRequest

public ReverseGeocodeRequest(GeoCoordinate location,
                             ReverseGeocodeMode mode,
                             float bearing)

Creates a reverse geocode request that resolves a GeoCoordinate into an Location.

Parameters:

location - A GeoCoordinate representing the query location context.

mode - A ReverseGeocodeMode mode in which the response should be filtered.

bearing - A bearing expresses the direction in which the vehicle is heading in degrees starting at true North and continuing clockwise around the compass. Ignored if mode is not equal to ReverseGeocodeMode.TRACK_POSITION.

Throws:

java.lang.IllegalArgumentException - Upon a failure to handle a passed argument.

Method Detail

execute

public ErrorCode execute(ResultListener<Location> listener)

Executes an asynchronous request.

Overrides:

execute in class Request<Location>

Parameters:

listener - A ResultListener passed along with the request to monitor progress

Returns:

The ErrorCode representing an appropriate result

Note:

The ErrorCode.SERVICE_UNAVAILABLE can be returned if current search service is unavailable for your region. For more information see the Developer's Guide.