java.lang.Object
com.esri.arcgisruntime.tasks.geocode.LocatorInfo

public final class LocatorInfo extends Object
Holds information about a LocatorTask.
Since:
100.0.0
See Also:
  • Method Details Link icon

    • getName Link icon

      public String getName()
      Gets the name of the LocatorTask.
      Returns:
      the name
      Since:
      100.0.0
    • getDescription Link icon

      public String getDescription()
      Gets the description of the LocatorTask.
      Returns:
      the description
      Since:
      100.0.0
    • getResultAttributes Link icon

      public List<LocatorAttribute> getResultAttributes()
      Gets the attributes that can be returned in the results of geocode or reverse geocode operations.
      Returns:
      an unmodifiable List of locator attributes
      Since:
      100.0.0
      See Also:
    • getIntersectionResultAttributes Link icon

      public List<LocatorAttribute> getIntersectionResultAttributes()
      Gets the attribute fields that can be returned in the results of geocode or reverse geocode operations when searching for street intersections.
      Returns:
      an unmodifiable List of locator attributes
      Since:
      100.0.0
      See Also:
    • getSearchAttributes Link icon

      public List<LocatorAttribute> getSearchAttributes()
      Gets the search attributes that can be used as inputs to multi-line geocode operations.
      Returns:
      an unmodifiable List of search attributes
      Since:
      100.0.0
      See Also:
    • getProperties Link icon

      public Map<String,String> getProperties()
      Gets the locator properties. For example, MinimumCandidateScore, SideOffsetUnits, SpellingSensitivity, MinimumMatchScore and so on.
      Returns:
      an unmodifiable Map; the keys are Strings containing the names of the properties and the values are Strings containing the values of the properties
      Since:
      100.0.0
    • getSpatialReference Link icon

      public SpatialReference getSpatialReference()
      Gets the default spatial reference.
      Returns:
      the default spatial reference
      Since:
      100.0.0
    • isSupportsIntersections Link icon

      public boolean isSupportsIntersections()
      Indicates if the LocatorTask supports geocoding of intersections.
      Returns:
      true if it supports intersections
      Since:
      100.0.0
    • isSupportsSuggestions Link icon

      public boolean isSupportsSuggestions()
      Indicates if the LocatorTask supports suggestions.
      Returns:
      true if it supports suggestions
      Since:
      100.0.0
    • isSupportsPoi Link icon

      public boolean isSupportsPoi()
      Indicates if the LocatorTask supports geocoding of Points Of Interest.
      Returns:
      true if it supports Points Of Interest
      Since:
      100.0.0
    • isSupportsAddresses Link icon

      public boolean isSupportsAddresses()
      Indicates if the LocatorTask supports geocoding of addresses (point addresses or street addresses). If supported, these can be specified as x/y coordinate pairs in the search text for geocode operations, where the spatial reference of the coordinates is WGS84. For example:
       future = locatorTask.geocodeAsync("-115.172783,36.114789");
       
      Returns:
      true if it supports point or street addresses
      Since:
      100.0.0
    • getVersion Link icon

      public String getVersion()
      Gets the version of the LocatorTask.
      Returns:
      the version
      Since:
      100.0.0