Place (HERE Android Premium SDK)

java.lang.Object
- com.here.android.mpa.search.Place

```
public class Place
extends java.lang.Object
```
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 Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`PUBLIC_TRANSPORT_RELATED_LINK_NAME` Key name to get the public-transport `DiscoveryLink` (from the related attributes) for this `Place`.
`static java.lang.String`	`RECOMMENDED_RELATED_LINK_NAME` Key name to get the recommended `DiscoveryLink` (from the related attributes) for this `Place`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.util.Map<java.lang.String,java.util.List<java.lang.String>>`	`getAlternativeNames()` Gets the alternative names for the `Place`.
`java.util.List<java.lang.String>`	`getAlternativeReferenceIds(java.lang.String name)` Get a list of alternative identifiers of the same reference identifier for a specific domain.
`java.lang.String`	`getAttributionText()` Gets the `String` representation of the attribution text for the `Place`.
`java.util.List<Category>`	`getCategories()` Gets the list of `Category` objects assigned to the `Place`.
`java.util.List<ContactDetail>`	`getContacts()` Gets the list of `Contact` objects for the `Place`.
`MediaCollectionPage<EditorialMedia>`	`getEditorials()` Gets the `MediaCollectionPage` containing `EditorialMedia` content for the `Place`.
`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 transitLines - A list of available public transport transit lines departures - A list of next departures for available public transport transit lines blindGuide - Whether a public transport stop has blind guides ('tactile paving'). elevator - Whether a public transport stop has elevator escalator - Whether a public transport stop has escalator
`java.lang.String`	`getIconUrl()` Gets the URL to retrieve the icon that best represents the `Place`.
`java.lang.String`	`getId()` Gets the unique identifier for the `Place`.
`MediaCollectionPage<ImageMedia>`	`getImages()` Gets the `MediaCollectionPage` containing `ImageMedia` content for the `Place`.
`Location`	`getLocation()` Gets the physical `Location` of the `Place`.
`java.lang.String`	`getName()` Gets the display name for the `Place`.
`MediaCollectionPage<RatingMedia>`	`getRatings()` Gets the `MediaCollectionPage` containing `RatingMedia` content for the `Place`.
`java.lang.String`	`getReference(java.lang.String name)` Get the reference identifier for a specific domain.
`java.util.Map<java.lang.String,DiscoveryLink>`	`getRelated()` Gets the related places (where available) that might also interest an application user viewing information for the `Place`.
`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.
`PlaceLink`	`getResidingVenue()` Gets the venue (if available) where the `Place` resides.
`MediaCollectionPage<ReviewMedia>`	`getReviews()` Gets the `MediaCollectionPage` containing `ReviewMedia` content for the `Place`.
`SupplierLink`	`getSupplier()` Gets the `Link` for the `Place` supplier.
`Ratings`	`getUserRatings()` Gets the HERE.com user-supplied `Ratings` for the `Place`.
`java.lang.String`	`getViewUri()` Gets the `String` representation of the URI for a user-viewable representation of the `Place`.
`int`	`hashCode()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - RECOMMENDED_RELATED_LINK_NAME
```
public static final java.lang.String RECOMMENDED_RELATED_LINK_NAME
```
    Key name to get the recommended DiscoveryLink (from the related attributes) for this Place.
    
    See Also:
    
    Constant Field Values
  - PUBLIC_TRANSPORT_RELATED_LINK_NAME
```
public static final java.lang.String PUBLIC_TRANSPORT_RELATED_LINK_NAME
```
    Key name to get the public-transport DiscoveryLink (from the related attributes) for this Place.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getId
```
public java.lang.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
  - getViewUri
```
public java.lang.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
  - getName
```
public java.lang.String getName()
```
    Gets the display name for the Place.
    
    Returns:
    
    The Place name
  - getAlternativeNames
```
public java.util.Map<java.lang.String,java.util.List<java.lang.String>> 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").
  - getLocation
```
public Location getLocation()
```
    Gets the physical Location of the Place.
    
    Returns:
    
    The Location
  - getCategories
```
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
  - getIconUrl
```
public java.lang.String getIconUrl()
```
    Gets the URL to retrieve the icon that best represents the Place.
    
    Returns:
    
    The icon URL.
  - getContacts
```
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)
  - getAttributionText
```
public java.lang.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)
  - getSupplier
```
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)
  - getUserRatings
```
public Ratings getUserRatings()
```
    Gets the HERE.com user-supplied Ratings for the Place.
    
    Returns:
    
    The HERE.com user-supplied Ratings for the Place.
  - getReference
```
public final java.lang.String getReference(java.lang.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 PlaceRequest#addReference(String) function.
    
    Parameters:
    
    name - The reference name.
    
    Returns:
    
    The reference identifier. If the reference identifier does not exist, an empty String is returned.
  - getAlternativeReferenceIds
```
public final java.util.List<java.lang.String> getAlternativeReferenceIds(java.lang.String name)
```
    Get a list of alternative identifiers of the same reference identifier for a specific domain. For example, a venue content identifier reference can have alternative identifiers. The list of alternative identifiers can be retrieved by calling this method with name "venues.content".
    NOTE: A reference will not be returned if it has not been queried with the PlaceRequest#addReference(String) function.
    
    Parameters:
    
    name - The reference name.
    
    Returns:
    
    The list of alternative identifiers. If alternative identifiers are not defined, an empty list is returned.
  - getExtendedAttributes
```
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
    - transitLines - A list of available public transport transit lines
    - departures - A list of next departures for available public transport transit lines
    - blindGuide - Whether a public transport stop has blind guides ('tactile paving').
    - elevator - Whether a public transport stop has elevator
    - escalator - Whether a public transport stop has escalator
    For transitLines ExtendedAttribute.TRANSIT_LINES_EXTENDED_ATTRIBUTE_ID and departures ExtendedAttribute.TRANSIT_DEPARTURES_EXTENDED_ATTRIBUTE_ID attributes, the returned object can be cast to TransitLinesAttribute and TransitDeparturesAttribute respectably. Which will allow further related attributes to be retrieved.
    Transit lines and departures information may not always be available in all transit station/stop locations. However, this information is available using the PUBLIC_TRANSPORT_RELATED_LINK_NAME DiscoveryLink from Place.getRelated().
    Returns:
    
    The list of ExtendedAttribute objects
    
    See Also:
    
    TransitLinesAttribute, TransitDeparturesAttribute
  - getEditorials
```
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)
  - getImages
```
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)
  - getRatings
```
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)
  - getReviews
```
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)
  - getRelated
```
public java.util.Map<java.lang.String,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 an empty Map.
    
    Returns:
    
    The java.util.Map of key-value elements representing the collection of links to places related to the Place (could be empty)
  - getResidingVenue
```
public PlaceLink getResidingVenue()
```
    Gets the venue (if available) where the Place resides. This might be of interest to an application user viewing information for the Place.
    
    Returns:
    
    The PlaceLink (could be null)
  - getReportingLink
```
public final 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.
    
    Returns:
    
    The report link, can be null.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
    
    Override:
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
    
    Override:

Class Place

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

RECOMMENDED_RELATED_LINK_NAME

PUBLIC_TRANSPORT_RELATED_LINK_NAME

Method Detail

getId

getViewUri

getName

getAlternativeNames

getLocation

getCategories

getIconUrl

getContacts

getAttributionText

getSupplier

getUserRatings

getReference

getAlternativeReferenceIds

getExtendedAttributes

getEditorials

getImages

getRatings

getReviews

getRelated

getResidingVenue

getReportingLink

hashCode

equals