net.sf.saxon.value

Class TimeValue

public final class TimeValue extends CalendarValue

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
TimeValue(CharSequence s)
Constructor: create a dateTime value from a supplied string, in ISO 8601 format
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
AtomicValueconvertPrimitive(BuiltInAtomicType requiredType, boolean validate, XPathContext context)
Convert to target data type
ObjectconvertToJava(Class target, XPathContext context)
Convert to Java object (for passing to external functions)
CalendarValuecopy()
Make a copy of this date, time, or dateTime value
booleanequals(Object other)
GregorianCalendargetCalendar()
Get a Java Calendar object corresponding to this time, on a reference date
AtomicValuegetComponent(int component)
Get a component of the value.
ItemTypegetItemType(TypeHierarchy th)
Determine the data type of the expression
CharSequencegetStringValueCS()
Convert to string
inthashCode()
SecondsDurationValuesubtract(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 CalendarValue.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

TimeValue

public TimeValue(CharSequence s)
Constructor: create a dateTime value from a supplied string, in ISO 8601 format

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 DateTimeValue (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

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)

convertPrimitive

public AtomicValue convertPrimitive(BuiltInAtomicType requiredType, boolean validate, XPathContext context)
Convert to target data type

Parameters: requiredType an integer identifying the required atomic type context

Returns: an AtomicValue, a value of the required type; or an ErrorValue

convertToJava

public Object convertToJava(Class target, XPathContext context)
Convert to Java object (for passing to external functions)

copy

public CalendarValue copy()
Make a copy of this date, time, or dateTime value

equals

public boolean equals(Object other)

getCalendar

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

getComponent

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

getItemType

public ItemType getItemType(TypeHierarchy th)
Determine the data type of the expression

Parameters: th

Returns: Type.TIME_TYPE,

getStringValueCS

public CharSequence getStringValueCS()
Convert to string

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

hashCode

public int hashCode()

subtract

public SecondsDurationValue subtract(CalendarValue other, XPathContext context)
Determine the difference between two points in time, as a duration

Parameters: other the other point in time context

Returns: the duration as an xdt:dayTimeDuration

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