Package com.here.sdk.search

Class AddressQuery

  • java.lang.Object
    • com.here.sdk.search.AddressQuery
  • public final class AddressQuery
extends java.lang.Object

    The options to specify an address query. A query can consist of parts of an address or full addresses, optionally comma separated. AddressQuery should only be used to search for parts of the address, excluding the POI name. For example, "Invalidenstraße 116, Berlin, Germany" is appropriate, whereas "HERE, Invalidenstraße 116, Berlin, Germany" is not. To be able to include the POI name, use TextQuery instead. SearchOptions.languageCode specifies the language of the query and determines the preferred language of the results.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      GeoCoordinates areaCenter
      Geographical coordinates of the center around which to provide the most relevant places.
      java.util.List<CountryCode> countries
      A list of countries that the query is applied in.
      java.lang.String query
      Desired address query to search.

    • Constructor Summary

      Constructors 
      Constructor Description
      AddressQuery​(java.lang.String query)
      Constructs an AddressQuery from the provided text query.
      AddressQuery​(java.lang.String query, GeoCoordinates areaCenter)
      Constructs an AddressQuery from the provided text query and geographical coordinates.
      AddressQuery​(java.lang.String query, GeoCoordinates areaCenter, java.util.List<CountryCode> countries)
      Constructs an AddressQuery from the provided text query, geographical coordinates and the list of countries the query is applied in.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      int hashCode()  

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • query

        @NonNull
public final java.lang.String query

        Desired address query to search.

      • areaCenter

        @Nullable
public final GeoCoordinates areaCenter

        Geographical coordinates of the center around which to provide the most relevant places. For Offline Search null value will result in SearchError.INVALID_AREA

      • countries

        @NonNull
public final java.util.List<CountryCode> countries

        A list of countries that the query is applied in. Not supported in OfflineSearchEngine (not available in all editions).

    • Constructor Detail

      • AddressQuery

        public AddressQuery​(@NonNull
                    java.lang.String query,
                    @NonNull
                    GeoCoordinates areaCenter)

        Constructs an AddressQuery from the provided text query and geographical coordinates.

        Parameters:
        query -

        Desired query to search.

        areaCenter -

        Geographical coordinates of the center around which to provide the most relevant places.

      • AddressQuery

        public AddressQuery​(@NonNull
                    java.lang.String query,
                    @NonNull
                    GeoCoordinates areaCenter,
                    @NonNull
                    java.util.List<CountryCode> countries)

        Constructs an AddressQuery from the provided text query, geographical coordinates and the list of countries the query is applied in.

        Parameters:
        query -

        Desired query to search.

        areaCenter -

        Geographical coordinates of the center around which to provide the most relevant places.

        countries -

        A list of countries that the query is applied in.

      • AddressQuery

        public AddressQuery​(@NonNull
                    java.lang.String query)

        Constructs an AddressQuery from the provided text query. Not supported in OfflineSearchEngine (not available in all editions).

        Parameters:
        query -

        Desired query to search.

    • Method Detail

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object