com.google.gdata.data.geo

Class GeoLat

java.lang.Object

com.google.gdata.data.AbstractExtension

com.google.gdata.data.ValueConstruct

com.google.gdata.data.geo.GeoLat

All Implemented Interfaces:

Extension

public class GeoLat
extends ValueConstruct

Extension for a W3C geo:lat element. It contains the getter/setter for specifying a latitude of a geo-coordinate. The coordinate is contained within the lat element as: <geo:lat>coordinate</geo:lat> . Note that the latitude element does not need to be a child of the geo:Point element. Please see the W3C document http://www.w3.org/2003/01/geo for more information.

See Also:

W3CPoint

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gdata.data.AbstractExtension

AbstractExtension.AttributesHandler

Field Summary

Fields

Modifier and Type	Field and Description
static int	COORDINATE_PRECISION This denotes the number of significant digits after the decimal point for a coordinate when represented by a string.
static double	MAX_LAT The maximmum acceptable value of a latitude coordinate in degrees.
static double	MIN_LAT The minimum acceptable value of a latitude coordinate in degrees.

Fields inherited from class com.google.gdata.data.ValueConstruct

attrName

Fields inherited from class com.google.gdata.data.AbstractExtension

localName, namespace

Constructor Summary

Constructors

Constructor and Description
GeoLat() Creates an instance of the GeoLat extension without a latitude value set.
GeoLat(java.lang.Double lat) Creates an immutable instance of GeoLat extension with the coordinate set to the value passed in.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Double	getLatitude() Returns the actual double coordinate for latitude.
void	setLatitude(java.lang.Double latitude) Sets the latitude represented by this element.
void	setValue(java.lang.String value) Overrides base implementation by validating that the string represents a latitude coordinate between -90 and 90 degrees.

Methods inherited from class com.google.gdata.data.ValueConstruct

consumeAttributes, equals, generate, getHandler, getValue, hashCode, hasValue, isRequired, putAttributes, setRequired

Methods inherited from class com.google.gdata.data.AbstractExtension

disableStrictValidation, enableStrictValidation, eq, generate, generateAttributes, getExtensionLocalName, getExtensionNamespace, isImmutable, isStrictValidation, sameClassAs, setImmutable, throwExceptionForMissingAttribute, throwExceptionIfImmutable, validate

Methods inherited from class java.lang.Object

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

Field Detail

MAX_LAT

public static final double MAX_LAT

The maximmum acceptable value of a latitude coordinate in degrees.

See Also:

Constant Field Values

MIN_LAT

public static final double MIN_LAT

The minimum acceptable value of a latitude coordinate in degrees.

See Also:

Constant Field Values

COORDINATE_PRECISION

public static final int COORDINATE_PRECISION

This denotes the number of significant digits after the decimal point for a coordinate when represented by a string.

See Also:

Constant Field Values

Constructor Detail

GeoLat

public GeoLat()

Creates an instance of the GeoLat extension without a latitude value set.

GeoLat

public GeoLat(java.lang.Double lat)
       throws java.lang.IllegalArgumentException

Creates an immutable instance of GeoLat extension with the coordinate set to the value passed in.

Parameters:

lat - The latitude coordinate reprensented by this element.

Throws:

java.lang.IllegalArgumentException - if the the latitude is not between -90 and 90.

Method Detail

getLatitude

public java.lang.Double getLatitude()

Returns the actual double coordinate for latitude. Note this value is not rounded unlike the value returned by getValue().

Returns:

the latitude represented by this element.

setLatitude

public void setLatitude(java.lang.Double latitude)

Sets the latitude represented by this element.

Parameters:

latitude - the latitude of this element.

setValue

public void setValue(java.lang.String value)

Overrides base implementation by validating that the string represents a latitude coordinate between -90 and 90 degrees. Also formats the the string so that it has a consistent number of significant digits after the decimal point.

Overrides:

setValue in class ValueConstruct

Parameters:

value - new value for the value construct or null to reset.