com.esri.adf.web.data
Interface GeocodeFunctionality

All Superinterfaces:

GISFunctionality

All Known Implementing Classes:

AGSGeocodeFunctionality, AIMSGeocodeFunctionality, AWSGeocodeFunctionality, EJBGeocodeFunctionality

public interface GeocodeFunctionality
extends GISFunctionality

The GeocodeFunctionality interface is implemented by functionalities to provide geocoding capability for the resource. For instance, the AGSGeocodeFunctionality provides geocoding for ArcGIS Server resources, the AIMSGeocodeFunctionality provides geocoding for ArcIMS resources, et al.

The GeocodeTask works with geocode functionalities referenced by the resources by the name FUNCTIONALITY_NAME. The GeocodeTask collects the information from the user and uses this functionality to geocode addresses, find address candidates, get address fields, get and set address field values, etc.

Field Summary

static java.lang.String

FUNCTIONALITY_NAME The name that should be given to the GeocodeFunctionality in order for it to be consumed by the GeocodeTask

Method Summary

java.util.List<AddressCandidate>	findAddressCandidates() Returns a List of AddressCandidates matching the current set of address field values.
AddressCandidate	geocodeAddress() Geocodes a single address based on the current set of address field values.
java.lang.String	getAddressFieldAlias(java.lang.String fieldName) Returns an alias for the given address field.
java.lang.String[]	getAddressFields() Returns an array of address fields for this geocoder.
java.lang.String	getAddressFieldValue(java.lang.String fieldName) Returns the value for a given address field.
void	setAddressFieldValue(java.lang.String fieldName, java.lang.String value) Sets the value for a given address field.

Methods inherited from interface com.esri.adf.web.data.GISFunctionality

destroyFunctionality, getResource, initFunctionality

Field Detail

FUNCTIONALITY_NAME

static final java.lang.String FUNCTIONALITY_NAME

The name that should be given to the GeocodeFunctionality in order for it to be consumed by the GeocodeTask

See Also:

Constant Field Values

Method Detail

getAddressFields

java.lang.String[] getAddressFields()

Returns an array of address fields for this geocoder.

The GeocodeTask dynamically generates input text box for each address field.

Returns:

a String array of address fields for this geocoder

setAddressFieldValue

void setAddressFieldValue(java.lang.String fieldName,
                          java.lang.String value)

Sets the value for a given address field.

Parameters:

fieldName - the address field for which the value is to be set

value - the value for the given address field

getAddressFieldValue

java.lang.String getAddressFieldValue(java.lang.String fieldName)

Returns the value for a given address field.

Parameters:

fieldName - the address field for which the value is to be returned

Returns:

the value for the given address field

getAddressFieldAlias

java.lang.String getAddressFieldAlias(java.lang.String fieldName)

Returns an alias for the given address field.

The GeocodeTask labels the input text box for the address field with this alias.

Parameters:

fieldName - the address field for which the alias is to be returned

Returns:

the alias for the given address field

findAddressCandidates

java.util.List<AddressCandidate> findAddressCandidates()

Returns a List of AddressCandidates matching the current set of address field values.

Different implementations can have different criteria for matching the address candidates. Such criterion can be specified and configured in the implementation itself. The GeocodeTask itself is agnostic of such implementation specific criteria as it simply makes this call to find the matching address candidates.

Returns:

a List of AddressCandidates matching the current set of address field values

geocodeAddress

AddressCandidate geocodeAddress()

Geocodes a single address based on the current set of address field values.

Different implementations can have different criteria for geocoding the address. Such criterion can be specified and configured in the implementation itself. The GeocodeTask itself is agnostic of such implementation specific criteria as it simply makes this call to get the geocoded address.

Returns:

a single geocoded address