Package com.here.sdk.search

Class GeoPlace

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

    GeoPlace struct represents a location object: such as a country, a city, a point of interest (POI) etc. It can be used for PersonalPlace creation, in order to provide search on custom places.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      Address address
      Address of the place Note: Address can have default value when no data is available.
      BusinessDetails business
      Business details Note: BusinessDetails can have default value when no data is available.
      java.util.List<PlaceCategory> categories
      List of corresponding categories Note: This list can be empty when no data is available.
      java.util.List<ExternalID> externalIDs
      Allows the client to set the id in their own system.
      LocationDetails location
      Geographical details Note: Can be null when retrieved from a suggestion's place property.
      java.lang.String title
      The localized title for the resource.
      PlaceType type
      Specifies place type.
      WebDetails web
      Contains info and direct web links to corresponding items.

    • Constructor Summary

      Constructors 
      Constructor Description
      GeoPlace()
      Creates a new instance.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      java.lang.String getID()
      Allow the client to access GeoPlace id.
      int hashCode()  
      boolean isMyPlace()
      Allow the client to access info about is it my place or not.
      static GeoPlace makeMyPlace​(java.lang.String title, GeoCoordinates coordinates)
      Creates a new instance of this class.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • title

        @NonNull
public java.lang.String title

        The localized title for the resource. Note: This String can be empty when no data is available.

      • externalIDs

        @NonNull
public java.util.List<ExternalID> externalIDs

        Allows the client to set the id in their own system. The list of supplier references to this place. The references are provided by external suppliers and are only available to users with valid contracts with said suppliers. If the user has no such contracts, the list is empty.

      • type

        @NonNull
public PlaceType type

        Specifies place type.

      • categories

        @NonNull
public java.util.List<PlaceCategory> categories

        List of corresponding categories Note: This list can be empty when no data is available.

      • address

        @NonNull
public Address address

        Address of the place Note: Address can have default value when no data is available.

      • location

        @Nullable
public LocationDetails location

        Geographical details Note: Can be null when retrieved from a suggestion's place property.

      • business

        @NonNull
public BusinessDetails business

        Business details Note: BusinessDetails can have default value when no data is available.

      • web

        @NonNull
public WebDetails web

        Contains info and direct web links to corresponding items. Note: WebDetails can have default value when no data is available.

    • Constructor Detail

      • GeoPlace

        public GeoPlace()

        Creates a new instance.

    • 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

      • makeMyPlace

        @NonNull
public static GeoPlace makeMyPlace​(@NonNull
                                   java.lang.String title,
                                   @NonNull
                                   GeoCoordinates coordinates)

        Creates a new instance of this class. All other properties will keep their default value and all properties containing lists will contain empty lists.

        Parameters:
        title -

        The title.

        coordinates -

        The coordinates.

        Returns:

        An instance of GeoPlace.

      • getID

        @NonNull
public java.lang.String getID()

        Allow the client to access GeoPlace id.

        Returns:

        The place id.

      • isMyPlace

        public boolean isMyPlace()

        Allow the client to access info about is it my place or not.

        Returns:

        True if it is my place, false otherwise.