net.sf.saxon.value

Class TimeValue

Implemented Interfaces:
Comparable, ConversionResult, GroundedValue, Item, PullEvent, Serializable, SequenceIterable, ValueRepresentation

public final class TimeValue
extends CalendarValue
implements Comparable

A value of type xs:time

Field Summary

Fields inherited from class net.sf.saxon.value.CalendarValue

NO_TIMEZONE

Fields inherited from class net.sf.saxon.value.AtomicValue

typeLabel

Fields inherited from class net.sf.saxon.value.Value

EMPTY_CLASS_ARRAY, INDETERMINATE_ORDERING

Fields inherited from interface net.sf.saxon.om.ValueRepresentation

EMPTY_VALUE_ARRAY

Constructor Summary

TimeValue(GregorianCalendar calendar, int tz)
Constructor: create a time value given a Java calendar object
TimeValue(byte hour, byte minute, byte second, int microsecond, int tz)
Construct a time value given the hour, minute, second, and microsecond components.

Method Summary

CalendarValue
add(DurationValue duration)
Add a duration to a dateTime
CalendarValue
adjustTimezone(int timezone)
Return a new time with the same normalized value, but in a different timezone.
int
compareTo(Object other)
Compare the value to another dateTime value
int
compareTo(CalendarValue other, XPathContext context)
Compare the value to another dateTime value
ConversionResult
convertPrimitive(BuiltInAtomicType requiredType, boolean validate, XPathContext context)
Convert to target data type
Object
convertToJava(Class target, XPathContext context)
Convert to Java object (for passing to external functions)
AtomicValue
copyAsSubType(AtomicType typeLabel)
Make a copy of this time value, but with a different type label
boolean
equals(Object other)
GregorianCalendar
getCalendar()
Get a Java Calendar object corresponding to this time, on a reference date
CharSequence
getCanonicalLexicalRepresentation()
Get the canonical lexical representation as defined in XML Schema.
ComparisonKey
getComparisonKey(XPathContext context)
Get a comparison key for this value.
AtomicValue
getComponent(int component)
Get a component of the value.
byte
getHour()
Get the hour component, 0-23
int
getMicrosecond()
Get the microsecond component, 0-999999
byte
getMinute()
Get the minute component, 0-59
BuiltInAtomicType
getPrimitiveType()
Determine the primitive type of the value.
Comparable
getSchemaComparable()
byte
getSecond()
Get the second component, 0-59
CharSequence
getStringValueCS()
Convert to string
int
hashCode()
static ConversionResult
makeTimeValue(CharSequence s)
Static factory method: create a time value from a supplied string, in ISO 8601 format
DayTimeDurationValue
subtract(CalendarValue other, XPathContext context)
Determine the difference between two points in time, as a duration
DateTimeValue
toDateTime()
Convert to a DateTime value.

Methods inherited from class net.sf.saxon.value.CalendarValue

add, adjustTimezone, adjustTimezone, appendTimezone, appendTimezone, compareTo, getCalendar, getComparisonKey, getStringValue, getTimezoneInMinutes, getXPathComparable, hasTimezone, removeTimezone, setTimezoneInMinutes, subtract, toDateTime

Methods inherited from class net.sf.saxon.value.AtomicValue

asAtomic, checkPermittedContents, convert, convert, convertPrimitive, copyAsSubType, effectiveBooleanValue, equals, getCardinality, getComponent, getItemType, getLength, getPrimitiveType, getSchemaComparable, getStringValue, getStringValueCS, getTypeLabel, getTypedValue, getXPathComparable, isNaN, itemAt, iterate, process, setTypeLabel, subsequence, toString

Methods inherited from class net.sf.saxon.value.Value

asItem, asItem, asIterator, asValue, checkPermittedContents, convertJavaObjectToXPath, convertToJava, convertToJava, effectiveBooleanValue, equals, fromItem, getCanonicalLexicalRepresentation, getCardinality, getItemType, getIterator, getLength, getSchemaComparable, getStringValue, getStringValueCS, itemAt, iterate, iterate, makeQNameValue, process, reduce, stringToNumber, toString

Constructor Details

TimeValue

public TimeValue(GregorianCalendar calendar,
                 int tz)
Constructor: create a time value given a Java calendar object
Parameters:
calendar - holds the date and time
tz - the timezone offset in minutes, or NO_TIMEZONE indicating that there is no timezone

TimeValue

public TimeValue(byte hour,
                 byte minute,
                 byte second,
                 int microsecond,
                 int tz)
Construct a time value given the hour, minute, second, and microsecond components. This constructor performs no validation.

Method Details

add

public CalendarValue add(DurationValue duration)
            throws XPathException
Add a duration to a dateTime
Overrides:
add in interface CalendarValue
Parameters:
duration - the duration to be added (may be negative)
Returns:
the new date
Throws:
XPathException - if the duration is an xs:duration, as distinct from a subclass thereof

adjustTimezone

public CalendarValue adjustTimezone(int timezone)
Return a new time with the same normalized value, but in a different timezone. This is called only for a TimeValue that has an explicit timezone
Overrides:
adjustTimezone in interface CalendarValue
Parameters:
timezone - the new timezone offset, in minutes
Returns:
the time in the new timezone. This will be a new TimeValue unless no change was required to the original value

compareTo

public int compareTo(Object other)
Compare the value to another dateTime value
Parameters:
other - The other dateTime value
Returns:
negative value if this one is the earler, 0 if they are chronologically equal, positive value if this one is the later. For this purpose, dateTime values with an unknown timezone are considered to be UTC values (the Comparable interface requires a total ordering).

compareTo

public int compareTo(CalendarValue other,
                     XPathContext context)
            throws NoDynamicContextException
Compare the value to another dateTime value
Overrides:
compareTo in interface CalendarValue
Parameters:
other - The other dateTime value
context - the XPath dynamic evaluation context
Returns:
negative value if this one is the earler, 0 if they are chronologically equal, positive value if this one is the later. For this purpose, dateTime values with an unknown timezone are considered to be UTC values (the Comparable interface requires a total ordering).
Throws:
NoDynamicContextException - if the implicit timezone is required and is not available (because the function is called at compile time)

convertPrimitive

public ConversionResult convertPrimitive(BuiltInAtomicType requiredType,
                                         boolean validate,
                                         XPathContext context)
Convert to target data type
Overrides:
convertPrimitive in interface AtomicValue
Parameters:
requiredType - an integer identifying the required atomic type
context - XPath dynamic evaluation context
Returns:
an AtomicValue, a value of the required type; or an ErrorValue

convertToJava

public Object convertToJava(Class target,
                            XPathContext context)
            throws XPathException
Convert to Java object (for passing to external functions)
Overrides:
convertToJava in interface Value

copyAsSubType

public AtomicValue copyAsSubType(AtomicType typeLabel)
Make a copy of this time value, but with a different type label
Overrides:
copyAsSubType in interface AtomicValue
Parameters:
typeLabel - the new type label. This must be a subtype of xs:time.

equals

public boolean equals(Object other)
Overrides:
equals in interface AtomicValue

getCalendar

public GregorianCalendar getCalendar()
Get a Java Calendar object corresponding to this time, on a reference date
Overrides:
getCalendar in interface CalendarValue

getCanonicalLexicalRepresentation

public CharSequence getCanonicalLexicalRepresentation()
Get the canonical lexical representation as defined in XML Schema. This is not always the same as the result of casting to a string according to the XPath rules. For an xs:time it is the time adjusted to UTC
Overrides:
getCanonicalLexicalRepresentation in interface Value
Returns:
the canonical lexical representation if defined in XML Schema

getComparisonKey

public ComparisonKey getComparisonKey(XPathContext context)
            throws NoDynamicContextException
Get a comparison key for this value. Two values are equal if and only if they their comparison keys are equal
Overrides:
getComparisonKey in interface CalendarValue
Parameters:
context - XPath dynamic context
Throws:
NoDynamicContextException - if the implicit timezone is required and is not available

getComponent

public AtomicValue getComponent(int component)
            throws XPathException
Get a component of the value. Returns null if the timezone component is requested and is not present.
Overrides:
getComponent in interface AtomicValue

getHour

public byte getHour()
Get the hour component, 0-23
Returns:
the hour

getMicrosecond

public int getMicrosecond()
Get the microsecond component, 0-999999
Returns:
the microseconds

getMinute

public byte getMinute()
Get the minute component, 0-59
Returns:
the minute

getPrimitiveType

public BuiltInAtomicType getPrimitiveType()
Determine the primitive type of the value. This delivers the same answer as getItemType().getPrimitiveItemType(). The primitive types are the 19 primitive types of XML Schema, plus xs:integer, xs:dayTimeDuration and xs:yearMonthDuration, and xs:untypedAtomic. For external objects, the result is AnyAtomicType.
Overrides:
getPrimitiveType in interface AtomicValue

getSchemaComparable

public Comparable getSchemaComparable()
Overrides:
getSchemaComparable in interface AtomicValue

getSecond

public byte getSecond()
Get the second component, 0-59
Returns:
the second

getStringValueCS

public CharSequence getStringValueCS()
Convert to string
Specified by:
getStringValueCS in interface Item
getStringValueCS in interface ValueRepresentation
Overrides:
getStringValueCS in interface AtomicValue
Returns:
ISO 8601 representation, in the localized timezone (the timezone held within the value).

hashCode

public int hashCode()

makeTimeValue

public static ConversionResult makeTimeValue(CharSequence s)
            throws XPathException
Static factory method: create a time value from a supplied string, in ISO 8601 format
Parameters:
s - the time in the lexical format hh:mm:ss[.ffffff] followed optionally by timezone in the form [+-]hh:mm or Z
Returns:
either a TimeValue corresponding to the xs:time, or a ValidationFailure if the supplied value was invalid

subtract

public DayTimeDurationValue subtract(CalendarValue other,
                                     XPathContext context)
            throws XPathException
Determine the difference between two points in time, as a duration
Overrides:
subtract in interface CalendarValue
Parameters:
other - the other point in time
context - XPath dynamic evaluation context
Returns:
the duration as an xs:dayTimeDuration
Throws:
XPathException - for example if one value is a date and the other is a time

toDateTime

public DateTimeValue toDateTime()
Convert to a DateTime value. The date components represent a reference date, as defined in the spec for comparing times.
Overrides:
toDateTime in interface CalendarValue