java.lang.Object | |
↳ | com.esri.core.tasks.ags.geocode.LocatorFindParameters |
The class holding the parameters to support the find operation for a geocoding
service.
The find operation of a geocoding service is used for single field geocoding, such as:
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
protected GeocodeParametersInternal | params |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
LocatorFindParameters(String text)
Constructs a FindParameters object with the given the search text.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
boolean | equals(Object obj) | ||||||||||
double |
getDistance()
Returns the search distance (in meters).
| ||||||||||
SpatialReference |
getInSR()
Returns the spatial reference of search extent.
| ||||||||||
Point |
getLocation()
Returns the search location.
| ||||||||||
int |
getMaxLocations()
Returns the maximum number for the returned candidates.
| ||||||||||
List<String> |
getOutFields()
Return a list of fields to be returned in the response.
| ||||||||||
SpatialReference |
getOutSR()
Returns the spatial reference of the xy coordinates for the geocode request.
| ||||||||||
Envelope |
getSearchExtent()
Returns searching extent;.
| ||||||||||
String |
getSourceCountry()
string value representing the country.
| ||||||||||
String |
getText()
Returns the search text string.
| ||||||||||
int | hashCode() | ||||||||||
void |
setDistance(double distance)
Sets the search distance.
| ||||||||||
void |
setLocation(Point location, SpatialReference sr)
Sets the search location.
| ||||||||||
void |
setMaxLocations(int maxLocations)
Sets the maximum number for returned candidates.
| ||||||||||
void |
setOutFields(List<String> outFields)
Sets a list of fields to be returned in the response.
| ||||||||||
void |
setOutSR(SpatialReference outSR)
Sets the spatial reference for the xy coordinates returned by the geocode request.
| ||||||||||
void |
setSearchExtent(Envelope searchExtent, SpatialReference inSR)
Sets the search extent.
| ||||||||||
void |
setSourceCountry(String sourceCountry)
Sets a string value representing the country.
| ||||||||||
void |
setText(String text)
Sets the search text.
| ||||||||||
String | toString() |
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
|
Constructs a FindParameters object with the given the search text.
text | a String for address, Points of interest (POI), a postal code. |
---|
Returns the search distance (in meters).
Returns the spatial reference of search extent.
Returns the maximum number for the returned candidates.
Return a list of fields to be returned in the response.
Returns the spatial reference of the xy coordinates for the geocode request.
Sets the search distance.
distance | the distance to set |
---|
Sets the search location.
location | the location to set |
---|---|
sr | SpatialReference of the point. |
Sets the maximum number for returned candidates. The default number is 10;
maxLocations | an integer |
---|
Sets a list of fields to be returned in the response.
outFields | a list field names |
---|
Sets the spatial reference for the xy coordinates returned by the geocode request.
outSR | SpatialReference a spatial reference the location candidates will be projected to |
---|
Sets the search extent.
searchExtent | an Envelope object. |
---|---|
inSR | the spatial reference of the Envelope object. |
Sets a string value representing the country. Providing this value increases geocoding speed. e.g. "USA"
sourceCountry | a String |
---|