Package net.sf.saxon.value
Class TimeValue
java.lang.Object
net.sf.saxon.value.Value
net.sf.saxon.value.AtomicValue
net.sf.saxon.value.CalendarValue
net.sf.saxon.value.TimeValue
- All Implemented Interfaces:
Serializable
,Comparable
,Expression
,Item
,ValueRepresentation
A value of type xs:time
- See Also:
-
Field Summary
Fields inherited from class net.sf.saxon.value.CalendarValue
NO_TIMEZONE
Fields inherited from class net.sf.saxon.value.Value
EMPTY_CLASS_ARRAY
Fields inherited from interface net.sf.saxon.expr.Expression
EVALUATE_METHOD, ITERATE_METHOD, PROCESS_METHOD
Fields inherited from interface net.sf.saxon.om.ValueRepresentation
EMPTY_VALUE_ARRAY
-
Constructor Summary
ConstructorsConstructorDescriptionTimeValue
(byte hour, byte minute, byte second, int microsecond, int tz) Construct a time value given the hour, minute, second, and microsecond components.Constructor: create a dateTime value from a supplied string, in ISO 8601 formatTimeValue
(GregorianCalendar calendar, int tz) Constructor: create a time value given a Java calendar object -
Method Summary
Modifier and TypeMethodDescriptionadd
(DurationValue duration) Add a duration to a dateTimeadjustTimezone
(int timezone) Return a new time with the same normalized value, but in a different timezone.int
Compare the value to another dateTime valueint
compareTo
(CalendarValue other, Configuration config) Compare the value to another dateTime valueconvertPrimitive
(BuiltInAtomicType requiredType, boolean validate, XPathContext context) Convert to target data typeconvertToJava
(Class target, XPathContext context) Convert to Java object (for passing to external functions)copy()
Make a copy of this date, time, or dateTime valueboolean
Compare two (sequence) values for equality.Get a Java Calendar object corresponding to this time, on a reference dategetComparisonKey
(Configuration config) Get a comparison key for this value.getComponent
(int component) Get a component of the value.Determine the data type of the expressionConvert to stringint
hashCode()
Return a hash code to support the equals() functionsubtract
(CalendarValue other, XPathContext context) Determine the difference between two points in time, as a durationConvert to a DateTime value.Methods inherited from class net.sf.saxon.value.CalendarValue
appendString, appendTimezone, appendTimezone, appendTwoDigits, getStringValue, getTimezoneInMinutes, hasTimezone, removeTimezone, setTimezoneInMinutes
Methods inherited from class net.sf.saxon.value.AtomicValue
checkPermittedContents, convert, convert, display, effectiveBooleanValue, evaluateAsString, evaluateItem, getCardinality, getImplementationMethod, getLength, getPrimitiveValue, getTypedValue, hasBuiltInType, iterate, process, toString
Methods inherited from class net.sf.saxon.value.Value
asItem, asIterator, asValue, convert, convertJavaObjectToXPath, getDependencies, getIterator, getParentExpression, getSpecialProperties, itemAt, iterateSubExpressions, makeQNameValue, optimize, promote, reduce, simplify, stringToNumber, typeCheck
-
Constructor Details
-
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-23minute
- the minutes value, 0-59second
- the seconds value, 0-59microsecond
- the number of microseconds, 0-999999tz
- the timezone displacement in minutes from UTC. Supply the valueCalendarValue.NO_TIMEZONE
if there is no timezone component.
-
TimeValue
Constructor: create a time value given a Java calendar object- Parameters:
calendar
- holds the date and timetz
- the timezone offset in minutes, or NO_TIMEZONE indicating that there is no timezone
-
TimeValue
Constructor: create a dateTime value from a supplied string, in ISO 8601 format- Throws:
XPathException
-
-
Method Details
-
convertPrimitive
public AtomicValue convertPrimitive(BuiltInAtomicType requiredType, boolean validate, XPathContext context) Convert to target data type- Specified by:
convertPrimitive
in classAtomicValue
- Parameters:
requiredType
- an integer identifying the required atomic typevalidate
- true if validation is required. If set to false, the caller guarantees that the value is valid for the target data type, and that further validation is therefore not required. Note that a validation failure may be reported even if validation was not requested.context
-- Returns:
- an AtomicValue, a value of the required type; or an ErrorValue
-
getStringValueCS
Convert to string- Specified by:
getStringValueCS
in interfaceItem
- Specified by:
getStringValueCS
in interfaceValueRepresentation
- Overrides:
getStringValueCS
in classAtomicValue
- Returns:
- ISO 8601 representation, in the localized timezone (the timezone held within the value).
- See Also:
-
toDateTime
Convert to a DateTime value. The date components represent a reference date, as defined in the spec for comparing times.- Specified by:
toDateTime
in classCalendarValue
-
getCalendar
Get a Java Calendar object corresponding to this time, on a reference date- Specified by:
getCalendar
in classCalendarValue
- Returns:
- A Calendar object representing the date and time. Note that Java can only represent the time to millisecond precision, and that it does not support the full range of timezones required by XPath (-14:00 to +14:00)
-
getItemType
Determine the data type of the expression- Specified by:
getItemType
in interfaceExpression
- Overrides:
getItemType
in classValue
- Parameters:
th
-- Returns:
- Type.TIME_TYPE,
-
copy
Make a copy of this date, time, or dateTime value- Specified by:
copy
in classCalendarValue
-
adjustTimezone
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- Specified by:
adjustTimezone
in classCalendarValue
- 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
-
convertToJava
Convert to Java object (for passing to external functions)- Overrides:
convertToJava
in classValue
- Throws:
XPathException
-
getComponent
Get a component of the value. Returns null if the timezone component is requested and is not present.- Overrides:
getComponent
in classAtomicValue
- Throws:
XPathException
-
compareTo
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
Compare the value to another dateTime value- Specified by:
compareTo
in classCalendarValue
- 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)
-
getComparisonKey
Get a comparison key for this value. Two values are equal if and only if they their comparison keys are equal- Specified by:
getComparisonKey
in classCalendarValue
-
equals
Description copied from class:Value
Compare two (sequence) values for equality. This supports identity constraints in XML Schema, which allow list-valued elements and attributes to participate in key and uniqueness constraints. This method returns false if any error occurs during the comparison, or if any of the items in either sequence is a node rather than an atomic value. -
hashCode
public int hashCode()Description copied from class:Value
Return a hash code to support the equals() function -
add
Add a duration to a dateTime- Specified by:
add
in classCalendarValue
- 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
-
subtract
public SecondsDurationValue subtract(CalendarValue other, XPathContext context) throws XPathException Determine the difference between two points in time, as a duration- Overrides:
subtract
in classCalendarValue
- Parameters:
other
- the other point in timecontext
-- Returns:
- the duration as an xdt:dayTimeDuration
- Throws:
XPathException
- for example if one value is a date and the other is a time
-