com.scvngr.levelup.core.model

Class Location

java.lang.Object

com.scvngr.levelup.core.model.Location

All Implemented Interfaces:

Parcelable

@Immutable
 @LevelUpApi(contract=PUBLIC)
public final class Location
extends Object
implements Parcelable

Representing a location of a merchant (which can have multiple) on the server.

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

Parcelable.ClassLoaderCreator<T>, Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static Parcelable.Creator<Location>	CREATOR Implements the Parcelable interface.
static String	URL_FACEBOOK URL key for Facebook.
static String	URL_FOODLER URL key for Foodler.
static String	URL_MENU URL key for Menu.
static String	URL_NEWSLETTER URL key for a newsletter.
static String	URL_OPENTABLE URL key for OpenTable.
static String	URL_TWITTER URL key for Twitter.
static String	URL_YELP URL key for Yelp.

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
Location(Set<Integer> categories, String extendedAddress, String hours, long id, double latitude, double longitude, String locality, long merchantId, String merchantName, String phone, String postalCode, String region, boolean shown, String streetAddress, Map<String,String> urls, String name)
Location(Set<Integer> categories, String extendedAddress, String hours, long id, double latitude, double longitude, String locality, long merchantId, String merchantName, String name, String phone, String postalCode, String region, boolean shown, String streetAddress)
Location(Set<Integer> categories, String extendedAddress, String hours, long id, double latitude, double longitude, String locality, long merchantId, String merchantName, String name, String phone, String postalCode, String region, boolean shown, String streetAddress, Map<String,String> urls) Deprecated.

Method Summary

Modifier and Type	Method and Description
int	describeContents()
boolean	equals(Object o)
Set<Integer>	getCategories() The categories that this Location is classified under.
String	getExtendedAddress() The Location's extended address.
String	getHours() The hours of operation for this Location.
long	getId() The web service ID of this Location.
double	getLatitude() The latitude of this Location.
String	getLocality() The locality (city) of this Location.
double	getLongitude() The longitude of this Location.
long	getMerchantId() The web service ID of the location's merchant.
String	getMerchantName() The name of the location's merchant.
String	getName() The name of the location, if different from the merchant name.
String	getPhone() The phone number of this Location.
String	getPostalCode() The postal code of this Location.
String	getRegion() The region (state in the US) of this Location.
String	getStreetAddress() The address of this Location.
String	getUrl(String key) Deprecated.
Map<String,String>	getUrls() Deprecated.
int	hashCode()
boolean	isShown() Whether or not this location is to be shown to the user.
String	toString()
void	writeToParcel(Parcel dest, int flags)

Methods inherited from class java.lang.Object

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

Field Detail

CREATOR

public static final Parcelable.Creator<Location> CREATOR

Implements the Parcelable interface.

URL_YELP

public static final String URL_YELP

URL key for Yelp.

See Also:

Constant Field Values

URL_OPENTABLE

public static final String URL_OPENTABLE

URL key for OpenTable.

See Also:

Constant Field Values

URL_MENU

public static final String URL_MENU

URL key for Menu.

See Also:

Constant Field Values

URL_TWITTER

public static final String URL_TWITTER

URL key for Twitter.

See Also:

Constant Field Values

URL_NEWSLETTER

public static final String URL_NEWSLETTER

URL key for a newsletter.

See Also:

Constant Field Values

URL_FACEBOOK

public static final String URL_FACEBOOK

URL key for Facebook.

See Also:

Constant Field Values

URL_FOODLER

public static final String URL_FOODLER

URL key for Foodler.

See Also:

Constant Field Values

Constructor Detail

Location

@Deprecated
public Location(Set<Integer> categories,
                            String extendedAddress,
                            String hours,
                            long id,
                            double latitude,
                            double longitude,
                            String locality,
                            long merchantId,
                            String merchantName,
                            String name,
                            String phone,
                            String postalCode,
                            String region,
                            boolean shown,
                            String streetAddress,
                            Map<String,String> urls)

Deprecated.

Parameters:

categories - the categories that this Location is classified under. null will turn into an empty set.

extendedAddress - the Location's extended address.

hours - the hours of operation for this Location.

id - the ID on the web service of this Location.

latitude - the latitude of this Location.

longitude - the longitude of this Location.

locality - the locality (city) of this Location.

merchantId - the ID number of the location's merchant.

merchantName - The name of the location's merchant.

name - The name of the location, if different from the merchant name.

phone - the phone number for this Location.

postalCode - the postal code for this Location.

region - the region (state in the US) for this Location.

shown - whether or not this location is to be shown to the user.

streetAddress - the address of this Location.

urls - a map of URLs associated with this Location. This map will be made unmodifiable.

Location

public Location(Set<Integer> categories,
                String extendedAddress,
                String hours,
                long id,
                double latitude,
                double longitude,
                String locality,
                long merchantId,
                String merchantName,
                String name,
                String phone,
                String postalCode,
                String region,
                boolean shown,
                String streetAddress)

Parameters:

categories - the categories that this Location is classified under. null will turn into an empty set.

extendedAddress - the Location's extended address.

hours - the hours of operation for this Location.

id - the ID on the web service of this Location.

latitude - the latitude of this Location.

longitude - the longitude of this Location.

locality - the locality (city) of this Location.

merchantId - the ID number of the location's merchant.

merchantName - The name of the location's merchant.

name - The name of the location, if different from the merchant name.

phone - the phone number for this Location.

postalCode - the postal code for this Location.

region - the region (state in the US) for this Location.

shown - whether or not this location is to be shown to the user.

streetAddress - the address of this Location.

Location

public Location(Set<Integer> categories,
                String extendedAddress,
                String hours,
                long id,
                double latitude,
                double longitude,
                String locality,
                long merchantId,
                String merchantName,
                String phone,
                String postalCode,
                String region,
                boolean shown,
                String streetAddress,
                Map<String,String> urls,
                String name)

Method Detail

getUrl

@Deprecated
public String getUrl(String key)

Deprecated.

Get a specific URL by key. URLs are now returned as a WebLink through the WebLinkRequestFactory.

Parameters:

key - the name of the given URL.

Returns:

a URL with the given key or null if there is no such mapping.

describeContents

public int describeContents()

Specified by:

describeContents in interface Parcelable

writeToParcel

public void writeToParcel(Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface Parcelable

getCategories

public Set<Integer> getCategories()

The categories that this Location is classified under.

getExtendedAddress

public String getExtendedAddress()

The Location's extended address.

getHours

public String getHours()

The hours of operation for this Location.

getId

public long getId()

The web service ID of this Location.

getLatitude

public double getLatitude()

The latitude of this Location.

getLongitude

public double getLongitude()

The longitude of this Location.

getLocality

public String getLocality()

The locality (city) of this Location.

getMerchantId

public long getMerchantId()

The web service ID of the location's merchant.

getMerchantName

public String getMerchantName()

The name of the location's merchant.

getPhone

public String getPhone()

The phone number of this Location.

getPostalCode

public String getPostalCode()

The postal code of this Location.

getRegion

public String getRegion()

The region (state in the US) of this Location.

isShown

public boolean isShown()

Whether or not this location is to be shown to the user.

getStreetAddress

public String getStreetAddress()

The address of this Location.

getUrls

@Deprecated
public Map<String,String> getUrls()

Deprecated.

A map of URLs associated with this Location. URLs are now returned as a WebLink through the WebLinkRequestFactory.

getName

public String getName()

The name of the location, if different from the merchant name. This is usually a familiar name that would make this location distinct amongst a set of locations where the merchant name would otherwise be identical e.g. "North End", "Charles St."

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object