Package net.sf.saxon.value

Class DayTimeDurationValue

java.lang.Object
net.sf.saxon.value.AtomicValue
net.sf.saxon.value.DurationValue
net.sf.saxon.value.DayTimeDurationValue
All Implemented Interfaces:
Comparable<XPathComparable>, Iterable<AtomicValue>, AtomicMatchKey, XPathComparable, AtomicSequence, GroundedValue, IdentityComparable, Item, Sequence, ConversionResult
public final class DayTimeDurationValue extends DurationValue implements XPathComparable
A value of type xs:dayTimeDuration (or a subtype thereof).

Internally this is held as an BigDecimal number of seconds. Some of the constructor and accessor methods cannot handle the full range of values.

  • Constructor Details

    • DayTimeDurationValue

      public DayTimeDurationValue(BigDecimal seconds)

    • DayTimeDurationValue

      public DayTimeDurationValue(BigDecimal seconds, AtomicType typeLabel)

  • Method Details

    • makeDayTimeDurationValue

      public static ConversionResult makeDayTimeDurationValue(UnicodeString 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 ValidationFailure if not

    • withMetadata

      public AtomicValue withMetadata(AtomicMetadata metadata)
      Create a copy of this atomic value, with a different type label
      Overrides:
      withMetadata in class DurationValue
      Parameters:
      metadata - 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

      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.
      Overrides:
      getPrimitiveType in class DurationValue
      Returns:
      the primitive type

    • getPrimitiveStringValue

      public UnicodeString getPrimitiveStringValue()
      Convert to string
      Overrides:
      getPrimitiveStringValue in class DurationValue
      Returns:
      ISO 8601 representation.

    • toString

      public String toString()
      Description copied from class: AtomicValue
      Get string value.
      Overrides:
      toString in class AtomicValue

    • getLengthInSeconds

      public double getLengthInSeconds()
      Get the length of duration in seconds. Note this may involve loss of precision. For an exact result, use DurationValue.getTotalSeconds()
      Returns:
      an approximation to the length of the duration in seconds, expressed as a double. May be negative.

    • getLengthInMicroseconds

      public long getLengthInMicroseconds()
      Get the length of duration in microseconds, as a long
      Returns:
      the length in nanoseconds, divided by one thousand, rounded towards zero
      Throws:
      ArithmeticException - if the number of microseconds is too high to be returned as a long.

    • 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

    • fromNanoseconds

      public static DayTimeDurationValue fromNanoseconds(long nanoseconds)
      Construct a duration value as a number of nanoseconds.
      Parameters:
      nanoseconds - the number of nanoseconds in the duration.
      Returns:
      the xs:dayTimeDuration represented by the given number of nanoseconds

    • fromJavaDuration

      public static DayTimeDurationValue fromJavaDuration(Duration duration)
      Factory method taking a Java 8 Duration object
      Parameters:
      duration - a duration as a Java 8 java.time.Duration
      Returns:
      the new xs:dayTimeDuration
      Since:
      9.9

    • toJavaDuration

      public Duration toJavaDuration()
      Convert this value to a Java 8 Duration object
      Returns:
      the duration expressed as a Java 8 java.time.Duration
      Since:
      9.9

    • multiply

      public DurationValue multiply(long factor) throws XPathException
      Multiply a duration by an integer
      Overrides:
      multiply in class DurationValue
      Parameters:
      factor - the number to multiply by
      Returns:
      the result of the multiplication
      Throws:
      XPathException - if an error is detected

    • multiply

      public DayTimeDurationValue multiply(double n) throws XPathException
      Multiply duration by a number. Follows the semantics of op:multiply-dayTimeDuration.
      Overrides:
      multiply in class DurationValue
      Parameters:
      n - the number to multiply by.
      Returns:
      the result of the multiplication
      Throws:
      XPathException - if the operand is Infinite or NaN, or if the resulting duration exceeds Saxon limits (2^63 seconds)

    • multiply

      public DayTimeDurationValue multiply(BigDecimal factor) throws XPathException
      Description copied from class: DurationValue
      Multiply a duration by a decimal
      Overrides:
      multiply in class DurationValue
      Parameters:
      factor - the number to multiply by
      Returns:
      the result of the multiplication
      Throws:
      XPathException - if an error is detected

    • divide

      public DurationValue divide(double n) throws XPathException
      Divide duration by a number. Follows the semantics of op:divide-dayTimeDuration.
      Overrides:
      divide in class DurationValue
      Parameters:
      n - the number to divide by.
      Returns:
      the result of the division
      Throws:
      XPathException - if the operand is zero or NaN, or if the resulting duration exceeds Saxon limits (2^63 seconds)

    • divide

      public BigDecimalValue divide(DurationValue other) throws XPathException
      Find the ratio between two durations
      Overrides:
      divide in class DurationValue
      Parameters:
      other - the dividend
      Returns:
      the ratio, as a decimal
      Throws:
      XPathException - when dividing by zero, or when dividing two durations of different type

    • add

      public DurationValue add(DurationValue other) throws XPathException
      Add two dayTimeDurations
      Overrides:
      add in class DurationValue
      Parameters:
      other - the duration to be added to this one
      Returns:
      the sum of the two durations
      Throws:
      XPathException - if an error is detected

    • subtract

      public DurationValue subtract(DurationValue other) throws XPathException
      Subtract two dayTime-durations
      Overrides:
      subtract in class DurationValue
      Parameters:
      other - the duration to be subtracted from this one
      Returns:
      the difference of the two durations
      Throws:
      XPathException - if an error is detected

    • negate

      public DurationValue negate() throws IllegalArgumentException
      Negate a duration (same as subtracting from zero, but it preserves the type of the original duration)
      Overrides:
      negate in class DurationValue
      Returns:
      the original duration with its sign reversed, retaining its type
      Throws:
      IllegalArgumentException

    • getXPathComparable

      public XPathComparable getXPathComparable(StringCollator collator, int implicitTimezone, int specVersion)
      Description copied from class: AtomicValue
      Get an object value that implements the XPath equality and ordering comparison semantics for this value. A collation is supplied for comparing strings, and an implicit timezone for comparing date/time values that have no saved timezone. An atomic value may return itself as the result, provided that its ordering rules are independent of the collation and timezone, and provided that it implements the XPathComparable interface: which means that its compareTo, equals, and hashCode methods must be compatible with the rules for XPath value comparisons.
      Overrides:
      getXPathComparable in class DurationValue
      Parameters:
      collator - the collation to be used when comparing strings
      implicitTimezone - the implicit timezone in the dynamic context, used when comparing dates/times with and without timezone
      specVersion - the version of the XPath specification (31 for 3.1, 40 for 4.0)
      Returns:
      an Object that implements the XPath value comparison semantics with respect to this atomic value. For an atomic type that is not ordered (according to XPath rules), return null.

    • getXPathMatchKey

      public AtomicMatchKey getXPathMatchKey(StringCollator collator, int implicitTimezone, int specVersion)
      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:
      getXPathMatchKey in class DurationValue
      Parameters:
      collator - Collation used for string comparison
      implicitTimezone - XPath dynamic context
      specVersion -
      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