org.eclipse.emf.ecore.util

Class DateConversionDelegateFactory

java.lang.Object

org.eclipse.emf.ecore.util.DateConversionDelegateFactory

All Implemented Interfaces:

EDataType.Internal.ConversionDelegate.Factory

public class DateConversionDelegateFactory
extends java.lang.Object
implements EDataType.Internal.ConversionDelegate.Factory

A conversion delegate factory for converting long, Long Date, java.sql.Date, Calendar, GregorianCalendar, and XMLGregorianCalendar instances to and from a string representation.

The annotation detail for the "format" key of this annotation must be present and the value must be one of the following forms:

  //Long
  //SimpleDateFormat/<simple-date-format-pattern>/<language>/<country>/<variant>
  //DateFormat/<date-style>/<language>/<country>/<variant>
  //DateTimeFormat/<date-style>/<time-style>/<language>/<country>/<variant>
  //TimeFormat/<time-style>/<language>/<country>/<variant>
 

The each of the value above have the following corresponding meaning:

• Long - The value will be converted to and from a long instant in time value using the lexical representation of Long.
• SimpleDateFormat - The value will be converted to and from a string representation using a SimpleDateFormat with the specified pattern. The locale specified by language, country, and variant will be used to construct the SimpleDataFormat. All the locale segments are optional, but should be specified if the date format is locale-specific to ensure that the serialization is portable to any other locale.
• DateFormat - The value will be converted to and from a string representation using the format returned by DateFormat.getDateInstance(int, Locale). The date-style must be one of FULL, LONG, MEDIUM, or SHORT. The locale specified by language, country, and variant will be used to specify the DateFormat. The variant is optional, but the language and country must be specified to ensure that the serialization is portable to any other locale.
• DateTimeFormat - The value will be converted to and from a string representation using the format returned by DateFormat.getDateTimeInstance(int, int, Locale). The date-style must be one of FULL, LONG, MEDIUM, or SHORT. The time-style must be one of FULL, LONG, MEDIUM, or SHORT. The locale specified by language, country, and variant will be used to specify the DateFormat. The variant is optional, but the language and country must be specified to ensure that the serialization is portable to any other locale.
• TimeFormat - The value will be converted to and from a string representation using the format returned by DateFormat.getTimeInstance(int, Locale). The time-style must be one of FULL, LONG, MEDIUM, or SHORT. The locale specified by language, country, and variant will be used to specify the DateFormat. The variant is optional, but the language and country must be specified to ensure that the serialization is portable to any other locale.

In all cases, the language, country, and variant, when present, must specify an available locale. In the case that the data type is a Calendar, other than GregorianCalendar, the URI may include a query segment specifying the calendar type, e.g.,

  //...?gregory
  //...?japanese
  //...?buddhist
 

When absent, gregory is the default.

To ensure that a serialized value is portable across all time zones, for those formats based on a date format, i.e., all them except //Long, the associated format's time zone is set to GMT .

Since:

2.14

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DateConversionDelegateFactory.AnnotationValidator An annotation validator for validating http:///org/eclipse/emf/ecore/util/DateConversionDelegate annotations.
static class	DateConversionDelegateFactory.CalendarBuilder A class that encapsulates the creation of a calendar from the instant in time or a Date.

Nested classes/interfaces inherited from interface org.eclipse.emf.ecore.EDataType.Internal.ConversionDelegate.Factory

EDataType.Internal.ConversionDelegate.Factory.Descriptor, EDataType.Internal.ConversionDelegate.Factory.Registry

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ANNOTATION_URI The annotation URI of thing conversion delegate factory.
static java.util.Set<java.lang.String>	CALENDAR_TYPES

Constructor Summary

Constructors

Constructor and Description
DateConversionDelegateFactory()

Method Summary

Modifier and Type	Method and Description
EDataType.Internal.ConversionDelegate	createConversionDelegate(EDataType eDataType) Creates a conversion delegate for the given EDataType.
static DateConversionDelegateFactory.CalendarBuilder	getCalendarBuilder(java.lang.String calendarType) Returns the calendar builder for the given calendar type.
static java.text.DateFormat	getDateFormat(URI formatURI) Returns the date format specified by the format URI.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ANNOTATION_URI

public static final java.lang.String ANNOTATION_URI

The annotation URI of thing conversion delegate factory.

See Also:

Constant Field Values

CALENDAR_TYPES

public static java.util.Set<java.lang.String> CALENDAR_TYPES

Constructor Detail

DateConversionDelegateFactory

public DateConversionDelegateFactory()

Method Detail

getCalendarBuilder

public static DateConversionDelegateFactory.CalendarBuilder getCalendarBuilder(java.lang.String calendarType)

Returns the calendar builder for the given calendar type. The type gregory is always present.

Parameters:

calendarType - the calendar type.

Returns:

the calendar builder for the given calendar type

createConversionDelegate

public EDataType.Internal.ConversionDelegate createConversionDelegate(EDataType eDataType)

Creates a conversion delegate for the given EDataType.

This implementation uses the "format" detail value to create a conversion delegate.

Specified by:

createConversionDelegate in interface EDataType.Internal.ConversionDelegate.Factory

Parameters:

eDataType - the EDataType for which a conversion delegate is to be created.

Returns:

a new conversion delegate for the given EDataType.

getDateFormat

public static java.text.DateFormat getDateFormat(URI formatURI)
                                          throws java.lang.IllegalArgumentException

Returns the date format specified by the format URI.

Parameters:

formatURI - the format URI as described in DateConversionDelegate.

Returns:

the date format specified by the format URI.

Throws:

java.lang.IllegalArgumentException - if the format is ill-formed.