org.opengts.geocoder
Interface ReverseGeocodeProvider

All Known Implementing Classes:

GeoNames, GisGraphy, GoogleGeocodeV2, GoogleGeocodeV3, Nominatim, ReverseGeocodeProviderAdapter, TinyGeocoder

public interface ReverseGeocodeProvider

Method Summary

ReverseGeocodeProvider	getFailoverReverseGeocodeProvider() Gets the failover ReverseGeocodeProvider
java.lang.String	getName() Returns the name of this ReverseGeocodeProvider
ReverseGeocode	getReverseGeocode(GeoPoint gp, java.lang.String localeStr, boolean cache) Returns the best address for the specified GeoPoint
boolean	isEnabled() Returns true if this ReverseGeocodeProvider is enabled
boolean	isFastOperation() Returns true if this operation will take less than about 20ms to complete the returned value is used to determine whether the 'getReverseGeocode' operation should be performed immediately, or lazily (ie.
void	setFailoverReverseGeocodeProvider(ReverseGeocodeProvider rgp) Sets the failover ReverseGeocodeProvider

Method Detail

getName

java.lang.String getName()

Returns the name of this ReverseGeocodeProvider

Returns:

The name of this ReverseGeocodeProvider

isEnabled

boolean isEnabled()

Returns true if this ReverseGeocodeProvider is enabled

Returns:

True if this ReverseGeocodeProvider is enabled, false otherwise

isFastOperation

boolean isFastOperation()

Returns true if this operation will take less than about 20ms to complete the returned value is used to determine whether the 'getReverseGeocode' operation should be performed immediately, or lazily (ie. in a separate thread).

Returns:

True if this is a fast (ie. local) operation

getReverseGeocode

ReverseGeocode getReverseGeocode(GeoPoint gp,
                                 java.lang.String localeStr,
                                 boolean cache)

Returns the best address for the specified GeoPoint

Returns:

The reverse-geocoded adress

setFailoverReverseGeocodeProvider

void setFailoverReverseGeocodeProvider(ReverseGeocodeProvider rgp)

Sets the failover ReverseGeocodeProvider

Parameters:

rgp - The failover ReverseGeocodeProvider

getFailoverReverseGeocodeProvider

ReverseGeocodeProvider getFailoverReverseGeocodeProvider()

Gets the failover ReverseGeocodeProvider

Returns:

The failover ReverseGeocodeProvider