GeoLocation (XMPP Extensions Library 0.4.0-beta API)

java.lang.Object
- rocks.xmpp.extensions.geoloc.model.GeoLocation

```
public final class GeoLocation
extends Object
```
The implementation of the <geoloc/> element in the http://jabber.org/protocol/geoloc namespace.
This class represents the geological location of a user.

4. Recommended Transport

Location information about human users SHOULD be communicated and transported by means of Publish-Subscribe (XEP-0060) [5] or the subset thereof specified in Personal Eventing Protocol (XEP-0163) [6].

Although the XMPP publish-subscribe extension is the preferred means for transporting location information about human users, applications that do not involve human users (e.g., device tracking) MAY use other transport methods; however, because location information is not pure presence information and can change independently of network availability, it SHOULD NOT be provided as an extension to <presence/>.

Author:

Christian Schudt

See Also:

XEP-0080: User Location, XML Schema

Field Summary

Fields
Modifier and Type Field and Description

static String NAMESPACE

Fields
Modifier and Type	Field and Description
`static String`	`NAMESPACE`

Constructor Summary

Constructors
Constructor and Description

GeoLocation()

GeoLocation(double latitude, double longitude)

Constructors
Constructor and Description
`GeoLocation()`
`GeoLocation(double latitude, double longitude)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Double`	`getAccuracy()` Gets the horizontal GPS error in meters.
`Double`	`getAltitude()` Gets the altitude in meters above or below sea level.
`String`	`getArea()` Gets a named area such as a campus or neighborhood.
`Double`	`getBearing()` Gets the GPS bearing (direction in which the entity is heading to reach its next waypoint), measured in decimal degrees relative to true north.
`String`	`getBuilding()` Gets a specific building on a street or in an area.
`String`	`getCountry()` Gets the nation where the user is located.
`String`	`getCountryCode()` Gets the ISO 3166 two-letter country code.
`String`	`getDatum()` Gets the GPS datum.
`String`	`getDescription()` Gets a natural-language name for or description of the location.
`String`	`getFloor()` Gets a particular floor in a building.
`String`	`getLanguage()` Gets the the natural language of location data.
`Double`	`getLatitude()` Gets the latitude in decimal degrees North.
`String`	`getLocality()` Gets a locality within the administrative region, such as a town or city.
`Double`	`getLongitude()` Gets the longitude in decimal degrees East.
`String`	`getPostalCode()` Gets a code used for postal delivery.
`String`	`getRegion()` Gets an administrative region of the nation, such as a state or province.
`String`	`getRoom()` Gets a particular room in a building.
`Double`	`getSpeed()` Gets the speed at which the entity is moving, in meters per second.
`String`	`getStreet()` Gets a thoroughfare within the locality, or a crossing of two thoroughfares.
`String`	`getText()` Gets a catch-all element that captures any other information about the location.
`Date`	`getTimestamp()` Gets the UTC timestamp specifying the moment when the reading was taken.
`TimeZone`	`getTimeZone()` Gets the time zone offset from UTC for the current location.
`URI`	`getUri()` Gets a URI or URL pointing to information about the location.
`void`	`setAccuracy(Double accuracy)` Sets the horizontal GPS error in meters.
`void`	`setAltitude(Double altitude)` Sets the altitude in meters above or below sea level.
`void`	`setArea(String area)` Sets a named area such as a campus or neighborhood.
`void`	`setBearing(Double bearing)` Sets the GPS bearing (direction in which the entity is heading to reach its next waypoint), measured in decimal degrees relative to true north.
`void`	`setBuilding(String building)` Sets a specific building on a street or in an area.
`void`	`setCountry(String country)` Sets the nation where the user is located.
`void`	`setCountryCode(String countryCode)` Sets the ISO 3166 two-letter country code.
`void`	`setDatum(String datum)` Sets the GPS datum.
`void`	`setDescription(String description)` Sets a natural-language name for or description of the location.
`void`	`setFloor(String floor)` Sets a particular floor in a building.
`void`	`setLanguage(String language)` Sets the natural language of location data.
`void`	`setLatitude(Double latitude)` Sets the latitude in decimal degrees North.
`void`	`setLocality(String locality)` Sets a locality within the administrative region, such as a town or city.
`void`	`setLongitude(Double longitude)` Sets the longitude in decimal degrees East.
`void`	`setPostalCode(String postalCode)` Sets a code used for postal delivery.
`void`	`setRegion(String region)` Sets an administrative region of the nation, such as a state or province.
`void`	`setRoom(String room)` Sets a particular room in a building.
`void`	`setSpeed(Double speed)` Sets the speed at which the entity is moving, in meters per second.
`void`	`setStreet(String street)` Sets a thoroughfare within the locality, or a crossing of two thoroughfares.
`void`	`setText(String text)` Sets a catch-all element that captures any other information about the location.
`void`	`setTimestamp(Date timestamp)` Sets the UTC timestamp specifying the moment when the reading was taken.
`void`	`setTimeZone(TimeZone timeZone)` Sets the time zone offset from UTC for the current location.
`void`	`setUri(URI uri)` Sets a URI or URL pointing to information about the location.
`String`	`toString()`

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

- Field Detail
  - NAMESPACE
```
public static final String NAMESPACE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - GeoLocation
```
public GeoLocation()
```
  - GeoLocation
```
public GeoLocation(double latitude,
                   double longitude)
```
- Method Detail
  - getAccuracy
```
public Double getAccuracy()
```
    Gets the horizontal GPS error in meters.
    
    Returns:
    
    The accuracy.
    
    See Also:
    
    setAccuracy(Double)
  - setAccuracy
```
public void setAccuracy(Double accuracy)
```
    Sets the horizontal GPS error in meters.
    
    Parameters:
    
    accuracy - The accuracy.
    
    See Also:
    
    getAccuracy()
  - getAltitude
```
public Double getAltitude()
```
    Gets the altitude in meters above or below sea level.
    
    Returns:
    
    The altitude.
    
    See Also:
    
    setAltitude(Double)
  - setAltitude
```
public void setAltitude(Double altitude)
```
    Sets the altitude in meters above or below sea level.
    
    Parameters:
    
    altitude - The altitude.
    
    See Also:
    
    getAltitude()
  - getArea
```
public String getArea()
```
    Gets a named area such as a campus or neighborhood.
    
    Returns:
    
    The area.
    
    See Also:
    
    setArea(String)
  - setArea
```
public void setArea(String area)
```
    Sets a named area such as a campus or neighborhood.
    
    Parameters:
    
    area - The area.
    
    See Also:
    
    getArea()
  - getBearing
```
public Double getBearing()
```
    Gets the GPS bearing (direction in which the entity is heading to reach its next waypoint), measured in decimal degrees relative to true north.
    
    Returns:
    
    The bearing.
    
    See Also:
    
    setBearing(Double)
  - setBearing
```
public void setBearing(Double bearing)
```
    Sets the GPS bearing (direction in which the entity is heading to reach its next waypoint), measured in decimal degrees relative to true north.
    
    Parameters:
    
    bearing - The bearing.
    
    See Also:
    
    getBearing()
  - getBuilding
```
public String getBuilding()
```
    Gets a specific building on a street or in an area.
    
    Returns:
    
    The building.
    
    See Also:
    
    setBuilding(String)
  - setBuilding
```
public void setBuilding(String building)
```
    Sets a specific building on a street or in an area.
    
    Parameters:
    
    building - The building.
    
    See Also:
    
    getBuilding()
  - getCountry
```
public String getCountry()
```
    Gets the nation where the user is located.
    
    Returns:
    
    The country.
    
    See Also:
    
    setCountry(String)
  - setCountry
```
public void setCountry(String country)
```
    Sets the nation where the user is located.
    
    Parameters:
    
    country - The country.
    
    See Also:
    
    getCountry()
  - getCountryCode
```
public String getCountryCode()
```
    Gets the ISO 3166 two-letter country code.
    
    Returns:
    
    The country code.
    
    See Also:
    
    setCountryCode(String)
  - setCountryCode
```
public void setCountryCode(String countryCode)
```
    Sets the ISO 3166 two-letter country code.
    
    Parameters:
    
    countryCode - The country code.
    
    See Also:
    
    getCountryCode()
  - getDatum
```
public String getDatum()
```
    Gets the GPS datum.
    
    Returns:
    
    The GPS datum.
    
    See Also:
    
    setDatum(String)
  - setDatum
```
public void setDatum(String datum)
```
    Sets the GPS datum.
    
    Parameters:
    
    datum - The GPS datum.
    
    See Also:
    
    getDatum()
  - getDescription
```
public String getDescription()
```
    Gets a natural-language name for or description of the location.
    
    Returns:
    
    The description.
    
    See Also:
    
    setDescription(String)
  - setDescription
```
public void setDescription(String description)
```
    Sets a natural-language name for or description of the location.
    
    Parameters:
    
    description - The description.
    
    See Also:
    
    getDescription()
  - getFloor
```
public String getFloor()
```
    Gets a particular floor in a building.
    
    Returns:
    
    The floor.
    
    See Also:
    
    setFloor(String)
  - setFloor
```
public void setFloor(String floor)
```
    Sets a particular floor in a building.
    
    Parameters:
    
    floor - The floor.
    
    See Also:
    
    getFloor()
  - getLatitude
```
public Double getLatitude()
```
    Gets the latitude in decimal degrees North.
    
    Returns:
    
    The latitude.
    
    See Also:
    
    setLatitude(Double)
  - setLatitude
```
public void setLatitude(Double latitude)
```
    Sets the latitude in decimal degrees North.
    
    Parameters:
    
    latitude - The latitude.
    
    See Also:
    
    getLatitude()
  - getLocality
```
public String getLocality()
```
    Gets a locality within the administrative region, such as a town or city.
    
    Returns:
    
    The locality.
    
    See Also:
    
    setLocality(String)
  - setLocality
```
public void setLocality(String locality)
```
    Sets a locality within the administrative region, such as a town or city.
    
    Parameters:
    
    locality - The locality.
    
    See Also:
    
    getLocality()
  - getLongitude
```
public Double getLongitude()
```
    Gets the longitude in decimal degrees East.
    
    Returns:
    
    The longitude.
    
    See Also:
    
    setLongitude(Double)
  - setLongitude
```
public void setLongitude(Double longitude)
```
    Sets the longitude in decimal degrees East.
    
    Parameters:
    
    longitude - The longitude.
    
    See Also:
    
    getLongitude()
  - getPostalCode
```
public String getPostalCode()
```
    Gets a code used for postal delivery.
    
    Returns:
    
    The postal code.
    
    See Also:
    
    setPostalCode(String)
  - setPostalCode
```
public void setPostalCode(String postalCode)
```
    Sets a code used for postal delivery.
    
    Parameters:
    
    postalCode - The postal code.
    
    See Also:
    
    getPostalCode()
  - getRegion
```
public String getRegion()
```
    Gets an administrative region of the nation, such as a state or province.
    
    Returns:
    
    The region.
    
    See Also:
    
    setRegion(String)
  - setRegion
```
public void setRegion(String region)
```
    Sets an administrative region of the nation, such as a state or province.
    
    Parameters:
    
    region - The region.
    
    See Also:
    
    getRegion()
  - getRoom
```
public String getRoom()
```
    Gets a particular room in a building.
    
    Returns:
    
    The room.
    
    See Also:
    
    setRoom(String)
  - setRoom
```
public void setRoom(String room)
```
    Sets a particular room in a building.
    
    Parameters:
    
    room - The room.
    
    See Also:
    
    getRoom()
  - getSpeed
```
public Double getSpeed()
```
    Gets the speed at which the entity is moving, in meters per second.
    
    Returns:
    
    The speed.
    
    See Also:
    
    setSpeed(Double)
  - setSpeed
```
public void setSpeed(Double speed)
```
    Sets the speed at which the entity is moving, in meters per second.
    
    Parameters:
    
    speed - The speed.
    
    See Also:
    
    getSpeed()
  - getStreet
```
public String getStreet()
```
    Gets a thoroughfare within the locality, or a crossing of two thoroughfares.
    
    Returns:
    
    The street.
    
    See Also:
    
    setStreet(String)
  - setStreet
```
public void setStreet(String street)
```
    Sets a thoroughfare within the locality, or a crossing of two thoroughfares.
    
    Parameters:
    
    street - The street.
    
    See Also:
    
    setStreet(String)
  - getText
```
public String getText()
```
    Gets a catch-all element that captures any other information about the location.
    
    Returns:
    
    The text.
    
    See Also:
    
    setText(String)
  - setText
```
public void setText(String text)
```
    Sets a catch-all element that captures any other information about the location.
    
    Parameters:
    
    text - The text.
    
    See Also:
    
    getText()
  - getTimestamp
```
public Date getTimestamp()
```
    Gets the UTC timestamp specifying the moment when the reading was taken.
    
    Returns:
    
    The timestamp.
    
    See Also:
    
    setTimestamp(java.util.Date)
  - setTimestamp
```
public void setTimestamp(Date timestamp)
```
    Sets the UTC timestamp specifying the moment when the reading was taken.
    
    Parameters:
    
    timestamp - The timestamp.
    
    See Also:
    
    getTimestamp()
  - getUri
```
public URI getUri()
```
    Gets a URI or URL pointing to information about the location.
    
    Returns:
    
    The URI.
    
    See Also:
    
    setUri(java.net.URI)
  - setUri
```
public void setUri(URI uri)
```
    Sets a URI or URL pointing to information about the location.
    
    Parameters:
    
    uri - The URI.
    
    See Also:
    
    getUri()
  - getLanguage
```
public String getLanguage()
```
    Gets the the natural language of location data.
    
    Returns:
    
    The language.
    
    See Also:
    
    setLanguage(String)
  - setLanguage
```
public void setLanguage(String language)
```
    Sets the natural language of location data.
    
    Parameters:
    
    language - The language.
    
    See Also:
    
    getLanguage()
  - getTimeZone
```
public TimeZone getTimeZone()
```
    Gets the time zone offset from UTC for the current location.
    
    Returns:
    
    The time zone.
  - setTimeZone
```
public void setTimeZone(TimeZone timeZone)
```
    Sets the time zone offset from UTC for the current location.
    
    Parameters:
    
    timeZone - The time zone.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class GeoLocation

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NAMESPACE

Constructor Detail

GeoLocation

GeoLocation

Method Detail

getAccuracy

setAccuracy

getAltitude

setAltitude

getArea

setArea

getBearing

setBearing

getBuilding

setBuilding

getCountry

setCountry

getCountryCode

setCountryCode

getDatum

setDatum

getDescription

setDescription

getFloor

setFloor

getLatitude

setLatitude

getLocality

setLocality

getLongitude

setLongitude

getPostalCode

setPostalCode

getRegion

setRegion

getRoom

setRoom

getSpeed

setSpeed

getStreet

setStreet

getText

setText

getTimestamp

setTimestamp

getUri

setUri

getLanguage

setLanguage

getTimeZone

setTimeZone

toString