org.glassfish.cafe.api.presence
Interface GeographicalLocation

public interface GeographicalLocation

The GeographicalLocationInfo components model the person�s or the device�s geographical location. The GeographicalLocationInfo and CivicLocationInfo interfaces together form an implementation of the GEOPRIV Location Object Format specified in RFC4119.

Method Summary

CivicLocationInfo	createCivicLocationInfo() Creates a CivicLocationInfo and adds it to the ImsGeographicalLocationInfo.
CivicLocationInfo	getCivicLocationInfo() Returns the CivicLocationInfo of the ImsGeographicalLocationInfo.
String	getCoordinates() Returns the coordinates of the current GeographicalLocationInfo.
String	getGMLId() Returns the Geography Markup Language (GML) identifier for the current point of the GeographicalLocationInfo.
String	getSRSName() Returns the Spatial Reference System (SRS) name of the current point of the GeographicalLocationInfo.
void	removeCivicLocationInfo() Removes any existing CivicLocationInfo from the GeographicalLocationInfo.
void	removePoint() Removes any existing point from the GeographicalLocation.
void	setPoint(String gmlId, String srsName, String coordinates) Sets the point of the current GeographicalLocationInfo, including the Geography Markup Language (GML) identifier, the Spartial Reference System (SRS) name and the coordinates.

Method Detail

createCivicLocationInfo

CivicLocationInfo createCivicLocationInfo()

Creates a CivicLocationInfo and adds it to the ImsGeographicalLocationInfo. This will replace any existing CivicLocationInfo.

Returns:

a new CivicLocationInfo.

getCivicLocationInfo

CivicLocationInfo getCivicLocationInfo()

Returns the CivicLocationInfo of the ImsGeographicalLocationInfo.

Returns:

the CivicLocationInfo or null if the CivicLocationInfo is not available

removeCivicLocationInfo

void removeCivicLocationInfo()

Removes any existing CivicLocationInfo from the GeographicalLocationInfo.

getCoordinates

String getCoordinates()

Returns the coordinates of the current GeographicalLocationInfo.

Returns:

the coordinates or null if the coordinate is not available.

getGMLId

String getGMLId()

Returns the Geography Markup Language (GML) identifier for the current point of the GeographicalLocationInfo.

Returns:

the GML identifier or null if the identifier is not available

getSRSName

String getSRSName()

Returns the Spatial Reference System (SRS) name of the current point of the GeographicalLocationInfo.

Returns:

the SRS name or null if the name is not available.

setPoint

void setPoint(String gmlId,
              String srsName,
              String coordinates)

Sets the point of the current GeographicalLocationInfo, including the Geography Markup Language (GML) identifier, the Spartial Reference System (SRS) name and the coordinates. This will replace any existing point.

Parameters:

gmlId - the GML identity.

srsName - the SRS name.

coordinates - the coordinates.

removePoint

void removePoint()

Removes any existing point from the GeographicalLocation.