Class SuggestParameters
- java.lang.Object
-
- com.esri.arcgisruntime.tasks.geocode.SuggestParameters
-
public final class SuggestParameters extends java.lang.Object
Holds parameters to be passed to suggest operations.- Since:
- 100.0.0
- See Also:
LocatorTask.suggestAsync(String, SuggestParameters)
-
-
Constructor Summary
Constructors Constructor Description SuggestParameters()
Constructs a SuggestParameters with default settings.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.List<java.lang.String>
getCategories()
Gets a mutable list of categories used to filter the results of the suggest operation.java.lang.String
getCountryCode()
Gets the country code used to filter the results of the suggest operation.int
getMaxResults()
Gets the maximum number of results to be returned by the suggest operation.Point
getPreferredSearchLocation()
Gets the preferred search location.Geometry
getSearchArea()
Gets the search area used to filter the results of the suggest operation.void
setCountryCode(java.lang.String countryCode)
Sets the country code used to filter the results of the suggest operation.void
setMaxResults(int maxResults)
Sets the maximum number of results to be returned by the suggest operation.void
setPreferredSearchLocation(Point preferredSearchLocation)
Sets the preferred search location.void
setSearchArea(Geometry searchArea)
Sets the search area used to filter the results of the suggest operation.
-
-
-
Method Detail
-
getCategories
public java.util.List<java.lang.String> getCategories()
Gets a mutable list of categories used to filter the results of the suggest operation. Initially this is an empty list which means no category filtering is done. Add entries to this list for each category for which results are required. Categories represent address and place types, for example "city", "school", "Ski Resort".- Returns:
- the list of categories used to filter suggest results
- Since:
- 100.0.0
-
getCountryCode
public java.lang.String getCountryCode()
Gets the country code used to filter the results of the suggest operation.- Returns:
- the country code, or an empty String if none has been set
- Since:
- 100.0.0
-
setCountryCode
public void setCountryCode(java.lang.String countryCode)
Sets the country code used to filter the results of the suggest operation. By default no such filtering is done.- Parameters:
countryCode
- the country code- Since:
- 100.0.0
-
getMaxResults
public int getMaxResults()
Gets the maximum number of results to be returned by the suggest operation.- Returns:
- the maximum number of results, in the range [1..15]
- Since:
- 100.0.0
-
setMaxResults
public void setMaxResults(int maxResults)
Sets the maximum number of results to be returned by the suggest operation. The default value is 5.- Parameters:
maxResults
- the maximum number of results, in the range [1..15]- Since:
- 100.0.0
-
getPreferredSearchLocation
public Point getPreferredSearchLocation()
Gets the preferred search location.- Returns:
- the preferred search location point, or null if none has been set
- Since:
- 100.0.0
-
setPreferredSearchLocation
public void setPreferredSearchLocation(Point preferredSearchLocation)
Sets the preferred search location. This defines an origin point location that is used to sort the SuggestResults based on their proximity to the location. The priority of results within a radius of 2000 meters (for online geocoding services) or 50000 meters (for offline locators) is boosted relative to those outside that radius. By default no preferred search location is set.- Parameters:
preferredSearchLocation
- the preferred search location point- Since:
- 100.0.0
-
getSearchArea
public Geometry getSearchArea()
Gets the search area used to filter the results of the suggest operation. This is a bounding rectangle outside which results are not returned.- Returns:
- a Geometry specifying the search area, or null if none has been set
- Since:
- 100.0.0
-
setSearchArea
public void setSearchArea(Geometry searchArea)
Sets the search area used to filter the results of the suggest operation. This is a bounding rectangle outside which results are not returned. By default no preferred search area is set.- Parameters:
searchArea
- an Envelope specifying the search area- Since:
- 100.0.0
-
-