Class DateTimeValue

    • Field Detail

      • EPOCH

        public static final DateTimeValue EPOCH
        Fixed date/time used by Java (and Unix) as the origin of the universe: 1970-01-01
    • Constructor Detail

      • DateTimeValue

        public DateTimeValue​(java.util.Calendar calendar,
                             boolean tzSpecified)
        Constructor: create a dateTime value given a Java calendar object
        Parameters:
        calendar - holds the date and time
        tzSpecified - indicates whether the timezone is specified
      • DateTimeValue

        public DateTimeValue​(int year,
                             byte month,
                             byte day,
                             byte hour,
                             byte minute,
                             byte second,
                             int microsecond,
                             int tz,
                             boolean xsd10Check)
        Constructor: construct a DateTimeValue from its components. This constructor performs no validation.
        Parameters:
        year - The year as held internally (note that the year before 1AD is 0)
        month - The month, 1-12
        day - The day 1-31
        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
        tz - the timezone displacement in minutes from UTC. Supply the value CalendarValue.NO_TIMEZONE if there is no timezone component.
        xsd10Check - true if the dateTime value should behave under XSD 1.0 rules, that is, negative dates assume there is no year zero. (Not that regardless of this setting, the year argument is set on the basis that the year before +1 is supplied as zero; but if the xsd10Check flag is set, this value will be displayed with a year of -1.)
    • Method Detail

      • getCurrentDateTime

        public static DateTimeValue getCurrentDateTime​(XPathContext context)
        Get the dateTime value representing the nominal date/time of this transformation run. Two calls within the same query or transformation will always return the same answer.
        Parameters:
        context - the XPath dynamic context. May be null, in which case the current date and time are taken directly from the system clock
        Returns:
        the current xs:dateTime
      • fromJavaDate

        public static DateTimeValue fromJavaDate​(java.util.Date suppliedDate)
                                          throws XPathException
        Factory method: create a dateTime value given a Java Date object. The returned dateTime value will always have a timezone, which will always be UTC.
        Parameters:
        suppliedDate - holds the date and time
        Returns:
        the corresponding xs:dateTime value
        Throws:
        XPathException
      • makeDateTimeValue

        public static DateTimeValue makeDateTimeValue​(DateValue date,
                                                      TimeValue time)
                                               throws XPathException
        Factory method: create a dateTime value given a date and a time.
        Parameters:
        date - the date
        time - the time
        Returns:
        the dateTime with the given components. If either component is null, returns null
        Throws:
        XPathException - if the timezones are both present and inconsistent
      • makeDateTimeValue

        public static ConversionResult makeDateTimeValue​(java.lang.CharSequence s,
                                                         ConversionRules rules)
        Factory method: create a dateTime value from a supplied string, in ISO 8601 format
        Parameters:
        s - a string in the lexical space of xs:dateTime
        rules - the conversion rules to be used (determining whether year zero is allowed)
        Returns:
        either a DateTimeValue representing the xs:dateTime supplied, or a ValidationFailure if the lexical value was invalid
      • convertToSubType

        public ValidationFailure convertToSubType​(BuiltInAtomicType subtype)
        Convert the value to a built-in subtype of xs:dateTime
        Parameters:
        subtype - the target subtype
        Returns:
        null if the conversion succeeds; a ValidationFailure describing the failure if it fails.
      • 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
      • getYear

        public int getYear()
        Get the year component, in its internal form (which allows a year zero)
        Returns:
        the year component
      • getMonth

        public byte getMonth()
        Get the month component, 1-12
        Returns:
        the month component
      • getDay

        public byte getDay()
        Get the day component, 1-31
        Returns:
        the day component
      • getHour

        public byte getHour()
        Get the hour component, 0-23
        Returns:
        the hour component (never 24, even if the input was specified as 24:00:00)
      • getMinute

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

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

        public int getMicrosecond()
        Get the microsecond component, 0-999999
        Returns:
        the microsecond component
      • toDateTime

        public DateTimeValue toDateTime()
        Convert the value to a DateTime, retaining all the components that are actually present, and substituting conventional values for components that are missing. (This method does nothing in the case of xs:dateTime, but is there to implement a method in the CalendarValue interface).
        Specified by:
        toDateTime in class CalendarValue
        Returns:
        the value as an xs:dateTime
      • isXsd10Rules

        public boolean isXsd10Rules()
        Ask whether this value uses the XSD 1.0 rules (which don't allow year zero) or the XSD 1.1 rules (which do).
        Returns:
        true if the value uses the XSD 1.0 rules
      • normalize

        public DateTimeValue normalize​(XPathContext cc)
                                throws NoDynamicContextException
        Normalize the date and time to be in timezone Z.
        Parameters:
        cc - used to supply the implicit timezone, used when the value has no explicit timezone
        Returns:
        in general, a new DateTimeValue in timezone Z, representing the same instant in time. Returns the original DateTimeValue if this is already in timezone Z.
        Throws:
        NoDynamicContextException - if the implicit timezone is needed and is not available
      • toJulianInstant

        public java.math.BigDecimal toJulianInstant()
        Get the Julian instant: a decimal value whose integer part is the Julian day number multiplied by the number of seconds per day, and whose fractional part is the fraction of the second. This method operates on the local time, ignoring the timezone. The caller should call normalize() before calling this method to get a normalized time.
        Returns:
        the Julian instant corresponding to this xs:dateTime value
      • fromJulianInstant

        public static DateTimeValue fromJulianInstant​(java.math.BigDecimal instant)
        Get the DateTimeValue corresponding to a given Julian instant
        Parameters:
        instant - the Julian instant: a decimal value whose integer part is the Julian day number multiplied by the number of seconds per day, and whose fractional part is the fraction of the second.
        Returns:
        the xs:dateTime value corresponding to the Julian instant. This will always be in timezone Z.
      • getCalendar

        public java.util.GregorianCalendar getCalendar()
        Get a Java Calendar object representing the value of this DateTime. This will respect the timezone if there is one, or be in GMT otherwise.
        Specified by:
        getCalendar in class CalendarValue
        Returns:
        a Java GregorianCalendar object representing the value of this xs:dateTime value.
      • getPrimitiveStringValue

        public java.lang.CharSequence getPrimitiveStringValue()
        Convert to string
        Specified by:
        getPrimitiveStringValue in class AtomicValue
        Returns:
        ISO 8601 representation. The value returned is the localized representation, that is it uses the timezone contained within the value itself.
      • toDateValue

        public DateValue toDateValue()
        Extract the Date part
        Returns:
        a DateValue representing the date part of the dateTime, retaining the timezone or its absence
      • toTimeValue

        public TimeValue toTimeValue()
        Extract the Time part
        Returns:
        a TimeValue representing the date part of the dateTime, retaining the timezone or its absence
      • getCanonicalLexicalRepresentation

        public java.lang.CharSequence getCanonicalLexicalRepresentation()
        Get the canonical lexical representation as defined in XML Schema. This is not always the same as the result of casting to a string according to the XPath rules. For an xs:dateTime it is the date/time adjusted to UTC.
        Overrides:
        getCanonicalLexicalRepresentation in class Value<AtomicValue>
        Returns:
        the canonical lexical representation as defined in XML Schema
      • copyAsSubType

        public AtomicValue copyAsSubType​(AtomicType typeLabel)
        Make a copy of this date, time, or dateTime value, but with a new type label
        Specified by:
        copyAsSubType in class AtomicValue
        Parameters:
        typeLabel - the type label to be attached to the new copy. It is the caller's responsibility to ensure that the value actually conforms to the rules for this type.
        Returns:
        the copied value
      • adjustTimezone

        public CalendarValue adjustTimezone​(int timezone)
        Return a new dateTime with the same normalized value, but in a different timezone.
        Specified by:
        adjustTimezone in class CalendarValue
        Parameters:
        timezone - the new timezone offset, in minutes
        Returns:
        the date/time in the new timezone. This will be a new DateTimeValue unless no change was required to the original value
      • getComponent

        public AtomicValue getComponent​(int 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 - identifies the required component, as a constant defined in class Component, for example Component.HOURS
        Returns:
        the value of the requested component of this value
        Throws:
        XPathException - if a dynamic error occurs
      • compareTo

        public int compareTo​(CalendarValue other,
                             XPathContext context)
                      throws NoDynamicContextException
        Compare the value to another dateTime value, following the XPath comparison semantics
        Specified by:
        compareTo in class CalendarValue
        Parameters:
        other - The other dateTime value
        context - XPath dynamic evaluation context
        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 values in the implicit timezone (the Comparable interface requires a total ordering).
        Throws:
        java.lang.ClassCastException - if the other value is not a DateTimeValue (the parameter is declared as CalendarValue to satisfy the interface)
        NoDynamicContextException - if the implicit timezone is needed and is not available
      • compareTo

        public int compareTo​(java.lang.Object v2)
        Context-free comparison of two DateTimeValue values. For this to work, the two values must either both have a timezone or both have none.
        Specified by:
        compareTo in interface java.lang.Comparable
        Parameters:
        v2 - the other value
        Returns:
        the result of the comparison: -1 if the first is earlier, 0 if they are equal, +1 if the first is later
        Throws:
        java.lang.ClassCastException - if the values are not comparable (which might be because no timezone is available)
      • getSchemaComparable

        public java.lang.Comparable getSchemaComparable()
        Description copied from class: AtomicValue
        Get a Comparable value that implements the XML Schema ordering comparison semantics for this value. An implementation must be provided for all atomic types.

        In the case of data types that are partially ordered, the returned Comparable extends the standard semantics of the compareTo() method by returning the value Value.INDETERMINATE_ORDERING when there is no defined order relationship between two given values. This value is also returned when two values of different types are compared.

        Specified by:
        getSchemaComparable in class AtomicValue
        Returns:
        a Comparable that follows XML Schema comparison rules
      • equals

        public boolean equals​(java.lang.Object o)
        Context-free comparison of two dateTime values
        Specified by:
        equals in class AtomicValue
        Parameters:
        o - the other date time value
        Returns:
        true if the two values represent the same instant in time
        Throws:
        java.lang.ClassCastException - if one of the values has a timezone and the other does not
      • hashCode

        public int hashCode()
        Hash code for context-free comparison of date time values. Note that equality testing and therefore hashCode() works only for values with a timezone
        Overrides:
        hashCode in class Value<AtomicValue>
        Returns:
        a hash code
      • hashCode

        static int hashCode​(int year,
                            byte month,
                            byte day,
                            byte hour,
                            byte minute,
                            byte second,
                            int microsecond,
                            int tzMinutes)