Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
javax.xml.datatype.DatatypeFactory
public abstract class DatatypeFactory
extends java.lang.Object
javax.xml.datatype
Object
s that map XML to/from Java Object
s.
newInstance()
is used to create a new DatatypeFactory
.
The following implementation resolution mechanisms are used in the following order:
DATATYPEFACTORY_PROPERTY
, "javax.xml.datatype.DatatypeFactory
",
exists, a class with the name of the property's value is instantiated.
Any Exception thrown during the instantiation process is wrapped as a DatatypeConfigurationException
.
java.util.Properties
Object
.
The Properties
Object
is then queried for the property as documented in the prior step
and processed as documented in the prior step.
META-INF/services/java.xml.datatype.DatatypeFactory
.
Any Exception thrown during the instantiation process is wrapped as a DatatypeConfigurationException
.
Class
specified by
DATATYPEFACTORY_IMPLEMENTATION_CLASS
, "javax.xml.datatype.DatatypeFactoryImpl
".
Any Exception thrown during the instantiation process is wrapped as a DatatypeConfigurationException
.
Field Summary | |
static String |
|
static String |
|
Constructor Summary | |
|
Method Summary | |
abstract Duration |
|
abstract Duration |
|
Duration |
|
abstract Duration |
|
Duration |
|
Duration |
|
Duration |
|
Duration |
|
Duration |
|
Duration |
|
Duration |
|
Duration |
|
static DatatypeFactory |
|
abstract XMLGregorianCalendar |
|
abstract XMLGregorianCalendar |
|
abstract XMLGregorianCalendar |
|
abstract XMLGregorianCalendar |
|
XMLGregorianCalendar |
|
XMLGregorianCalendar |
|
XMLGregorianCalendar |
|
XMLGregorianCalendar |
|
XMLGregorianCalendar |
|
public static final String DATATYPEFACTORY_IMPLEMENTATION_CLASS
Default implementation class name as defined in JSR 206: Java(TM) API for XML Processing (JAXP) 1.3. Default value isorg.apache.xerces.jaxp.datatype.DatatypeFactoryImpl
.
public static final String DATATYPEFACTORY_PROPERTY
Default property name as defined in JSR 206: Java(TM) API for XML Processing (JAXP) 1.3. Default value isjavax.xml.datatype.DatatypeFactory
.
protected DatatypeFactory()
Protected constructor to prevent instaniation outside of package. UsenewInstance()
to create aDatatypeFactory
.
public abstract Duration newDuration(String lexicalRepresentation)
Obtain a new instance of aDuration
specifying theDuration
as its string representation, "PnYnMnDTnHnMnS", as defined in XML Schema 1.0 section 3.2.6.1. XML Schema Part 2: Datatypes, 3.2.6 duration, definesduration
as:duration represents a duration of time. The value space of duration is a six-dimensional space where the coordinates designate the Gregorian year, month, day, hour, minute, and second components defined in Section 5.5.3.2 of [ISO 8601], respectively. These components are ordered in their significance by their order of appearance i.e. as year, month, day, hour, minute, and second.All six values are set and availabe from the createdDuration
The XML Schema specification states that values can be of an arbitrary size. Implementations may chose not to or be incapable of supporting arbitrarily large and/or small values. AnUnsupportedOperationException
will be thrown with a message indicating implementation limits if implementation capacities are exceeded.
- Parameters:
lexicalRepresentation
-String
representation of aDuration
.
- Returns:
- New
Duration
created from parsing thelexicalRepresentation
.
public abstract Duration newDuration(boolean isPositive, BigInteger years, BigInteger months, BigInteger days, BigInteger hours, BigInteger minutes, BigDecimal seconds)
Obtain a new instance of aDuration
specifying theDuration
as isPositive, years, months, days, hours, minutes, seconds. The XML Schema specification states that values can be of an arbitrary size. Implementations may chose not to or be incapable of supporting arbitrarily large and/or small values. AnUnsupportedOperationException
will be thrown with a message indicating implementation limits if implementation capacities are exceeded. Anull
value indicates that field isnot set.
- Parameters:
isPositive
- Set tofalse
to create a negative duration. When the length of the duration is zero, this parameter will be ignored.years
- of thisDuration
months
- of thisDuration
days
- of thisDuration
hours
- of thisDuration
minutes
- of thisDuration
seconds
- of thisDuration
- Returns:
- New
Duration
created from the specified values.
public Duration newDuration(boolean isPositive, int years, int months, int days, int hours, int minutes, int seconds)
Obtain a new instance of aDuration
specifying theDuration
as isPositive, years, months, days, hours, minutes, seconds. ADatatypeConstants.FIELD_UNDEFINED
value indicates that field isnot set.
- Parameters:
isPositive
- Set tofalse
to create a negative duration. When the length of the duration is zero, this parameter will be ignored.years
- of thisDuration
months
- of thisDuration
days
- of thisDuration
hours
- of thisDuration
minutes
- of thisDuration
seconds
- of thisDuration
- Returns:
- New
Duration
created from the specified values.
- See Also:
newDuration( boolean isPositive, BigInteger years, BigInteger months, BigInteger days, BigInteger hours, BigInteger minutes, BigDecimal seconds)
public abstract Duration newDuration(long durationInMilliSeconds)
Obtain a new instance of aDuration
specifying theDuration
as milliseconds. XML Schema Part 2: Datatypes, 3.2.6 duration, definesduration
as:duration represents a duration of time. The value space of duration is a six-dimensional space where the coordinates designate the Gregorian year, month, day, hour, minute, and second components defined in Section 5.5.3.2 of [ISO 8601], respectively. These components are ordered in their significance by their order of appearance i.e. as year, month, day, hour, minute, and second.All six values are set by computing their values from the specified milliseconds and are availabe using theget
methods of the createdDuration
. The values conform to and are defined by:The default start instance is defined by
- ISO 8601:2000(E) Section 5.5.3.2 Alternative format
- W3C XML Schema 1.0 Part 2, Appendix D, ISO 8601 Date and Time Formats
XMLGregorianCalendar
Date/Time Datatype Field Mapping Between XML Schema 1.0 and Java RepresentationGregorianCalendar
's use of the start of the epoch: i.e.,java.util.Calendar.YEAR
= 1970,java.util.Calendar.MONTH
=java.util.Calendar.JANUARY
,java.util.Calendar.DATE
= 1, etc. This is important as there are variations in the Gregorian Calendar, e.g. leap years have different days in the month =java.util.Calendar.FEBRUARY
so the result ofDuration.getMonths()
andDuration.getDays()
can be influenced.
- Parameters:
durationInMilliSeconds
- Duration in milliseconds to create.
- Returns:
- New
Duration
representingdurationInMilliSeconds
.
public Duration newDurationDayTime(String lexicalRepresentation)
Create aDuration
of typexdt:dayTimeDuration
by parsing itsString
representation, "PnDTnHnMnS", XQuery 1.0 and XPath 2.0 Data Model, xdt:dayTimeDuration. The datatypexdt:dayTimeDuration
is a subtype ofxs:duration
whose lexical representation contains only day, hour, minute, and second components. This datatype resides in the namespacehttp://www.w3.org/2003/11/xpath-datatypes
. All four values are set and availabe from the createdDuration
The XML Schema specification states that values can be of an arbitrary size. Implementations may chose not to or be incapable of supporting arbitrarily large and/or small values. AnUnsupportedOperationException
will be thrown with a message indicating implementation limits if implementation capacities are exceeded.
- Parameters:
lexicalRepresentation
- Lexical representation of a duration.
- Returns:
- New
Duration
created using the specifiedlexicalRepresentation
.
public Duration newDurationDayTime(boolean isPositive, BigInteger day, BigInteger hour, BigInteger minute, BigInteger second)
Create aDuration
of typexdt:dayTimeDuration
using the specifiedday
,hour
,minute
andsecond
as defined in XQuery 1.0 and XPath 2.0 Data Model, xdt:dayTimeDuration. The datatypexdt:dayTimeDuration
is a subtype ofxs:duration
whose lexical representation contains only day, hour, minute, and second components. This datatype resides in the namespacehttp://www.w3.org/2003/11/xpath-datatypes
. The XML Schema specification states that values can be of an arbitrary size. Implementations may chose not to or be incapable of supporting arbitrarily large and/or small values. AnUnsupportedOperationException
will be thrown with a message indicating implementation limits if implementation capacities are exceeded. Anull
value indicates that field isnot set.
- Parameters:
isPositive
- Set tofalse
to create a negative duration. When the length of the duration is zero, this parameter will be ignored.day
- Day ofDuration
.hour
- Hour ofDuration
.minute
- Minute ofDuration
.second
- Second ofDuration
.
- Returns:
- New
Duration
created with the specifiedday
,hour
,minute
andsecond
.
public Duration newDurationDayTime(boolean isPositive, int day, int hour, int minute, int second)
Create aDuration
of typexdt:dayTimeDuration
using the specifiedday
,hour
,minute
andsecond
as defined in XQuery 1.0 and XPath 2.0 Data Model, xdt:dayTimeDuration. The datatypexdt:dayTimeDuration
is a subtype ofxs:duration
whose lexical representation contains only day, hour, minute, and second components. This datatype resides in the namespacehttp://www.w3.org/2003/11/xpath-datatypes
. ADatatypeConstants.FIELD_UNDEFINED
value indicates that field isnot set.
- Parameters:
isPositive
- Set tofalse
to create a negative duration. When the length of the duration is zero, this parameter will be ignored.day
- Day ofDuration
.hour
- Hour ofDuration
.minute
- Minute ofDuration
.second
- Second ofDuration
.
- Returns:
- New
Duration
created with the specifiedday
,hour
,minute
andsecond
.
public Duration newDurationDayTime(long durationInMilliseconds)
Create aDuration
of typexdt:dayTimeDuration
using the specified milliseconds as defined in XQuery 1.0 and XPath 2.0 Data Model, xdt:dayTimeDuration. The datatypexdt:dayTimeDuration
is a subtype ofxs:duration
whose lexical representation contains only day, hour, minute, and second components. This datatype resides in the namespacehttp://www.w3.org/2003/11/xpath-datatypes
. All four values are set by computing their values from the specified milliseconds and are availabe using theget
methods of the createdDuration
. The values conform to and are defined by:The default start instance is defined by
- ISO 8601:2000(E) Section 5.5.3.2 Alternative format
- W3C XML Schema 1.0 Part 2, Appendix D, ISO 8601 Date and Time Formats
XMLGregorianCalendar
Date/Time Datatype Field Mapping Between XML Schema 1.0 and Java RepresentationGregorianCalendar
's use of the start of the epoch: i.e.,java.util.Calendar.YEAR
= 1970,java.util.Calendar.MONTH
=java.util.Calendar.JANUARY
,java.util.Calendar.DATE
= 1, etc. This is important as there are variations in the Gregorian Calendar, e.g. leap years have different days in the month =java.util.Calendar.FEBRUARY
so the result ofDuration.getDays()
can be influenced. Any remaining milliseconds after determining the day, hour, minute and second are discarded.
- Parameters:
durationInMilliseconds
- Milliseconds ofDuration
to create.
- Returns:
- New
Duration
created with the specifieddurationInMilliseconds
.
public Duration newDurationYearMonth(String lexicalRepresentation)
Create aDuration
of typexdt:yearMonthDuration
by parsing itsString
representation, "PnYnM", XQuery 1.0 and XPath 2.0 Data Model, xdt:yearMonthDuration. The datatypexdt:yearMonthDuration
is a subtype ofxs:duration
whose lexical representation contains only year and month components. This datatype resides in the namespaceXMLConstants.W3C_XPATH_DATATYPE_NS_URI
. Both values are set and availabe from the createdDuration
The XML Schema specification states that values can be of an arbitrary size. Implementations may chose not to or be incapable of supporting arbitrarily large and/or small values. AnUnsupportedOperationException
will be thrown with a message indicating implementation limits if implementation capacities are exceeded.
- Parameters:
lexicalRepresentation
- Lexical representation of a duration.
- Returns:
- New
Duration
created using the specifiedlexicalRepresentation
.
public Duration newDurationYearMonth(boolean isPositive, BigInteger year, BigInteger month)
Create aDuration
of typexdt:yearMonthDuration
using the specifiedyear
andmonth
as defined in XQuery 1.0 and XPath 2.0 Data Model, xdt:yearMonthDuration. The XML Schema specification states that values can be of an arbitrary size. Implementations may chose not to or be incapable of supporting arbitrarily large and/or small values. AnUnsupportedOperationException
will be thrown with a message indicating implementation limits if implementation capacities are exceeded. Anull
value indicates that field isnot set.
- Parameters:
isPositive
- Set tofalse
to create a negative duration. When the length of the duration is zero, this parameter will be ignored.year
- Year ofDuration
.month
- Month ofDuration
.
- Returns:
- New
Duration
created using the specifiedyear
andmonth
.
public Duration newDurationYearMonth(boolean isPositive, int year, int month)
Create aDuration
of typexdt:yearMonthDuration
using the specifiedyear
andmonth
as defined in XQuery 1.0 and XPath 2.0 Data Model, xdt:yearMonthDuration. ADatatypeConstants.FIELD_UNDEFINED
value indicates that field isnot set.
- Parameters:
isPositive
- Set tofalse
to create a negative duration. When the length of the duration is zero, this parameter will be ignored.year
- Year ofDuration
.month
- Month ofDuration
.
- Returns:
- New
Duration
created using the specifiedyear
andmonth
.
public Duration newDurationYearMonth(long durationInMilliseconds)
Create aDuration
of typexdt:yearMonthDuration
using the specified milliseconds as defined in XQuery 1.0 and XPath 2.0 Data Model, xdt:yearMonthDuration. The datatypexdt:yearMonthDuration
is a subtype ofxs:duration
whose lexical representation contains only year and month components. This datatype resides in the namespaceXMLConstants.W3C_XPATH_DATATYPE_NS_URI
. Both values are set by computing their values from the specified milliseconds and are availabe using theget
methods of the createdDuration
. The values conform to and are defined by:The default start instance is defined by
- ISO 8601:2000(E) Section 5.5.3.2 Alternative format
- W3C XML Schema 1.0 Part 2, Appendix D, ISO 8601 Date and Time Formats
XMLGregorianCalendar
Date/Time Datatype Field Mapping Between XML Schema 1.0 and Java RepresentationGregorianCalendar
's use of the start of the epoch: i.e.,java.util.Calendar.YEAR
= 1970,java.util.Calendar.MONTH
=java.util.Calendar.JANUARY
,java.util.Calendar.DATE
= 1, etc. This is important as there are variations in the Gregorian Calendar, e.g. leap years have different days in the month =java.util.Calendar.FEBRUARY
so the result ofDuration.getMonths()
can be influenced. Any remaining milliseconds after determining the year and month are discarded.
- Parameters:
durationInMilliseconds
- Milliseconds ofDuration
to create.
- Returns:
- New
Duration
created using the specifieddurationInMilliseconds
.
public static DatatypeFactory newInstance() throws DatatypeConfigurationException
Obtain a new instance of aDatatypeFactory
. The implementation resolution mechanisms are defined in thisClass
's documentation.
- Returns:
- New instance of a
DocumentBuilderFactory
- Throws:
DatatypeConfigurationException
- If the implementation is not available or cannot be instantiated.
public abstract XMLGregorianCalendar newXMLGregorianCalendar()
Create a new instance of anXMLGregorianCalendar
. All date/time datatype fields set toDatatypeConstants.FIELD_UNDEFINED
or null.
- Returns:
- New
XMLGregorianCalendar
with all date/time datatype fields set toDatatypeConstants.FIELD_UNDEFINED
or null.
public abstract XMLGregorianCalendar newXMLGregorianCalendar(BigInteger year, int month, int day, int hour, int minute, int second, BigDecimal fractionalSecond, int timezone)
Constructor allowing for complete value spaces allowed by W3C XML Schema 1.0 recommendation for xsd:dateTime and related builtin datatypes. Note thatyear
parameter supports arbitrarily large numbers and fractionalSecond has infinite precision. Anull
value indicates that field isnot set.
- Parameters:
year
- ofXMLGregorianCalendar
to be created.month
- ofXMLGregorianCalendar
to be created.day
- ofXMLGregorianCalendar
to be created.hour
- ofXMLGregorianCalendar
to be created.minute
- ofXMLGregorianCalendar
to be created.second
- ofXMLGregorianCalendar
to be created.fractionalSecond
- ofXMLGregorianCalendar
to be created.timezone
- ofXMLGregorianCalendar
to be created.
- Returns:
XMLGregorianCalendar
created from specified values.
public abstract XMLGregorianCalendar newXMLGregorianCalendar(GregorianCalendar cal)
Create anXMLGregorianCalendar
from aGregorianCalendar
.*conversion loss of information. It is not possible to represent a
Field by Field Conversion from GregorianCalendar
to anXMLGregorianCalendar
java.util.GregorianCalendar
fieldjavax.xml.datatype.XMLGregorianCalendar
fieldERA == GregorianCalendar.BC ? -YEAR : YEAR
XMLGregorianCalendar.setYear(int year)
MONTH + 1
XMLGregorianCalendar.setMonth(int month)
DAY_OF_MONTH
XMLGregorianCalendar.setDay(int day)
HOUR_OF_DAY, MINUTE, SECOND, MILLISECOND
XMLGregorianCalendar.setTime(int hour, int minute, int second, BigDecimal fractional)
(ZONE_OFFSET + DST_OFFSET) / (60*1000)
(in minutes)XMLGregorianCalendar.setTimezone(int offset)
*java.util.GregorianCalendar
daylight savings timezone id in the XML Schema 1.0 date/time datatype representation. To compute the return value'sTimeZone
field,
- when
this.getTimezone() != FIELD_UNDEFINED
, create ajava.util.TimeZone
with a custom timezone id using thethis.getTimezone()
.- else use the
GregorianCalendar
default timezone value for the host is defined as specified byjava.util.TimeZone.getDefault()
.
- Parameters:
cal
-java.util.GregorianCalendar
used to createXMLGregorianCalendar
- Returns:
XMLGregorianCalendar
created fromjava.util.GregorianCalendar
public abstract XMLGregorianCalendar newXMLGregorianCalendar(String lexicalRepresentation)
Create a new XMLGregorianCalendar by parsing the String as a lexical representation. Parsing the lexical string representation is defined in XML Schema 1.0 Part 2, Section 3.2.[7-14].1, Lexical Representation. The string representation may not have any leading and trailing whitespaces. The parsing is done field by field so that the following holds for any lexically correct String x:newXMLGregorianCalendar(x).toXMLFormat().equals(x)Except for the noted lexical/canonical representation mismatches listed in XML Schema 1.0 errata, Section 3.2.7.2.
- Parameters:
lexicalRepresentation
- Lexical representation of one the eight XML Schema date/time datatypes.
- Returns:
XMLGregorianCalendar
created from thelexicalRepresentation
.
public XMLGregorianCalendar newXMLGregorianCalendar(int year, int month, int day, int hour, int minute, int second, int millisecond, int timezone)
Constructor of value spaces that ajava.util.GregorianCalendar
instance would need to convert to anXMLGregorianCalendar
instance.XMLGregorianCalendar eon
andfractionalSecond
are set tonull
ADatatypeConstants.FIELD_UNDEFINED
value indicates that field isnot set.
- Parameters:
year
- ofXMLGregorianCalendar
to be created.month
- ofXMLGregorianCalendar
to be created.day
- ofXMLGregorianCalendar
to be created.hour
- ofXMLGregorianCalendar
to be created.minute
- ofXMLGregorianCalendar
to be created.second
- ofXMLGregorianCalendar
to be created.millisecond
- ofXMLGregorianCalendar
to be created.timezone
- ofXMLGregorianCalendar
to be created.
- Returns:
XMLGregorianCalendar
created from specified values.
public XMLGregorianCalendar newXMLGregorianCalendarDate(int year, int month, int day, int timezone)
Create a Java representation of XML Schema builtin datatypedate
org*
. For example, an instance ofgYear
can be created invoking this factory withmonth
andday
parameters set toDatatypeConstants.FIELD_UNDEFINED
. ADatatypeConstants.FIELD_UNDEFINED
value indicates that field isnot set.
- Parameters:
year
- ofXMLGregorianCalendar
to be created.month
- ofXMLGregorianCalendar
to be created.day
- ofXMLGregorianCalendar
to be created.timezone
- offset in minutes.DatatypeConstants.FIELD_UNDEFINED
indicates optional field is not set.
- Returns:
XMLGregorianCalendar
created from parameter values.
- See Also:
DatatypeConstants.FIELD_UNDEFINED
public XMLGregorianCalendar newXMLGregorianCalendarTime(int hours, int minutes, int seconds, BigDecimal fractionalSecond, int timezone)
Create a Java instance of XML Schema builtin datatype time. Anull
value indicates that field isnot set. ADatatypeConstants.FIELD_UNDEFINED
value indicates that field isnot set.
- Parameters:
hours
- number of hoursminutes
- number of minutesseconds
- number of secondsfractionalSecond
- value ofnull
indicates that this optional field is not set.timezone
- offset in minutes.DatatypeConstants.FIELD_UNDEFINED
indicates optional field is not set.
- Returns:
XMLGregorianCalendar
created from parameter values.
- See Also:
DatatypeConstants.FIELD_UNDEFINED
public XMLGregorianCalendar newXMLGregorianCalendarTime(int hours, int minutes, int seconds, int timezone)
Create a Java instance of XML Schema builtin datatypetime
. ADatatypeConstants.FIELD_UNDEFINED
value indicates that field isnot set.
- Parameters:
hours
- number of hoursminutes
- number of minutesseconds
- number of secondstimezone
- offset in minutes.DatatypeConstants.FIELD_UNDEFINED
indicates optional field is not set.
- Returns:
XMLGregorianCalendar
created from parameter values.
- See Also:
DatatypeConstants.FIELD_UNDEFINED
public XMLGregorianCalendar newXMLGregorianCalendarTime(int hours, int minutes, int seconds, int milliseconds, int timezone)
Create a Java instance of XML Schema builtin datatype time. ADatatypeConstants.FIELD_UNDEFINED
value indicates that field isnot set.
- Parameters:
hours
- number of hoursminutes
- number of minutesseconds
- number of secondsmilliseconds
- number of millisecondstimezone
- offset in minutes.DatatypeConstants.FIELD_UNDEFINED
indicates optional field is not set.
- Returns:
XMLGregorianCalendar
created from parameter values.
- See Also:
DatatypeConstants.FIELD_UNDEFINED