net.sf.saxon.value

Class DateTimeValue

public final class DateTimeValue extends CalendarValue implements Comparable

A value of type DateTime
Field Summary
static DateTimeValueEPOCH
Fixed date/time used by Java (and Unix) as the origin of the universe: 1970-01-01
Constructor Summary
DateTimeValue(Calendar calendar, boolean tzSpecified)
Constructor: create a dateTime value given a Java calendar object
DateTimeValue(int year, byte month, byte day, byte hour, byte minute, byte second, int microsecond, int tz)
Constructor: construct a DateTimeValue from its components.
Method Summary
CalendarValueadd(DurationValue duration)
Add a duration to a dateTime
CalendarValueadjustTimezone(int timezone)
Return a new dateTime with the same normalized value, but in a different timezone.
intcompareTo(CalendarValue other, XPathContext context)
Compare the value to another dateTime value, following the XPath comparison semantics
intcompareTo(Object v2)
Context-free comparison of two DateTimeValue values.
ConversionResultconvertPrimitive(BuiltInAtomicType requiredType, boolean validate, XPathContext context)
Convert to target data type
ValidationFailureconvertToSubType(BuiltInAtomicType subtype)
Convert the value to a built-in subtype of xs:dateTime
AtomicValuecopyAsSubType(AtomicType typeLabel)
Make a copy of this date, time, or dateTime value, but with a new type label
booleanequals(Object o)
Context-free comparison of two dateTime values
static DateTimeValuefromJavaDate(Date suppliedDate)
Factory method: create a dateTime value given a Java Date object.
static DateTimeValuefromJulianInstant(BigDecimal instant)
Get the DateTimeValue corresponding to a given Julian instant
GregorianCalendargetCalendar()
Get a Java Calendar object representing the value of this DateTime.
CharSequencegetCanonicalLexicalRepresentation()
Get the canonical lexical representation as defined in XML Schema.
ComparisonKeygetComparisonKey(XPathContext context)
Get a comparison key for this value.
AtomicValuegetComponent(int component)
Get a component of the value.
static DateTimeValuegetCurrentDateTime(XPathContext context)
Get the dateTime value representing the nominal date/time of this transformation run.
bytegetDay()
Get the day component, 1-31
bytegetHour()
Get the hour component, 0-23
intgetMicrosecond()
Get the microsecond component, 0-999999
bytegetMinute()
Get the minute component, 0-59
bytegetMonth()
Get the month component, 1-12
CharSequencegetPrimitiveStringValue()
Convert to string
BuiltInAtomicTypegetPrimitiveType()
Determine the primitive type of the value.
ComparablegetSchemaComparable()
bytegetSecond()
Get the second component, 0-59
intgetYear()
Get the year component, in its internal form (which allows a year zero)
inthashCode()
Hash code for context-free comparison of date time values.
static inthashCode(int year, byte month, byte day, byte hour, byte minute, byte second, int microsecond, int tzMinutes)
static DateTimeValuemakeDateTimeValue(DateValue date, TimeValue time)
Factory method: create a dateTime value given a date and a time.
static ConversionResultmakeDateTimeValue(CharSequence s)
Factory method: create a dateTime value from a supplied string, in ISO 8601 format
DateTimeValuenormalize(XPathContext cc)
Normalize the date and time to be in timezone Z.
DayTimeDurationValuesubtract(CalendarValue other, XPathContext context)
Determine the difference between two points in time, as a duration
DateTimeValuetoDateTime()
Convert the value to a DateTime, retaining all the components that are actually present, and substituting conventional values for components that are missing.
DateValuetoDateValue()
Extract the Date part
BigDecimaltoJulianInstant()
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.
TimeValuetoTimeValue()
Extract the Time part

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(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)
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 NO_TIMEZONE if there is no timezone component.

Method Detail

add

public CalendarValue add(DurationValue duration)
Add a duration to a dateTime

Parameters: duration the duration to be added (may be negative)

Returns: the new date

Throws: net.sf.saxon.trans.XPathException if the duration is an xs:duration, as distinct from a subclass thereof

adjustTimezone

public CalendarValue adjustTimezone(int timezone)
Return a new dateTime with the same normalized value, but in a different timezone.

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

compareTo

public int compareTo(CalendarValue other, XPathContext context)
Compare the value to another dateTime value, following the XPath comparison semantics

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: 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(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.

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: ClassCastException if the values are not comparable (which might be because no timezone is available)

convertPrimitive

public ConversionResult convertPrimitive(BuiltInAtomicType requiredType, boolean validate, XPathContext context)
Convert to target data type

Parameters: requiredType an integer identifying the required atomic type context the XPath dynamic context

Returns: an AtomicValue, a value of the required type; or an ErrorValue

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.

copyAsSubType

public AtomicValue copyAsSubType(AtomicType typeLabel)
Make a copy of this date, time, or dateTime value, but with a new type label

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.

equals

public boolean equals(Object o)
Context-free comparison of two dateTime values

Parameters: o the other date time value

Returns: true if the two values represent the same instant in time

Throws: ClassCastException if one of the values has a timezone and the other does not

fromJavaDate

public static DateTimeValue fromJavaDate(Date suppliedDate)
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

fromJulianInstant

public static DateTimeValue fromJulianInstant(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 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.

Returns: a Java GregorianCalendar object representing the value of this xs:dateTime value.

getCanonicalLexicalRepresentation

public 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.

Returns: the canonical lexical representation as defined in XML Schema

getComparisonKey

public ComparisonKey getComparisonKey(XPathContext context)
Get a comparison key for this value. Two values are equal if and only if they their comparison keys are equal

Parameters: context XPath dynamic context

Throws: NoDynamicContextException if the implicit timezone is needed and is not available

getComponent

public AtomicValue getComponent(int component)
Get a component of the value. Returns null if the timezone component is requested and is not present.

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

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)

getMicrosecond

public int getMicrosecond()
Get the microsecond component, 0-999999

Returns: the microsecond component

getMinute

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

Returns: the minute component

getMonth

public byte getMonth()
Get the month component, 1-12

Returns: the month component

getPrimitiveStringValue

public CharSequence getPrimitiveStringValue()
Convert to string

Returns: ISO 8601 representation. The value returned is the localized representation, that is it uses the timezone contained within the value itself.

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.

getSchemaComparable

public Comparable getSchemaComparable()

getSecond

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

Returns: the second component

getYear

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

Returns: the year component

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

Returns: a hash code

hashCode

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

makeDateTimeValue

public static DateTimeValue makeDateTimeValue(DateValue date, TimeValue time)
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(CharSequence s)
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

Returns: either a DateTimeValue representing the xs:dateTime supplied, or a ValidationFailure if the lexical value was invalid

normalize

public DateTimeValue normalize(XPathContext cc)
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

subtract

public DayTimeDurationValue subtract(CalendarValue other, XPathContext context)
Determine the difference between two points in time, as a duration

Parameters: other the other point in time context the XPath dynamic context

Returns: the duration as an xs:dayTimeDuration

Throws: net.sf.saxon.trans.XPathException for example if one value is a date and the other is a time

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).

Returns: the value as an xs:dateTime

toDateValue

public DateValue toDateValue()
Extract the Date part

Returns: a DateValue representing the date part of the dateTime, retaining the timezone or its absence

toJulianInstant

public 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

toTimeValue

public TimeValue toTimeValue()
Extract the Time part

Returns: a TimeValue representing the date part of the dateTime, retaining the timezone or its absence