prajna.data.field

Class LocationFieldDesc

java.lang.Object

prajna.data.field.FieldDesc<Location>

prajna.data.field.LocationFieldDesc

All Implemented Interfaces:

java.io.Serializable, Xmlizable

public class LocationFieldDesc
extends FieldDesc<Location>

Field description for data fields which represent locations. The field descriptor handles parsing values. Since locations can simply be placenames, this description class does not force any particular formats on the values.

Author:

Edward Swing

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LocationFieldDesc() Default constructor with no arguments, useful for cases where the descriptor is configured from XML elements.
LocationFieldDesc(java.lang.String fieldName) Constructor taking a field name.

Method Summary

Methods

Modifier and Type	Method and Description
DataType	getFieldType() Get the field type for this field description
boolean	isValid(Location value) Determines whether the given location is valid.
Location	parse(java.lang.String stringVal) Parse a string into a location.
Location	parseValueIntoRecord(DataRecord rec, java.lang.String value) Parse the string value, and store it in a location field in the specified data record.
protected void	setValues(org.w3c.dom.NodeList valueList) Set the values for this field description.
void	storeDefaultIntoRecord(DataRecord rec) Store the default value into the data record provided.
org.w3c.dom.Element	toXml(org.w3c.dom.Document doc) Convert this field description into an XML element for the specified document.

Methods inherited from class prajna.data.field.FieldDesc

addSourceField, applyTransform, getDefaultValue, getFieldName, getLookupIndexField, getLookupTable, getLookupValueField, getSourceFields, getTransform, isMultiValue, loadFromXml, setDefaultValue, setFieldName, setMultiValue

Methods inherited from class java.lang.Object

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

Constructor Detail

LocationFieldDesc

public LocationFieldDesc()

Default constructor with no arguments, useful for cases where the descriptor is configured from XML elements.

LocationFieldDesc

public LocationFieldDesc(java.lang.String fieldName)

Constructor taking a field name.

Parameters:

fieldName - the field name for this descriptor

Method Detail

getFieldType

public DataType getFieldType()

Get the field type for this field description

Specified by:

getFieldType in class FieldDesc<Location>

Returns:

FieldType.LOCATION

isValid

public boolean isValid(Location value)

Determines whether the given location is valid. Since any location is currently valid, this method always returns true.

Specified by:

isValid in class FieldDesc<Location>

Parameters:

value - the location to evaluate

Returns:

true

parse

public Location parse(java.lang.String stringVal)

Parse a string into a location. A new Location object is created with the string as its name. If the location can be parsed into a GeoCoord - if it is a latitude/longitude pair in either DDMMSS format or decimal degrees - the center of the location is set to that coordinate. This description field does not yet validate whether a particular location is a valid locaation reference.

Specified by:

parse in class FieldDesc<Location>

Parameters:

stringVal - the value to parse

Returns:

a Location object with the name stringVal, and optional center coordinate

parseValueIntoRecord

public Location parseValueIntoRecord(DataRecord rec,
                            java.lang.String value)

Parse the string value, and store it in a location field in the specified data record. The DataRecord.setLocationField method will be invoked with a location constructed from the parse() method.

Specified by:

parseValueIntoRecord in class FieldDesc<Location>

Parameters:

rec - the DataRecord to parse the value into

value - the String value to be parsed

Returns:

the location value added

setValues

protected void setValues(org.w3c.dom.NodeList valueList)

Set the values for this field description. This method currently does nothing.

Specified by:

setValues in class FieldDesc<Location>

Parameters:

valueList - set of value nodes

storeDefaultIntoRecord

public void storeDefaultIntoRecord(DataRecord rec)

Store the default value into the data record provided. If the default value is null, no action is taken.

Specified by:

storeDefaultIntoRecord in class FieldDesc<Location>

Parameters:

rec - the DataRecord to store the value into

toXml

public org.w3c.dom.Element toXml(org.w3c.dom.Document doc)

Convert this field description into an XML element for the specified document. This method sets the fieldName and type fields TODO: DOCUMENT ME

Specified by:

toXml in interface Xmlizable

Specified by:

toXml in class FieldDesc<Location>

Parameters:

doc - the XML document

Returns:

the Element containing the information for this field description