net.sf.saxon.value

Class DayTimeDurationValue

public final class DayTimeDurationValue extends DurationValue implements Comparable

A value of type xs:dayTimeDuration
Constructor Summary
DayTimeDurationValue(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
DurationValueadd(DurationValue other)
Add two dayTimeDurations
intcompareTo(Object other)
Compare the value to another duration value
AtomicValuecopyAsSubType(AtomicType typeLabel)
Create a copy of this atomic value, with a different type label
DecimalValuedivide(DurationValue other)
Find the ratio between two durations
static DayTimeDurationValuefromMicroseconds(long microseconds)
Construct a duration value as a number of microseconds.
static DayTimeDurationValuefromMilliseconds(long milliseconds)
Construct a duration value as a number of milliseconds.
static DayTimeDurationValuefromSeconds(BigDecimal seconds)
Construct a duration value as a number of seconds.
longgetLengthInMicroseconds()
Get length of duration in microseconds, as a long
longgetLengthInMilliseconds()
Get length of duration in milliseconds, as a long
doublegetLengthInSeconds()
Get length of duration in seconds
CharSequencegetPrimitiveStringValue()
Convert to string
BuiltInAtomicTypegetPrimitiveType()
Determine the primitive type of the value.
ObjectgetXPathComparable(boolean ordered, StringCollator collator, XPathContext context)
Get a Comparable value that implements the XPath ordering comparison semantics for this value.
static ConversionResultmakeDayTimeDurationValue(CharSequence s)
Factory method: create a duration value from a supplied string, in ISO 8601 format [-]PnDTnHnMnS
DurationValuemultiply(double n)
Multiply duration by a number.
DurationValuenegate()
Negate a duration (same as subtracting from zero, but it preserves the type of the original duration)
DurationValuesubtract(DurationValue other)
Subtract two dayTime-durations

Constructor Detail

DayTimeDurationValue

public DayTimeDurationValue(int sign, int days, int hours, int minutes, long seconds, int microseconds)
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 duratoins days number of days hours number of hours minutes number of minutes seconds number of seconds microseconds 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 Detail

add

public DurationValue add(DurationValue other)
Add two dayTimeDurations

compareTo

public int compareTo(Object other)
Compare the value to another duration 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)

copyAsSubType

public AtomicValue copyAsSubType(AtomicType typeLabel)
Create a copy of this atomic value, with a different type label

Parameters: typeLabel the type label of the new copy. The caller is responsible for checking that the value actually conforms to this type.

divide

public DecimalValue divide(DurationValue other)
Find the ratio between two durations

Parameters: other the dividend

Returns: the ratio, as a decimal

Throws: XPathException

fromMicroseconds

public static DayTimeDurationValue fromMicroseconds(long microseconds)
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.

fromMilliseconds

public static DayTimeDurationValue fromMilliseconds(long milliseconds)
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.

fromSeconds

public static DayTimeDurationValue fromSeconds(BigDecimal seconds)
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

getLengthInMicroseconds

public long getLengthInMicroseconds()
Get length of duration in microseconds, as a long

Returns: the length in microseconds

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)

getLengthInSeconds

public double getLengthInSeconds()
Get length of duration in seconds

getPrimitiveStringValue

public CharSequence getPrimitiveStringValue()
Convert to string

Returns: ISO 8601 representation.

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.

getXPathComparable

public Object getXPathComparable(boolean ordered, StringCollator collator, XPathContext context)
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.

Parameters: ordered true if an ordered comparable is needed collator Collation used for string comparison context XPath dynamic context

makeDayTimeDurationValue

public static ConversionResult makeDayTimeDurationValue(CharSequence s)
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

multiply

public DurationValue multiply(double n)
Multiply duration by a number. This is also used when dividing a duration by a number.

negate

public DurationValue negate()
Negate a duration (same as subtracting from zero, but it preserves the type of the original duration)

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)

subtract

public DurationValue subtract(DurationValue other)
Subtract two dayTime-durations