Package com.massifmaps.geocoding

Class OSMOfflineReverseGeocodingService

java.lang.Object

com.massifmaps.geocoding.ReverseGeocodingService

com.massifmaps.geocoding.OSMOfflineReverseGeocodingService

public class OSMOfflineReverseGeocodingService
extends ReverseGeocodingService

A reverse geocoding service that uses custom geocoding database files.
Note: this class is experimental and may change or even be removed in future SDK versions.

Constructor Summary

Constructors

Constructor	Description
OSMOfflineReverseGeocodingService(String path)	Constructs a new instance of the OSMOfflineReverseGeocodingService given path to the geocoding database.

Method Summary

Modifier and Type	Method	Description
GeocodingResultVector	calculateAddresses(ReverseGeocodingRequest request)	Calculates matching addresses from the specified reverse geocoding request.
String	getLanguage()	Returns the language of the expected results.
void	setLanguage(String lang)	Sets the language of the expected results.

Methods inherited from class java.lang.Object

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

Constructor Details

OSMOfflineReverseGeocodingService

public OSMOfflineReverseGeocodingService(String path)
                                  throws IOException

Constructs a new instance of the OSMOfflineReverseGeocodingService given path to the geocoding database.

Parameters:

path - The full path to the geocoding database file.

Throws:

Exception - If the database file could not be opened or read.

IOException

Method Details

getLanguage

public String getLanguage()

Description copied from class: ReverseGeocodingService

Returns the language of the expected results.

Overrides:

getLanguage in class ReverseGeocodingService

Returns:

The language of the expected results. As ISO 639-1 code or empty string.

setLanguage

public void setLanguage(String lang)

Description copied from class: ReverseGeocodingService

Sets the language of the expected results.

Overrides:

setLanguage in class ReverseGeocodingService

Parameters:

lang - The language to use as ISO 639-1 code. Empty string can be used for default language.

calculateAddresses

public GeocodingResultVector calculateAddresses(ReverseGeocodingRequest request)
                                         throws IOException

Description copied from class: ReverseGeocodingService

Calculates matching addresses from the specified reverse geocoding request.

Overrides:

calculateAddresses in class ReverseGeocodingService

Parameters:

request - The reverse geocoding request to use.

Returns:

The list of matching geocoding results, sorted by descending ranks.

Throws:

IOException