prajna.data.field

Class TimeFieldDesc

java.lang.Object

prajna.data.field.FieldDesc<TimeSpan>

prajna.data.field.TimeFieldDesc

All Implemented Interfaces:

java.io.Serializable, Xmlizable

public class TimeFieldDesc
extends FieldDesc<TimeSpan>

Field description for a Time field. This field description provides date format specification and parsing.

Author:

Edward Swing

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TimeFieldDesc() Default constructor with no arguments, useful for cases where the descriptor is configured from XML elements.
TimeFieldDesc(java.lang.String fieldName) Constructor taking a field name.
TimeFieldDesc(java.lang.String fieldName, java.lang.String dateFormat) Constructor taking a field name and date format.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDatePattern() Get the date format pattern string used to parse or format dates
java.lang.String	getDurationField() Get the field to be used to identify the duration field within the original data source.
DataType	getFieldType() Get the field type for this field description
java.text.SimpleDateFormat	getFormat() Return the format used to parse and write values.
java.lang.String	getSourceStartField() Get the field to be used to identify the start field within the original data source.
java.lang.String	getSourceStopField() Get the field to be used to identify the stop field within the original data source.
boolean	isSpanField() Return whether this field specifies a span.
boolean	isValid(TimeSpan value) Return whether a field value is valid.
void	loadFromXml(org.w3c.dom.Element elem) Load the field description from XML.
TimeSpan	parse(java.lang.String stringVal) Parses the string into a TimeSpan.
java.util.Date	parseDate(java.lang.String stringVal) Parses the string into a single Date.
TimeSpan	parseDuration(java.util.Date startDate, java.lang.String durationStr) Parses a duration field into a span.
TimeSpan	parseDuration(TimeSpan span, java.lang.String durationStr) Parses a duration field into a span.
TimeSpan	parseStopTime(TimeSpan span, java.lang.String stopTimeStr) Parses a stop time field into a span.
TimeSpan	parseValueIntoRecord(DataRecord rec, java.lang.String value) Parse the string value, and store it in a time field in the specified data record.
protected void	setValues(org.w3c.dom.NodeList valueList) Set the values for this Date 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, setDefaultValue, setFieldName, setMultiValue

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeFieldDesc

public TimeFieldDesc()

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

TimeFieldDesc

public TimeFieldDesc(java.lang.String fieldName)

Constructor taking a field name.

Parameters:

fieldName - the field name for this descriptor

TimeFieldDesc

public TimeFieldDesc(java.lang.String fieldName,
             java.lang.String dateFormat)

Constructor taking a field name and date format. The format should conform to the format string accepted by java.util.SimpleDateFormat

Parameters:

fieldName - the field name for this descriptor

dateFormat - the pattern of the dates accepted by this field descriptor

Method Detail

getDatePattern

public java.lang.String getDatePattern()

Get the date format pattern string used to parse or format dates

Returns:

the date format pattern

getDurationField

public java.lang.String getDurationField()

Get the field to be used to identify the duration field within the original data source.

Returns:

the source duration field

getFieldType

public DataType getFieldType()

Get the field type for this field description

Specified by:

getFieldType in class FieldDesc<TimeSpan>

Returns:

FieldType.TIME

getFormat

public java.text.SimpleDateFormat getFormat()

Return the format used to parse and write values. By default, this method uses the default SimpleDateFormat.

Returns:

the format

getSourceStartField

public java.lang.String getSourceStartField()

Get the field to be used to identify the start field within the original data source.

Returns:

the source start field

getSourceStopField

public java.lang.String getSourceStopField()

Get the field to be used to identify the stop field within the original data source.

Returns:

the source stop field

isSpanField

public boolean isSpanField()

Return whether this field specifies a span. The field specifies a span if both the sourceStartField and sourceStopField values are set.

Returns:

true if this TimeFieldDesc represents a time span field, false otherwise.

isValid

public boolean isValid(TimeSpan value)

Return whether a field value is valid.

Specified by:

isValid in class FieldDesc<TimeSpan>

Parameters:

value -

Returns:

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

loadFromXml

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

Load the field description from XML. This method calls the superclass method to handle most data loading. It then checks to see if the element has the attributes sourceStartField and sourceStopField. If so, these values are stored for later access.

Specified by:

loadFromXml in interface Xmlizable

Overrides:

loadFromXml in class FieldDesc<TimeSpan>

Parameters:

elem - the field description element

parse

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

Parses the string into a TimeSpan. It uses the SimpleDateFormat to parse the string. If the SimpleDateFormat format string is set to millis, this parse method interprets that to mean that the date is specified in milliseconds, and parses the string value as a long integer accordingly. The parse method looks for a separator equal to " - " to identify strings with both a start and stop date identified; if the separator string is within the string argument, the parser attempts to split the string into both a start and stop date.

Specified by:

parse in class FieldDesc<TimeSpan>

Parameters:

stringVal - the value to parse into a date

Returns:

the date value parsed

Throws:

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

parseDate

public java.util.Date parseDate(java.lang.String stringVal)
                         throws java.text.ParseException

Parses the string into a single Date. It uses the SimpleDateFormat to parse the string. If the SimpleDateFormat format string is set to millis, this parse method interprets that to mean that the date is specified in milliseconds, and parses the string value as a long integer accordingly. Most other date parsing functions for this field descriptor ultimately call this method.

Parameters:

stringVal - the value to parse into a date

Returns:

the date value parsed

Throws:

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

parseDuration

public TimeSpan parseDuration(java.util.Date startDate,
                     java.lang.String durationStr)

Parses a duration field into a span. This method takes a start date and a duration string. It adds the duration to the start date to determine a new TimeSpan object.

Parameters:

startDate - the start of the TimeSpan

durationStr - the duration string. This value should be parsed as a number

Returns:

a new TimeSpan

parseDuration

public TimeSpan parseDuration(TimeSpan span,
                     java.lang.String durationStr)

Parses a duration field into a span. This method takes an existing TimeSpan, extracts the start time, and adds the duration to it to determine a new TimeSpan object.

Parameters:

span - the original TimeSpan object

durationStr - the duration string. This value should be parsed as a number

Returns:

a new TimeSpan

parseStopTime

public TimeSpan parseStopTime(TimeSpan span,
                     java.lang.String stopTimeStr)
                       throws java.text.ParseException

Parses a stop time field into a span. This method takes an existing TimeSpan, extracts the start time, and applies the stop time to it to determine a new TimeSpan object.

Parameters:

span - the original TimeSpan object

stopTimeStr - the stop time string. This value should be in the same format as the start time string field

Returns:

a new TimeSpan

Throws:

java.text.ParseException - If there is a problem parsing the duration

parseValueIntoRecord

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

Parse the string value, and store it in a time field in the specified data record. The DataRecord.setTimeField method will be invoked with a time span constructed from the parse() method.

Specified by:

parseValueIntoRecord in class FieldDesc<TimeSpan>

Parameters:

rec - the DataRecord to parse the value into

value - the String value to be parsed

Returns:

the TimeSpan added

Throws:

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

setValues

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

Set the values for this Date field description. This method looks for any element with a tag name of format to specify the format of the dates provided. If the format has a value of millis, the format is interpreted to mean milliseconds since epoch.

Specified by:

setValues in class FieldDesc<TimeSpan>

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<TimeSpan>

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 format 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<TimeSpan>

Parameters:

doc - The document used to construct the element

Returns:

the element representing this field description