net.sf.saxon.value
Class DateTimeValue

java.lang.Object
  extended bynet.sf.saxon.value.Value
      extended bynet.sf.saxon.value.AtomicValue
          extended bynet.sf.saxon.value.CalendarValue
              extended bynet.sf.saxon.value.DateTimeValue
All Implemented Interfaces:
java.lang.Comparable, Expression, Item, java.io.Serializable, ValueRepresentation

public final class DateTimeValue
extends CalendarValue
implements java.lang.Comparable

A value of type DateTime

See Also:
Serialized Form

Field Summary
 
Fields inherited from class net.sf.saxon.value.CalendarValue
calendar, zoneSpecified
 
Fields inherited from interface net.sf.saxon.expr.Expression
EVALUATE_METHOD, ITERATE_METHOD, PROCESS_METHOD
 
Constructor Summary
DateTimeValue(java.lang.CharSequence s)
          Constructor: create a dateTime value from a supplied string, in ISO 8601 format
DateTimeValue(DateValue date, TimeValue time)
          Constructor: create a dateTime value given a date and a time.
DateTimeValue(java.util.GregorianCalendar calendar, boolean tzSpecified)
          Constructor: create a dateTime value given a Java calendar object
 
Method Summary
 CalendarValue add(DurationValue duration)
          Add a duration to a dateTime
static void appendTimezone(java.util.Calendar calendar, FastStringBuffer sb)
          Add a string representation of the timezone, typically formatted as "Z" or "+03:00" or "-10:00", to the supplied string buffer
 int compareTo(java.lang.Object other)
          Compare the value to another dateTime value
 AtomicValue convertPrimitive(BuiltInAtomicType requiredType, boolean validate)
          Convert to target data type
 java.lang.Object convertToJava(java.lang.Class target, XPathContext context)
          Convert to Java object (for passing to external functions)
 boolean equals(java.lang.Object other)
          Compare two (sequence) values for equality.
 java.util.Calendar getCalendar()
          Get the Calendar object representing the value of this DateTime
 AtomicValue getComponent(int component)
          Get a component of the value.
static DateTimeValue getCurrentDateTime(XPathContext context)
          get the dateTime value representing the nominal date/time of this transformation run.
 ItemType getItemType()
          Determine the data type of the exprssion
 java.lang.String getStringValue()
          Convert to string
 java.util.Date getUTCDate()
          Get the UTC date/time corresponding to this dateTime.
 int hashCode()
          Return a hash code to support the equals() function
 CalendarValue removeTimezone()
          Return a dateTime with the same localized value, but without the timezone component
 CalendarValue setTimezone(SecondsDurationValue tz)
          Return a date, time, or dateTime with the same normalized value, but in a different timezone
 SecondsDurationValue subtract(CalendarValue other, XPathContext context)
          Determine the difference between two points in time, as a duration
 
Methods inherited from class net.sf.saxon.value.AtomicValue
checkPermittedContents, convert, convert, display, effectiveBooleanValue, evaluateAsString, evaluateItem, getCardinality, getImplementationMethod, getLength, getPrimitiveValue, getStringValueCS, getTypedValue, hasBuiltInType, iterate, process, toString
 
Methods inherited from class net.sf.saxon.value.Value
analyze, asItem, asValue, collapseWhitespace, convert, convertJavaObjectToXPath, getDependencies, getIterator, getParentExpression, getSpecialProperties, itemAt, iterateSubExpressions, makeQNameValue, normalizeWhitespace, promote, simplify, stringToNumber, trimWhitespace
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DateTimeValue

public DateTimeValue(java.util.GregorianCalendar 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(DateValue date,
                     TimeValue time)
              throws XPathException
Constructor: create a dateTime value given a date and a time.

Parameters:
date - the date
time - the time
Throws:
XPathException - if the timezones are both present and inconsistent

DateTimeValue

public DateTimeValue(java.lang.CharSequence s)
              throws XPathException
Constructor: create a dateTime value from a supplied string, in ISO 8601 format

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.


getUTCDate

public java.util.Date getUTCDate()
Get the UTC date/time corresponding to this dateTime. This normalizes the value to incorporate the timezone information, for example 2002-01-01T07:00:00-05:00 gives the same answer as 2002-01-01T12:00:00Z


getCalendar

public java.util.Calendar getCalendar()
Get the Calendar object representing the value of this DateTime


convertPrimitive

public AtomicValue convertPrimitive(BuiltInAtomicType requiredType,
                                    boolean validate)
Convert to target data type

Specified by:
convertPrimitive in class AtomicValue
Parameters:
requiredType - an integer identifying the required atomic type
validate - true if validation is required. If set to false, the caller guarantees that the value is valid for the target data type, and that further validation is therefore not required. Note that a validation failure may be reported even if validation was not requested.
Returns:
an AtomicValue, a value of the required type; or an ErrorValue

getStringValue

public java.lang.String getStringValue()
Convert to string

Specified by:
getStringValue in interface Item
Specified by:
getStringValue 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.

appendTimezone

public static void appendTimezone(java.util.Calendar calendar,
                                  FastStringBuffer sb)
Add a string representation of the timezone, typically formatted as "Z" or "+03:00" or "-10:00", to the supplied string buffer

Parameters:
calendar - The Calendar whose timezone value is required
sb - The StringBuffer that will be updated with the resulting string representation

getItemType

public ItemType getItemType()
Determine the data type of the exprssion

Specified by:
getItemType in interface Expression
Overrides:
getItemType in class Value
Returns:
Type.DATE_TIME,

removeTimezone

public CalendarValue removeTimezone()
Return a dateTime with the same localized value, but without the timezone component

Specified by:
removeTimezone in class CalendarValue
Returns:
the result of removing the timezone

setTimezone

public CalendarValue setTimezone(SecondsDurationValue tz)
                          throws XPathException
Return a date, time, or dateTime with the same normalized value, but in a different timezone

Specified by:
setTimezone in class CalendarValue
Returns:
the date/time in the new timezone
Throws:
XPathException

add

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

subtract

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

Overrides:
subtract in class CalendarValue
Parameters:
other - the other point in time
context -
Returns:
the duration as an xdt:dayTimeDuration
Throws:
XPathException - for example if one value is a date and the other is a time

convertToJava

public java.lang.Object convertToJava(java.lang.Class target,
                                      XPathContext context)
                               throws XPathException
Convert to Java object (for passing to external functions)

Overrides:
convertToJava in class Value
Throws:
XPathException

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
Throws:
XPathException

compareTo

public int compareTo(java.lang.Object other)
Compare the value to another dateTime value

Specified by:
compareTo in interface java.lang.Comparable
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 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 Object to satisfy the Comparable interface)

equals

public boolean equals(java.lang.Object other)
Description copied from class: Value
Compare two (sequence) values for equality. This supports identity constraints in XML Schema, which allow list-valued elements and attributes to participate in key and uniqueness constraints. This method returns false if any error occurs during the comparison, or if any of the items in either sequence is a node rather than an atomic value.

Overrides:
equals in class Value

hashCode

public int hashCode()
Description copied from class: Value
Return a hash code to support the equals() function

Overrides:
hashCode in class Value