prajna.data.field

Class UrlFieldDesc

java.lang.Object

prajna.data.field.FieldDesc<java.net.URL>

prajna.data.field.UrlFieldDesc

All Implemented Interfaces:

java.io.Serializable, Xmlizable

public class UrlFieldDesc
extends FieldDesc<java.net.URL>

Field Descriptor for URLs. This class is experimental, and may be changed to include URIs as well.

Author:

Edward Swing

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UrlFieldDesc() Default constructor with no arguments, useful for cases where the descriptor is configured from XML elements.
UrlFieldDesc(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(java.net.URL value) Return whether a field value is valid.
java.net.URL	parse(java.lang.String stringVal) Parse the value into the format for this field description.
java.net.URL	parseValueIntoRecord(DataRecord rec, java.lang.String value) Validate the string value, and store it in a string field in the specified data record.
protected void	setValues(org.w3c.dom.NodeList valueList) Set the values for this URL 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 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

UrlFieldDesc

public UrlFieldDesc()

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

UrlFieldDesc

public UrlFieldDesc(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<java.net.URL>

Returns:

FieldType.TEXT

isValid

public boolean isValid(java.net.URL value)

Return whether a field value is valid. This method always returns true

Specified by:

isValid in class FieldDesc<java.net.URL>

Parameters:

value - the field value

Returns:

true

parse

public java.net.URL parse(java.lang.String stringVal)
                   throws java.text.ParseException

Parse the value into the format for this field description. This method simply tries to initialize a URL from the string, throwing a ParseException of that fails.

Specified by:

parse in class FieldDesc<java.net.URL>

Parameters:

stringVal - the value to parse

Returns:

the parsed URL

Throws:

java.text.ParseException - if the string cannot be parsed as an integer

parseValueIntoRecord

public java.net.URL parseValueIntoRecord(DataRecord rec,
                                java.lang.String value)
                                  throws java.text.ParseException

Validate the string value, and store it in a string field in the specified data record. The value is checked against the maximum strign length allowed If the value is valid, the DataRecord.setTextField method will be invoked.

Specified by:

parseValueIntoRecord in class FieldDesc<java.net.URL>

Parameters:

rec - the DataRecord to parse the value into

value - the String value to be parsed

Returns:

the string value added

Throws:

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

java.text.ParseException - if there is a problem parsing the string

setValues

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

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

Specified by:

setValues in class FieldDesc<java.net.URL>

Parameters:

valueList - list of value nodes. These are child nodes of the values element

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<java.net.URL>

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 the optional maxLength text node. If the default value is set, this method adds it as well.

Specified by:

toXml in interface Xmlizable

Specified by:

toXml in class FieldDesc<java.net.URL>

Parameters:

doc - The document used to construct the element

Returns:

the element representing this field description