Package com.esri.arcgisruntime.tasks.geocode

Class ReverseGeocodeParameters

    • Constructor Summary

      Constructors 
      Constructor Description
      ReverseGeocodeParameters()
      Constructs a ReverseGeocodeParameters with default settings.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.List<java.lang.String> getFeatureTypes()
      Gets a mutable list of feature types used to filter the results of the reverse geocode operation.
      double getMaxDistance()
      Gets the maximum distance from the given location within which a matching address will be searched.
      int getMaxResults()
      Gets the maximum number of results to be returned by the reverse geocode operation.
      java.lang.String getOutputLanguageCode()
      Gets the language code to be requested in the reverse geocode operation.
      SpatialReference getOutputSpatialReference()
      Gets the spatial reference to be used for coordinates returned in the GeocodeResults.
      java.util.List<java.lang.String> getResultAttributeNames()
      Gets a mutable list of the names of attributes to be returned in the GeocodeResults.
      boolean isForStorage()
      Gets the value of the forStorage flag.
      void setForStorage​(boolean forStorage)
      Sets the value of the forStorage flag.
      void setMaxDistance​(double maxDistance)
      Sets the maximum distance from the given location within which a matching address will be searched.
      void setMaxResults​(int maxResults)
      Sets the maximum number of results to be returned by the reverse geocode operation.
      void setOutputLanguageCode​(java.lang.String languageCode)
      Sets the language code to be requested in the reverse geocode operation.
      void setOutputSpatialReference​(SpatialReference outputSpatialReference)
      Sets the spatial reference to be used for coordinates returned in the GeocodeResults.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ReverseGeocodeParameters

        public ReverseGeocodeParameters()
        Constructs a ReverseGeocodeParameters with default settings.
        Since:
        100.0.0

    • Method Detail

      • getResultAttributeNames

        public java.util.List<java.lang.String> getResultAttributeNames()
        Gets a mutable list of the names of attributes to be returned in the GeocodeResults. Initially this is an empty list which means no attributes will be returned. Add names to this list for each attribute to be returned, or add "*" for all attributes to be returned.

        Note: online geocoding services always return a standard set of attributes in reverse geocode results, so this list has no effect when using an online service.

        Returns:
        the list of attribute names to be returned
        Since:
        100.0.0
        See Also:
        GeocodeResult.getAttributes()

      • getFeatureTypes

        public java.util.List<java.lang.String> getFeatureTypes()
        Gets a mutable list of feature types used to filter the results of the reverse geocode operation. Initially this is an empty list which means no feature type filtering is done. Add entries to this list for each feature type for which results are required.

        Note: Currently only one feature type has any effect - specifying "intersection" causes the nearest street intersection to be returned.

        Returns:
        the list of feature types used to filter geocode results
        Since:
        100.0.0

      • isForStorage

        public boolean isForStorage()
        Gets the value of the forStorage flag. This specifies whether the results of the reverse geocode operation will be persisted.
        Returns:
        true if the results of the reverse geocode operation will be persisted, false otherwise
        Since:
        100.0.0

      • setForStorage

        public void setForStorage​(boolean forStorage)
        Sets the value of the forStorage flag. This specifies whether the results of the reverse geocode operation will be persisted. The default value is false, which indicates the results of the operation can't be stored, but they can be temporarily displayed on a map for instance. If you store the results, in a database for example, you need to set this parameter to true.
        Parameters:
        forStorage - true if the results of the reverse geocode operation will be persisted, false otherwise
        Since:
        100.0.0

      • getMaxDistance

        public double getMaxDistance()
        Gets the maximum distance from the given location within which a matching address will be searched.
        Returns:
        the maximum distance in meters, in the range [1000..50000]
        Since:
        100.0.0

      • setMaxDistance

        public void setMaxDistance​(double maxDistance)
        Sets the maximum distance from the given location within which a matching address will be searched. The default value is 1000 meters.
        Parameters:
        maxDistance - the maximum distance in meters, in the range [1000..50000]
        Since:
        100.0.0

      • getMaxResults

        public int getMaxResults()
        Gets the maximum number of results to be returned by the reverse geocode operation.
        Returns:
        the maximum number of results
        Since:
        100.0.0

      • setMaxResults

        public void setMaxResults​(int maxResults)
        Sets the maximum number of results to be returned by the reverse geocode operation. The default value is 1.

        Note: currently this method has no effect because reverse geocode operations return only one result.

        Parameters:
        maxResults - the maximum number of results
        Since:
        100.0.0

      • getOutputLanguageCode

        public java.lang.String getOutputLanguageCode()
        Gets the language code to be requested in the reverse geocode operation. Results will be returned in this language if it is available.
        Returns:
        a two-digit language code, for example "FR" for French, or an empty String if none has been set
        Since:
        100.0.0

      • setOutputLanguageCode

        public void setOutputLanguageCode​(java.lang.String languageCode)
        Sets the language code to be requested in the reverse geocode operation. Results will be returned in this language if it is available. By default no particular language is requested.
        Parameters:
        languageCode - a two-digit language code, for example "FR" for French
        Since:
        100.0.0

      • getOutputSpatialReference

        public SpatialReference getOutputSpatialReference()
        Gets the spatial reference to be used for coordinates returned in the GeocodeResults.
        Returns:
        the output spatial reference, or null if none has been set
        Since:
        100.0.0