|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectnet.sf.saxon.value.Value<AtomicValue>
net.sf.saxon.value.AtomicValue
net.sf.saxon.value.CalendarValue
net.sf.saxon.value.DateTimeValue
public final class DateTimeValue
A value of type DateTime
| Field Summary | |
|---|---|
static DateTimeValue |
EPOCH
Fixed date/time used by Java (and Unix) as the origin of the universe: 1970-01-01 |
| Fields inherited from class net.sf.saxon.value.CalendarValue |
|---|
NO_TIMEZONE |
| Fields inherited from class net.sf.saxon.value.AtomicValue |
|---|
typeLabel |
| Fields inherited from class net.sf.saxon.value.Value |
|---|
INDETERMINATE_ORDERING |
| Fields inherited from interface net.sf.saxon.om.ValueRepresentation |
|---|
EMPTY_VALUE_ARRAY |
| 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,
boolean xsd10Check)
Constructor: construct a DateTimeValue from its components. |
|
| Method Summary | |
|---|---|
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(Object v2)
Context-free comparison of two DateTimeValue values. |
ValidationFailure |
convertToSubType(BuiltInAtomicType subtype)
Convert the value to a built-in subtype of xs:dateTime |
AtomicValue |
copyAsSubType(AtomicType typeLabel)
Make a copy of this date, time, or dateTime value, but with a new type label |
boolean |
equals(Object o)
Context-free comparison of two dateTime values |
static DateTimeValue |
fromJavaDate(Date suppliedDate)
Factory method: create a dateTime value given a Java Date object. |
static DateTimeValue |
fromJulianInstant(BigDecimal instant)
Get the DateTimeValue corresponding to a given Julian instant |
GregorianCalendar |
getCalendar()
Get a Java Calendar object representing the value of this DateTime. |
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 |
CharSequence |
getPrimitiveStringValue()
Convert to string |
BuiltInAtomicType |
getPrimitiveType()
Determine the primitive type of the value. |
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 |
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. |
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). |
static ConversionResult |
makeDateTimeValue(CharSequence s,
ConversionRules rules)
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. |
DateValue |
toDateValue()
Extract the Date part |
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. |
TimeValue |
toTimeValue()
Extract the Time part |
| Methods inherited from class net.sf.saxon.value.CalendarValue |
|---|
adjustTimezone, appendTimezone, appendTimezone, getTimezoneInMinutes, getXPathComparable, hasTimezone, isIdentical, makeCalendarValue, removeTimezone, setTimezoneInMinutes |
| Methods inherited from class net.sf.saxon.value.AtomicValue |
|---|
asAtomic, checkPermittedContents, effectiveBooleanValue, getCardinality, getItemType, getLength, getStringValue, getStringValueCS, getTypedValue, getTypeLabel, isNaN, itemAt, iterate, process, setTypeLabel, subsequence, toString |
| Methods inherited from class net.sf.saxon.value.Value |
|---|
asItem, asItem, asIterator, asValue, convertToJava, fromItem, getIterator, getSequenceLength, reduce |
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static final DateTimeValue EPOCH
| Constructor Detail |
|---|
public DateTimeValue(Calendar calendar,
boolean tzSpecified)
calendar - holds the date and timetzSpecified - indicates whether the timezone is specified
public DateTimeValue(int year,
byte month,
byte day,
byte hour,
byte minute,
byte second,
int microsecond,
int tz,
boolean xsd10Check)
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.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 |
|---|
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 clock
public static DateTimeValue fromJavaDate(Date suppliedDate)
throws XPathException
suppliedDate - holds the date and time
XPathException
public static DateTimeValue makeDateTimeValue(DateValue date,
TimeValue time)
throws XPathException
date - the datetime - the time
XPathException - if the timezones are both present and inconsistent
public static ConversionResult makeDateTimeValue(CharSequence s,
ConversionRules rules)
s - a string in the lexical space of xs:dateTimerules - the conversion rules to be used (determining whether year zero is allowed)
public ValidationFailure convertToSubType(BuiltInAtomicType subtype)
subtype - the target subtype
public BuiltInAtomicType getPrimitiveType()
getPrimitiveType in class AtomicValuepublic 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 in class CalendarValuepublic boolean isXsd10Rules()
public DateTimeValue normalize(XPathContext cc)
throws NoDynamicContextException
cc - used to supply the implicit timezone, used when the value has
no explicit timezone
NoDynamicContextException - if the implicit timezone is needed and is not available
public ComparisonKey getComparisonKey(XPathContext context)
throws NoDynamicContextException
getComparisonKey in class CalendarValuecontext - XPath dynamic context
NoDynamicContextException - if the implicit timezone is needed and is not availablepublic BigDecimal toJulianInstant()
public static DateTimeValue fromJulianInstant(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 GregorianCalendar getCalendar()
getCalendar in class CalendarValuepublic CharSequence getPrimitiveStringValue()
getPrimitiveStringValue in class AtomicValuepublic DateValue toDateValue()
public TimeValue toTimeValue()
public CharSequence getCanonicalLexicalRepresentation()
getCanonicalLexicalRepresentation in class Value<AtomicValue>public AtomicValue copyAsSubType(AtomicType typeLabel)
copyAsSubType in class AtomicValuetypeLabel - 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 in class CalendarValuetimezone - the new timezone offset, in minutes
public CalendarValue add(DurationValue duration)
throws XPathException
add in class CalendarValueduration - the duration to be added (may be negative)
XPathException - if the duration is an xs:duration, as distinct from
a subclass thereof
public DayTimeDurationValue subtract(CalendarValue other,
XPathContext context)
throws XPathException
subtract in class CalendarValueother - the other point in timecontext - the XPath dynamic context
XPathException - for example if one value is a date and the other is a time
public AtomicValue getComponent(int component)
throws XPathException
getComponent in class AtomicValuecomponent - identifies the required component, as a constant defined in class
Component, for example Component.HOURS
XPathException - if a dynamic error occurs
public int compareTo(CalendarValue other,
XPathContext context)
throws NoDynamicContextException
compareTo in class CalendarValueother - The other dateTime valuecontext - XPath dynamic evaluation context
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(Object v2)
compareTo in interface Comparablev2 - the other value
ClassCastException - if the values are not comparable (which might be because
no timezone is available)public Comparable getSchemaComparable()
AtomicValueIn 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 in class AtomicValuepublic boolean equals(Object o)
equals in class AtomicValueo - the other date time value
ClassCastException - if one of the values has a timezone and the other does notpublic int hashCode()
hashCode in class Value<AtomicValue>
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||