com.atakmap.android.user.geocode

Interface GeocodeManager.Geocoder

Enclosing class:

GeocodeManager

public static interface GeocodeManager.Geocoder

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() A freetext description used to describe to the user the actual geocoding capability.
java.util.List<android.location.Address>	getLocation(GeoPoint gp) The actual work required to turn a geopoint into an address.
java.util.List<android.location.Address>	getLocation(java.lang.String address, GeoBounds bounds) Given a freetext address and an optionally supplied geobounds, attempt to return an address.
java.lang.String	getTitle() A freetext title used to describe to the user the actual name of the geocoding capability.
java.lang.String	getUniqueIdentifier() Used to identify the Geocoder when the user selects it for use in the system.
boolean	testServiceAvailable()

Method Detail

getUniqueIdentifier

java.lang.String getUniqueIdentifier()

Used to identify the Geocoder when the user selects it for use in the system.

Returns:

the suggested return is a constant unique identifier for the specifc geocoder implementation.

getTitle

java.lang.String getTitle()

A freetext title used to describe to the user the actual name of the geocoding capability.

Returns:

a text string not guaranteed to be unique.

getDescription

java.lang.String getDescription()

A freetext description used to describe to the user the actual geocoding capability.

Returns:

a text string not guaranteed to be unique.

testServiceAvailable

boolean testServiceAvailable()

getLocation

java.util.List<android.location.Address> getLocation(GeoPoint gp)

The actual work required to turn a geopoint into an address.

Parameters:

gp - the geopoint

Returns:

the android address.

getLocation

java.util.List<android.location.Address> getLocation(java.lang.String address,
                                                     GeoBounds bounds)

Given a freetext address and an optionally supplied geobounds, attempt to return an address. the GeoBounds can be null.

Returns:

a list of Addresses containing the latitude and longitude. For the purposes of display in ATAK, the address lines are the only thing looked at.