prajna.data.field

Class IntFieldDesc

java.lang.Object

prajna.data.field.FieldDesc<java.lang.Integer>

prajna.data.field.IntFieldDesc

All Implemented Interfaces:

java.io.Serializable, Xmlizable

Direct Known Subclasses:

NumericFieldDesc

public class IntFieldDesc
extends FieldDesc<java.lang.Integer>

Field description for integer data fields. This class provides optional bounds for an integer range.

Author:

Edward Swing

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
DataType	getFieldType() Get the field type for this field description
int	getMaxValue() Get the maximum value allowed by this descriptor.
int	getMinValue() Get the minimum value allowed by this descriptor.
boolean	isValid(java.lang.Integer value) Return whether a field value is valid.
java.lang.Integer	parse(java.lang.String stringVal) Parse the value into the format for this field description.
java.lang.Integer	parseValueIntoRecord(DataRecord rec, java.lang.String value) Parse the string value, and store it in an integer field in the specified data record.
protected void	setValues(org.w3c.dom.NodeList valueList) Set the values for this Integer 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

IntFieldDesc

public IntFieldDesc()

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

IntFieldDesc

public IntFieldDesc(java.lang.String fieldName)

Constructor taking a field name.

Parameters:

fieldName - the field name for this descriptor

IntFieldDesc

public IntFieldDesc(java.lang.String fieldName,
            int min,
            int max)

Constructor taking a field name and a range.

Parameters:

fieldName - the field name for this descriptor

min - the minimum value

max - the maximum value

Method Detail

getFieldType

public DataType getFieldType()

Get the field type for this field description

Specified by:

getFieldType in class FieldDesc<java.lang.Integer>

Returns:

FieldType.INT

getMaxValue

public int getMaxValue()

Get the maximum value allowed by this descriptor.

Returns:

the maximum value allowed

getMinValue

public int getMinValue()

Get the minimum value allowed by this descriptor.

Returns:

the minimum value allowed

isValid

public boolean isValid(java.lang.Integer value)

Return whether a field value is valid. This method checks of the string length is between the maximum and minimum values, if they are set.

Specified by:

isValid in class FieldDesc<java.lang.Integer>

Parameters:

value - the field value

Returns:

true if the field is valid for this field description, false otherwise

parse

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

Parse the value into the format for this field description. This method simply uses the Integer class to convert the string, throwing a ParseException of that fails.

Specified by:

parse in class FieldDesc<java.lang.Integer>

Parameters:

stringVal - the value to parse

Returns:

the parsed integer

Throws:

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

parseValueIntoRecord

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

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

Specified by:

parseValueIntoRecord in class FieldDesc<java.lang.Integer>

Parameters:

rec - the DataRecord to parse the value into

value - the String value to be parsed

Returns:

the integer value added

Throws:

java.text.ParseException - if the value cannot be parsed properly

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 for this Integer field description. This method looks for any element with a tag name of maxValue or maxValue to specify the maximum and minimum values accepted by this field.

Specified by:

setValues in class FieldDesc<java.lang.Integer>

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.lang.Integer>

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 maxValue and minValue text nodes. 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.lang.Integer>

Parameters:

doc - The document used to construct the element

Returns:

the element representing this field description