View source for EclipseLink/DesignDocs/317962

<div style="margin:5px;float:right;border:1px solid #000000;padding:5px">__TOC__</div>
= Design Specification:  MOXy Extensions: Additional MOXy external metadata and annotation support required =

[http://bugs.eclipse.org/317962 ER 317962]

== Document History ==
{|{{BMTableStyle}}
|-{{BMTHStyle}}
! 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 [http://bugs.eclipse.org/293925 ER 293925]
|}

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

== Concepts ==

* List any relevant concepts here.

== Requirements ==

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

== Design Constraints ==

=== EclipseLink MOXy Annotations ===

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

=== EclipseLink JPA Annotations ===

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

== High Level Design ==

=== EclipseLink MOXy extension support ===

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/Phase2.1 Phase #2 – Provide additional support that will allow configuration similar to that of deployment XML]
* [http://wiki.eclipse.org/EclipseLink/DesignDocs/317962/Phase3 Phase #3 – MOXy Equivalents of relevant JPA Annotations]

== Design / Functionality ==

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

== API ==

== GUI ==

== Config files ==

== Documentation ==

== Open Issues ==

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

{|{{BMTableStyle}}
|-{{BMTHStyle}}
! Issue #
! Owner
! Description / Notes
|- 
|
|
|
|}

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

{|{{BMTableStyle}}
|-{{BMTHStyle}}
! Issue #
! Description / Notes
! Decision
|- 
|
|
|
|}

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