org.exist.xquery.value
Class AbstractDateTimeValue

java.lang.Object
  org.exist.xquery.value.AtomicValue
      org.exist.xquery.value.ComputableValue
          org.exist.xquery.value.AbstractDateTimeValue

All Implemented Interfaces:

Comparable, Indexable, Item, Sequence

Direct Known Subclasses:

DateTimeValue, DateValue, GDayValue, GMonthDayValue, GMonthValue, GYearMonthValue, GYearValue, TimeValue

public abstract class AbstractDateTimeValue
extends ComputableValue

Author:

wolf, Piotr Kaminski, ljo

Field Summary

XMLGregorianCalendar	calendar
static int	DAY
static int	HOUR
static int	MILLISECOND
static int	MINUTE
static int	MONTH
static int	SECOND
static int	YEAR

Fields inherited from class org.exist.xquery.value.AtomicValue

EMPTY_VALUE

Fields inherited from interface org.exist.xquery.value.Sequence

EMPTY_SEQUENCE

Method Summary

AbstractDateTimeValue	adjustedToTimezone(DayTimeDurationValue offset)
static XMLGregorianCalendar	cloneXMLGregorianCalendar(XMLGregorianCalendar calendar) Utility method that is able to clone a calendar whose year is 0 (whatever a year 0 means).
int	compareTo(Collator collator, AtomicValue other)
boolean	compareTo(Collator collator, int operator, AtomicValue other)
int	compareTo(Object o)
int	conversionPreference(Class javaClass) Returns a preference indicator, indicating the preference of a value to be converted into the given Java class.
abstract AtomicValue	convertTo(int requiredType) Convert this item into an atomic value, whose type corresponds to the specified target type.
ComputableValue	div(ComputableValue other)
boolean	effectiveBooleanValue() Get the effective boolean value of this sequence.
int	getPart(int part)
String	getStringValue() Return the string value of this item (see the definition of string value in XPath).
Sequence	getTimezone()
AtomicValue	max(Collator collator, AtomicValue other)
AtomicValue	min(Collator collator, AtomicValue other)
ComputableValue	mult(ComputableValue other)
static String	normalizeDate(String dateValue) The method normalizeDate
static String	normalizeTime(String timeValue) The method normalizeTime
ComputableValue	plus(ComputableValue other)
Object	toJavaObject(Class target) Convert the value into an instance of the specified Java class.
AbstractDateTimeValue	withoutTimezone()

Methods inherited from class org.exist.xquery.value.ComputableValue

minus

Methods inherited from class org.exist.xquery.value.AtomicValue

add, addAll, atomize, clearContext, contains, copyTo, dump, endsWith, getCardinality, getCollectionIterator, getDocumentSet, getItemCount, getItemType, getState, getType, hasChanged, hasMany, hasOne, isCacheable, isCached, isEmpty, isPersistentSet, itemAt, iterate, nodeMoved, promote, removeDuplicates, serializeValue, setIsCached, setSelfAsContext, startsWith, toMemNodeSet, toNodeSet, toSAX, toSequence, toString, unorderedIterator

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

calendar

public final XMLGregorianCalendar calendar

YEAR

public static final int YEAR

See Also:

Constant Field Values

MONTH

public static final int MONTH

See Also:

Constant Field Values

DAY

public static final int DAY

See Also:

Constant Field Values

HOUR

public static final int HOUR

See Also:

Constant Field Values

MINUTE

public static final int MINUTE

See Also:

Constant Field Values

SECOND

public static final int SECOND

See Also:

Constant Field Values

MILLISECOND

public static final int MILLISECOND

See Also:

Constant Field Values

Method Detail

getStringValue

public String getStringValue()
                      throws XPathException

Description copied from interface: Item

Return the string value of this item (see the definition of string value in XPath).

Specified by:

getStringValue in interface Item

Specified by:

getStringValue in interface Sequence

Specified by:

getStringValue in class ComputableValue

Throws:

XPathException

effectiveBooleanValue

public boolean effectiveBooleanValue()
                              throws XPathException

Description copied from interface: Sequence

Get the effective boolean value of this sequence. Will be false if the sequence is empty, true otherwise.

Specified by:

effectiveBooleanValue in interface Sequence

Specified by:

effectiveBooleanValue in class AtomicValue

Throws:

XPathException

convertTo

public abstract AtomicValue convertTo(int requiredType)
                               throws XPathException

Description copied from interface: Item

Convert this item into an atomic value, whose type corresponds to the specified target type. requiredType should be one of the type constants defined in Type. An XPathException is thrown if the conversion is impossible.

Specified by:

convertTo in interface Item

Specified by:

convertTo in interface Sequence

Specified by:

convertTo in class ComputableValue

Parameters:

requiredType - one of the type constants defined in class Type

Throws:

XPathException

getPart

public int getPart(int part)

adjustedToTimezone

public AbstractDateTimeValue adjustedToTimezone(DayTimeDurationValue offset)
                                         throws XPathException

Throws:

XPathException

withoutTimezone

public AbstractDateTimeValue withoutTimezone()
                                      throws XPathException

Throws:

XPathException

getTimezone

public Sequence getTimezone()
                     throws XPathException

Throws:

XPathException

compareTo

public boolean compareTo(Collator collator,
                         int operator,
                         AtomicValue other)
                  throws XPathException

Specified by:

compareTo in class ComputableValue

Throws:

XPathException

compareTo

public int compareTo(Collator collator,
                     AtomicValue other)
              throws XPathException

Specified by:

compareTo in class ComputableValue

Throws:

XPathException

max

public AtomicValue max(Collator collator,
                       AtomicValue other)
                throws XPathException

Specified by:

max in class ComputableValue

Throws:

XPathException

min

public AtomicValue min(Collator collator,
                       AtomicValue other)
                throws XPathException

Specified by:

min in class ComputableValue

Throws:

XPathException

plus

public ComputableValue plus(ComputableValue other)
                     throws XPathException

Specified by:

plus in class ComputableValue

Throws:

XPathException

mult

public ComputableValue mult(ComputableValue other)
                     throws XPathException

Specified by:

mult in class ComputableValue

Throws:

XPathException

div

public ComputableValue div(ComputableValue other)
                    throws XPathException

Specified by:

div in class ComputableValue

Throws:

XPathException

conversionPreference

public int conversionPreference(Class javaClass)

Description copied from interface: Sequence

Returns a preference indicator, indicating the preference of a value to be converted into the given Java class. Low numbers mean that the value can be easily converted into the given class.

Specified by:

conversionPreference in interface Item

Specified by:

conversionPreference in interface Sequence

Overrides:

conversionPreference in class AtomicValue

toJavaObject

public Object toJavaObject(Class target)
                    throws XPathException

Description copied from interface: Sequence

Convert the value into an instance of the specified Java class.

Specified by:

toJavaObject in interface Item

Specified by:

toJavaObject in interface Sequence

Overrides:

toJavaObject in class AtomicValue

Throws:

XPathException

compareTo

public int compareTo(Object o)

Specified by:

compareTo in interface Comparable

Overrides:

compareTo in class AtomicValue

normalizeDate

public static String normalizeDate(String dateValue)
                            throws XPathException

The method normalizeDate

Parameters:

dateValue - a String value

Returns:

a String value

Throws:

XPathException - if an error occurs

normalizeTime

public static String normalizeTime(String timeValue)
                            throws XPathException

The method normalizeTime

Parameters:

timeValue - a String value

Returns:

a String value

Throws:

XPathException

cloneXMLGregorianCalendar

public static XMLGregorianCalendar cloneXMLGregorianCalendar(XMLGregorianCalendar calendar)

Utility method that is able to clone a calendar whose year is 0 (whatever a year 0 means). It looks like the JDK is unable to do that.

Parameters:

calendar - The Calendar to clone

Returns:

the cloned Calendar