Package net.sf.saxon.value

Class TimeValue

    • Constructor Detail

      • TimeValue

        @Deprecated
public TimeValue​(byte hour,
                 byte minute,
                 byte second,
                 int microsecond,
                 int tzMinutes)
        Deprecated.
        since 10.0: use the constructor TimeValue(byte, byte, byte, int, int, AtomicType) that accepts nanosecond precision
        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
        tzMinutes - the timezone displacement in minutes from UTC. Supply the value CalendarValue.NO_TIMEZONE if there is no timezone component.

      • TimeValue

        public TimeValue​(byte hour,
                 byte minute,
                 byte second,
                 int nanosecond,
                 int tzMinutes,
                 AtomicType typeLabel)
        Private constructor to construct a time value given the hour, minute, second, and nanosecond 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
        nanosecond - the number of microseconds, 0-999999
        tzMinutes - the timezone displacement in minutes from UTC. Supply the value CalendarValue.NO_TIMEZONE if there is no timezone component.
        typeLabel - the type annotation (must be a subtype of xs:time)

      • TimeValue

        public TimeValue​(java.util.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

    • Method Detail

      • makeTimeValue

        public TimeValue makeTimeValue​(byte hour,
                               byte minute,
                               byte second,
                               int nanosecond,
                               int tz)
        Factory method to construct a time value given the hour, minute, second, and nanosecond 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
        nanosecond - the number of nanoseconds, 0-999_999_999
        tz - the timezone displacement in minutes from UTC. Supply the value CalendarValue.NO_TIMEZONE if there is no timezone component.
        Returns:
        the constructed time value

      • makeTimeValue

        public static ConversionResult makeTimeValue​(UnicodeString s)
        Static factory method: create a time value from a supplied string, in ISO 8601 format
        Parameters:
        s - the time in the lexical format hh:mm:ss[.ffffff] followed optionally by timezone in the form [+-]hh:mm or Z
        Returns:
        either a TimeValue corresponding to the xs:time, or a ValidationFailure if the supplied value was invalid

      • 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.
        Specified by:
        getPrimitiveType in class AtomicValue
        Returns:
        the primitive type

      • getHour

        public byte getHour()
        Get the hour component, 0-23
        Returns:
        the hour

      • getMinute

        public byte getMinute()
        Get the minute component, 0-59
        Returns:
        the minute

      • getSecond

        public byte getSecond()
        Get the second component, 0-59
        Returns:
        the second

      • getMicrosecond

        public int getMicrosecond()
        Get the microsecond component, 0-999_999
        Returns:
        the nanoseconds component divided by 1000, rounded towards zero

      • getNanosecond

        public int getNanosecond()
        Get the nanosecond component, 0-999_999
        Returns:
        the nanoseconds

      • getPrimitiveStringValue

        public UnicodeString getPrimitiveStringValue()
        Convert to string
        Specified by:
        getPrimitiveStringValue in class AtomicValue
        Returns:
        ISO 8601 representation, in the localized timezone (the timezone held within the value).

      • toDateTime

        public DateTimeValue 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 class CalendarValue
        Returns:
        the equivalent DateTimeValue

      • getCalendar

        public java.util.GregorianCalendar getCalendar()
        Get a Java Calendar object corresponding to this time, on a reference date
        Specified by:
        getCalendar in class CalendarValue
        Returns:
        A Calendar object representing the date and time. Note that Java can only represent the time to millisecond precision.

      • copyAsSubType

        public AtomicValue copyAsSubType​(AtomicType typeLabel)
        Make a copy of this time value, but with a different type label
        Specified by:
        copyAsSubType in class AtomicValue
        Parameters:
        typeLabel - the new type label. This must be a subtype of xs:time.
        Returns:
        the copied value

      • adjustTimezone

        public TimeValue 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
        Specified by:
        adjustTimezone in class CalendarValue
        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

      • getComponent

        public AtomicValue getComponent​(AccessorFn.Component component)
                         throws XPathException
        Get a component of the value. Returns null if the timezone component is requested and is not present.
        Overrides:
        getComponent in class AtomicValue
        Parameters:
        component - the required component
        Returns:
        the value of the requested component of this value
        Throws:
        XPathException - if a dynamic error occurs

      • getXPathComparable

        public XPathComparable getXPathComparable​(StringCollator collator,
                                          int implicitTimezone)
                                   throws NoDynamicContextException
        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 CalendarValue
        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
        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.
        Throws:
        NoDynamicContextException - if the supplied implicit timezone is "NO_TIMEZONE" (meaning unknown), and the implicit timezone is actually required because the value in question is a date/time value with no timezone. This can cause a failure to evaluate expressions statically (because the implicit timezone is not known statically), and it will then be caught, meaning that the expression has to be evaluated dynamically.

      • compareTo

        public int compareTo​(XPathComparable other)
        Compare the value to another dateTime value
        Specified by:
        compareTo in interface java.lang.Comparable<XPathComparable>
        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:
        java.lang.ClassCastException - if the other value is not a TimeValue (the parameter is declared as Object to satisfy the Comparable interface)

      • compareTo

        public int compareTo​(CalendarValue other,
                     int implicitTimezone)
              throws NoDynamicContextException
        Compare the value to another dateTime value
        Specified by:
        compareTo in class CalendarValue
        Parameters:
        other - The other dateTime value
        implicitTimezone - The implicit timezone assumed for a value with no timezone
        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:
        java.lang.ClassCastException - if the other value is not a DateTimeValue (the parameter is declared as Object to satisfy the Comparable interface)
        NoDynamicContextException - if the implicit timezone is required and is not available (because the function is called at compile time)

      • equals

        public boolean equals​(java.lang.Object other)
        Description copied from class: AtomicValue
        The equals() methods on atomic values is defined to follow the semantics of eq when applied to two atomic values. When the other operand is not an atomic value, the result is undefined (may be false, may be an exception). When the other operand is an atomic value that cannot be compared with this one, the method must throw a ClassCastException.

        The hashCode() method is consistent with equals().

        Overrides:
        equals in class AtomicValue
        Parameters:
        other - the other value
        Returns:
        true (in a subclass) if the other operand is an atomic value and the two values are equal as defined by the XPath eq operator

      • hashCode

        public int hashCode()
        Description copied from class: AtomicValue
        Returns a hash code value for the object.
        Overrides:
        hashCode in class AtomicValue

      • add

        public TimeValue add​(DurationValue duration)
              throws XPathException
        Add a duration to a dateTime
        Specified by:
        add in class CalendarValue
        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