public final class DateTimeValue extends CalendarValue implements java.lang.Comparable
?????? | ????? |
---|---|
static DateTimeValue |
javaOrigin
Fixed date/time used by Java (and Unix) as the origin of the universe: 1970-01-01
|
NO_TIMEZONE
typeLabel
EMPTY_CLASS_ARRAY, INDETERMINATE_ORDERING
EMPTY_VALUE_ARRAY
?????? |
---|
DateTimeValue(java.util.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.
|
?????? | ????? |
---|---|
CalendarValue |
add(DurationValue duration)
Add a duration to a dateTime
|
CalendarValue |
adjustTimezone(int timezone)
Return a new dateTime with the same normalized value, but
in a different timezone.
|
int |
compareTo(CalendarValue other,
XPathContext context)
Compare the value to another dateTime value, following the XPath comparison semantics
|
int |
compareTo(java.lang.Object v2)
Context-free comparison of two DateTimeValue values.
|
ConversionResult |
convertPrimitive(BuiltInAtomicType requiredType,
boolean validate,
XPathContext context)
Convert to target data type
|
AtomicValue |
copyAsSubType(AtomicType typeLabel)
Make a copy of this date, time, or dateTime value, but with a new type label
|
boolean |
equals(java.lang.Object o)
Context-free comparison of two dateTime values
|
static DateTimeValue |
fromJavaDate(java.util.Date suppliedDate)
Factory method: create a dateTime value given a Java Date object.
|
static DateTimeValue |
fromJulianInstant(java.math.BigDecimal instant)
Get the DateTimeValue corresponding to a given Julian instant
|
java.util.GregorianCalendar |
getCalendar()
Get a Java Calendar object representing the value of this DateTime.
|
java.lang.CharSequence |
getCanonicalLexicalRepresentation()
Get the canonical lexical representation as defined in XML Schema.
|
ComparisonKey |
getComparisonKey(XPathContext context)
Get a comparison key for this value.
|
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.
|
byte |
getDay()
Get the day component, 1-31
|
byte |
getHour()
Get the hour component, 0-23
|
int |
getMicrosecond()
Get the microsecond component, 0-999999
|
byte |
getMinute()
Get the minute component, 0-59
|
byte |
getMonth()
Get the month component, 1-12
|
BuiltInAtomicType |
getPrimitiveType()
Determine the primitive type of the value.
|
java.lang.Comparable |
getSchemaComparable()
Get a Comparable value that implements the XML Schema ordering comparison semantics for this value.
|
byte |
getSecond()
Get the second component, 0-59
|
java.lang.CharSequence |
getStringValueCS()
Convert to string
|
int |
getYear()
Get the year component, in its internal form (which allows a year zero)
|
int |
hashCode()
Hash code for context-free comparison of date time values.
|
static ConversionResult |
makeDateTimeValue(java.lang.CharSequence s)
Factory method: create a dateTime value from a supplied string, in
ISO 8601 format
|
static DateTimeValue |
makeDateTimeValue(DateValue date,
TimeValue time)
Factory method: create a dateTime value given a date and a time.
|
DateTimeValue |
normalize(XPathContext cc)
Normalize the date and time to be in timezone Z.
|
DayTimeDurationValue |
subtract(CalendarValue other,
XPathContext context)
Determine the difference between two points in time, as a duration
|
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.
|
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.
|
adjustTimezone, appendTimezone, appendTimezone, getStringValue, getTimezoneInMinutes, getXPathComparable, hasTimezone, removeTimezone, setTimezoneInMinutes
asAtomic, checkPermittedContents, convert, convert, effectiveBooleanValue, getCardinality, getItemType, getLength, getTypedValue, getTypeLabel, isNaN, itemAt, iterate, process, setTypeLabel, subsequence, toString
asItem, asItem, asIterator, asValue, convertToJava, fromItem, getIterator, iterate, makeQNameValue, reduce, stringToNumber
public static final DateTimeValue javaOrigin
public DateTimeValue(java.util.Calendar calendar, boolean tzSpecified)
calendar
- holds the date and timetzSpecified
- indicates whether the timezone is specifiedpublic DateTimeValue(int year, byte month, byte day, byte hour, byte minute, byte second, int microsecond, int tz)
year
- The year as held internally (note that the year before 1AD is 0)month
- The month, 1-12day
- The day 1-31hour
- the hour value, 0-23minute
- the minutes value, 0-59second
- the seconds value, 0-59microsecond
- the number of microseconds, 0-999999tz
- the timezone displacement in minutes from UTC. Supply the value
CalendarValue.NO_TIMEZONE
if there is no timezone component.public static DateTimeValue getCurrentDateTime(XPathContext context)
context
- the XPath dynamic context. May be null, in which case
the current date and time are taken directly from the system clockpublic static DateTimeValue fromJavaDate(java.util.Date suppliedDate) throws XPathException
suppliedDate
- holds the date and timeXPathException
public static DateTimeValue makeDateTimeValue(DateValue date, TimeValue time) throws XPathException
date
- the datetime
- the timeXPathException
- if the timezones are both present and inconsistentpublic static ConversionResult makeDateTimeValue(java.lang.CharSequence s)
s
- a string in the lexical space of xs:dateTimepublic BuiltInAtomicType getPrimitiveType()
getPrimitiveType
??? AtomicValue
public int getYear()
public byte getMonth()
public byte getDay()
public byte getHour()
public byte getMinute()
public byte getSecond()
public int getMicrosecond()
public DateTimeValue toDateTime()
CalendarValue
interface).toDateTime
??? CalendarValue
public DateTimeValue normalize(XPathContext cc) throws NoDynamicContextException
cc
- used to supply the implicit timezone, used when the value has
no explicit timezoneNoDynamicContextException
- if the implicit timezone is needed and is not availablepublic ComparisonKey getComparisonKey(XPathContext context) throws NoDynamicContextException
getComparisonKey
??? CalendarValue
context
- XPath dynamic contextNoDynamicContextException
- if the implicit timezone is needed and is not availablepublic java.math.BigDecimal toJulianInstant()
public static DateTimeValue fromJulianInstant(java.math.BigDecimal instant)
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.public java.util.GregorianCalendar getCalendar()
getCalendar
??? CalendarValue
public ConversionResult convertPrimitive(BuiltInAtomicType requiredType, boolean validate, XPathContext context)
convertPrimitive
??? AtomicValue
requiredType
- an integer identifying the required atomic typecontext
- the XPath dynamic contextvalidate
- 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.public java.lang.CharSequence getStringValueCS()
getStringValueCS
???? Item
getStringValueCS
???? ValueRepresentation
getStringValueCS
??? AtomicValue
Item.getStringValue()
public java.lang.CharSequence getCanonicalLexicalRepresentation()
getCanonicalLexicalRepresentation
??? Value
public AtomicValue copyAsSubType(AtomicType typeLabel)
copyAsSubType
??? AtomicValue
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.public CalendarValue adjustTimezone(int timezone)
adjustTimezone
??? CalendarValue
timezone
- the new timezone offset, in minutespublic CalendarValue add(DurationValue duration) throws XPathException
add
??? CalendarValue
duration
- the duration to be added (may be negative)XPathException
- if the duration is an xs:duration, as distinct from
a subclass thereofpublic DayTimeDurationValue subtract(CalendarValue other, XPathContext context) throws XPathException
subtract
??? CalendarValue
other
- the other point in timecontext
- the XPath dynamic contextXPathException
- for example if one value is a date and the other is a timepublic AtomicValue getComponent(int component) throws XPathException
getComponent
??? AtomicValue
component
- identifies the required component, as a constant defined in class
Component
, for example Component.HOURS
XPathException
public int compareTo(CalendarValue other, XPathContext context) throws NoDynamicContextException
compareTo
??? CalendarValue
other
- The other dateTime valuecontext
- XPath dynamic evaluation contextjava.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 availablepublic int compareTo(java.lang.Object v2)
compareTo
???? java.lang.Comparable
v2
- the other valuejava.lang.ClassCastException
- if the values are not comparable (which might be because
no timezone is available)public java.lang.Comparable getSchemaComparable()
AtomicValue
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.
getSchemaComparable
??? AtomicValue
public boolean equals(java.lang.Object o)
equals
??? AtomicValue
o
- the other date time valuejava.lang.ClassCastException
- if one of the values has a timezone and the other does notpublic int hashCode()
hashCode
??? java.lang.Object