net.java.sip.communicator.service.protocol
Interface OperationSetGeolocation

All Superinterfaces:

OperationSet

All Known Implementing Classes:

OperationSetGeolocationJabberImpl

public interface OperationSetGeolocation
extends OperationSet

This interface is an extension of the operation set, meant to be implemented by protocols that support exchange of geolocation details (like Jabber for example).

Author:

Guillaume Schreiner

Field Summary

static String	ALT The name of the geolocation map key corresponding to the altitude in meters above or below sea level (e.g.
static String	AREA The name of the geolocation map key that we use for storing named areas such as a campus or neighborhood (e.g.
static String	BEARING The name of the geolocation map key that we use for storing GPS bearing (direction in which the entity is heading to reach its next waypoint), measured in decimal degrees relative to true north.
static String	BUILDING The name of the geolocation map key that we use for indicating a specific building on a street or in an area (e.g.
static String	COUNTRY The name of the geolocation map key that we use for indicating the nation where the user is located (e.g.
static String	DATUM GPS datum.
static String	DESCRIPTION The name of the geolocation map key that we use for storing a natural-language name for or description of a given location (e.g.
static String	ERROR The name of the geolocation map key that we use for storing horizontal GPS errors in arc minutes (e.g.
static String	FLOOR The name of the geolocation map key that we use for storing a particular floor in a building (e.g.
static String	LAT The name of the geolocation map key that we use for storing geographic latitude in decimal degrees North (e.g.
static String	LOCALITY The name of the geolocation map key that we use for indicating a locality within the administrative region, such as a town or city (e.g.
static String	LON The name of the geolocation map key that we use for indicating longitude in decimal degrees East (e.g.
static String	POSTALCODE The name of the geolocation map key that we use for storing post codes (or any code used for postal delivery) (e.g.
static String	REGION The name of the geolocation map key that we use for indicating an administrative region of the nation, such as a state or province (e.g.
static String	ROOM The name of the geolocation map key that we use for indicating a particular room in a building (e.g.
static String	STREET The name of the geolocation map key that we use for storing a thoroughfare within a locality, or a crossing of two thoroughfares (e.g.
static String	TEXT The name of the geolocation map key that we use to indicate a catch-all element that captures any other information about the location (e.g.
static String	TIMESTAMP The name of the geolocation map key that we use to indicate UTC timestamp specifying the moment when the reading was taken (e.g.

Method Summary

void	addGeolocationListener(GeolocationListener listener) Registers a listener that would get notifications any time a contact publishes a new geolocation.
void	publishGeolocation(Map<String,String> geolocation) Publish the location contained in the geolocation map to all contacts in our contact list.
Map<String,String>	queryContactGeolocation(String contactIdentifier) Retrieve the geolocation of the contact corresponding to contactIdentifier.
void	removeGeolocationListener(GeolocationListener listener) Removes a listener previously registered for notifications of changes in the contact geolocation details.

Field Detail

ALT

static final String ALT

The name of the geolocation map key corresponding to the altitude in meters above or below sea level (e.g. 1609).

See Also:

Constant Field Values

AREA

static final String AREA

The name of the geolocation map key that we use for storing named areas such as a campus or neighborhood (e.g. Central Park).

See Also:

Constant Field Values

BEARING

static final String BEARING

The name of the geolocation map key that we use for storing GPS bearing (direction in which the entity is heading to reach its next waypoint), measured in decimal degrees relative to true north.

See Also:

Constant Field Values

BUILDING

static final String BUILDING

The name of the geolocation map key that we use for indicating a specific building on a street or in an area (e.g. The Empire State Building).

See Also:

Constant Field Values

COUNTRY

static final String COUNTRY

The name of the geolocation map key that we use for indicating the nation where the user is located (e.g. Greenland).

See Also:

Constant Field Values

DATUM

static final String DATUM

GPS datum.

See Also:

Constant Field Values

DESCRIPTION

static final String DESCRIPTION

The name of the geolocation map key that we use for storing a natural-language name for or description of a given location (e.g. Bill's house).

See Also:

Constant Field Values

ERROR

static final String ERROR

The name of the geolocation map key that we use for storing horizontal GPS errors in arc minutes (e.g. 10).

See Also:

Constant Field Values

FLOOR

static final String FLOOR

The name of the geolocation map key that we use for storing a particular floor in a building (e.g. 102).

See Also:

Constant Field Values

LAT

static final String LAT

The name of the geolocation map key that we use for storing geographic latitude in decimal degrees North (e.g. 39.75).

See Also:

Constant Field Values

LOCALITY

static final String LOCALITY

The name of the geolocation map key that we use for indicating a locality within the administrative region, such as a town or city (e.g. Paris).

See Also:

Constant Field Values

LON

static final String LON

The name of the geolocation map key that we use for indicating longitude in decimal degrees East (e.g. -104.99).

See Also:

Constant Field Values

POSTALCODE

static final String POSTALCODE

The name of the geolocation map key that we use for storing post codes (or any code used for postal delivery) (e.g. 67000).

See Also:

Constant Field Values

REGION

static final String REGION

The name of the geolocation map key that we use for indicating an administrative region of the nation, such as a state or province (e.g. Ile de France).

See Also:

Constant Field Values

ROOM

static final String ROOM

The name of the geolocation map key that we use for indicating a particular room in a building (e.g. C-425).

See Also:

Constant Field Values

STREET

static final String STREET

The name of the geolocation map key that we use for storing a thoroughfare within a locality, or a crossing of two thoroughfares (e.g. 34th and Broadway).

See Also:

Constant Field Values

TEXT

static final String TEXT

The name of the geolocation map key that we use to indicate a catch-all element that captures any other information about the location (e.g. North-West corner of the lobby).

See Also:

Constant Field Values

TIMESTAMP

static final String TIMESTAMP

The name of the geolocation map key that we use to indicate UTC timestamp specifying the moment when the reading was taken (e.g. 2007-05-27T21:12Z).

See Also:

Constant Field Values

Method Detail

publishGeolocation

void publishGeolocation(Map<String,String> geolocation)

Publish the location contained in the geolocation map to all contacts in our contact list.

Parameters:

geolocation - a java.uil.Map containing the geolocation details of the position we'd like to publish.

queryContactGeolocation

Map<String,String> queryContactGeolocation(String contactIdentifier)

Retrieve the geolocation of the contact corresponding to contactIdentifier.

Parameters:

contactIdentifier - the address of the Contact whose geolocation details we'd like to retrieve.

Returns:

a java.util.Map containing the geolocation details of the contact with address contactIdentifier.

addGeolocationListener

void addGeolocationListener(GeolocationListener listener)

Registers a listener that would get notifications any time a contact publishes a new geolocation.

Parameters:

listener - the GeolocationListener to register

removeGeolocationListener

void removeGeolocationListener(GeolocationListener listener)

Removes a listener previously registered for notifications of changes in the contact geolocation details.

Parameters:

listener - the GeolocationListener to unregister