net.rim.device.api.lbs.maps.server.exchange
Class ReverseGeocodeExchange

java.lang.Object
  extended by net.rim.device.api.lbs.maps.server.exchange.ServerExchange
      extended by net.rim.device.api.lbs.maps.server.exchange.TleServerExchange
          extended by net.rim.device.api.lbs.maps.server.exchange.ReverseGeocodeExchange

public final class ReverseGeocodeExchange
extends TleServerExchange

Handles the building and parsing of a reverse geocoding request.

When a request for reverse geocoding is made through the ReverseGeocoder, the results are placed in an instance of this class.

Since:
BlackBerry API 7.0.0

Field Summary
static int ADDRESS
          Use this constant to request the nearest address or nearest street to the specified latitude/longitude.
static int CITY
          Use this constant for reverse geocoding requests to return a value at the city level.
static int COUNTRY
          Use this constant for reverse geocoding requests to return a value at the country level.
static int MCC
          Use this to constant for reverse geocoding requests to return a value at the Mobile Country Code (MCC) level.
static int POSTAL
          Use this to constant for reverse geocoding requests to return a value at the postal/zip code level.
static int PROVINCE_STATE
          Use this constant for reverse geocoding requests to return a value at the province/state level.
static int TIME_ZONE_ID
          Use this to constant for reverse geocoding requests to return the time zone ID.
 
Method Summary
 int getAdminBoundary()
          Retrieves the administrative level boundary that is used for this request.
 LatLonRectangle getBoundingBox()
          Retrieves the bounding box that encompasses the result.
 MapPoint getOrigin()
          Retrieves the location point coordinates for this reverse geocoding request.
 Vector getResults()
          Retrieves the search results.
 
Methods inherited from class net.rim.device.api.lbs.maps.server.exchange.ServerExchange
getExceptionList, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 



Field Detail

ADDRESS

public static final int ADDRESS
Use this constant to request the nearest address or nearest street to the specified latitude/longitude.

If the nearest address cannot be found, the nearest administrative region will be returned. This could be a combination of city, state/province and/or country depending on whether the location is inside one of these boundaries.

See Also:
Constant Field Values
Since:
BlackBerry API 7.0.0

COUNTRY

public static final int COUNTRY
Use this constant for reverse geocoding requests to return a value at the country level. This returns the name of the country.

See Also:
Constant Field Values
Since:
BlackBerry API 7.0.0

PROVINCE_STATE

public static final int PROVINCE_STATE
Use this constant for reverse geocoding requests to return a value at the province/state level. This returns the name of the province/state and country.

See Also:
Constant Field Values
Since:
BlackBerry API 7.0.0

CITY

public static final int CITY
Use this constant for reverse geocoding requests to return a value at the city level. This returns the name of the city, province/state and country.

See Also:
Constant Field Values
Since:
BlackBerry API 7.0.0

POSTAL

public static final int POSTAL
Use this to constant for reverse geocoding requests to return a value at the postal/zip code level. This will return the postal/zip code, province/state and country.

See Also:
Constant Field Values
Since:
BlackBerry API 7.0.0

MCC

public static final int MCC
Use this to constant for reverse geocoding requests to return a value at the Mobile Country Code (MCC) level. This returns the MMC, city, province/state and country.

See Also:
Constant Field Values
Since:
BlackBerry API 7.0.0

TIME_ZONE_ID

public static final int TIME_ZONE_ID
Use this to constant for reverse geocoding requests to return the time zone ID.

See Also:
Constant Field Values
Since:
BlackBerry API 7.0.0


Method Detail

getResults

public Vector getResults()
Retrieves the search results.

Returns:
A Vector of matched locations.
Since:
BlackBerry API 7.0.0

getAdminBoundary

public int getAdminBoundary()
Retrieves the administrative level boundary that is used for this request.

Returns:
The administrative boundary, which could be one of the following:
Since:
BlackBerry API 7.0.0

getOrigin

public MapPoint getOrigin()
Retrieves the location point coordinates for this reverse geocoding request.

Returns:
The location coordinates.
Since:
BlackBerry API 7.0.0

getBoundingBox

public LatLonRectangle getBoundingBox()
Retrieves the bounding box that encompasses the result.

Returns:
The bounding box that is determined by the location server.
Since:
BlackBerry API 7.0.0





Copyright 1999-2011 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Java is a trademark of Oracle America Inc. in the US and other countries.
Legal