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:
Comparable, Expression, Item, Serializable

public final class DateTimeValue
extends CalendarValue
implements Comparable

A value of type DateTime

See Also:
Serialized Form

Field Summary
 
Fields inherited from class net.sf.saxon.value.CalendarValue
calendar, zoneSpecified
 
Constructor Summary
DateTimeValue(CharSequence s)
          Constructor: create a dateTime value from a supplied string, in ISO 8601 format
DateTimeValue(GregorianCalendar calendar, boolean tzSpecified)
          Constructor: create a dateTime value given a Java calendar object
DateTimeValue(XPathContext context)
          Constructor: create a dateTime value representing the nominal date/time of this transformation run.
 
Method Summary
 CalendarValue add(DurationValue duration)
          Add a duration to a dateTime
protected static void appendSeconds(Calendar calendar, StringBuffer sb)
           
protected static void appendString(StringBuffer sb, int value, int size)
           
static void appendTimezone(Calendar calendar, StringBuffer sb)
          Add a string representation of the timezone, typically formatted as "Z" or "+03:00" or "-10:00", to the supplied string buffer
protected static void appendTimezone(int timeZoneOffset, StringBuffer 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(Object other)
          Compare the value to another dateTime value
 int conversionPreference(Class required)
          Get conversion preference for this value to a Java class.
 AtomicValue convert(int requiredType)
          Convert to target data type
 Object convertToJava(Class target)
          Convert to Java object (for passing to external functions)
 void display(int level, NamePool pool)
          Diagnostic print of expression structure
 boolean equals(Object other)
           
 Calendar getCalendar()
          Get the Calendar object representing the value of this DateTime
 AtomicValue getComponent(int component)
          Get a component of the value.
 ItemType getItemType()
          Determine the data type of the exprssion
 String getStringValue()
          Convert to string
 Date getUTCDate()
          Get the UTC date/time corresponding to this dateTime.
 int hashCode()
           
 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)
          Determine the difference between two points in time, as a duration
 
Methods inherited from class net.sf.saxon.value.AtomicValue
convert, convert, effectiveBooleanValue, evaluateAsString, evaluateItem, getCardinality, getPrimitiveValue, getTypedValue, iterate
 
Methods inherited from class net.sf.saxon.value.Value
analyze, asItem, asValue, collapseWhitespace, getDependencies, getSpecialProperties, getSubExpressions, inverse, normalizeWhitespace, promote, simplify, stringToInteger, stringToNumber, trimWhitespace
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DateTimeValue

public DateTimeValue(XPathContext context)
Constructor: create a dateTime value representing the nominal date/time of this transformation run. Two calls within the same transformation will always return the same answer.


DateTimeValue

public DateTimeValue(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(CharSequence s)
              throws XPathException
Constructor: create a dateTime value from a supplied string, in ISO 8601 format

Method Detail

getUTCDate

public 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 Calendar getCalendar()
Get the Calendar object representing the value of this DateTime


convert

public AtomicValue convert(int requiredType)
                    throws XPathException
Convert to target data type

Specified by:
convert in class AtomicValue
Parameters:
requiredType - an integer identifying the required atomic type
Returns:
an AtomicValue, a value of the required type
Throws:
XPathException - if the conversion is not possible

getStringValue

public String getStringValue()
Convert to string

Specified by:
getStringValue in interface Item
Returns:
ISO 8601 representation. The value returned is the localized representation, that is it uses the timezone contained within the value itself.

appendString

protected static void appendString(StringBuffer sb,
                                   int value,
                                   int size)

appendSeconds

protected static void appendSeconds(Calendar calendar,
                                    StringBuffer sb)

appendTimezone

public static void appendTimezone(Calendar calendar,
                                  StringBuffer 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

appendTimezone

protected static void appendTimezone(int timeZoneOffset,
                                     StringBuffer sb)
Add a string representation of the timezone, typically formatted as "Z" or "+03:00" or "-10:00", to the supplied string buffer

Parameters:
timeZoneOffset - The timezone offset in minutes
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
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)
                              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
Returns:
the duration as an xdt:dayTimeDuration
Throws:
XPathException - for example if one value is a date and the other is a time

conversionPreference

public int conversionPreference(Class required)
Get conversion preference for this value to a Java class. A low result indicates higher preference.

Overrides:
conversionPreference in class AtomicValue

convertToJava

public Object convertToJava(Class target)
                     throws XPathException
Convert to Java object (for passing to external functions)

Overrides:
convertToJava in class AtomicValue
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(Object other)
Compare the value to another dateTime value

Specified by:
compareTo in interface 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 UTC values (the Comparable interface requires a total ordering).
Throws:
ClassCastException - if the other value is not a DateTimeValue (the parameter is declared as Object to satisfy the Comparable interface)

equals

public boolean equals(Object other)

hashCode

public int hashCode()

display

public void display(int level,
                    NamePool pool)
Diagnostic print of expression structure

Specified by:
display in interface Expression
Parameters:
level - indentation level for this expression