|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.esri.adf.web.ags.data.AGSGeocodeFunctionality
public class AGSGeocodeFunctionality
Field Summary | |
---|---|
protected HashMap<String,Object> |
address
|
protected AGSGeocodeResource |
agsgeo
|
protected HashMap<String,String> |
aliases
|
protected boolean |
fetchAddressDetails
|
protected String[] |
fields
|
static String |
MATCH_ADDRESS_FIELD_NAME
|
static String |
MINIMUM_CANDIDATE_SCORE
|
protected com.esri.arcgisws.PropertySet |
mods
|
static String |
OUTPUT_SPATIAL_REFERENCE
|
static String |
SCORE_FIELD_NAME
|
Fields inherited from interface com.esri.adf.web.data.GeocodeFunctionality |
---|
FUNCTIONALITY_NAME |
Constructor Summary | |
---|---|
AGSGeocodeFunctionality()
|
Method Summary | |
---|---|
protected com.esri.arcgisws.PropertySet |
createAddressPropertySet()
|
void |
destroyFunctionality()
The cleanup chores (such as releasing held resources) for the functionality must be performed in this method. |
List<AddressCandidate> |
findAddressCandidates()
Returns a List of AddressCandidate s based on the current set of address field values . |
String |
generateAddressString()
|
AddressCandidate |
geocodeAddress()
Geocodes a single address based on the current set of address field values . |
String |
getAddressFieldAlias(String fieldName)
Returns an alias for the given address field . |
String[] |
getAddressFields()
Returns an array of address fields for this geocoder. |
String |
getAddressFieldValue(String fieldName)
Returns the value for a given address field . |
int |
getMinScore()
|
AGSGeocodeResource |
getResource()
Returns the GISResource associated with this functionality. |
void |
initFunctionality(GISResource resource)
The initialization chores for the functionality must be performed in this method. |
boolean |
isFetchAddressDetails()
|
void |
setAddressFieldValue(String fieldName,
String value)
Sets the value for a given address field . |
void |
setFetchAddressDetails(boolean fetchAddressDetails)
|
void |
setMinScore(int minScore)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected AGSGeocodeResource agsgeo
protected String[] fields
protected HashMap<String,String> aliases
protected HashMap<String,Object> address
protected com.esri.arcgisws.PropertySet mods
protected boolean fetchAddressDetails
public static final String SCORE_FIELD_NAME
public static final String MATCH_ADDRESS_FIELD_NAME
public static final String MINIMUM_CANDIDATE_SCORE
public static final String OUTPUT_SPATIAL_REFERENCE
Constructor Detail |
---|
public AGSGeocodeFunctionality()
Method Detail |
---|
public void initFunctionality(GISResource resource)
GISFunctionality
The initialization chores for the functionality must be performed in this method. This method is called by the
resource
when the functionality needs to be initialized. This happens either when the resource
itself is being initialized or if users add this functionality to the resource using the
GISResource.addFunctionality(String, GISFunctionality)
method after the resource has already
been initialized.
Classes which implement this method should maintain the resource
as a class instance variable and
return the same in the GISFunctionality.getResource()
method. The functionality is ready for use only after this method has
been called.
initFunctionality
in interface GISFunctionality
resource
- the GISResource
that this functionality supportsGISResource.init(WebContext)
public void destroyFunctionality()
GISFunctionality
The cleanup chores (such as releasing held resources) for the functionality must be performed in this method. This
method is called by the GISResource
when the resource itself is being destroyed.
The functionality is no longer usable after this method has been called.
destroyFunctionality
in interface GISFunctionality
GISResource.destroy()
public String[] getAddressFields()
GeocodeFunctionality
Returns an array of address fields for this geocoder. Every implementation of GeocodeFunctionality
defines the address fields that are available.
The GeocodeTask
dynamically generates input text box for each address field.
getAddressFields
in interface GeocodeFunctionality
String
array of address fields for this geocoderpublic void setAddressFieldValue(String fieldName, String value)
GeocodeFunctionality
Sets the value for a given address field
.
setAddressFieldValue
in interface GeocodeFunctionality
fieldName
- the address field for which the value is to be setvalue
- the value for the given address fieldpublic String getAddressFieldValue(String fieldName)
GeocodeFunctionality
Returns the value for a given address field
.
getAddressFieldValue
in interface GeocodeFunctionality
fieldName
- the address field for which the value is to be returned
public String getAddressFieldAlias(String fieldName)
GeocodeFunctionality
Returns an alias for the given address field
.
The GeocodeTask
labels the input text box for the address field with this alias.
getAddressFieldAlias
in interface GeocodeFunctionality
fieldName
- the address field for which the alias is to be returned
public AddressCandidate geocodeAddress()
GeocodeFunctionality
Geocodes a single address based on the current set of address field values
.
geocodeAddress
in interface GeocodeFunctionality
protected com.esri.arcgisws.PropertySet createAddressPropertySet()
public String generateAddressString()
public List<AddressCandidate> findAddressCandidates()
GeocodeFunctionality
Returns a List
of AddressCandidate
s based on the current set of address field values
.
findAddressCandidates
in interface GeocodeFunctionality
List
of AddressCandidate
s matching the current set of address field valuespublic AGSGeocodeResource getResource()
GISFunctionality
Returns the GISResource
associated with this functionality.
The resource passed to GISFunctionality.initFunctionality(GISResource)
is maintained as a class variable and is accessible
through this method.
getResource
in interface GISFunctionality
GISResource
associated with this functionalitypublic boolean isFetchAddressDetails()
public int getMinScore()
public void setMinScore(int minScore)
minScore
- the minScore to setpublic void setFetchAddressDetails(boolean fetchAddressDetails)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |