org.apache.xerces.jaxp.datatype

Class DatatypeFactoryImpl

public class DatatypeFactoryImpl extends DatatypeFactory

Factory that creates new javax.xml.datatype Objects that map XML to/from Java Objects.

{@link #newInstance()} is used to create a new DatatypeFactory. The following implementation resolution mechanisms are used in the following order:

  1. If the system property specified by {@link #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 {@link DatatypeConfigurationException}.
  2. If the file ${JAVA_HOME}/lib/jaxp.properties exists, it is loaded in a {@link 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.
  3. The services resolution mechanism is used, e.g. META-INF/services/java.xml.datatype.DatatypeFactory. Any Exception thrown during the instantiation process is wrapped as a {@link DatatypeConfigurationException}.
  4. The final mechanism is to attempt to instantiate the Class specified by {@link #DATATYPEFACTORY_IMPLEMENTATION_CLASS}, "javax.xml.datatype.DatatypeFactoryImpl". Any Exception thrown during the instantiation process is wrapped as a {@link DatatypeConfigurationException}.

Version: $Id: DatatypeFactoryImpl.java,v 1.3 2005/06/06 04:45:59 mrglavas Exp $

Author: Joseph Fialli Jeff Suttor

Constructor Summary
DatatypeFactoryImpl()

Public constructor is empty..

Use {@link DatatypeFactory#newInstance()} to create a DatatypeFactory.

Method Summary
DurationnewDuration(String lexicalRepresentation)

Obtain a new instance of a Duration specifying the Duration 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, defines duration as:

duration represents a duration of time.
DurationnewDuration(long durationInMilliseconds)

Obtain a new instance of a Duration specifying the Duration as milliseconds.

XML Schema Part 2: Datatypes, 3.2.6 duration, defines duration as:

duration represents a duration of time.
DurationnewDuration(boolean isPositive, BigInteger years, BigInteger months, BigInteger days, BigInteger hours, BigInteger minutes, BigDecimal seconds)

Obtain a new instance of a Duration specifying the Duration as isPositive, years, months, days, hours, minutes, seconds.

The XML Schema specification states that values can be of an arbitrary size.

XMLGregorianCalendarnewXMLGregorianCalendar()

Create a new instance of an XMLGregorianCalendar.

All date/time datatype fields set to {@link DatatypeConstants#FIELD_UNDEFINED} or null.

XMLGregorianCalendarnewXMLGregorianCalendar(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.

XMLGregorianCalendarnewXMLGregorianCalendar(GregorianCalendar cal)

Create an XMLGregorianCalendar from a {@link GregorianCalendar}.

Field by Field Conversion from {@link GregorianCalendar} to an {@link XMLGregorianCalendar}
java.util.GregorianCalendar field javax.xml.datatype.XMLGregorianCalendar field
ERA == GregorianCalendar.BC ?
XMLGregorianCalendarnewXMLGregorianCalendar(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.

Constructor Detail

DatatypeFactoryImpl

public DatatypeFactoryImpl()

Public constructor is empty..

Use {@link DatatypeFactory#newInstance()} to create a DatatypeFactory.

Method Detail

newDuration

public Duration newDuration(String lexicalRepresentation)

Obtain a new instance of a Duration specifying the Duration 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, defines duration 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 created {@link Duration}

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. An {@link UnsupportedOperationException} will be thrown with a message indicating implementation limits if implementation capacities are exceeded.

Parameters: lexicalRepresentation String representation of a Duration.

Returns: New Duration created from parsing the lexicalRepresentation.

Throws: IllegalArgumentException If lexicalRepresentation is not a valid representation of a Duration. UnsupportedOperationException If implementation cannot support requested values. NullPointerException if lexicalRepresentation is null.

newDuration

public Duration newDuration(long durationInMilliseconds)

Obtain a new instance of a Duration specifying the Duration as milliseconds.

XML Schema Part 2: Datatypes, 3.2.6 duration, defines duration 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 the get methods of the created {@link Duration}. The values conform to and are defined by:

The default start instance is defined by {@link GregorianCalendar}'s use of the start of the epoch: i.e., {@link java.util.Calendar#YEAR} = 1970, {@link java.util.Calendar#MONTH} = {@link java.util.Calendar#JANUARY}, {@link 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 = {@link java.util.Calendar#FEBRUARY} so the result of {@link Duration#getMonths()} and {@link Duration#getDays()} can be influenced.

Parameters: durationInMilliseconds Duration in milliseconds to create.

Returns: New Duration representing durationInMilliseconds.

newDuration

public Duration newDuration(boolean isPositive, BigInteger years, BigInteger months, BigInteger days, BigInteger hours, BigInteger minutes, BigDecimal seconds)

Obtain a new instance of a Duration specifying the Duration 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. An {@link UnsupportedOperationException} will be thrown with a message indicating implementation limits if implementation capacities are exceeded.

Parameters: isPositive Set to false to create a negative duration. When the length of the duration is zero, this parameter will be ignored. years of this Duration months of this Duration days of this Duration hours of this Duration minutes of this Duration seconds of this Duration

Returns: New Duration created from the specified values.

Throws: IllegalArgumentException If values are not a valid representation of a Duration. UnsupportedOperationException If implementation cannot support requested values. NullPointerException If any values are null.

See Also: DatatypeFactoryImpl

newXMLGregorianCalendar

public XMLGregorianCalendar newXMLGregorianCalendar()

Create a new instance of an XMLGregorianCalendar.

All date/time datatype fields set to {@link DatatypeConstants#FIELD_UNDEFINED} or null.

Returns: New XMLGregorianCalendar with all date/time datatype fields set to {@link DatatypeConstants#FIELD_UNDEFINED} or null.

newXMLGregorianCalendar

public 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 the lexicalRepresentation.

Throws: IllegalArgumentException If the lexicalRepresentation is not a valid XMLGregorianCalendar. NullPointerException If lexicalRepresentation is null.

newXMLGregorianCalendar

public XMLGregorianCalendar newXMLGregorianCalendar(GregorianCalendar cal)

Create an XMLGregorianCalendar from a {@link GregorianCalendar}.

Field by Field Conversion from {@link GregorianCalendar} to an {@link XMLGregorianCalendar}
java.util.GregorianCalendar field javax.xml.datatype.XMLGregorianCalendar field
ERA == GregorianCalendar.BC ? -YEAR : YEAR {@link XMLGregorianCalendar#setYear(int year)}
MONTH + 1 {@link XMLGregorianCalendar#setMonth(int month)}
DAY_OF_MONTH {@link XMLGregorianCalendar#setDay(int day)}
HOUR_OF_DAY, MINUTE, SECOND, MILLISECOND {@link XMLGregorianCalendar#setTime(int hour, int minute, int second, BigDecimal fractional)}
(ZONE_OFFSET + DST_OFFSET) / (60*1000)
(in minutes)
{@link XMLGregorianCalendar#setTimezone(int offset)}*

*conversion loss of information. It is not possible to represent a java.util.GregorianCalendar daylight savings timezone id in the XML Schema 1.0 date/time datatype representation.

To compute the return value's TimeZone field,

  • when this.getTimezone() != FIELD_UNDEFINED, create a java.util.TimeZone with a custom timezone id using the this.getTimezone().
  • else use the GregorianCalendar default timezone value for the host is defined as specified by java.util.TimeZone.getDefault().
  • Parameters: cal java.util.GregorianCalendar used to create XMLGregorianCalendar

    Returns: XMLGregorianCalendar created from java.util.GregorianCalendar

    Throws: NullPointerException If cal is null.

newXMLGregorianCalendar

public 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 that year parameter supports arbitrarily large numbers and fractionalSecond has infinite precision.

Parameters: year of XMLGregorianCalendar to be created. month of XMLGregorianCalendar to be created. day of XMLGregorianCalendar to be created. hour of XMLGregorianCalendar to be created. minute of XMLGregorianCalendar to be created. second of XMLGregorianCalendar to be created. fractionalSecond of XMLGregorianCalendar to be created. timezone of XMLGregorianCalendar to be created.

Returns: XMLGregorianCalendar created from specified values.

Throws: IllegalArgumentException If any individual parameter's value is outside the maximum value constraint for the field as determined by the Date/Time Data Mapping table in {@link XMLGregorianCalendar} or if the composite values constitute an invalid XMLGregorianCalendar instance as determined by {@link XMLGregorianCalendar#isValid()}. NullPointerException If any parameters are null.

Copyright B) 1999-2005 Apache XML Project. All Rights Reserved.