Difference between revisions of "EclipseLink/DesignDocs/317962"

From Eclipsepedia

Jump to: navigation, search
(EclipseLink MOXy extension support via annotations)
(EclipseLink MOXy extension support)
 
(16 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
<div style="margin:5px;float:right;border:1px solid #000000;padding:5px">__TOC__</div>
 
<div style="margin:5px;float:right;border:1px solid #000000;padding:5px">__TOC__</div>
= Design Specification:  MOXy Extensions: Additional MOXy annotation support required =
+
= Design Specification:  MOXy Extensions: Additional MOXy external metadata and annotation support required =
  
 
[http://bugs.eclipse.org/317962 ER 317962]
 
[http://bugs.eclipse.org/317962 ER 317962]
Line 42: Line 42:
 
== High Level Design ==
 
== High Level Design ==
  
=== EclipseLink MOXy extension support via annotations ===
+
=== EclipseLink MOXy extension support ===
  
 
This support will be added as outlined in the following phases:
 
This support will be added as outlined in the following phases:
 
* [http://wiki.eclipse.org/EclipseLink/DesignDocs/317962/Phase1 Phase #1 – Provide MOXy annotation support equivalent to our XML metadata support]
 
* [http://wiki.eclipse.org/EclipseLink/DesignDocs/317962/Phase1 Phase #1 – Provide MOXy annotation support equivalent to our XML metadata support]
* [http://wiki.eclipse.org/EclipseLink/DesignDocs/317962/Phase2 Phase #2 – Provide additional MOXy external metadata and annotation support that allows similar configuration abilities as with deployment XML]
+
* [http://wiki.eclipse.org/EclipseLink/DesignDocs/317962/Phase2.1 Phase #2 – Provide additional support that will allow configuration similar to that of deployment XML]
** Phase #2 will be broken up into two parts:
+
* [http://wiki.eclipse.org/EclipseLink/DesignDocs/317962/Phase3 Phase #3 – MOXy Equivalents of relevant JPA Annotations]
*** [http://wiki.eclipse.org/EclipseLink/DesignDocs/317962/Phase2.1 Phase #2.1 - Provide additional MOXy external metadata support that allows similar configuration abilities as with deployment XML]
+
*** [http://wiki.eclipse.org/EclipseLink/DesignDocs/317962/Phase2.2 Phase #2.2 - Provide additional MOXy annotation support that allows similar configuration abilities as with deployment XML]
+
  
 
== Design / Functionality ==
 
== Design / Functionality ==

Latest revision as of 16:02, 17 August 2010

[edit] Design Specification: MOXy Extensions: Additional MOXy external metadata and annotation support required

ER 317962

[edit] Document History

Date Author Version Description & Notes
2010/06/25 David McCann Initial Contribution. The work outlined in this design document is a continuation of the work done for ER 293925

[edit] Project overview

Goals:

  • Provide MOXy annotation support equivalent to our XML metadata support.
  • Provide additional MOXy annotation support that will allow similar configuration abilities as with deployment XML.

[edit] Concepts

  • List any relevant concepts here.

[edit] Requirements

The following sections will expand the goals of this project into more concrete requirements.

[edit] Design Constraints

[edit] EclipseLink MOXy Annotations

We require the same level of support through annotations as we have via EclipseLink XML metadata

[edit] EclipseLink JPA Annotations

The annotations should have the same feel as the equivalent annotations for EclipseLink JPA whenever possible.

[edit] High Level Design

[edit] EclipseLink MOXy extension support

This support will be added as outlined in the following phases:

[edit] Design / Functionality

[edit] Testing

The basic testing strategy will be to have a test suite for each annotation (JAXB) and mapping (MOXy). Each suite will, at a minimum, test schema generation, unmarshal and marshal operations.

[edit] API

[edit] GUI

[edit] Config files

[edit] Documentation

[edit] Open Issues

This section lists the open issues that are still pending that must be decided prior to fully implementing this project's requirements.

Issue # Owner Description / Notes

[edit] Decisions

This section lists decisions made. These are intended to document the resolution of open issues or constraints added to the project that are important.

Issue # Description / Notes Decision

[edit] Future Considerations

During the research for this project the following items were identified as out of scope but are captured here as potential future enhancements. If agreed upon during the review process these should be logged in the bug system.