|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object javax.xml.datatype.XMLGregorianCalendar net.sf.saxon.xqj.SaxonXMLGregorianCalendar
public class SaxonXMLGregorianCalendar
Saxon implementation of the JAXP class javax.xml.datatype.XMLGregorianCalendar.
This is currently used only by the XQJ interface for XQuery: the normal representation of a
date, time, or dateTime value in Saxon is with a subclass of CalendarValue
The JAXP specification for this class defines it in terms of XML Schema 1.0 semantics. This implementation is more aligned to the XPath 2.0 semantics of the data types.
Note that this class, unlike the representations of all other data types, is mutable.
Constructor Summary | |
---|---|
SaxonXMLGregorianCalendar(CalendarValue value)
Create a SaxonXMLGregorianCalendar from a Saxon CalendarValue object |
Method Summary | |
---|---|
void |
add(Duration duration)
Add duration to this instance. |
void |
clear()
Unset all fields to undefined. |
Object |
clone()
Creates and returns a copy of this object. |
int |
compare(XMLGregorianCalendar xmlGregorianCalendar)
Compare two instances of W3C XML Schema 1.0 date/time datatypes according to partial order relation defined in W3C XML Schema 1.0 Part 2, Section 3.2.7.3, Order relation on dateTime. |
int |
getDay()
Return day in month or DatatypeConstants.FIELD_UNDEFINED . |
BigInteger |
getEon()
Return high order component for XML Schema 1.0 dateTime datatype field for year . |
BigInteger |
getEonAndYear()
Return XML Schema 1.0 dateTime datatype field for year . |
BigDecimal |
getFractionalSecond()
Return fractional seconds. |
int |
getHour()
Return hours or DatatypeConstants.FIELD_UNDEFINED . |
int |
getMicrosecond()
Return microsecond precision of getFractionalSecond() . |
int |
getMinute()
Return minutes or DatatypeConstants.FIELD_UNDEFINED . |
int |
getMonth()
Return number of month or DatatypeConstants.FIELD_UNDEFINED . |
int |
getSecond()
Return seconds or DatatypeConstants.FIELD_UNDEFINED . |
int |
getTimezone()
Return timezone offset in minutes or DatatypeConstants.FIELD_UNDEFINED if this optional field is not defined. |
TimeZone |
getTimeZone(int defaultZoneoffset)
Returns a java.util.TimeZone for this class. |
QName |
getXMLSchemaType()
Return the name of the XML Schema date/time type that this instance maps to. |
int |
getYear()
Return low order component for XML Schema 1.0 dateTime datatype field for year or DatatypeConstants.FIELD_UNDEFINED . |
boolean |
isValid()
Validate instance by getXMLSchemaType() constraints. |
XMLGregorianCalendar |
normalize()
Normalize this instance to UTC. |
void |
reset()
Reset this XMLGregorianCalendar to its original values. |
void |
setCalendarValue(CalendarValue value)
Set the calendar value of this object |
void |
setDay(int day)
Set days in month. |
void |
setFractionalSecond(BigDecimal fractional)
Set fractional seconds. |
void |
setHour(int hour)
Set hours. |
void |
setMillisecond(int millisecond)
Set milliseconds. |
void |
setMinute(int minute)
Set minutes. |
void |
setMonth(int month)
Set month. |
void |
setSecond(int second)
Set seconds. |
void |
setTimezone(int offset)
Set the number of minutes in the timezone offset. |
void |
setYear(BigInteger year)
Set low and high order component of XSD dateTime year field. |
void |
setYear(int year)
Set year of XSD dateTime year field. |
CalendarValue |
toCalendarValue()
Convert this SaxonXMLGregorianCalendar to a Saxon CalendarValue object |
GregorianCalendar |
toGregorianCalendar()
Convert this XMLGregorianCalendar to a GregorianCalendar . |
GregorianCalendar |
toGregorianCalendar(TimeZone timezone,
Locale aLocale,
XMLGregorianCalendar defaults)
Convert this XMLGregorianCalendar along with provided parameters
to a GregorianCalendar instance. |
String |
toXMLFormat()
Return the lexical representation of this instance. |
Methods inherited from class javax.xml.datatype.XMLGregorianCalendar |
---|
equals, getMillisecond, hashCode, setTime, setTime, setTime, toString |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public SaxonXMLGregorianCalendar(CalendarValue value)
value
- the CalendarValueMethod Detail |
---|
public void setCalendarValue(CalendarValue value)
value
- the calendar valuepublic void clear()
Unset all fields to undefined.
Set all int fields to DatatypeConstants.FIELD_UNDEFINED
and reference fields
to null.
clear
in class XMLGregorianCalendar
public void reset()
Reset this XMLGregorianCalendar
to its original values.
Saxon does not attempt to reset to the initial value as defined in the specification of
the superclass, because it cannot distinguish the initial setting from subsequent changes.
This method is therefore synonymous with clear()
reset
in class XMLGregorianCalendar
public void setYear(BigInteger year)
Set low and high order component of XSD dateTime
year field.
Unset this field by invoking the setter with a parameter value of null
.
setYear
in class XMLGregorianCalendar
year
- value constraints summarized in year field of date/time field mapping table.
IllegalArgumentException
- if year
parameter is
outside value constraints for the field as specified in
date/time field mapping table.public void setYear(int year)
Set year of XSD dateTime
year field.
Unset this field by invoking the setter with a parameter value of
DatatypeConstants.FIELD_UNDEFINED
.
Note: if the absolute value of the year
parameter
is less than 10^9, the eon component of the XSD year field is set to
null
by this method.
setYear
in class XMLGregorianCalendar
year
- value constraints are summarized in year field of date/time field mapping table.
If year is DatatypeConstants.FIELD_UNDEFINED
, then eon is set to null
.public void setMonth(int month)
Set month.
Unset this field by invoking the setter with a parameter value of DatatypeConstants.FIELD_UNDEFINED
.
setMonth
in class XMLGregorianCalendar
month
- value constraints summarized in month field of date/time field mapping table.
IllegalArgumentException
- if month
parameter is
outside value constraints for the field as specified in
date/time field mapping table.public void setDay(int day)
Set days in month.
Unset this field by invoking the setter with a parameter value of DatatypeConstants.FIELD_UNDEFINED
.
setDay
in class XMLGregorianCalendar
day
- value constraints summarized in day field of date/time field mapping table.
IllegalArgumentException
- if day
parameter is
outside value constraints for the field as specified in
date/time field mapping table.public void setTimezone(int offset)
Set the number of minutes in the timezone offset.
Unset this field by invoking the setter with a parameter value of DatatypeConstants.FIELD_UNDEFINED
.
setTimezone
in class XMLGregorianCalendar
offset
- value constraints summarized in
timezone field of date/time field mapping table.
IllegalArgumentException
- if offset
parameter is
outside value constraints for the field as specified in
date/time field mapping table.public void setHour(int hour)
Set hours.
Unset this field by invoking the setter with a parameter value of DatatypeConstants.FIELD_UNDEFINED
.
setHour
in class XMLGregorianCalendar
hour
- value constraints summarized in hour field of date/time field mapping table.
IllegalArgumentException
- if hour
parameter is outside value constraints for the field as specified in
date/time field mapping table.public void setMinute(int minute)
Set minutes.
Unset this field by invoking the setter with a parameter value of DatatypeConstants.FIELD_UNDEFINED
.
setMinute
in class XMLGregorianCalendar
minute
- value constraints summarized in minute field of date/time field mapping table.
IllegalArgumentException
- if minute
parameter is outside value constraints for the field as specified in
date/time field mapping table.public void setSecond(int second)
Set seconds.
Unset this field by invoking the setter with a parameter value of DatatypeConstants.FIELD_UNDEFINED
.
setSecond
in class XMLGregorianCalendar
second
- value constraints summarized in second field of date/time field mapping table.
IllegalArgumentException
- if second
parameter is outside value constraints for the field as specified in
date/time field mapping table.public void setMillisecond(int millisecond)
Set milliseconds.
Unset this field by invoking the setter with a parameter value of DatatypeConstants.FIELD_UNDEFINED
.
setMillisecond
in class XMLGregorianCalendar
millisecond
- value constraints summarized in
millisecond field of date/time field mapping table.
IllegalArgumentException
- if millisecond
parameter is outside value constraints for the field as specified
in date/time field mapping table.public void setFractionalSecond(BigDecimal fractional)
Set fractional seconds.
Unset this field by invoking the setter with a parameter value of null
.
setFractionalSecond
in class XMLGregorianCalendar
fractional
- value constraints summarized in
fractional field of date/time field mapping table.
IllegalArgumentException
- if fractional
parameter is outside value constraints for the field as specified
in date/time field mapping table.public BigInteger getEon()
Return high order component for XML Schema 1.0 dateTime datatype field for
year
.
null
if this optional part of the year field is not defined.
Value constraints for this value are summarized in year field of date/time field mapping table.
getEon
in class XMLGregorianCalendar
XMLGregorianCalendar
. The value
returned is an integer multiple of 10^9.getYear()
,
getEonAndYear()
public int getYear()
Return low order component for XML Schema 1.0 dateTime datatype field for
year
or DatatypeConstants.FIELD_UNDEFINED
.
Value constraints for this value are summarized in year field of date/time field mapping table.
getYear
in class XMLGregorianCalendar
XMLGregorianCalendar
.getEon()
,
getEonAndYear()
public BigInteger getEonAndYear()
Return XML Schema 1.0 dateTime datatype field for
year
.
Value constraints for this value are summarized in year field of date/time field mapping table.
getEonAndYear
in class XMLGregorianCalendar
eon
and BigInteger.valueOf(year)
when both fields are defined. When only year
is defined,
return it. When both eon
and year
are not
defined, return null
.getEon()
,
getYear()
public int getMonth()
Return number of month or DatatypeConstants.FIELD_UNDEFINED
.
Value constraints for this value are summarized in month field of date/time field mapping table.
getMonth
in class XMLGregorianCalendar
XMLGregorianCalendar
.public int getDay()
DatatypeConstants.FIELD_UNDEFINED
.
Value constraints for this value are summarized in day field of date/time field mapping table.
getDay
in class XMLGregorianCalendar
setDay(int)
public int getTimezone()
DatatypeConstants.FIELD_UNDEFINED
if this optional field is not defined.
Value constraints for this value are summarized in timezone field of date/time field mapping table.
getTimezone
in class XMLGregorianCalendar
setTimezone(int)
public int getHour()
DatatypeConstants.FIELD_UNDEFINED
.
Returns DatatypeConstants.FIELD_UNDEFINED
if this field is not defined.
Value constraints for this value are summarized in hour field of date/time field mapping table.
getHour
in class XMLGregorianCalendar
XMLGregorianCalendar.setTime(int, int, int)
public int getMinute()
DatatypeConstants.FIELD_UNDEFINED
.
Returns DatatypeConstants.FIELD_UNDEFINED
if this field is not defined.
Value constraints for this value are summarized in minute field of date/time field mapping table.
getMinute
in class XMLGregorianCalendar
XMLGregorianCalendar.setTime(int, int, int)
public int getSecond()
Return seconds or DatatypeConstants.FIELD_UNDEFINED
.
Returns DatatypeConstants.FIELD_UNDEFINED
if this field is not defined.
When this field is not defined, the optional xs:dateTime
fractional seconds field, represented by
getFractionalSecond()
and XMLGregorianCalendar.getMillisecond()
,
must not be defined.
Value constraints for this value are summarized in second field of date/time field mapping table.
getSecond
in class XMLGregorianCalendar
XMLGregorianCalendar
.getFractionalSecond()
,
XMLGregorianCalendar.getMillisecond()
,
XMLGregorianCalendar.setTime(int, int, int)
public int getMicrosecond()
Return microsecond precision of getFractionalSecond()
.
This method represents a convenience accessor to infinite
precision fractional second value returned by
getFractionalSecond()
. The returned value is the rounded
down to microseconds value of
getFractionalSecond()
. When getFractionalSecond()
returns null
, this method must return
DatatypeConstants.FIELD_UNDEFINED
.
Value constraints for this value are summarized in second field of date/time field mapping table.
XMLGregorianCalendar
.getFractionalSecond()
,
XMLGregorianCalendar.setTime(int, int, int)
public BigDecimal getFractionalSecond()
Return fractional seconds.
null
is returned when this optional field is not defined.
Value constraints are detailed in second field of date/time field mapping table.
This optional field can only have a defined value when the
xs:dateTime second field, represented by getSecond()
,
does not return DatatypeConstants.FIELD_UNDEFINED
.
getFractionalSecond
in class XMLGregorianCalendar
XMLGregorianCalendar
.getSecond()
,
XMLGregorianCalendar.setTime(int, int, int, java.math.BigDecimal)
public int compare(XMLGregorianCalendar xmlGregorianCalendar)
Compare two instances of W3C XML Schema 1.0 date/time datatypes according to partial order relation defined in W3C XML Schema 1.0 Part 2, Section 3.2.7.3, Order relation on dateTime.
xsd:dateTime
datatype field mapping to accessors of
this class are defined in
date/time field mapping table.
compare
in class XMLGregorianCalendar
xmlGregorianCalendar
- Instance of XMLGregorianCalendar
to compare
this
XMLGregorianCalendar
and
the specified xmlGregorianCalendar
as
DatatypeConstants.LESSER
,
DatatypeConstants.EQUAL
,
DatatypeConstants.GREATER
or
DatatypeConstants.INDETERMINATE
.
NullPointerException
- if xmlGregorianCalendar
is null.public XMLGregorianCalendar normalize()
Normalize this instance to UTC.
2000-03-04T23:00:00+03:00 normalizes to 2000-03-04T20:00:00Z
Implements W3C XML Schema Part 2, Section 3.2.7.3 (A).
normalize
in class XMLGregorianCalendar
XMLGregorianCalendar
normalized to UTC.public String toXMLFormat()
Return the lexical representation of this
instance.
The format is specified in
XML Schema 1.0 Part 2, Section 3.2.[7-14].1,
Lexical Representation".
Specific target lexical representation format is determined by
getXMLSchemaType()
.
toXMLFormat
in class XMLGregorianCalendar
String
, representation of this XMLGregorianCalendar
IllegalStateException
- if the combination of set fields
does not match one of the eight defined XML Schema builtin date/time datatypes.public QName getXMLSchemaType()
Return the name of the XML Schema date/time type that this instance maps to. Type is computed based on fields that are set.
getXMLSchemaType
in class XMLGregorianCalendar
DatatypeConstants.DATETIME
,
DatatypeConstants.TIME
,
DatatypeConstants.DATE
,
DatatypeConstants.GYEARMONTH
,
DatatypeConstants.GMONTHDAY
,
DatatypeConstants.GYEAR
,
DatatypeConstants.GMONTH
or
DatatypeConstants.GDAY
.
IllegalStateException
- if the combination of set fields
does not match one of the eight defined XML Schema builtin
date/time datatypes.public boolean isValid()
getXMLSchemaType()
constraints.
isValid
in class XMLGregorianCalendar
public void add(Duration duration)
Add duration
to this instance.
The computation is specified in
XML Schema 1.0 Part 2, Appendix E,
Adding durations to dateTimes>.
date/time field mapping table
defines the mapping from XML Schema 1.0 dateTime
fields
to this class' representation of those fields.
add
in class XMLGregorianCalendar
duration
- Duration to add to this XMLGregorianCalendar
.
NullPointerException
- when duration
parameter is null
.public GregorianCalendar toGregorianCalendar()
Convert this XMLGregorianCalendar
to a GregorianCalendar
.
When this
instance has an undefined field, this
conversion relies on the java.util.GregorianCalendar
default
for its corresponding field. A notable difference between
XML Schema 1.0 date/time datatypes and java.util.GregorianCalendar
is that Timezone value is optional for date/time datatypes and it is
a required field for java.util.GregorianCalendar
. See javadoc
for java.util.TimeZone.getDefault()
on how the default
is determined. To explicitly specify the TimeZone
instance, see
toGregorianCalendar(java.util.TimeZone, Locale, javax.xml.datatype.XMLGregorianCalendar)
.
toGregorianCalendar
in class XMLGregorianCalendar
toGregorianCalendar(java.util.TimeZone, java.util.Locale, javax.xml.datatype.XMLGregorianCalendar)
public GregorianCalendar toGregorianCalendar(TimeZone timezone, Locale aLocale, XMLGregorianCalendar defaults)
Convert this XMLGregorianCalendar
along with provided parameters
to a GregorianCalendar
instance.
Since XML Schema 1.0 date/time datetypes has no concept of
timezone ids or daylight savings timezone ids, this conversion operation
allows the user to explicitly specify one with
timezone
parameter.
To compute the return value's TimeZone
field,
timeZone
is non-null,
it is the timezone field.this.getTimezone() != FIELD_UNDEFINED
,
create a java.util.TimeZone
with a custom timezone id
using the this.getTimezone()
.defaults.getTimezone() != FIELD_UNDEFINED
,
create a java.util.TimeZone
with a custom timezone id
using defaults.getTimezone()
.GregorianCalendar
default timezone value
for the host is defined as specified by
java.util.TimeZone.getDefault()
.To ensure consistency in conversion implementations, the new
GregorianCalendar
should be instantiated in following
manner.
java.util.GregorianCalendar(TimeZone,
Locale)
with TimeZone set as specified above and the
Locale
parameter.
Calendar.clear()
GregorianCalendar.setGregorianChange(
new Date(Long.MIN_VALUE))
.Calendar.set(int,int)
toGregorianCalendar
in class XMLGregorianCalendar
timezone
- provide Timezone. null
is a legal value.aLocale
- provide explicit Locale. Use default GregorianCalendar locale if
value is null
.defaults
- provide default field values to use when corresponding
field for this instance is FIELD_UNDEFINED or null.
If defaults
is null
or a field
within the specified defaults
is undefined,
just use java.util.GregorianCalendar
defaults.
public TimeZone getTimeZone(int defaultZoneoffset)
Returns a java.util.TimeZone
for this class.
If timezone field is defined for this instance, returns TimeZone initialized with custom timezone id of zoneoffset. If timezone field is undefined, try the defaultZoneoffset that was passed in. If defaultZoneoffset is FIELD_UNDEFINED, return default timezone for this host. (Same default as java.util.GregorianCalendar).
getTimeZone
in class XMLGregorianCalendar
defaultZoneoffset
- default zoneoffset if this zoneoffset is
DatatypeConstants.FIELD_UNDEFINED
.
public Object clone()
Creates and returns a copy of this object.
clone
in class XMLGregorianCalendar
Object
public CalendarValue toCalendarValue()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |