Package net.sf.saxon.value
Class DayTimeDurationValue
java.lang.Object
net.sf.saxon.value.Value
net.sf.saxon.value.AtomicValue
net.sf.saxon.value.DurationValue
net.sf.saxon.value.DayTimeDurationValue
- All Implemented Interfaces:
Serializable
,Comparable
,PullEvent
,SequenceIterable
,GroundedValue
,Item
,ValueRepresentation
,ConversionResult
A value of type xs:dayTimeDuration
- See Also:
-
Field Summary
Fields inherited from class net.sf.saxon.value.DurationValue
microseconds, months, negative, seconds
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
ConstructorsConstructorDescriptionDayTimeDurationValue
(int sign, int days, int hours, int minutes, long seconds, int microseconds) Create a dayTimeDuration given the number of days, hours, minutes, and seconds. -
Method Summary
Modifier and TypeMethodDescriptionadd
(DurationValue other) Add two dayTimeDurationsint
Compare the value to another duration valuecopyAsSubType
(AtomicType typeLabel) Create a copy of this atomic value, with a different type labeldivide
(DurationValue other) Find the ratio between two durationsstatic DayTimeDurationValue
fromMicroseconds
(long microseconds) Construct a duration value as a number of microseconds.static DayTimeDurationValue
fromMilliseconds
(long milliseconds) Construct a duration value as a number of milliseconds.static DayTimeDurationValue
fromSeconds
(BigDecimal seconds) Construct a duration value as a number of seconds.long
Get length of duration in microseconds, as a longlong
Get length of duration in milliseconds, as a longdouble
Get length of duration in secondsDetermine the primitive type of the value.Convert to stringgetXPathComparable
(boolean ordered, StringCollator collator, XPathContext context) Get a Comparable value that implements the XPath ordering comparison semantics for this value.static ConversionResult
Factory method: create a duration value from a supplied string, in ISO 8601 format [-]PnDTnHnMnSmultiply
(double n) Multiply duration by a number.negate()
Negate a duration (same as subtracting from zero, but it preserves the type of the original duration)subtract
(DurationValue other) Subtract two dayTime-durationsMethods inherited from class net.sf.saxon.value.DurationValue
badDuration, convertPrimitive, equals, getComponent, getDays, getHours, getMicroseconds, getMinutes, getMonths, getSchemaComparable, getSchemaComparable, getSeconds, getStringValue, getYears, hashCode, makeDuration, normalizeDuration, normalizeZeroDuration, signum, simpleInteger
Methods inherited from class net.sf.saxon.value.AtomicValue
asAtomic, checkPermittedContents, convert, convert, effectiveBooleanValue, getCardinality, getItemType, getLength, getTypedValue, getTypeLabel, isNaN, itemAt, iterate, process, setTypeLabel, subsequence, toString
Methods inherited from class net.sf.saxon.value.Value
asItem, asItem, asIterator, asValue, convertToJava, fromItem, getCanonicalLexicalRepresentation, getIterator, iterate, makeQNameValue, reduce, stringToNumber
-
Constructor Details
-
DayTimeDurationValue
public DayTimeDurationValue(int sign, int days, int hours, int minutes, long seconds, int microseconds) throws IllegalArgumentException Create a dayTimeDuration given the number of days, hours, minutes, and seconds. This constructor performs no validation. The components (apart from sign) must all be non-negative integers; they need not be normalized (for example, 36 hours is acceptable)- Parameters:
sign
- positive number for positive durations, negative for negative duratoinsdays
- number of dayshours
- number of hoursminutes
- number of minutesseconds
- number of secondsmicroseconds
- number of microseconds- Throws:
IllegalArgumentException
- if the value is out of range; specifically, if the total number of seconds exceeds 2^63; or if any of the values is negative
-
-
Method Details
-
makeDayTimeDurationValue
Factory method: create a duration value from a supplied string, in ISO 8601 format [-]PnDTnHnMnS- Parameters:
s
- the lexical representation of the xs:dayTimeDuration value- Returns:
- a DayTimeDurationValue if the format is correct, or a ValidationErrorValue if not
-
copyAsSubType
Create a copy of this atomic value, with a different type label- Overrides:
copyAsSubType
in classDurationValue
- Parameters:
typeLabel
- the type label of the new copy. The caller is responsible for checking that the value actually conforms to this type.- Returns:
- the copied value
-
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 classDurationValue
- Returns:
- the primitive type
-
getStringValueCS
Convert to string- Specified by:
getStringValueCS
in interfaceItem
- Specified by:
getStringValueCS
in interfaceValueRepresentation
- Overrides:
getStringValueCS
in classDurationValue
- Returns:
- ISO 8601 representation.
- See Also:
-
getLengthInSeconds
public double getLengthInSeconds()Get length of duration in seconds- Overrides:
getLengthInSeconds
in classDurationValue
- Returns:
- the duration in seconds, as a double
-
getLengthInMilliseconds
public long getLengthInMilliseconds()Get length of duration in milliseconds, as a long- Returns:
- the length of the duration rounded to milliseconds (may be negative)
-
getLengthInMicroseconds
public long getLengthInMicroseconds()Get length of duration in microseconds, as a long- Returns:
- the length in microseconds
-
fromSeconds
Construct a duration value as a number of seconds.- Parameters:
seconds
- the number of seconds in the duration. May be negative- Returns:
- the xs:dayTimeDuration value with the specified length
- Throws:
XPathException
-
fromMilliseconds
Construct a duration value as a number of milliseconds.- Parameters:
milliseconds
- the number of milliseconds in the duration (may be negative)- Returns:
- the corresponding xs:dayTimeDuration value
- Throws:
ValidationException
- if implementation-defined limits are exceeded, specifically if the total number of seconds exceeds 2^63.
-
fromMicroseconds
public static DayTimeDurationValue fromMicroseconds(long microseconds) throws IllegalArgumentException Construct a duration value as a number of microseconds.- Parameters:
microseconds
- the number of microseconds in the duration. The maximum and minimum limits are such that the number of days in the duration must fit in a 32-bit signed integer.- Returns:
- the xs:dayTimeDuration represented by the given number of microseconds
- Throws:
IllegalArgumentException
- if the value is out of range.
-
multiply
Multiply duration by a number. This is also used when dividing a duration by a number.- Overrides:
multiply
in classDurationValue
- Parameters:
n
- the number to multiply by- Returns:
- the result of the multiplication
- Throws:
XPathException
-
divide
Find the ratio between two durations- Overrides:
divide
in classDurationValue
- Parameters:
other
- the dividend- Returns:
- the ratio, as a decimal
- Throws:
XPathException
-
add
Add two dayTimeDurations- Overrides:
add
in classDurationValue
- Parameters:
other
- the duration to be added to this one- Returns:
- the sum of the two durations
- Throws:
XPathException
-
subtract
Subtract two dayTime-durations- Overrides:
subtract
in classDurationValue
- Parameters:
other
- the duration to be subtracted from this one- Returns:
- the difference of the two durations
- Throws:
XPathException
-
negate
Negate a duration (same as subtracting from zero, but it preserves the type of the original duration)- Overrides:
negate
in classDurationValue
- Returns:
- the original duration with its sign reversed, retaining its type
- Throws:
IllegalArgumentException
- in the extremely unlikely event that the duration is one that cannot be negated (because the limit for positive durations is one second off from the limit for negative durations)
-
compareTo
Compare the value to another duration value- Specified by:
compareTo
in interfaceComparable
- 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)
-
getXPathComparable
Get a Comparable value that implements the XPath ordering comparison semantics for this value. Returns null if the value is not comparable according to XPath rules. The default implementation returns the value itself. This is modified for types such as xs:duration which allow ordering comparisons in XML Schema, but not in XPath.- Overrides:
getXPathComparable
in classDurationValue
- Parameters:
ordered
- true if an ordered comparable is neededcollator
- Collation used for string comparisoncontext
- XPath dynamic context- Returns:
- an Object whose equals() and hashCode() methods implement the XPath comparison semantics with respect to this atomic value. If ordered is specified, the result will either be null if no ordering is defined, or will be a Comparable
-