public class Geo extends VCardProperty implements HasAltId
Defines a set of latitude/longitude coordinates. There is no rule as to what
these coordinates represent, but their meaning could vary depending on the
value of the vCard's Kind
property:
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(40.7127, -74.0059); vcard.setGeo(geo);
Property name: GEO
Supported versions: 2.1, 3.0, 4.0
group, parameters
Constructor and Description |
---|
Geo(Double latitude,
Double longitude)
Creates a geo property.
|
Geo(GeoUri uri)
Creates a geo property.
|
Modifier and Type | Method and Description |
---|---|
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.
|
_supportedVersions, addParameter, compareTo, getGroup, getParameter, getParameters, getParameters, getSupportedVersions, removeParameter, setGroup, setParameter, setParameters, validate
public Geo(Double latitude, Double longitude)
latitude
- the latitudelongitude
- the longitudepublic Geo(GeoUri uri)
uri
- the geo URIpublic Double getLatitude()
public void setLatitude(Double latitude)
latitude
- the latitudepublic Double getLongitude()
public void setLongitude(Double longitude)
longitude
- the longitudepublic GeoUri getGeoUri()
public void setGeoUri(GeoUri uri)
uri
- the geo URI objectpublic String getType()
Supported versions: 4.0
public void setType(String type)
Supported versions: 4.0
type
- the TYPE value (this should be either "work" or "home") or
null to removepublic String getMediaType()
Supported versions: 4.0
public void setMediaType(String mediaType)
Supported versions: 4.0
mediaType
- the media type or null to removepublic List<Integer[]> getPids()
VCardProperty
Gets all PID values.
Supported versions: 4.0
VCardParameters.getPids()
public void addPid(int localId, int clientPidMapRef)
VCardProperty
Adds a PID value.
Supported versions: 4.0
localId
- the local IDclientPidMapRef
- the ID used to reference the property's globally
unique identifier in the CLIENTPIDMAP property.VCardParameters.addPid(int, int)
public void removePids()
VCardProperty
Removes all PID values.
Supported versions: 4.0
VCardParameters.removePids()
public Integer getPref()
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
VCardParameters.getPref()
public void setPref(Integer pref)
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
pref
- the preference value or null to removeVCardParameters.setPref(java.lang.Integer)
public String getAltId()
HasAltId
Supported versions: 4.0
getAltId
in interface HasAltId
VCardParameters.getAltId()
public void setAltId(String altId)
HasAltId
Supported versions: 4.0
setAltId
in interface HasAltId
altId
- the ALTID or null to removeVCardParameters.setAltId(java.lang.String)
protected void _validate(List<Warning> warnings, VCardVersion version, VCard vcard)
VCardProperty
_validate
in class VCardProperty
warnings
- the list to add the warnings toversion
- the version to check the property againstvcard
- the vCard this property belongs toThis software is published under the BSD license. Copyright © 2003-${build.year}, CRIXP AG, Switzerland, All rights reserved. Use is subject to license terms.