prajna.data.field

Class GeoFieldDesc

java.lang.Object

prajna.data.field.FieldDesc<GeoCoord>

prajna.data.field.GeoFieldDesc

All Implemented Interfaces:

java.io.Serializable, Xmlizable

public class GeoFieldDesc
extends FieldDesc<GeoCoord>

Field description for data fields which have geographic coordinates

Author:

Edward Swing

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GeoFieldDesc() Default constructor with no arguments, useful for cases where the descriptor is configured from XML elements.
GeoFieldDesc(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(GeoCoord value) Return whether a field value is valid.
GeoCoord	parse(java.lang.String stringVal) Parse the value into the format for this field description.
GeoCoord	parseValueIntoRecord(DataRecord rec, java.lang.String value) Parse the string value, and store it in an enumerated value field in the specified data record.
protected void	setValues(org.w3c.dom.NodeList valueList) Set the values according to the series of elements specified by the values tag in the corresponding XML Document.
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 to an XML Element.

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

GeoFieldDesc

public GeoFieldDesc()

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

GeoFieldDesc

public GeoFieldDesc(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<GeoCoord>

Returns:

DataType.GEO

isValid

public boolean isValid(GeoCoord value)

Return whether a field value is valid. This method returns true as long as the latitude is between 90 and -90.

Specified by:

isValid in class FieldDesc<GeoCoord>

Parameters:

value - the field value

Returns:

true

parse

public GeoCoord parse(java.lang.String stringVal)

Parse the value into the format for this field description. Since this field description handles strings, this method simply returns its argument.

Specified by:

parse in class FieldDesc<GeoCoord>

Parameters:

stringVal - the value to parse

Returns:

the parsed string, the stringVal argument.

parseValueIntoRecord

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

Parse the string value, and store it in an enumerated value field in the specified data record. The value is checked against the allowed values. If the value is valid, the DataRecord.setTextField method will be invoked.

Specified by:

parseValueIntoRecord in class FieldDesc<GeoCoord>

Parameters:

rec - the DataRecord to parse the value into

value - the String value to be parsed

Returns:

the value added

Throws:

java.lang.IllegalArgumentException - if the value is not a valid value of this Enumerated Value field

setValues

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

Set the values according to the series of elements specified by the values tag in the corresponding XML Document. Currently this method is a stub.

Specified by:

setValues in class FieldDesc<GeoCoord>

Parameters:

valueList - list of nodes. This should be the child nodes of the values element for this attribute declaration.

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<GeoCoord>

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 to an XML Element. This method creates a fieldDef element, sets the fieldName and fieldType, and creates a values child element. The values element contains all valid values for this enumerated field, in separate value tags. If the default value is set, this method adds it as well.

Specified by:

toXml in interface Xmlizable

Specified by:

toXml in class FieldDesc<GeoCoord>

Parameters:

doc - The document used to construct the element

Returns:

the element representing this field description