com.mapinfo.geocode.service

Class GeocodeServiceResponse

java.lang.Object

com.mapinfo.geocode.service.GeocodeServiceResponse

public class GeocodeServiceResponse
extends Object

This class holds return information from a geocode or reverse geocode request

Constructor Summary

Constructors

Constructor and Description
GeocodeServiceResponse(Response internalResponse) The only constructor takes the response from the engine level and converts to use all concrete objects to avoid classes defined by interfaces at the web service API level.

Method Summary

Modifier and Type	Method and Description
List<Candidate>	getCandidates() Returns the list of candidates.
Set<String>	getCustomFieldKeys()
String	getCustomFieldValue(String key)
Map<String,String>	getCustomValues()
int	getTotalMatches() For a regular geocode, we list the number of possible candidates that are considered "close" with respect to the input address.
int	getTotalPossibleCandidates() For a reverse geocode, only one candidate can ever be returned.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

GeocodeServiceResponse

public GeocodeServiceResponse(Response internalResponse)
                       throws GeocodingException

The only constructor takes the response from the engine level and converts to use all concrete objects to avoid classes defined by interfaces at the web service API level.

Parameters:

internalResponse - the response from the internal API layer.

Throws:

GeocodingException - if internalResponse is null or data is unlicensed

Method Detail

getCandidates

public List<Candidate> getCandidates()

Returns the list of candidates. An empty list indicates no candidates found and is not an error. For reverse geocode, the list will only contain a single candidate.

Returns:

list of candidate addresses from geocoding engine

getTotalPossibleCandidates

public int getTotalPossibleCandidates()

For a reverse geocode, only one candidate can ever be returned. But for a regular geocode, we may find a large number of candidates, and only return a few. This allows us to see how many candidates were actually found

Returns:

number of candidates found

getTotalMatches

public int getTotalMatches()

For a regular geocode, we list the number of possible candidates that are considered "close" with respect to the input address. This may exceed the number of candidates actually returned. For reverse geocode, "close" has no meaning and we will always return 1.

Returns:

number of close candidates found

toString

public String toString()

Overrides:

toString in class Object

getCustomValues

public Map<String,String> getCustomValues()

getCustomFieldKeys

public Set<String> getCustomFieldKeys()

getCustomFieldValue

public String getCustomFieldValue(String key)