net.sf.saxon.value

Class TimeValue

public final class TimeValue extends CalendarValue implements Comparable

A value of type xs:time
Constructor Summary
TimeValue(byte hour, byte minute, byte second, int microsecond, int tz)
Construct a time value given the hour, minute, second, and microsecond components.
TimeValue(GregorianCalendar calendar, int tz)
Constructor: create a time value given a Java calendar object
Method Summary
CalendarValueadd(DurationValue duration)
Add a duration to a dateTime
CalendarValueadjustTimezone(int timezone)
Return a new time with the same normalized value, but in a different timezone.
intcompareTo(Object other)
Compare the value to another dateTime value
intcompareTo(CalendarValue other, XPathContext context)
Compare the value to another dateTime value
ConversionResultconvertPrimitive(BuiltInAtomicType requiredType, boolean validate, XPathContext context)
Convert to target data type
AtomicValuecopyAsSubType(AtomicType typeLabel)
Make a copy of this time value, but with a different type label
booleanequals(Object other)
GregorianCalendargetCalendar()
Get a Java Calendar object corresponding to this time, on a reference date
CharSequencegetCanonicalLexicalRepresentation()
Get the canonical lexical representation as defined in XML Schema.
ComparisonKeygetComparisonKey(XPathContext context)
Get a comparison key for this value.
AtomicValuegetComponent(int component)
Get a component of the value.
bytegetHour()
Get the hour component, 0-23
intgetMicrosecond()
Get the microsecond component, 0-999999
bytegetMinute()
Get the minute component, 0-59
CharSequencegetPrimitiveStringValue()
Convert to string
BuiltInAtomicTypegetPrimitiveType()
Determine the primitive type of the value.
ComparablegetSchemaComparable()
bytegetSecond()
Get the second component, 0-59
inthashCode()
static ConversionResultmakeTimeValue(CharSequence s)
Static factory method: create a time value from a supplied string, in ISO 8601 format
DayTimeDurationValuesubtract(CalendarValue other, XPathContext context)
Determine the difference between two points in time, as a duration
DateTimeValuetoDateTime()
Convert to a DateTime value.

Constructor Detail

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.

Parameters: hour the hour value, 0-23 minute the minutes value, 0-59 second the seconds value, 0-59 microsecond the number of microseconds, 0-999999 tz the timezone displacement in minutes from UTC. Supply the value NO_TIMEZONE if there is no timezone component.

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

Method Detail

add

public CalendarValue add(DurationValue duration)
Add a duration to a dateTime

Parameters: duration the duration to be added (may be negative)

Returns: the new date

Throws: net.sf.saxon.trans.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

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

Throws: ClassCastException if the other value is not a TimeValue (the parameter is declared as Object to satisfy the Comparable interface)

compareTo

public int compareTo(CalendarValue other, XPathContext context)
Compare the value to another dateTime value

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: ClassCastException if the other value is not a DateTimeValue (the parameter is declared as Object to satisfy the Comparable interface) 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

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

copyAsSubType

public AtomicValue copyAsSubType(AtomicType typeLabel)
Make a copy of this time value, but with a different type label

Parameters: typeLabel the new type label. This must be a subtype of xs:time.

equals

public boolean equals(Object other)

getCalendar

public GregorianCalendar getCalendar()
Get a Java Calendar object corresponding to this time, on a reference date

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

Returns: the canonical lexical representation if defined in XML Schema

getComparisonKey

public ComparisonKey getComparisonKey(XPathContext context)
Get a comparison key for this value. Two values are equal if and only if they their comparison keys are equal

Parameters: context XPath dynamic context

Throws: NoDynamicContextException if the implicit timezone is required and is not available

getComponent

public AtomicValue getComponent(int component)
Get a component of the value. Returns null if the timezone component is requested and is not present.

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

getPrimitiveStringValue

public CharSequence getPrimitiveStringValue()
Convert to string

Returns: ISO 8601 representation, in the localized timezone (the timezone held within the value).

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.

getSchemaComparable

public Comparable getSchemaComparable()

getSecond

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

Returns: the second

hashCode

public int hashCode()

makeTimeValue

public static ConversionResult makeTimeValue(CharSequence s)
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)
Determine the difference between two points in time, as a duration

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.