public class

LocatorFindParameters

extends Object
java.lang.Object
   ↳ com.esri.core.tasks.ags.geocode.LocatorFindParameters

Class Overview

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:

  • Street addresses: 380 New York St, Redlands, CA 92373
  • Administrative place names, such as city/county/state/province/country names: Seattle, Washington
  • Postal codes: 92591 USA
  • Points of interest (POI) and businesses: Disneyland,banks in Paris

Summary

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

Fields

protected GeocodeParametersInternal params

Public Constructors

public LocatorFindParameters (String text)

Constructs a FindParameters object with the given the search text.

Parameters
text a String for address, Points of interest (POI), a postal code.

Public Methods

public boolean equals (Object obj)

public double getDistance ()

Returns the search distance (in meters).

Returns
  • double

public SpatialReference getInSR ()

Returns the spatial reference of search extent.

Returns
  • the spatial reference of the search extent

public Point getLocation ()

Returns the search location.

Returns
  • the location a Point.

public int getMaxLocations ()

Returns the maximum number for the returned candidates.

Returns
  • an integer

public List<String> getOutFields ()

Return a list of fields to be returned in the response.

Returns
  • a list field names

public SpatialReference getOutSR ()

Returns the spatial reference of the xy coordinates for the geocode request.

Returns
  • SpatialReference a spatial reference the location candidates will be projected to

public Envelope getSearchExtent ()

Returns searching extent;.

Returns
  • an Envelope object.

public String getSourceCountry ()

string value representing the country.

Returns
  • a String.

public String getText ()

Returns the search text string.

Returns
  • search text string

public int hashCode ()

public void setDistance (double distance)

Sets the search distance.

Parameters
distance the distance to set

public void setLocation (Point location, SpatialReference sr)

Sets the search location.

Parameters
location the location to set
sr SpatialReference of the point.

public void setMaxLocations (int maxLocations)

Sets the maximum number for returned candidates. The default number is 10;

Parameters
maxLocations an integer

public void setOutFields (List<String> outFields)

Sets a list of fields to be returned in the response.

Parameters
outFields a list field names

public void setOutSR (SpatialReference outSR)

Sets the spatial reference for the xy coordinates returned by the geocode request.

Parameters
outSR SpatialReference a spatial reference the location candidates will be projected to

public void setSearchExtent (Envelope searchExtent, SpatialReference inSR)

Sets the search extent.

Parameters
searchExtent an Envelope object.
inSR the spatial reference of the Envelope object.

public void setSourceCountry (String sourceCountry)

Sets a string value representing the country. Providing this value increases geocoding speed. e.g. "USA"

Parameters
sourceCountry a String

public void setText (String text)

Sets the search text.

Parameters
text the text

public String toString ()