FileDocCategorySizeDatePackage
Geocoder.javaAPI DocAndroid 1.5 API10671Wed May 06 22:42:00 BST 2009android.location

Geocoder

public final class Geocoder extends Object
A class for handling geocoding and reverse geocoding. Geocoding is the process of transforming a street address or other description of a location into a (latitude, longitude) coordinate. Reverse geocoding is the process of transforming a (latitude, longitude) coordinate into a (partial) address. The amount of detail in a reverse geocoded location description may vary, for example one might contain the full street address of the closest building, while another might contain only a city name and postal code. The Geocoder class requires a backend service that is not included in the core android framework. The Geocoder query methods will return an empty list if there no backend service in the platform.

Fields Summary
private static final String
TAG
private String
mLanguage
private String
mCountry
private String
mVariant
private String
mAppName
private ILocationManager
mService
Constructors Summary
public Geocoder(android.content.Context context, Locale locale)
Constructs a Geocoder whose responses will be localized for the given Locale.

param
context the Context of the calling Activity
param
locale the desired Locale for the query results
throws
NullPointerException if Locale is null


                                            
         
        if (locale == null) {
            throw new NullPointerException("locale == null");
        }
        mLanguage = locale.getLanguage();
        mCountry = locale.getCountry();
        mVariant = locale.getVariant();
        mAppName = context.getPackageName();

        IBinder b = ServiceManager.getService(Context.LOCATION_SERVICE);
        mService = ILocationManager.Stub.asInterface(b);
    
public Geocoder(android.content.Context context)
Constructs a Geocoder whose responses will be localized for the default system Locale.

param
context the Context of the calling Activity

        this(context, Locale.getDefault());
    
Methods Summary
public java.util.ListgetFromLocation(double latitude, double longitude, int maxResults)
Returns an array of Addresses that are known to describe the area immediately surrounding the given latitude and longitude. The returned addresses will be localized for the locale provided to this class's constructor.

The returned values may be obtained by means of a network lookup. The results are a best guess and are not guaranteed to be meaningful or correct. It may be useful to call this method from a thread separate from your primary UI thread.

param
latitude the latitude a point for the search
param
longitude the longitude a point for the search
param
maxResults max number of addresses to return. Smaller numbers (1 to 5) are recommended
return
a list of Address objects. Returns null or empty list if no matches were found or there is no backend service available.
throws
IllegalArgumentException if latitude is less than -90 or greater than 90
throws
IllegalArgumentException if longitude is less than -180 or greater than 180
throws
IOException if the network is unavailable or any other I/O problem occurs

        if (latitude < -90.0 || latitude > 90.0) {
            throw new IllegalArgumentException("latitude == " + latitude);
        }
        if (longitude < -180.0 || longitude > 180.0) {
            throw new IllegalArgumentException("longitude == " + longitude);
        }
        try {
            List<Address> results = new ArrayList<Address>();
            String ex =  mService.getFromLocation(latitude, longitude, maxResults,
                mLanguage, mCountry, mVariant, mAppName, results);
            if (ex != null) {
                throw new IOException(ex);
            } else {
                return results;
            }
        } catch (RemoteException e) {
            Log.e(TAG, "getFromLocation: got RemoteException", e);
            return null;
        }
    
public java.util.ListgetFromLocationName(java.lang.String locationName, int maxResults)
Returns an array of Addresses that are known to describe the named location, which may be a place name such as "Dalvik, Iceland", an address such as "1600 Amphitheatre Parkway, Mountain View, CA", an airport code such as "SFO", etc.. The returned addresses will be localized for the locale provided to this class's constructor.

The query will block and returned values will be obtained by means of a network lookup. The results are a best guess and are not guaranteed to be meaningful or correct. It may be useful to call this method from a thread separate from your primary UI thread.

param
locationName a user-supplied description of a location
param
maxResults max number of results to return. Smaller numbers (1 to 5) are recommended
return
a list of Address objects. Returns null or empty list if no matches were found or there is no backend service available.
throws
IllegalArgumentException if locationName is null
throws
IOException if the network is unavailable or any other I/O problem occurs

        if (locationName == null) {
            throw new IllegalArgumentException("locationName == null");
        }
        try {
            List<Address> results = new ArrayList<Address>();
            String ex = mService.getFromLocationName(locationName,
                0, 0, 0, 0, maxResults, mLanguage, mCountry, mVariant, mAppName, results);
            if (ex != null) {
                throw new IOException(ex);
            } else {
                return results;
            }
        } catch (RemoteException e) {
            Log.e(TAG, "getFromLocationName: got RemoteException", e);
            return null;
        }
    
public java.util.ListgetFromLocationName(java.lang.String locationName, int maxResults, double lowerLeftLatitude, double lowerLeftLongitude, double upperRightLatitude, double upperRightLongitude)
Returns an array of Addresses that are known to describe the named location, which may be a place name such as "Dalvik, Iceland", an address such as "1600 Amphitheatre Parkway, Mountain View, CA", an airport code such as "SFO", etc.. The returned addresses will be localized for the locale provided to this class's constructor.

You may specify a bounding box for the search results by including the Latitude and Longitude of the Lower Left point and Upper Right point of the box.

The query will block and returned values will be obtained by means of a network lookup. The results are a best guess and are not guaranteed to be meaningful or correct. It may be useful to call this method from a thread separate from your primary UI thread.

param
locationName a user-supplied description of a location
param
maxResults max number of addresses to return. Smaller numbers (1 to 5) are recommended
param
lowerLeftLatitude the latitude of the lower left corner of the bounding box
param
lowerLeftLongitude the longitude of the lower left corner of the bounding box
param
upperRightLatitude the latitude of the upper right corner of the bounding box
param
upperRightLongitude the longitude of the upper right corner of the bounding box
return
a list of Address objects. Returns null or empty list if no matches were found or there is no backend service available.
throws
IllegalArgumentException if locationName is null
throws
IllegalArgumentException if any latitude is less than -90 or greater than 90
throws
IllegalArgumentException if any longitude is less than -180 or greater than 180
throws
IOException if the network is unavailable or any other I/O problem occurs

        if (locationName == null) {
            throw new IllegalArgumentException("locationName == null");
        }
        if (lowerLeftLatitude < -90.0 || lowerLeftLatitude > 90.0) {
            throw new IllegalArgumentException("lowerLeftLatitude == "
                + lowerLeftLatitude);
        }
        if (lowerLeftLongitude < -180.0 || lowerLeftLongitude > 180.0) {
            throw new IllegalArgumentException("lowerLeftLongitude == "
                + lowerLeftLongitude);
        }
        if (upperRightLatitude < -90.0 || upperRightLatitude > 90.0) {
            throw new IllegalArgumentException("upperRightLatitude == "
                + upperRightLatitude);
        }
        if (upperRightLongitude < -180.0 || upperRightLongitude > 180.0) {
            throw new IllegalArgumentException("upperRightLongitude == "
                + upperRightLongitude);
        }
        try {
            ArrayList<Address> result = new ArrayList<Address>();
            String ex =  mService.getFromLocationName(locationName,
                lowerLeftLatitude, lowerLeftLongitude, upperRightLatitude, upperRightLongitude,
                maxResults, mLanguage, mCountry, mVariant, mAppName, result);
            if (ex != null) {
                throw new IOException(ex);
            } else {
                return result;
            }
        } catch (RemoteException e) {
            Log.e(TAG, "getFromLocationName: got RemoteException", e);
            return null;
        }