prajna.data.field

Class DataTemplate

java.lang.Object

prajna.data.DataRecord

prajna.data.field.DataTemplate

All Implemented Interfaces:

java.io.Serializable, Xmlizable

public class DataTemplate
extends DataRecord
implements Xmlizable

Provides field descriptions and formats for data structure elements. The DataTemplate class identifies the fields that a DataRecord may have. It identifies what field types correspond to which field names, and also identifies allowed values. The DataTemplate can also function as a formatted DataRecord which enforces its format on underlying data values.

Author:

Edward Swing

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DataTemplate(org.w3c.dom.Element elem) Instantiates a new data template from an XML element
DataTemplate(java.util.Set<FieldDesc<?>> fieldDescriptions) Instantiates a new DataTemplate from a set of Field Description objects
DataTemplate(java.lang.String name, java.util.Set<DataRecord> records) Instantiates a new data template from a name and set of DataRecord objects.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addFieldDesc(java.lang.String fieldName, FieldDesc<?> desc) Adds the field description to the internal tables.
void	addNameKey(java.lang.String nameKey) Add a name key for this template
DataRecord	createDataRecord(org.w3c.dom.Element elem) Creates a data record from the XML element.
FieldDesc<?>	getFieldDescription(java.lang.String fieldName) Gets the field description for a particular field name.
java.util.HashMap<java.lang.String,FieldDesc<?>>	getFieldDescriptions() Returns a defensive copy of the field descriptions.
java.lang.String	getNameKey() Get the name key.
java.util.List<java.lang.String>	getNameKeyList() Get the name key list.
java.lang.String	getQuery() Get the query string associated with this template
java.lang.String	getRecordIdentifier() Get the record identifier, which is used by some accessors to determine what the records are.
void	loadFromXml(org.w3c.dom.Element elem) Load info from a DataTemplate element.
boolean	matchesTemplate(DataRecord node) Determines if a DataRecord matches this DataTemplate.
void	mergeData(DataTemplate otherNode) Merges the data from another DataRecord with this one.
void	setEnumField(java.lang.String fieldName, java.lang.String fieldValue) Sets the value for a particular enumerated value field.
void	setFloatField(java.lang.String fieldName, double fieldValue) Sets the value for a particular data field.
void	setIntField(java.lang.String fieldName, java.lang.Integer fieldValue) Sets the value for a particular integer field.
void	setLocationField(java.lang.String fieldName, Location fieldValue) Sets the value for a particular location field.
void	setMeasureField(java.lang.String fieldName, Measure fieldValue) Sets the value for a particular measure field.
void	setRecordIdentifier(java.lang.String recordIdentifier) Set the record identifier, which is used by some accessors to determine what the records are.
void	setTextField(java.lang.String fieldName, java.lang.String fieldValue) Sets the value for a particular text field.
void	setTimeField(java.lang.String fieldName, TimeSpan fieldValue) Sets the value for a particular time field.
org.w3c.dom.Element	toXml(org.w3c.dom.Document doc) Converts this DataRecordTemplate to an XML Element.
boolean	validateFields(DataRecord record) Validate fields against the specifications for this Data Template.

Methods inherited from class prajna.data.DataRecord

addEnumFieldValue, addIntFieldValue, addLocationFieldValue, addMeasureFieldValue, addTextFieldValue, addTimeFieldValue, getAllFieldNames, getEnumField, getEnumFieldNames, getEnumValues, getFieldAsString, getFieldType, getFloatField, getIntField, getIntFieldNames, getIntValues, getLink, getLocationField, getLocationFieldNames, getLocationValues, getMeasureField, getMeasureFieldNames, getMeasureValues, getName, getTextField, getTextFieldNames, getTextValues, getTimeField, getTimeFieldNames, getTimeValues, isMultiValued, mergeData, parseDataField, removeEnumFieldValue, removeField, removeIntFieldValue, removeLocationFieldValue, removeMeasureFieldValue, removeTextFieldValue, removeTimeFieldValue, setLink, setName, toString, writeFieldsToMap, writeFieldsToString

Methods inherited from class java.lang.Object

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

Constructor Detail

DataTemplate

public DataTemplate(org.w3c.dom.Element elem)

Instantiates a new data template from an XML element

Parameters:

elem - the XML element

DataTemplate

public DataTemplate(java.util.Set<FieldDesc<?>> fieldDescriptions)

Instantiates a new DataTemplate from a set of Field Description objects

Parameters:

fieldDescriptions - the set of field descriptions

DataTemplate

public DataTemplate(java.lang.String name,
            java.util.Set<DataRecord> records)

Instantiates a new data template from a name and set of DataRecord objects.

Parameters:

name - the template name

records - the set of records

Method Detail

addFieldDesc

protected void addFieldDesc(java.lang.String fieldName,
                FieldDesc<?> desc)

Adds the field description to the internal tables.

Parameters:

fieldName - the field name

desc - the field description object

addNameKey

public void addNameKey(java.lang.String nameKey)

Add a name key for this template

Parameters:

nameKey - the new name key

createDataRecord

public DataRecord createDataRecord(org.w3c.dom.Element elem)

Creates a data record from the XML element. The resulting data record conforms to this Data Template.

Parameters:

elem - the XML element

Returns:

the new DataRecord

getFieldDescription

public FieldDesc<?> getFieldDescription(java.lang.String fieldName)

Gets the field description for a particular field name.

Parameters:

fieldName - the field name

Returns:

the field description

getFieldDescriptions

public java.util.HashMap<java.lang.String,FieldDesc<?>> getFieldDescriptions()

Returns a defensive copy of the field descriptions.

Returns:

the field descriptions

getNameKey

public java.lang.String getNameKey()

Get the name key. This is the field which should be used for the distinct name of any nodes. The value of the name key should correspond to a source field within the data set, not necessarily one of the field declarations. Most templates should only use a single name key

Returns:

the name key field name

getNameKeyList

public java.util.List<java.lang.String> getNameKeyList()

Get the name key list. This is the list of fields which should be used for the name of any nodes. The value of the name keys should correspond to a source field within the data set, not necessarily one of the field declarations. Most templates should only use a single name key.

Returns:

the list of field names for the name key

getQuery

public java.lang.String getQuery()

Get the query string associated with this template

Returns:

the query string

getRecordIdentifier

public java.lang.String getRecordIdentifier()

Get the record identifier, which is used by some accessors to determine what the records are. The identifier can refer to a table within a database, or an element name in an XML file, etc.

Returns:

the record identifier

loadFromXml

public void loadFromXml(org.w3c.dom.Element elem)

Load info from a DataTemplate element.

Specified by:

loadFromXml in interface Xmlizable

Parameters:

elem - the element

matchesTemplate

public boolean matchesTemplate(DataRecord node)

Determines if a DataRecord matches this DataTemplate. The DataRecord matches if all fields are valid fields that are contained within this DataTemplate.

Parameters:

node - the DataRecord to check

Returns:

true if the record matches this template, false otherwise

mergeData

public void mergeData(DataTemplate otherNode)

Merges the data from another DataRecord with this one. The fields which do not occur in this DataRecord will be set to the values from the other DataRecord. If there is a conflict, the value for this DataRecord will not change.

Parameters:

otherNode - The other node to merge with this node.

setEnumField

public void setEnumField(java.lang.String fieldName,
                java.lang.String fieldValue)

Sets the value for a particular enumerated value field. This method ensures that the enumerated value is one of the allowed values for the field

Overrides:

setEnumField in class DataRecord

Parameters:

fieldName - the name of the enumerated value field

fieldValue - the value of the enumerated value field

setFloatField

public void setFloatField(java.lang.String fieldName,
                 double fieldValue)

Sets the value for a particular data field. Setting the float field actually creates (and sets) a Measure value with the Unitless unit type. This method ensures that the value conforms to the format of the specified measure field.

Overrides:

setFloatField in class DataRecord

Parameters:

fieldName - the name of the text field

fieldValue - the value of the text field

setIntField

public void setIntField(java.lang.String fieldName,
               java.lang.Integer fieldValue)

Sets the value for a particular integer field. This method ensures that the value conforms to the field specification.

Overrides:

setIntField in class DataRecord

Parameters:

fieldName - the name of the integer field

fieldValue - the value of the integer field

setLocationField

public void setLocationField(java.lang.String fieldName,
                    Location fieldValue)

Sets the value for a particular location field. This method ensures that the location value field conforms to the field specification.

Overrides:

setLocationField in class DataRecord

Parameters:

fieldName - the name of the location field

fieldValue - the value of the location field

setMeasureField

public void setMeasureField(java.lang.String fieldName,
                   Measure fieldValue)

Sets the value for a particular measure field. This method ensures that the measure value field conforms to the field specification.

Overrides:

setMeasureField in class DataRecord

Parameters:

fieldName - the name of the measure field

fieldValue - the value of the measure field

setRecordIdentifier

public void setRecordIdentifier(java.lang.String recordIdentifier)

Set the record identifier, which is used by some accessors to determine what the records are. The identifier can refer to a table within a database, or an element name in an XML file, etc.

Parameters:

recordIdentifier - the record identifier

setTextField

public void setTextField(java.lang.String fieldName,
                java.lang.String fieldValue)

Sets the value for a particular text field. This method ensures that the text value field conforms to the field specification.

Overrides:

setTextField in class DataRecord

Parameters:

fieldName - the name of the text field

fieldValue - the value of the text field

setTimeField

public void setTimeField(java.lang.String fieldName,
                TimeSpan fieldValue)

Sets the value for a particular time field. This method ensures that the time value field conforms to the field specification.

Overrides:

setTimeField in class DataRecord

Parameters:

fieldName - the name of the time field

fieldValue - the value of the time field

toXml

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

Converts this DataRecordTemplate to an XML Element. The XML is of the same format read by the constructor.

Specified by:

toXml in interface Xmlizable

Parameters:

doc - DOM Document object

Returns:

the XML representation of this DataRecordTemplate

validateFields

public boolean validateFields(DataRecord record)

Validate fields against the specifications for this Data Template.

Parameters:

record - the record to validate

Returns:

true, if all fields of the record conform to the specifications for those fields in the template, and if there are no additional fields in the record.