oracle.panama.spatial.geocoder
Interface Geocoder

public interface Geocoder

This interface defines the functionality of a geocoder: computing lat/lon coordinates for an address.

Any class implementing this interface should be thread-safe.

Field Summary

static java.lang.String	MATCH_MODE_NORMAL The normal match mode
static java.lang.String	MATCH_MODE_RELAXED The relaxed match mode
static java.lang.String	MATCH_MODE_STANDARD The standard match mode
static java.lang.String	MATCH_MODE_TIGHT The tight match mode

Method Summary

Location[]	geocodeAddress(Location inp, java.lang.String matchMode) This returns an array of Location objects with the geocoded result.
Location[][]	geocodeAddresses(Location[] inp, java.lang.String matchMode) Bulk geocoding for an array of addresses.
Location	geocodeTelephone(java.lang.String tel, boolean requestLatLon) This function geocodes a telephone number.
Location[]	geocodeTelephones(java.lang.String[] tel, boolean requestLatLon) This function bulk-geocodes telephone numbers.
Location[]	reverseGeocodePoint(Point pt) This function reverse geocodes a point to result in a matching address.
Location[][]	reverseGeocodePoints(Point[] pt) This function reverse bulk-geocodes points to result in matching addresses.
java.lang.String[]	reverseGeocodeTelephone(Location addressWithName) This function reverse geocodes an address - thus finds a telephone numbers for this address.
java.lang.String[][]	reverseGeocodeTelephones(Location[] addressWithName) This function reverse bulk-geocodes addresses - thus finds telephone numbers for addresses.
java.lang.String	xmlGeocode(org.w3c.dom.Document xmlRequest) This function performs geocoding based on an XML request (eLocation XML).

Field Detail

MATCH_MODE_NORMAL

public static final java.lang.String MATCH_MODE_NORMAL

The normal match mode

See Also:

Constant Field Values

MATCH_MODE_RELAXED

public static final java.lang.String MATCH_MODE_RELAXED

The relaxed match mode

See Also:

Constant Field Values

MATCH_MODE_STANDARD

public static final java.lang.String MATCH_MODE_STANDARD

The standard match mode

See Also:

Constant Field Values

MATCH_MODE_TIGHT

public static final java.lang.String MATCH_MODE_TIGHT

The tight match mode

See Also:

Constant Field Values

Method Detail

geocodeAddress

public Location[] geocodeAddress(Location inp,
                                 java.lang.String matchMode)

This returns an array of Location objects with the geocoded result. If the address in unambiguous there will only be one result. This function MUST be implemented by each provider proxy. It is part of the required core functionality. Any provider not supporting this function might have serious restrictions in supporting any reasonable application. At the very least, such a "lacking" provider proxy could not be used as a "primary" provider. However, fail-over guarantees that applications would work if this function is covered by at least one provider proxy.

Parameters:

inp - a Location object representing an address to be geocoded

matchMode - a String representing the requested matchmode

Returns:

an array of Location objects representing the geocoded lat/lon

geocodeAddresses

public Location[][] geocodeAddresses(Location[] inp,
                                     java.lang.String matchMode)

Bulk geocoding for an array of addresses. This function MAY be implemented by a provider proxy. It is part of the optional functionality and some provider proxies do support it.

Parameters:

inp - an array of Location objects representing addresses to be geocoded

matchMode - a String representing the requested matchmode

Returns:

an array of arrays of Location objects representing the geocoded lat/lons

geocodeTelephone

public Location geocodeTelephone(java.lang.String tel,
                                 boolean requestLatLon)

This function geocodes a telephone number. This function MAY be implemented by a provider proxy. It is part of the optional functionality and some provider proxies do support it.

Parameters:

tel - a String representing the telephone number to geocode

requestLatLon - a boolean representing whether the actual lat/lon geocode is requested or just the textual address

Returns:

a Location

geocodeTelephones

public Location[] geocodeTelephones(java.lang.String[] tel,
                                    boolean requestLatLon)

This function bulk-geocodes telephone numbers. This function MAY be implemented by a provider proxy. It is part of the optional functionality and some provider proxies do support it.

Parameters:

tel - an array of String representing the telephone numbers to geocode

requestLatLon - a boolean representing whether the actual lat/lon geocode is requested or just the textual address

Returns:

an array of Location

reverseGeocodePoint

public Location[] reverseGeocodePoint(Point pt)

This function reverse geocodes a point to result in a matching address. This function MAY be implemented by a provider proxy. It is part of the optional functionality and some provider proxies do support it.

Parameters:

pt - a Point representing the location for which to find an address

Returns:

an array of Location representing the (possibly more than one) alternative addresses matching this point

reverseGeocodePoints

public Location[][] reverseGeocodePoints(Point[] pt)

This function reverse bulk-geocodes points to result in matching addresses. This function MAY be implemented by a provider proxy. It is part of the optional functionality and some provider proxies do support it.

Parameters:

pt - an array of Point representing the locations for which to find addresses

Returns:

an array of array of Locations representing the (possibly more than one) alternative addresses matching each point

reverseGeocodeTelephone

public java.lang.String[] reverseGeocodeTelephone(Location addressWithName)

This function reverse geocodes an address - thus finds a telephone numbers for this address. The address is required to contain a name to resolve ambiguity. This function MAY be implemented by a provider proxy. It is part of the optional functionality and some provider proxies do support it.

Parameters:

addressWithName - a Location representing the address to find a telephone number for

Returns:

a String array representing the telephone numbers

reverseGeocodeTelephones

public java.lang.String[][] reverseGeocodeTelephones(Location[] addressWithName)

This function reverse bulk-geocodes addresses - thus finds telephone numbers for addresses. The addresses are required to contain a name to resolve ambiguity. This function MAY be implemented by a provider proxy. It is part of the optional functionality and some provider proxies do support it.

Parameters:

addressWithName - an array of Locations representing the addresses to find telephone numbers for

Returns:

an array of array of String representing the telephone numbers

xmlGeocode

public java.lang.String xmlGeocode(org.w3c.dom.Document xmlRequest)

This function performs geocoding based on an XML request (eLocation XML). This function IS NOT TO BE implemented by any provider proxy. It is performed by the framework itself and translated to other functions.

Parameters:

xmlRequest - a Document object representing the XMl document of the geocoding request.

Returns:

a String representing the XMl String of the geocoding response.