public class Place
extends java.lang.Object
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.
Location
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 . |
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()
|
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
|
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()
|
Location |
getLocation()
Gets the physical
Location of the Place . |
java.lang.String |
getName()
Gets the display name for the
Place . |
MediaCollectionPage<RatingMedia> |
getRatings()
|
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.
|
MediaCollectionPage<ReviewMedia> |
getReviews()
|
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() |
public static final java.lang.String RECOMMENDED_RELATED_LINK_NAME
DiscoveryLink
(from the related attributes) for this
Place
.public static final java.lang.String PUBLIC_TRANSPORT_RELATED_LINK_NAME
DiscoveryLink
(from the related attributes) for
this Place
.public java.lang.String getId()
Place
. Applications that want
to keep a reference to a place should store the ID for subsequent linking
to additional resources.public java.lang.String getViewUri()
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.Place
public java.lang.String getName()
Place
.Place
namepublic java.util.Map<java.lang.String,java.util.List<java.lang.String>> getAlternativeNames()
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
.
empty
) collection keyed
using a language code (eg. "en").public Location getLocation()
Location
of the Place
.Location
public java.util.List<Category> getCategories()
Category
objects assigned to the Place
.
Note: categories maybe optional (especially when offline), so a call to
this method could return empty
.
Category
objectspublic java.lang.String getIconUrl()
Place
.public java.util.List<ContactDetail> getContacts()
Contact
objects for the Place
.
Note: contact information for a Place
is optional, so a call to
this method could return empty
.
Contact
objects (could be empty
)public java.lang.String getAttributionText()
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
.
empty
)public SupplierLink getSupplier()
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
.
Link
(could be null
)public Ratings getUserRatings()
Ratings
for the Place
.Ratings
for the Place
.public final java.lang.String getReference(java.lang.String name)
PlacesBaseRequest#setReferences
function.name
- The reference name.public final java.util.List<java.lang.String> getAlternativeReferenceIds(java.lang.String name)
PlacesBaseRequest#setReferences
function.name
- The reference name.public java.util.List<ExtendedAttribute> getExtendedAttributes()
Place
, a list of ExtendedAttribute
objects that can include information such as:
ExtendedAttribute
objectspublic MediaCollectionPage<EditorialMedia> getEditorials()
MediaCollectionPage
containing EditorialMedia
content
for the Place
.
Note: editorial content for a Place
is optional, so a call to
this method could return null
.
MediaCollectionPage
(could be null
)public MediaCollectionPage<ImageMedia> getImages()
MediaCollectionPage
containing ImageMedia
content for
the Place
.
Note: image content for a Place
is optional, so a call to this
method could return null
.
MediaCollectionPage
(could be null
)public MediaCollectionPage<RatingMedia> getRatings()
MediaCollectionPage
containing RatingMedia
content
for the Place
.
Note: rating content for a Place
is optional, so a call to this
method could return null
.
MediaCollectionPage
(could be null
)public MediaCollectionPage<ReviewMedia> getReviews()
MediaCollectionPage
containing ReviewMedia
content
for the Place
.
Note: review content for a Place
is optional, so a call to this
method could return null
.
MediaCollectionPage
(could be null
)public java.util.Map<java.lang.String,DiscoveryLink> getRelated()
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
.
java.util.Map
of key-value elements representing the collection of links
to places related to the Place
(could be empty
)public final ReportingLink getReportingLink()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object