HERE Android SDK Developer's Guide

Place

The class Place is a member of com.here.android.mpa.search .

Class Summary

public class Place

extends java.lang.Object

Represents a set of data about a physical place.

[For complete information, see the section Class Details]

See also:

Location

Field Summary

Table 1. Fields in Place
Fields

public static final String PUBLIC_TRANSPORT_RELATED_LINK_NAME

Key name to get the public-transport DiscoveryLink (from the related attributes) for this Place .

public static final String RECOMMENDED_RELATED_LINK_NAME

Key name to get the recommended DiscoveryLink (from the related attributes) for this Place .

Method Summary

Table 2. Methods in Place
Methods

public boolean equals (Object obj)

For documentation, see java.lang.Object

public Map getAlternativeNames ()

Gets the alternative names for the Place .

public String getAttributionText ()

Gets the String representation of the attribution text for the Place .

public java.util.List <Category> getCategories ()

Gets the list of Category objects assigned to the Place .

public java.util.List <ContactDetail> getContacts ()

Gets the list of Contact objects for the Place .

public MediaCollectionPage<EditorialMedia> getEditorials ()

Gets the MediaCollectionPage containing EditorialMedia content for the Place .

public java.util.List <ExtendedAttribute> getExtendedAttributes ()

Gets additional information about a Place , a list of ExtendedAttribute objects that can include information such as:

  • payment - A list of available payment methods (such as cash, credit card, direct debit, etc.)
  • openingHours - A list of hours during which the place is open for business
  • annualClosings - A description of annual closing dates such as holidays or other special occasions
  • price - A price list
  • nearestLandmark - A description of the nearest landmark
  • languagesSpoken - A list of the languages that are spoken at the place
  • availableParking - A list of parking options available nearby
  • smoking - Whether smoking is allowed
  • disabledAccess - Whether disabled access is available

public String getIconUrl ()

Gets the URL to retrieve the icon that best represents the Place .

public String getId ()

Gets the unique identifier for the Place .

public MediaCollectionPage<ImageMedia> getImages ()

Gets the MediaCollectionPage containing ImageMedia content for the Place .

public Location getLocation ()

Gets the physical Location of the Place .

public String getName ()

Gets the display name for the Place .

public MediaCollectionPage<RatingMedia> getRatings ()

Gets the MediaCollectionPage containing RatingMedia content for the Place .

public String getReference (String name)

Get the reference identifier for a specific domain.

public java.util.Map <java.lang.String, com.here.android.mpa.search.DiscoveryLink> getRelated ()

Gets the related places (where available) that might also interest an application user viewing information for the Place .

public ReportingLink getReportingLink ()

Gets the link for getting options for reporting an place because, for example, if it contains inappropriate content or the place does not exists.

public MediaCollectionPage<ReviewMedia> getReviews ()

Gets the MediaCollectionPage containing ReviewMedia content for the Place .

public SupplierLink getSupplier ()

Gets the Link for the Place supplier.

public Ratings getUserRatings ()

Gets the HERE.com user-supplied Ratings for the Place .

public String getViewUri ()

Gets the String representation of the URI for a user-viewable representation of the Place .

public int hashCode ()

For documentation, see java.lang.Object

Class Details

Represents a set of data about a physical place.

A Place acts as a container for various information about a place, which itself is a point of interest such as a popular restaurant, a park, or someone's home.

Note: a Place can contain attributes, collections of media about the place, and key-value pairs of related places.

See also:

Location

Field Details

Key name to get the public-transport DiscoveryLink (from the related attributes) for this Place .

Key name to get the recommended DiscoveryLink (from the related attributes) for this Place .

Method Details

public boolean equals (Object obj)

For documentation, see java.lang.Object

Parameters:

  • obj

public Map getAlternativeNames ()

Gets the alternative names for the Place . The returned Map collection is keyed using a language code (eg. "en").

Note: an alternative name is optional, so a call to this method could return empty .

Returns:

The alternative names (could be empty) collection keyed using a language code (eg. "en").

public String getAttributionText ()

Gets the String representation of the attribution text for the Place .

Note: attribution text for a Place is optional, so a call to this method could return empty .

Returns:

The attribution text (could be empty)

public java.util.List <Category> getCategories ()

Gets the list of Category objects assigned to the Place .

Note: categories maybe optional (especially when offline), so a call to this method could return empty .

Returns:

The list of Category objects

public java.util.List <ContactDetail> getContacts ()

Gets the list of Contact objects for the Place .

Note: contact information for a Place is optional, so a call to this method could return empty .

Returns:

The list of Contact objects (could be empty)

public MediaCollectionPage<EditorialMedia> getEditorials ()

Gets the MediaCollectionPage containing EditorialMedia content for the Place .

Note: editorial content for a Place is optional, so a call to this method could return null .

Returns:

The MediaCollectionPage (could be null)

public java.util.List <ExtendedAttribute> getExtendedAttributes ()

Gets additional information about a Place , a list of ExtendedAttribute objects that can include information such as:

  • payment - A list of available payment methods (such as cash, credit card, direct debit, etc.)
  • openingHours - A list of hours during which the place is open for business
  • annualClosings - A description of annual closing dates such as holidays or other special occasions
  • price - A price list
  • nearestLandmark - A description of the nearest landmark
  • languagesSpoken - A list of the languages that are spoken at the place
  • availableParking - A list of parking options available nearby
  • smoking - Whether smoking is allowed
  • disabledAccess - Whether disabled access is available

Returns:

The list of ExtendedAttribute objects

public String getIconUrl ()

Gets the URL to retrieve the icon that best represents the Place .

Returns:

The icon URL.

public String getId ()

Gets the unique identifier for the Place . Applications that want to keep a reference to a place should store the ID for subsequent linking to additional resources.

Returns:

The ID

public MediaCollectionPage<ImageMedia> getImages ()

Gets the MediaCollectionPage containing ImageMedia content for the Place .

Note: image content for a Place is optional, so a call to this method could return null .

Returns:

The MediaCollectionPage (could be null)

public Location getLocation ()

Gets the physical Location of the Place .

Returns:

The Location

public String getName ()

Gets the display name for the Place .

Returns:

The Place name

public MediaCollectionPage<RatingMedia> getRatings ()

Gets the MediaCollectionPage containing RatingMedia content for the Place .

Note: rating content for a Place is optional, so a call to this method could return null .

Returns:

The MediaCollectionPage (could be null)

public String getReference (String name)

Get the reference identifier for a specific domain. For example, a place can have a reference to an extruded building object in the map. The reference identifier can be retrieved by calling this method with name 'building'. NOTE: A reference will not be returned if it has not been queried with the PlacesBaseRequest#setReferences function.

Parameters:

  • name

    The reference name.

Returns:

The reference identifier. If the reference identifier does not exist, an empty String is returned.

public java.util.Map <java.lang.String, com.here.android.mpa.search.DiscoveryLink> getRelated ()

Gets the related places (where available) that might also interest an application user viewing information for the Place . The returned Map is keyed by a title for the related places (e.g. PUBLIC_TRANSPORT_RELATED_LINK_NAME ), while the associated value is a link to a page of related places.

Note: if there are no related places, the attribute is not present and this method will return null .

Returns:

The java.util.Map of key-value elements representing the collection of links to places related to the Place (could be empty)

Gets the link for getting options for reporting an place because, for example, if it contains inappropriate content or the place does not exists.

Returns:

The report link.

public MediaCollectionPage<ReviewMedia> getReviews ()

Gets the MediaCollectionPage containing ReviewMedia content for the Place .

Note: review content for a Place is optional, so a call to this method could return null .

Returns:

The MediaCollectionPage (could be null)

public SupplierLink getSupplier ()

Gets the Link for the Place supplier. A supplier link extends the standard link object with an optional icon link pointing to the supplier's brand icon.

Note: a Link for a Place supplier is optional, so a call to this method could return null .

Returns:

The supplier Link (could be null)

public Ratings getUserRatings ()

Gets the HERE.com user-supplied Ratings for the Place .

Returns:

The HERE.com user-supplied Ratings for the Place.

public String getViewUri ()

Gets the String representation of the URI for a user-viewable representation of the Place . Applications must provide at least one such URI for every Place they fetch.

Returns:

The URI to a viewable site for the Place

public int hashCode ()

For documentation, see java.lang.Object