Package com.esri.arcgisruntime.tasks.geocode

Class LocatorInfo

  • public final class LocatorInfo
extends java.lang.Object
    Holds information about a LocatorTask.
    Since:
    100.0.0
    See Also:
    LocatorTask

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDescription()
      Gets the description of the LocatorTask.
      java.util.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.
      java.lang.String getName()
      Gets the name of the LocatorTask.
      java.util.Map<java.lang.String,​java.lang.String> getProperties()
      Gets the locator properties.
      java.util.List<LocatorAttribute> getResultAttributes()
      Gets the attributes that can be returned in the results of geocode or reverse geocode operations.
      java.util.List<LocatorAttribute> getSearchAttributes()
      Gets the search attributes that can be used as inputs to multi-line geocode operations.
      SpatialReference getSpatialReference()
      Gets the default spatial reference.
      java.lang.String getVersion()
      Gets the version of the LocatorTask.
      boolean isSupportsAddresses()
      Indicates if the LocatorTask supports geocoding of addresses (point addresses or street addresses).
      boolean isSupportsIntersections()
      Indicates if the LocatorTask supports geocoding of intersections.
      boolean isSupportsPoi()
      Indicates if the LocatorTask supports geocoding of Points Of Interest.
      boolean isSupportsSuggestions()
      Indicates if the LocatorTask supports suggestions.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • getName

        public java.lang.String getName()
        Gets the name of the LocatorTask.
        Returns:
        the name
        Since:
        100.0.0

      • getDescription

        public java.lang.String getDescription()
        Gets the description of the LocatorTask.
        Returns:
        the description
        Since:
        100.0.0

      • getProperties

        public java.util.Map<java.lang.String,​java.lang.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

        public SpatialReference getSpatialReference()
        Gets the default spatial reference.
        Returns:
        the default spatial reference
        Since:
        100.0.0

      • isSupportsIntersections

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

      • isSupportsSuggestions

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

      • isSupportsPoi

        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

        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

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