dk.heick.properties.types

Class LatLngPropertyType

java.lang.Object

dk.heick.properties.PropertyType<LatLng>

dk.heick.properties.types.LatLngPropertyType

All Implemented Interfaces:

Serializable

public class LatLngPropertyType
extends PropertyType<LatLng>

See detailed descriptions in the LatLng and GeoUtils documentation.
Java conversion of Geodesy representation conversion functions (c) Chris Veness 2002-2014
- www.movable-type.co.uk/scripts/latlong.html.

PropertyType that validates to a to double seperated by comma to a LatLng instance (Latitude,Longitude).
This type convert and validates a string to a dk.heick.properties.types.custom.LatLng.

Constructor Example			Comments
Property<LatLng> A_PROPERTY = new Property<LatLng>("name", new LatLngPropertyType());			Default value is null.
Property<LatLng> A_PROPERTY = new Property<LatLng>("name", new LatLngPropertyType(new LatLng(25.205,-36.4578));			Default value is new LatLng(25.205,-36.4578).
Type of value(s)	Examples	Result	Comments
Valid	25.205,-36.4578	new LatLng(25.205,-36.4578)	Validate successfully. Can parse many formats.
Valid	25.0° 12.0' 18.0"S , 136.0° 07.0' 08.0"E	new LatLng(25.205,-36.4578)
Invalid	cow	null	Validate will throw an exception. The resulting value is null.
Invalid	«empty string»	null
Invalid	«only spaces»	null
Invalid	null	defaultValue OR null	Validate will throw an exception. Return default value if set, otherwise null.

Since:

1.9

Author:

Frederik Heick

See Also:

LatLng, GeoUtils, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static char	LAT_LNG_SEPERATOR Seperates the Latitude and Longtiude value in a string, default value is a comma, ",".
static String	TYPE The type name string constant of LatLngPropertyType

Constructor Summary

Constructors

Constructor and Description
LatLngPropertyType() Default constructor, no default value.
LatLngPropertyType(LatLng defaultValue)

Method Summary

Modifier and Type	Method and Description
List<String>	getRestrictions() Gets a detailed description of the PropertyType with any constraints that might influence the validation.
LatLng	validateValue(String propertyName, String value) Converts the string representation of to a typed value.

Methods inherited from class dk.heick.properties.PropertyType

equals, getDefaultValue, getDefaultValueAsString, getDefaultValueDescription, getDescription, getDescription, getInitializationPriority, getIo, getLogger, getTypeName, hasDefaultValue, isDefaultValueValid, postGetValueProcessing, setDefaultValue, setInitializationPriority, setIo, setTypedValue, setTypeName, toString, toType, validate, validateConstraints, validateNullType

Methods inherited from class java.lang.Object

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

Field Detail

LAT_LNG_SEPERATOR

public static final char LAT_LNG_SEPERATOR

Seperates the Latitude and Longtiude value in a string, default value is a comma, ",".

See Also:

GeoUtils.LAT_LNG_SEPERATOR, Constant Field Values

TYPE

public static final String TYPE

The type name string constant of LatLngPropertyType

See Also:

Constant Field Values

Constructor Detail

LatLngPropertyType

public LatLngPropertyType()

Default constructor, no default value.

LatLngPropertyType

public LatLngPropertyType(LatLng defaultValue)

Parameters:

defaultValue -

Method Detail

getRestrictions

public List<String> getRestrictions()

Description copied from class: PropertyType

Gets a detailed description of the PropertyType with any constraints that might influence the validation.
This includes a description for the default value, if the default do not it self parse the validation of the type, the exception is appended to the description.

Specified by:

getRestrictions in class PropertyType<LatLng>

Returns:

the restrictions of the PropertyType as a list of strings.

validateValue

public LatLng validateValue(String propertyName,
                            String value)
                     throws PropertyException

Description copied from class: PropertyType

Converts the string representation of to a typed value.
Including validation of any restrictions the PropertyType might have.
See the individual property type class description for details on how it convert to a typed value.

IMPORTANT: This only validates the value not the constraints of the PropertyType, which is at this point assumed to be valid.

Specified by:

validateValue in class PropertyType<LatLng>

Parameters:

propertyName - the name of the property used for logging purposes. To uniquely identify the Property with validation issues.

value - the string representation of the property

Returns:

the typed converted value.

Throws:

PropertyException - if the conversion failed.