Save This Page
Home » xml-commons-external-1.4.01-src » javax » xml » datatype » [javadoc | source]
javax.xml.datatype
abstract public class: XMLGregorianCalendar [javadoc | source]
java.lang.Object
   javax.xml.datatype.XMLGregorianCalendar

All Implemented Interfaces:
    Cloneable

Representation for W3C XML Schema 1.0 date/time datatypes. Specifically, these date/time datatypes are dateTime, time, date, gYearMonth, gMonthDay, gYear gMonth and gDay defined in the XML Namespace "http://www.w3.org/2001/XMLSchema". These datatypes are normatively defined in W3C XML Schema 1.0 Part 2, Section 3.2.7-14.

The table below defines the mapping between XML Schema 1.0 date/time datatype fields and this class' fields. It also summarizes the value constraints for the date and time fields defined in W3C XML Schema 1.0 Part 2, Appendix D, ISO 8601 Date and Time Formats.

Date/Time Datatype Field Mapping Between XML Schema 1.0 and Java Representation
XML Schema 1.0
datatype
field
Related
XMLGregorianCalendar
Accessor(s)
Value Range
year #getYear() + #getEon() or
#getEonAndYear
getYear() is a value between -(10^9-1) to (10^9)-1 or DatatypeConstants#FIELD_UNDEFINED .
#getEon() is high order year value in billion of years.
getEon() has values greater than or equal to (10^9) or less than or equal to -(10^9). A value of null indicates field is undefined.
Given that XML Schema 1.0 errata states that the year zero will be a valid lexical value in a future version of XML Schema, this class allows the year field to be set to zero. Otherwise, the year field value is handled exactly as described in the errata and [ISO-8601-1988]. Note that W3C XML Schema 1.0 validation does not allow for the year field to have a value of zero.
month #getMonth() 1 to 12 or DatatypeConstants#FIELD_UNDEFINED
day #getDay() Independent of month, max range is 1 to 31 or DatatypeConstants#FIELD_UNDEFINED .
The normative value constraint stated relative to month field's value is in W3C XML Schema 1.0 Part 2, Appendix D.
hour #getHour() 0 to 24 or DatatypeConstants#FIELD_UNDEFINED . For a value of 24, the minute and second field must be zero per XML Schema Errata.
minute #getMinute() 0 to 59 or DatatypeConstants#FIELD_UNDEFINED
second #getSecond() + #getMillisecond() /1000 or
#getSecond() + #getFractionalSecond()
#getSecond() from 0 to 60 or DatatypeConstants#FIELD_UNDEFINED .
(Note: 60 only allowable for leap second.)
#getFractionalSecond() allows for infinite precision over the range from 0.0 to 1.0 when the #getSecond() is defined.
FractionalSecond is optional and has a value of null when it is undefined.
#getMillisecond() is the convenience millisecond precision of value of #getFractionalSecond() .
timezone #getTimezone() Number of minutes or DatatypeConstants#FIELD_UNDEFINED . Value range from -14 hours (-14 * 60 minutes) to 14 hours (14 * 60 minutes).

All maximum value space constraints listed for the fields in the table above are checked by factory methods, @{link DatatypeFactory}, setter methods and parse methods of this class. IllegalArgumentException is thrown when a parameter's value is outside the value constraint for the field or if the composite values constitute an invalid XMLGregorianCalendar instance (for example, if the 31st of June is specified).

The following operations are defined for this class:

Method from javax.xml.datatype.XMLGregorianCalendar Summary:
add,   clear,   clone,   compare,   equals,   getDay,   getEon,   getEonAndYear,   getFractionalSecond,   getHour,   getMillisecond,   getMinute,   getMonth,   getSecond,   getTimeZone,   getTimezone,   getXMLSchemaType,   getYear,   hashCode,   isValid,   normalize,   reset,   setDay,   setFractionalSecond,   setHour,   setMillisecond,   setMinute,   setMonth,   setSecond,   setTime,   setTime,   setTime,   setTimezone,   setYear,   setYear,   toGregorianCalendar,   toGregorianCalendar,   toString,   toXMLFormat
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.xml.datatype.XMLGregorianCalendar Detail:
 abstract public  void add(Duration duration)
 abstract public  void clear()
 abstract public Object clone()

    Creates and returns a copy of this object.

 abstract public int compare(XMLGregorianCalendar xmlGregorianCalendar)
 public boolean equals(Object obj) 

    Indicates whether parameter obj is "equal to" this one.

 abstract public int getDay()
 abstract 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.

 abstract public BigInteger getEonAndYear()
 abstract public BigDecimal getFractionalSecond()
 abstract public int getHour()
 public int getMillisecond() 
 abstract public int getMinute()
 abstract public int getMonth()
 abstract public int getSecond()
 abstract 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).

 abstract public int getTimezone()
 abstract public QName getXMLSchemaType()
 abstract public int getYear()
 public int hashCode() 

    Returns a hash code consistent with the definition of the equals method.

 abstract public boolean isValid()
    Validate instance by getXMLSchemaType() constraints.
 abstract 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).

 abstract public  void reset()
 abstract public  void setDay(int day)
 abstract public  void setFractionalSecond(BigDecimal fractional)

    Set fractional seconds.

    Unset this field by invoking the setter with a parameter value of null.

 abstract public  void setHour(int hour)
 abstract public  void setMillisecond(int millisecond)
 abstract public  void setMinute(int minute)
 abstract public  void setMonth(int month)
 abstract public  void setSecond(int second)
 public  void setTime(int hour,
    int minute,
    int second) 

    Set time as one unit.

 public  void setTime(int hour,
    int minute,
    int second,
    BigDecimal fractional) 

    Set time as one unit, including the optional infinite precision fractional seconds.

 public  void setTime(int hour,
    int minute,
    int second,
    int millisecond) 

    Set time as one unit, including optional milliseconds.

 abstract public  void setTimezone(int offset)
 abstract 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.

 abstract 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.

 abstract 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(TimeZone, Locale, XMLGregorianCalendar) .

    Field by Field Conversion from this class to java.util.GregorianCalendar
    java.util.GregorianCalendar field javax.xml.datatype.XMLGregorianCalendar field
    ERA #getEonAndYear() .signum() < 0 ? GregorianCalendar.BC : GregorianCalendar.AD
    YEAR #getEonAndYear() .abs().intValue()*
    MONTH #getMonth() - DatatypeConstants#JANUARY + GregorianCalendar#JANUARY
    DAY_OF_MONTH #getDay()
    HOUR_OF_DAY #getHour()
    MINUTE #getMinute()
    SECOND #getSecond()
    MILLISECOND get millisecond order from #getFractionalSecond() *
    GregorianCalendar.setTimeZone(TimeZone) #getTimezone() formatted into Custom timezone id
    * designates possible loss of precision during the conversion due to source datatype having higher precision than target datatype.

    To ensure consistency in conversion implementations, the new GregorianCalendar should be instantiated in following manner.

    • Using timeZone value as defined above, create a new java.util.GregorianCalendar(timeZone,Locale.getDefault()).
    • Initialize all GregorianCalendar fields by calling {(@link GegorianCalendar#clear()}.
    • Obtain a pure Gregorian Calendar by invoking GregorianCalendar.setGregorianChange( new Date(Long.MIN_VALUE)).
    • Its fields ERA, YEAR, MONTH, DAY_OF_MONTH, HOUR_OF_DAY, MINUTE, SECOND and MILLISECOND are set using the method Calendar.set(int,int)

 abstract 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,

    • when parameter timeZone is non-null, it is the timezone field.
    • else when this.getTimezone() != FIELD_UNDEFINED, create a java.util.TimeZone with a custom timezone id using the this.getTimezone().
    • else when defaults.getTimezone() != FIELD_UNDEFINED, create a java.util.TimeZone with a custom timezone id using defaults.getTimezone().
    • else use the 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.

    • Create a new java.util.GregorianCalendar(TimeZone, Locale) with TimeZone set as specified above and the Locale parameter.
    • Initialize all GregorianCalendar fields by calling GregorianCalendar#clear()
    • Obtain a pure Gregorian Calendar by invoking GregorianCalendar.setGregorianChange( new Date(Long.MIN_VALUE)).
    • Its fields ERA, YEAR, MONTH, DAY_OF_MONTH, HOUR_OF_DAY, MINUTE, SECOND and MILLISECOND are set using the method Calendar.set(int,int)

 public String toString() 

    Returns a String representation of this XMLGregorianCalendar Object.

    The result is a lexical representation generated by #toXMLFormat() .

 abstract public String toXMLFormat()