ezvcard.property
Class Geo

java.lang.Object
  ezvcard.property.VCardProperty
      ezvcard.property.Geo

All Implemented Interfaces:

HasAltId, Comparable<VCardProperty>

public class Geo
extends VCardProperty
implements HasAltId

A set of latitude/longitude coordinates. There is no rule for what these coordinates must represent, but the meaning could vary depending on the value of Kind:

KIND value	GEO meaning
"individual"	the location of the person's home or workplace.
"group"	the location of the group's meeting place.
"org"	the coordinates of the organization's headquarters.
"location"	the coordinates of the location itself.

Code sample

 VCard vcard = new VCard();
 Geo geo = new Geo(-123.456, 12.54);
 vcard.setGeo(geo);
 

Property name: GEO

Supported versions: 2.1, 3.0, 4.0

Author:

Michael Angstadt

Field Summary

Fields inherited from class ezvcard.property.VCardProperty

group, parameters

Constructor Summary

Geo(Double latitude, Double longitude)
Creates a geo property.

Geo(GeoUri uri)
Creates a geo property.

Method Summary

protected void	_validate(List<Warning> warnings, VCardVersion version, VCard vcard) Checks the property for data consistency problems or deviations from the spec.
void	addPid(int localId, int clientPidMapRef) Adds a PID value.
String	getAltId() Gets the property's ALTID parameter.
GeoUri	getGeoUri() Gets the raw object used for storing the GEO information.
Double	getLatitude() Gets the latitude.
Double	getLongitude() Gets the longitude.
String	getMediaType() Gets the MEDIATYPE parameter.
List<Integer[]>	getPids() Gets all PID values.
Integer	getPref() Gets the preference value.
String	getType() Gets the TYPE parameter.
void	removePids() Removes all PID values.
void	setAltId(String altId) Sets the property's ALTID parameter.
void	setGeoUri(GeoUri uri) Sets the raw object used for storing the GEO information.
void	setLatitude(Double latitude) Sets the latitude.
void	setLongitude(Double longitude) Sets the longitude.
void	setMediaType(String mediaType) Sets the MEDIATYPE parameter.
void	setPref(Integer pref) Sets the preference value.
void	setType(String type) Sets the TYPE parameter.

Methods inherited from class ezvcard.property.VCardProperty

_supportedVersions, addParameter, compareTo, getGroup, getParameter, getParameters, getParameters, getSupportedVersions, removeParameter, setGroup, setParameter, setParameters, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

Geo

public Geo(Double latitude,
           Double longitude)

Creates a geo property.

Parameters:

latitude - the latitude

longitude - the longitude

Geo

public Geo(GeoUri uri)

Creates a geo property.

Parameters:

uri - the geo URI

Method Detail

getLatitude

public Double getLatitude()

Gets the latitude.

Returns:

the latitude

setLatitude

public void setLatitude(Double latitude)

Sets the latitude.

Parameters:

latitude - the latitude

getLongitude

public Double getLongitude()

Gets the longitude.

Returns:

the longitude

setLongitude

public void setLongitude(Double longitude)

Sets the longitude.

Parameters:

longitude - the longitude

getGeoUri

public GeoUri getGeoUri()

Gets the raw object used for storing the GEO information. This can be used to supplement the GEO value with additional information (such as altitude or level of accuracy). Geo URIs are only supported by vCard version 4.0. Only latitude and longitude values are used when marshalling to earlier vCard versions.

Returns:

the geo URI object or null if not set

See Also:

RFC 5870

setGeoUri

public void setGeoUri(GeoUri uri)

Sets the raw object used for storing the GEO information. This can be used to supplement the GEO value with additional information (such as altitude or level of accuracy). Geo URIs are only supported by vCard version 4.0. Only latitude and longitude values are used when marshalling to earlier vCard versions.

Parameters:

uri - the geo URI object

See Also:

RFC 5870

getType

public String getType()

Gets the TYPE parameter.

Supported versions: 4.0

Returns:

the TYPE value (typically, this will be either "work" or "home") or null if it doesn't exist

setType

public void setType(String type)

Sets the TYPE parameter.

Supported versions: 4.0

Parameters:

type - the TYPE value (this should be either "work" or "home") or null to remove

getMediaType

public String getMediaType()

Gets the MEDIATYPE parameter.

Supported versions: 4.0

Returns:

the media type or null if not set

setMediaType

public void setMediaType(String mediaType)

Sets the MEDIATYPE parameter.

Supported versions: 4.0

Parameters:

mediaType - the media type or null to remove

getPids

public List<Integer[]> getPids()

Description copied from class: VCardProperty

Gets all PID values.

Supported versions: 4.0

Returns:

the PID values or empty set if there are none

See Also:

VCardParameters.getPids()

addPid

public void addPid(int localId,
                   int clientPidMapRef)

Description copied from class: VCardProperty

Adds a PID value.

Supported versions: 4.0

Parameters:

localId - the local ID

clientPidMapRef - the ID used to reference the property's globally unique identifier in the CLIENTPIDMAP property.

See Also:

VCardParameters.addPid(int, int)

removePids

public void removePids()

Description copied from class: VCardProperty

Removes all PID values.

Supported versions: 4.0

See Also:

VCardParameters.removePids()

getPref

public Integer getPref()

Description copied from class: VCardProperty

Gets the preference value. The lower the number, the more preferred this property instance is compared with other properties in the same vCard of the same type. If a property doesn't have a preference value, then it is considered the least preferred.

Supported versions: 4.0

Returns:

the preference value or null if it doesn't exist

See Also:

VCardParameters.getPref()

setPref

public void setPref(Integer pref)

Description copied from class: VCardProperty

Sets the preference value. The lower the number, the more preferred this property instance is compared with other properties in the same vCard of the same type. If a property doesn't have a preference value, then it is considered the least preferred.

Supported versions: 4.0

Parameters:

pref - the preference value or null to remove

See Also:

VCardParameters.setPref(java.lang.Integer)

getAltId

public String getAltId()

Description copied from interface: HasAltId

Gets the property's ALTID parameter.

Supported versions: 4.0

Specified by:

getAltId in interface HasAltId

Returns:

the ALTID or null if it doesn't exist

See Also:

VCardParameters.getAltId()

setAltId

public void setAltId(String altId)

Description copied from interface: HasAltId

Sets the property's ALTID parameter.

Supported versions: 4.0

Specified by:

setAltId in interface HasAltId

Parameters:

altId - the ALTID or null to remove

See Also:

VCardParameters.setAltId(java.lang.String)

_validate

protected void _validate(List<Warning> warnings,
                         VCardVersion version,
                         VCard vcard)

Description copied from class: VCardProperty

Checks the property for data consistency problems or deviations from the spec. Meant to be overridden by child classes that wish to provide validation logic.

Overrides:

_validate in class VCardProperty

Parameters:

warnings - the list to add the warnings to

version - the version to check the property against

vcard - the vCard this property belongs to