prajna.data.field

Class BooleanFieldDesc

java.lang.Object

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

prajna.data.field.BooleanFieldDesc

All Implemented Interfaces:

java.io.Serializable, Xmlizable

public class BooleanFieldDesc
extends FieldDesc<java.lang.Boolean>

Field Descriptor for a Boolean field.

Author:

Edward Swing

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BooleanFieldDesc() Default constructor with no arguments, useful for cases where the descriptor is configured from XML elements.
BooleanFieldDesc(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.lang.Boolean value) Return whether a field value is valid.
java.lang.Boolean	parse(java.lang.String stringVal) Parse a given expression into a boolean value.
java.lang.Boolean	parseValueIntoRecord(DataRecord rec, java.lang.String value) Parse the given value into a data record field.
protected void	setValues(org.w3c.dom.NodeList valueList) Set values for this field descriptor.
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

BooleanFieldDesc

public BooleanFieldDesc()

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

BooleanFieldDesc

public BooleanFieldDesc(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.lang.Boolean>

Returns:

DataType.BOOLEAN

isValid

public boolean isValid(java.lang.Boolean value)

Return whether a field value is valid. Since a boolean can only have True or False values, this always returns true.

Specified by:

isValid in class FieldDesc<java.lang.Boolean>

Parameters:

value - the field value

Returns:

true

parse

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

Parse a given expression into a boolean value. This method parses both true/false and yes/no into boolean values, ignoring case.

Specified by:

parse in class FieldDesc<java.lang.Boolean>

Parameters:

stringVal - the string value to parse

Returns:

the boolean value

Throws:

java.text.ParseException - if the expression is not parseable

parseValueIntoRecord

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

Parse the given value into a data record field. This stores a string representation of the boolean value into an enumerated field in the data record

Specified by:

parseValueIntoRecord in class FieldDesc<java.lang.Boolean>

Parameters:

rec - the data record

value - the string value to parse

Returns:

the value parsed

Throws:

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

setValues

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

Set values for this field descriptor. This method is a stub, since the values for booleans are only true and false.

Specified by:

setValues in class FieldDesc<java.lang.Boolean>

Parameters:

valueList - the value list

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.Boolean>

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. Not implemented yet.

Specified by:

toXml in interface Xmlizable

Specified by:

toXml in class FieldDesc<java.lang.Boolean>

Parameters:

doc - The document used to construct the element

Returns:

the element representing this field description