org.opencrx.application.uses.ezvcard.property

Class PlaceProperty

java.lang.Object

org.opencrx.application.uses.ezvcard.property.VCardProperty

org.opencrx.application.uses.ezvcard.property.PlaceProperty

All Implemented Interfaces:

Comparable<VCardProperty>, HasAltId

Direct Known Subclasses:

Birthplace, Deathplace

public class PlaceProperty
extends VCardProperty
implements HasAltId

Represents the location of a physical place.

Author:

Michael Angstadt

See Also:

RFC 6474

Field Summary

Fields

Modifier and Type	Field and Description
protected GeoUri	geoUri
protected String	text
protected String	uri

Fields inherited from class org.opencrx.application.uses.ezvcard.property.VCardProperty

group, parameters

Constructor Summary

Constructors

Constructor and Description
PlaceProperty() Creates a new place property.
PlaceProperty(double latitude, double longitude) Creates a new place property.
PlaceProperty(String text) Creates a new place property.

Method Summary

Modifier and Type	Method and Description
Set<VCardVersion>	_supportedVersions() Gets the vCard versions that support this property.
protected void	_validate(List<Warning> warnings, VCardVersion version, VCard vcard) Checks the property for data consistency problems or deviations from the spec.
String	getAltId() Gets the property's ALTID parameter.
GeoUri	getGeoUri() Gets the location's geo position.
String	getLanguage() Gets the language that the property value is written in.
Double	getLatitude() Gets the latitude of the location.
Double	getLongitude() Gets the longitude of the location.
String	getText() Gets the text value representing the location.
String	getUri() Gets the URI representing the location.
void	setAltId(String altId) Sets the property's ALTID parameter.
void	setCoordinates(double latitude, double longitude) Sets the property's value to a set of geo coordinates.
void	setGeoUri(GeoUri geoUri) Sets the property's value to a set of geo coordinates.
void	setLanguage(String language) Sets the language that the property value is written in.
void	setText(String text) Sets the property's value to a text value.
void	setUri(String uri) Sets the property's value to a URI.

Methods inherited from class org.opencrx.application.uses.ezvcard.property.VCardProperty

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

Field Detail

geoUri

protected GeoUri geoUri

uri

protected String uri

text

protected String text

Constructor Detail

PlaceProperty

public PlaceProperty()

Creates a new place property.

PlaceProperty

public PlaceProperty(double latitude,
                     double longitude)

Creates a new place property.

Parameters:

latitude - the latitude coordinate of the place

longitude - the longitude coordinate of the place

PlaceProperty

public PlaceProperty(String text)

Creates a new place property.

Parameters:

text - a text value representing the place

Method Detail

_supportedVersions

public Set<VCardVersion> _supportedVersions()

Description copied from class: VCardProperty

Gets the vCard versions that support this property.

This method should be overridden by child classes if the property does not support all vCard versions. The default implementation of this method returns all vCard versions.

Overrides:

_supportedVersions in class VCardProperty

Returns:

the vCard versions that support this property.

getLatitude

public Double getLatitude()

Gets the latitude of the location.

Returns:

the latitude or null if there is no geo information

getLongitude

public Double getLongitude()

Gets the longitude of the location.

Returns:

the longitude or null if there is no geo information

getGeoUri

public GeoUri getGeoUri()

Gets the location's geo position.

Returns:

the geo position or null if there is no geo information

setCoordinates

public void setCoordinates(double latitude,
                           double longitude)

Sets the property's value to a set of geo coordinates.

Parameters:

latitude - the latitude

longitude - the longitude

setGeoUri

public void setGeoUri(GeoUri geoUri)

Sets the property's value to a set of geo coordinates.

Parameters:

geoUri - the geo URI

getUri

public String getUri()

Gets the URI representing the location.

Returns:

the URI or null if no URI is set

setUri

public void setUri(String uri)

Sets the property's value to a URI.

Parameters:

uri - the URI

getText

public String getText()

Gets the text value representing the location.

Returns:

the text value or null if no text value is set

setText

public void setText(String text)

Sets the property's value to a text value.

Parameters:

text - the text

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)

getLanguage

public String getLanguage()

Description copied from class: VCardProperty

Gets the language that the property value is written in.

Returns:

the language or null if not set

See Also:

VCardParameters.getLanguage()

setLanguage

public void setLanguage(String language)

Description copied from class: VCardProperty

Sets the language that the property value is written in.

Parameters:

language - the language or null to remove

See Also:

VCardParameters.setLanguage(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