com.inrix.sdk.model

Class LearnedLocation

java.lang.Object

com.inrix.sdk.model.Location

com.inrix.sdk.model.LearnedLocation

All Implemented Interfaces:

Parcelable

public class LearnedLocation
extends Location
implements Parcelable

Represents a location the user frequently visits. These locations are learned through geolocation heuristics and are not explicitly created/saved by the user.

See Also:

LocationsManager.getLearnedLocations(com.inrix.sdk.LocationsManager.GetLearnedLocationsOptions, com.inrix.sdk.LocationsManager.IGetLearnedLocationsListener)

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<LearnedLocation>	CREATOR Creator for a parcelable LearnedLocation.

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Method Summary

Methods

Modifier and Type	Method and Description
int	describeContents()
boolean	equals(Object o)
Map<String,Double>	getDayConditionalLikelihoods() Likelihood of visiting the learned location in relation to the day of the week.
Map<String,Double>	getHourConditionalLikelihoods() Gets the likelihood of visiting the learned location in relation to the hour of the day.
Date	getLastVisitedDate() Gets the date/time the user last visited this LearnedLocation.
double	getLikelihood() Gets the likelihood of this LearnedLocation.
int	getWeight() Gets the relative weight of this LearnedLocation relative to other LearnedLocations.
int	hashCode()
boolean	isHidden() Gets the current visibility of the LearnedLocation.
void	writeToParcel(Parcel dest, int flags)

Methods inherited from class com.inrix.sdk.model.Location

getAddress, getGeoPoint, getName, getTimeZone, setAddress, setGeoPoint, setName

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

CREATOR

public static final Parcelable.Creator<LearnedLocation> CREATOR

Creator for a parcelable LearnedLocation.

Method Detail

isHidden

public boolean isHidden()

Gets the current visibility of the LearnedLocation. All LearnedLocations are visible unless they are explicitly hidden.

Returns:

true if the location is hidden, false otherwise.

getHourConditionalLikelihoods

public Map<String,Double> getHourConditionalLikelihoods()

Gets the likelihood of visiting the learned location in relation to the hour of the day.

Returns:

Likelihood per hour.

getDayConditionalLikelihoods

public Map<String,Double> getDayConditionalLikelihoods()

Likelihood of visiting the learned location in relation to the day of the week.

Returns:

Likelihood per day of week.

getLikelihood

public double getLikelihood()

Gets the likelihood of this LearnedLocation. The likelihood is a probabilistic representation of the LearnedLocation.getWeight() and indicates how frequently a user visits this LearnedLocation relative to other LearnedLocations represented as a fractional value between 0 and 1 (inclusive).

Returns:

The likelihood of this LearnedLocation.

getWeight

public int getWeight()

Gets the relative weight of this LearnedLocation relative to other LearnedLocations. A higher number indicates that the user visits this location more frequently than another location with a lower weight.

Returns:

The weight of this location.

getLastVisitedDate

public Date getLastVisitedDate()

Gets the date/time the user last visited this LearnedLocation.

Returns:

The last visited Date if available, null otherwise.

equals

public boolean equals(Object o)

Overrides:

equals in class Location

hashCode

public int hashCode()

Overrides:

hashCode in class Location

describeContents

public int describeContents()

Specified by:

describeContents in interface Parcelable

Overrides:

describeContents in class Location

writeToParcel

public void writeToParcel(Parcel dest,
                 int flags)

Specified by:

writeToParcel in interface Parcelable

Overrides:

writeToParcel in class Location