prajna.data

Class DataRecord

java.lang.Object

prajna.data.DataRecord

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

DataTemplate, SequentialRecord

public class DataRecord
extends java.lang.Object
implements java.io.Serializable

Low level element for passing data. This class essentially consists of a set of maps of field-value pairs for the node, along with the node name. A DataRecord provides a means to include various typed information as a composite element.

Author:

Edward Swing

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DataRecord() Creates a new DataRecord object with no name
DataRecord(java.lang.String recName) Creates a new DataRecord object.

Method Summary

Methods

Modifier and Type	Method and Description
void	addEnumFieldValue(java.lang.String fieldName, java.lang.String fieldValue) Add an enumerated value to the given field.
void	addIntFieldValue(java.lang.String fieldName, java.lang.Integer fieldValue) Add an integer value to the given field.
void	addLocationFieldValue(java.lang.String fieldName, Location fieldValue) Add a location value to the given field.
void	addMeasureFieldValue(java.lang.String fieldName, Measure fieldValue) Add a measure value to the given field.
void	addTextFieldValue(java.lang.String fieldName, java.lang.String fieldValue) Add a text value to the given field.
void	addTimeFieldValue(java.lang.String fieldName, TimeSpan fieldValue) Add a time value to the given field.
java.util.Set<java.lang.String>	getAllFieldNames() Get the set of all field names set in this data record
java.lang.String	getEnumField(java.lang.String fieldName) Gets the value for a particular enumerated value field.
java.util.Set<java.lang.String>	getEnumFieldNames() Get the set of the enumerated value field names contained within this DataRecord.
java.util.Set<java.lang.String>	getEnumValues(java.lang.String fieldName) Get the set of enumerated values for the given fieldName
java.lang.String	getFieldAsString(java.lang.String fieldName) Gets the value of the specified field, converted to a String.
DataType	getFieldType(java.lang.String fieldName) Get the type of data for this field
double	getFloatField(java.lang.String fieldName) Gets the value for a particular floating point field.
int	getIntField(java.lang.String fieldName) Gets the value for a particular integer field.
java.util.Set<java.lang.String>	getIntFieldNames() Get the set of the integer field names contained within this DataRecord
java.util.Set<java.lang.Integer>	getIntValues(java.lang.String fieldName) Get the set of integer values for the given fieldName
java.lang.String	getLink() Get the link associated with this record.
Location	getLocationField(java.lang.String fieldName) Gets the value for a particular location field.
java.util.Set<java.lang.String>	getLocationFieldNames() Get the set of the location field names contained within this DataRecord
java.util.Set<Location>	getLocationValues(java.lang.String fieldName) Get the set of location values for the given fieldName
Measure	getMeasureField(java.lang.String fieldName) Gets the value for a particular measure field.
java.util.Set<java.lang.String>	getMeasureFieldNames() Get the set of the measure field names contained within this DataRecord
java.util.Set<Measure>	getMeasureValues(java.lang.String fieldName) Get the set of measure values for the given fieldName
java.lang.String	getName() Gets the name of this DataRecord
java.lang.String	getTextField(java.lang.String fieldName) Gets the value for a particular text field.
java.util.Set<java.lang.String>	getTextFieldNames() Get the set of the text field names contained within this DataRecord
java.util.Set<java.lang.String>	getTextValues(java.lang.String fieldName) Get the set of text values for the given fieldName
TimeSpan	getTimeField(java.lang.String fieldName) Gets the value for a particular time field.
java.util.Set<java.lang.String>	getTimeFieldNames() Get the set of the time field names contained within this DataRecord
java.util.Set<TimeSpan>	getTimeValues(java.lang.String fieldName) Get the set of time values for the given fieldName
boolean	isMultiValued(java.lang.String fieldName) Return whether the given field has multiple values.
void	mergeData(DataRecord otherRecord) Merges the data from another DataRecord with this one.
void	parseDataField(java.lang.String fieldName, java.lang.String dataString) Attempt to add a data element based upon how the data string parses.
void	removeEnumFieldValue(java.lang.String fieldName, java.lang.String fieldValue) Remove an enumerated value from the set of values for the given fieldName.
void	removeField(java.lang.String fieldName) remove the values and key for the specified fieldName.
void	removeIntFieldValue(java.lang.String fieldName, java.lang.Integer fieldValue) Remove an integer value from the set of values for the given fieldName.
void	removeLocationFieldValue(java.lang.String fieldName, Location fieldValue) Remove a location value from the set of values for the given fieldName.
void	removeMeasureFieldValue(java.lang.String fieldName, Measure fieldValue) Remove a measure value from the set of values for the given fieldName.
void	removeTextFieldValue(java.lang.String fieldName, java.lang.String fieldValue) Remove a string value from the set of values for the given fieldName.
void	removeTimeFieldValue(java.lang.String fieldName, TimeSpan fieldValue) Remove a timespan value from the set of values for the given fieldName.
void	setEnumField(java.lang.String fieldName, java.lang.String fieldValue) Sets the value for a particular enumerated 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 text field.
void	setLink(java.lang.String linkString) Set the link associated with this record.
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	setName(java.lang.String recName) Set the name for this data record
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.
java.lang.String	toString() Return a string representation of the DataRecord.
java.util.Map<java.lang.String,java.lang.String>	writeFieldsToMap() Create a map with all fields and their values represented as strings.
java.lang.String	writeFieldsToString() Create a string containing the content of all fields in this DataRecord.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataRecord

public DataRecord()

Creates a new DataRecord object with no name

DataRecord

public DataRecord(java.lang.String recName)

Creates a new DataRecord object.

Parameters:

recName - the name of this DataRecord

Method Detail

addEnumFieldValue

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

Add an enumerated value to the given field. This method adds an additional value to the values associated with the field name

Parameters:

fieldName - the name of the enumerated field

fieldValue - the value of the enumerated field

addIntFieldValue

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

Add an integer value to the given field. This method adds an additional value to the values associated with the field name

Parameters:

fieldName - the name of the integer field

fieldValue - the value of the integer field

addLocationFieldValue

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

Add a location value to the given field. This method adds an additional value to the values associated with the field name

Parameters:

fieldName - the name of the location field

fieldValue - the value of the location field

addMeasureFieldValue

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

Add a measure value to the given field. This method adds an additional value to the values associated with the field name

Parameters:

fieldName - the name of the measure field

fieldValue - the value of the measure field

addTextFieldValue

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

Add a text value to the given field. This method adds an additional value to the values associated with the field name

Parameters:

fieldName - the name of the text field

fieldValue - the value of the text field

addTimeFieldValue

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

Add a time value to the given field. This method adds an additional value to the values associated with the field name

Parameters:

fieldName - the name of the time field

fieldValue - the value of the time field

getAllFieldNames

public java.util.Set<java.lang.String> getAllFieldNames()

Get the set of all field names set in this data record

Returns:

the set of all field names.

getEnumField

public java.lang.String getEnumField(java.lang.String fieldName)

Gets the value for a particular enumerated value field. If the fieldName has multiple values associated with it, an arbitrary value is returned.

Parameters:

fieldName - the name of the enumerated value field

Returns:

the value of the enumerated value field

getEnumFieldNames

public java.util.Set<java.lang.String> getEnumFieldNames()

Get the set of the enumerated value field names contained within this DataRecord.

Returns:

a list of the enumerated value fields contained within the DataRecord

getEnumValues

public java.util.Set<java.lang.String> getEnumValues(java.lang.String fieldName)

Get the set of enumerated values for the given fieldName

Parameters:

fieldName - the name of the enumerated field

Returns:

the set of values for the field

getFieldAsString

public java.lang.String getFieldAsString(java.lang.String fieldName)

Gets the value of the specified field, converted to a String. If a field has multiple values, these values are separated by the pipe character.

Parameters:

fieldName - the field name

Returns:

a string version of the field value.

getFieldType

public DataType getFieldType(java.lang.String fieldName)

Get the type of data for this field

Parameters:

fieldName - the field name

Returns:

the type of data stored for that field name, or null if the field has not been set in this DataRecord

getFloatField

public double getFloatField(java.lang.String fieldName)

Gets the value for a particular floating point field. Floating point values are stored as Measures, and the value of the corresponding measurement is returned from this method. If the fieldName has multiple values associated with it, an arbitrary value is returned.

Parameters:

fieldName - the name of the floating point field

Returns:

the numerical value of the measurement

getIntField

public int getIntField(java.lang.String fieldName)

Gets the value for a particular integer field. If the fieldName has multiple values associated with it, an arbitrary value is returned.

Parameters:

fieldName - the name of the integer field

Returns:

the value of the integer field

getIntFieldNames

public java.util.Set<java.lang.String> getIntFieldNames()

Get the set of the integer field names contained within this DataRecord

Returns:

a list of the integer fields contained within the DataRecord

getIntValues

public java.util.Set<java.lang.Integer> getIntValues(java.lang.String fieldName)

Get the set of integer values for the given fieldName

Parameters:

fieldName - the name of the integer field

Returns:

the set of values for the field

getLink

public java.lang.String getLink()

Get the link associated with this record.

Returns:

the link for this record

getLocationField

public Location getLocationField(java.lang.String fieldName)

Gets the value for a particular location field. If the fieldName has multiple values associated with it, an arbitrary value is returned.

Parameters:

fieldName - the name of the location field

Returns:

the value of the location field

getLocationFieldNames

public java.util.Set<java.lang.String> getLocationFieldNames()

Get the set of the location field names contained within this DataRecord

Returns:

a list of the location fields contained within the DataRecord

getLocationValues

public java.util.Set<Location> getLocationValues(java.lang.String fieldName)

Get the set of location values for the given fieldName

Parameters:

fieldName - the name of the locaation field

Returns:

the set of values for the field

getMeasureField

public Measure getMeasureField(java.lang.String fieldName)

Gets the value for a particular measure field. If the fieldName has multiple values associated with it, an arbitrary value is returned.

Parameters:

fieldName - the name of the measure field

Returns:

the value of the measure field

getMeasureFieldNames

public java.util.Set<java.lang.String> getMeasureFieldNames()

Get the set of the measure field names contained within this DataRecord

Returns:

a list of the measure fields contained within the DataRecord

getMeasureValues

public java.util.Set<Measure> getMeasureValues(java.lang.String fieldName)

Get the set of measure values for the given fieldName

Parameters:

fieldName - the name of the measure field

Returns:

the set of values for the field

getName

public java.lang.String getName()

Gets the name of this DataRecord

Returns:

the name of this DataRecord

getTextField

public java.lang.String getTextField(java.lang.String fieldName)

Gets the value for a particular text field. If the fieldName has multiple values associated with it, an arbitrary value is returned.

Parameters:

fieldName - the name of the text field

Returns:

the value of the text field

getTextFieldNames

public java.util.Set<java.lang.String> getTextFieldNames()

Get the set of the text field names contained within this DataRecord

Returns:

a list of the text fields contained within the DataRecord

getTextValues

public java.util.Set<java.lang.String> getTextValues(java.lang.String fieldName)

Get the set of text values for the given fieldName

Parameters:

fieldName - the name of the text field

Returns:

the set of values for the field

getTimeField

public TimeSpan getTimeField(java.lang.String fieldName)

Gets the value for a particular time field. If the fieldName has multiple values associated with it, an arbitrary value is returned.

Parameters:

fieldName - the name of the time field

Returns:

the value of the time field

getTimeFieldNames

public java.util.Set<java.lang.String> getTimeFieldNames()

Get the set of the time field names contained within this DataRecord

Returns:

a list of the time fields contained within the DataRecord

getTimeValues

public java.util.Set<TimeSpan> getTimeValues(java.lang.String fieldName)

Get the set of time values for the given fieldName

Parameters:

fieldName - the name of the time field

Returns:

the set of values for the field

isMultiValued

public boolean isMultiValued(java.lang.String fieldName)

Return whether the given field has multiple values. This method returns true if the field has more than one value.

Parameters:

fieldName - the name of the field

Returns:

true if the field has more than one value, false if the field has only one value or no values.

mergeData

public void mergeData(DataRecord otherRecord)

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:

otherRecord - The other node to merge with this node.

parseDataField

public void parseDataField(java.lang.String fieldName,
                  java.lang.String dataString)

Attempt to add a data element based upon how the data string parses. This method goes thru the various data types, trying to guess what the data element's type should be. If nothing else is found, it is assumed to be a text string. This method should be used with care.

Parameters:

fieldName - the field name

dataString - the data string which is parsed and stored

removeEnumFieldValue

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

Remove an enumerated value from the set of values for the given fieldName. If the fieldValue was the last value for that fieldName, the references for the fieldName are also removed.

Parameters:

fieldName - The field name for the enumerated value

fieldValue - The value to remove

removeField

public void removeField(java.lang.String fieldName)

remove the values and key for the specified fieldName. Following this operation, the reference to the field will be removed

Parameters:

fieldName - the field to be cleared

removeIntFieldValue

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

Remove an integer value from the set of values for the given fieldName. If the fieldValue was the last value for that fieldName, the references for the fieldName are also removed.

Parameters:

fieldName - The field name for the integer value

fieldValue - The value to remove

removeLocationFieldValue

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

Remove a location value from the set of values for the given fieldName. If the fieldValue was the last value for that fieldName, the references for the fieldName are also removed.

Parameters:

fieldName - The field name for the location value

fieldValue - The value to remove

removeMeasureFieldValue

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

Remove a measure value from the set of values for the given fieldName. If the fieldValue was the last value for that fieldName, the references for the fieldName are also removed.

Parameters:

fieldName - The field name for the measure value

fieldValue - The value to remove

removeTextFieldValue

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

Remove a string value from the set of values for the given fieldName. If the fieldValue was the last value for that fieldName, the references for the fieldName are also removed.

Parameters:

fieldName - The field name for the string value

fieldValue - The value to remove

removeTimeFieldValue

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

Remove a timespan value from the set of values for the given fieldName. If the fieldValue was the last value for that fieldName, the references for the fieldName are also removed.

Parameters:

fieldName - The field name for the timespan value

fieldValue - The value to remove

setEnumField

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

Sets the value for a particular enumerated field. This method clears the values associated with the particular fieldName, and then sets the value to the given fieldValue

Parameters:

fieldName - the name of the enumerated field

fieldValue - the value of the enumerated 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 clears the values associated with the particular fieldName, and then sets the value to the given fieldValue

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 text field. This method clears the values associated with the particular fieldName, and then sets the value to the given fieldValue

Parameters:

fieldName - the name of the text field

fieldValue - the value of the text field

setLink

public void setLink(java.lang.String linkString)

Set the link associated with this record. The link can be anything from a hyperlink to an action string, based upon the need of the program manipulating the data records.

Parameters:

linkString - the link associated with the record

setLocationField

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

Sets the value for a particular location field. This method clears the values associated with the particular fieldName, and then sets the value to the given fieldValue

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 clears the values associated with the particular fieldName, and then sets the value to the given fieldValue

Parameters:

fieldName - the name of the measure field

fieldValue - the value of the measure field

setName

public void setName(java.lang.String recName)

Set the name for this data record

Parameters:

recName - the record name

setTextField

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

Sets the value for a particular text field. This method clears the values associated with the particular fieldName, and then sets the value to the given fieldValue

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 clears the values associated with the particular fieldName, and then sets the value to the given fieldValue

Parameters:

fieldName - the name of the time field

fieldValue - the value of the time field

toString

public java.lang.String toString()

Return a string representation of the DataRecord. Simply returns the record name.

Overrides:

toString in class java.lang.Object

Returns:

a String representation of the DataRecord.

writeFieldsToMap

public java.util.Map<java.lang.String,java.lang.String> writeFieldsToMap()

Create a map with all fields and their values represented as strings. This method may be used to create data structures or to iterate over fields easily.

Returns:

a map of all fields with their values converted to Strings

writeFieldsToString

public java.lang.String writeFieldsToString()

Create a string containing the content of all fields in this DataRecord. The fields are listed in alphabetic order according to field name, separated by newline characters.

Returns:

String containing all fields of the data record