|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.saxon.value.Value<AtomicValue> net.sf.saxon.value.AtomicValue net.sf.saxon.value.CalendarValue
public abstract class CalendarValue
Abstract superclass for Date, Time, and DateTime.
Field Summary | |
---|---|
static int |
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 | |
---|---|
CalendarValue()
|
Method Summary | |
---|---|
abstract CalendarValue |
add(DurationValue duration)
Add a duration to this date/time value |
CalendarValue |
adjustTimezone(DayTimeDurationValue tz)
Return a new date, time, or dateTime with the same normalized value, but in a different timezone, specified as a dayTimeDuration |
abstract CalendarValue |
adjustTimezone(int tz)
Return a new date, time, or dateTime with the same normalized value, but in a different timezone |
void |
appendTimezone(FastStringBuffer sb)
Add a string representation of the timezone, typically formatted as "Z" or "+03:00" or "-10:00", to a supplied string buffer |
static void |
appendTimezone(int tz,
FastStringBuffer sb)
Format a timezone and append it to a buffer |
abstract int |
compareTo(CalendarValue other,
XPathContext context)
Compare this value to another value of the same type, using the supplied Configuration to get the implicit timezone if required. |
abstract GregorianCalendar |
getCalendar()
Get a Java Calendar object that represents this date/time value. |
abstract ComparisonKey |
getComparisonKey(XPathContext context)
Get a comparison key for this value. |
int |
getTimezoneInMinutes()
Get the timezone value held in this object. |
Object |
getXPathComparable(boolean ordered,
StringCollator collator,
XPathContext context)
Get an object value that implements the XPath equality and ordering comparison semantics for this value. |
boolean |
hasTimezone()
Determine whether this value includes a timezone |
boolean |
isIdentical(Value v)
Determine whether two atomic values are identical, as determined by XML Schema rules. |
static ConversionResult |
makeCalendarValue(CharSequence s,
ConversionRules rules)
Parse a string to create a CalendarValue whose actual type will depend on the format of the string |
CalendarValue |
removeTimezone()
Return a date, time, or dateTime with the same localized value, but without the timezone component |
void |
setTimezoneInMinutes(int minutes)
Modify the timezone value held in this object. |
DayTimeDurationValue |
subtract(CalendarValue other,
XPathContext context)
Determine the difference between two points in time, as a duration |
abstract 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 |
Methods inherited from class net.sf.saxon.value.AtomicValue |
---|
asAtomic, checkPermittedContents, copyAsSubType, effectiveBooleanValue, equals, getCardinality, getComponent, getItemType, getLength, getPrimitiveStringValue, getPrimitiveType, getSchemaComparable, 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, getCanonicalLexicalRepresentation, getIterator, getSequenceLength, hashCode, reduce |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int NO_TIMEZONE
Constructor Detail |
---|
public CalendarValue()
Method Detail |
---|
public static ConversionResult makeCalendarValue(CharSequence s, ConversionRules rules)
s
- a string in the lexical space of one of the date/time types (date, time, dateTime,
gYearMonth, gYear, gMonth, gMonthDay, or gDayrules
-
public final boolean hasTimezone()
public final void setTimezoneInMinutes(int minutes)
minutes
- The timezone offset from GMT in minutes, positive or negative; or the special
value NO_TIMEZONE indicating that the value is not in a timezone (this is the default if this
method is not called)public abstract DateTimeValue toDateTime()
public final int getTimezoneInMinutes()
public abstract GregorianCalendar getCalendar()
public abstract CalendarValue add(DurationValue duration) throws XPathException
duration
- the duration to be added (which might be negative)
XPathException
public DayTimeDurationValue subtract(CalendarValue other, XPathContext context) throws XPathException
other
- the other point in timecontext
- the dynamic context, used to obtain timezone information. May be set to null
only if both values contain an explicit timezone, or if neither does so.
XPathException
- for example if one value is a date and the other is a timepublic final CalendarValue removeTimezone()
public abstract CalendarValue adjustTimezone(int tz)
tz
- the new timezone offset from UTC, in minutes
public final CalendarValue adjustTimezone(DayTimeDurationValue tz) throws XPathException
tz
- the new timezone, in minutes
XPathException
public Object getXPathComparable(boolean ordered, StringCollator collator, XPathContext context) throws NoDynamicContextException
getXPathComparable
in class AtomicValue
ordered
- true if an ordered comparison is required. In this case the result is null if the
type is unordered; in other cases the returned value will be a Comparable.collator
- collation used for stringscontext
- the XPath dynamic evaluation context, used in cases where the comparison is context
sensitive @return an Object whose equals() and hashCode() methods implement the XPath comparison semantics
NoDynamicContextException
- if the comparison depends on dynamic context information that
is not available, for example implicit timezonepublic abstract int compareTo(CalendarValue other, XPathContext context) throws NoDynamicContextException
other
- the other value to be comparedcontext
- the XPath dynamic evaluation context. May be null if no context is required
NoDynamicContextException
- if the supplied context is an early evaluation context and the
result depends on the implicit timezone, which is not available at compile timepublic abstract ComparisonKey getComparisonKey(XPathContext context) throws NoDynamicContextException
context
- XPath dynamic evaluation context, used to obtain implicit timezone
NoDynamicContextException
- if the implicit timezone is needed and is not availablepublic boolean isIdentical(Value v)
AtomicValue
Note that even this check ignores the type annotation of the value. The integer 3 and the short 3 are considered identical, even though they are not fully interchangeable. "Identical" means the same point in the value space, regardless of type annotation.
NaN is identical to itself.
isIdentical
in class AtomicValue
v
- the other value to be compared with this one
public final void appendTimezone(FastStringBuffer sb)
sb
- The StringBuffer that will be updated with the resulting string
representationpublic static void appendTimezone(int tz, FastStringBuffer sb)
tz
- the timezonesb
- the buffer
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |