com.veriplace.client
Class Location

java.lang.Object
  com.veriplace.client.Position
      com.veriplace.client.Location

public class Location
extends Position

Representation of the location of a Veriplace user.

This class inherits all of the properties of Position, which always include longitude and latitude coordinates in degrees and an uncertainty radius in meters. Geographic address information such as street address and city are also included whenever possible.

Properties not inherited from Position are:

• A unique identifier (getId()) which can be used to requery the same data using GetLocationAPI.getLocationById(com.veriplace.oauth.consumer.Token, User, long).
• A creation timestamp indicating the date and time that the location was generated.
• An expiration date after which the location must be discarded, as per the Veriplace Developer Terms of Service.
• An optional PositionReference with a PointOfInterest describing a nearby business or landmark (if you requested this information).
• An optional PositionReference with a StreetIntersection describing a nearby street intersection (if you requested this information).

Constructor Summary

Location(java.lang.Long id, java.util.Date creationDate, java.util.Date expirationDate, double longitude, double latitude, double uncertainty, java.lang.String street, java.lang.String neighborhood, java.lang.String city, java.lang.String state, java.lang.String postal, java.lang.String countryCode)

Location(long id, java.util.Date creationDate, java.util.Date expirationDate, Position position)

Location(long id, java.util.Date creationDate, java.util.Date expirationDate, Position position, PositionReference<PointOfInterest> nearestPointOfInterest, PositionReference<StreetIntersection> nearestIntersection)

Method Summary

java.util.Date	getCreationDate() Get this location's creation date, which indicates whether the location represents a current or cached position.
java.util.Date	getExpirationDate() Get this location's expiration date, which indicates when this location must be deleted.
java.lang.Long	getId() Get this location's unique identifier, which may be used to retrieve its data without relying on external storage.
PositionReference<StreetIntersection>	getNearestIntersection() Get a description of a nearby street intersection, including the distance and direction to it.
PositionReference<PointOfInterest>	getNearestPointOfInterest() Get a description of a nearby business or landmark, including the distance and direction to it.

Methods inherited from class com.veriplace.client.Position

getAddressLine, getCity, getCountryCode, getLatitude, getLongitude, getNeighborhood, getPostal, getState, getStreet, getStreet2, getUncertainty, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Location

public Location(long id,
                java.util.Date creationDate,
                java.util.Date expirationDate,
                Position position)

Location

public Location(long id,
                java.util.Date creationDate,
                java.util.Date expirationDate,
                Position position,
                PositionReference<PointOfInterest> nearestPointOfInterest,
                PositionReference<StreetIntersection> nearestIntersection)

Location

public Location(java.lang.Long id,
                java.util.Date creationDate,
                java.util.Date expirationDate,
                double longitude,
                double latitude,
                double uncertainty,
                java.lang.String street,
                java.lang.String neighborhood,
                java.lang.String city,
                java.lang.String state,
                java.lang.String postal,
                java.lang.String countryCode)

Method Detail

getId

public java.lang.Long getId()

Get this location's unique identifier, which may be used to retrieve its data without relying on external storage.

Note that location updates will not generally have ids.

getCreationDate

public java.util.Date getCreationDate()

Get this location's creation date, which indicates whether the location represents a current or cached position.

getExpirationDate

public java.util.Date getExpirationDate()

Get this location's expiration date, which indicates when this location must be deleted.

getNearestPointOfInterest

public PositionReference<PointOfInterest> getNearestPointOfInterest()

Get a description of a nearby business or landmark, including the distance and direction to it.

This property will be null if you did not specifically request point-of-interest information in your original location request, or if no such point could be found.

getNearestIntersection

public PositionReference<StreetIntersection> getNearestIntersection()

Get a description of a nearby street intersection, including the distance and direction to it.

This property will be null if you did not specifically request street intersection information in your original location request, or if no such intersection could be found.