org.opennms.features.geocoder

Interface GeocoderService

All Known Implementing Classes:

GoogleGeocoderService, MapquestGeocoderService, NominatimGeocoderService

public interface GeocoderService

A GeocoderService capable of resolving an address string to actual coordinates.

Author:

mvrueden

Method Summary

Modifier and Type	Method and Description
GeocoderConfiguration	getConfiguration() Returns configuration of the GeocoderService.
String	getId() A unique identifier for this GeocoderService.
GeocoderResult	resolveAddress(String address) Resolves the given address string to valid coordinates.
void	validateConfiguration(Map<String,Object> properties) Validates the provided configuration properties.

Method Detail

getId

String getId()

A unique identifier for this GeocoderService.

Returns:

The unique identifier for this GeocoderService.

resolveAddress

GeocoderResult resolveAddress(String address)
                       throws GeocoderConfigurationException

Resolves the given address string to valid coordinates. Originally it returned only the Coordinates but that makes it hard to distinguish if there was no valid address or an exception occurred.

Parameters:

address - The address to resolve

Returns:

The result of the resolution

Throws:

GeocoderException

GeocoderConfigurationException

getConfiguration

GeocoderConfiguration getConfiguration()

Returns configuration of the GeocoderService.

Returns:

configuration.

validateConfiguration

void validateConfiguration(Map<String,Object> properties)
                    throws GeocoderConfigurationException

Validates the provided configuration properties.

Parameters:

properties - to validate

Throws:

GeocoderConfigurationException - in case the configuration is invalid.