Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "EclipseLinkAttributeMappingOptions"
(→Concepts) |
(→Functional Specification: Dali Support for EclipseLink Attribute Mapping Options) |
||
| (18 intermediate revisions by one other user not shown) | |||
| Line 2: | Line 2: | ||
= Functional Specification: Dali Support for EclipseLink Attribute Mapping Options = | = Functional Specification: Dali Support for EclipseLink Attribute Mapping Options = | ||
| − | [http://bugs.eclipse.org/238441 bug 238441] - private owned support | + | [http://bugs.eclipse.org/238441 bug 238441] - private owned support for java |
| − | [http://bugs.eclipse.org/ | + | [http://bugs.eclipse.org/248756 bug 248756] - ... for eclipselink-orm.xml |
| + | [http://bugs.eclipse.org/238455 bug 238455] - join fetch support for java | ||
| + | |||
| + | [http://bugs.eclipse.org/249055 bug 249055] - ... for eclipselink-orm.xml | ||
| + | |||
| + | [http://bugs.eclipse.org/238458 bug 238458] - mutable support for java | ||
| + | |||
| + | [http://bugs.eclipse.org/249106 bug 249106] - ... for eclipselink-orm.xml | ||
| + | |||
== Document History == | == Document History == | ||
{|{{BMTableStyle}} | {|{{BMTableStyle}} | ||
| Line 16: | Line 24: | ||
!Karen Butzke | !Karen Butzke | ||
!Draft | !Draft | ||
| + | |- | ||
| + | !10-16-2008 | ||
| + | !Paul Fullbright | ||
| + | !Added eclipselink-orm.xml bug links | ||
|} | |} | ||
== Project overview == | == Project overview == | ||
| − | + | This feature is about adding the new attribute level annotations supported by the EclipseLink JPA extension. | |
Goals: | Goals: | ||
| − | * | + | * Add JPA Details view widgets for the PrivateOwned, JoinFetch, and Mutable annotations |
| − | * | + | * Add JPA Details view widgets for eclipselink-orm.xml private-owned, join-fetch, mutable elements |
| + | * Provide the appropriate defaults and validation for these settings | ||
== Concepts == | == Concepts == | ||
| Line 30: | Line 43: | ||
Present any concepts relevant to the feature. | Present any concepts relevant to the feature. | ||
| − | http://wiki.eclipse.org/Using_EclipseLink_JPA_Extensions_(ELUG)#How_to_Use_the_.40PrivateOwned_Annotation | + | [http://wiki.eclipse.org/Using_EclipseLink_JPA_Extensions_(ELUG)#How_to_Use_the_.40PrivateOwned_Annotation EclipseLink PrivateOwned annotation documentation] |
| − | http://wiki.eclipse.org/Using_EclipseLink_JPA_Extensions_(ELUG)#How_to_Use_the_.40JoinFetch_Annotation | + | [http://wiki.eclipse.org/Using_EclipseLink_JPA_Extensions_(ELUG)#How_to_Use_the_.40JoinFetch_Annotation EclipseLink JoinFetch annotation documentation] |
| + | |||
| + | [http://wiki.eclipse.org/Using_EclipseLink_JPA_Extensions_(ELUG)#How_to_Use_the_.40Mutable_Annotation EclipseLink Mutable annotation documentation] | ||
== Requirements / Functionality == | == Requirements / Functionality == | ||
| − | The | + | === Private Owned === |
| + | [[Using%20EclipseLink%20JPA%20Extensions%20(ELUG)#How_to_Use_the_.40PrivateOwned_Annotation|@PrivateOwned]] annotation is supported on OneToOne, OneToMany and VariableOneToOne mappings. The corresponding element in the eclipselink-orm.xml is private-owned. | ||
| + | |||
| + | Private owned options, to be displayed as a check box: | ||
| + | * True | ||
| + | * False | ||
| + | |||
| + | === Join Fetch === | ||
| + | [[Using%20EclipseLink%20JPA%20Extensions%20(ELUG)#How_to_Use_the_.40JoinFetch_Annotation|@JoinFetch]] annotation is supported on OneToOne, OneToMany, ManyToOne, ManyToMany, BasicCollection, and BasicMap mappings. The corresponding element in the eclipselink-orm.xml is join-fetch. | ||
| + | |||
| + | Join Fetch options, to be displayed as a combo box: | ||
| + | * Default (Inner) | ||
| + | * Inner | ||
| + | * Outer | ||
| + | |||
| + | A checkbox is used to enabled Join Fetch, if you check it the JoinFetch annotation is added and the combo box is enabled and displays Default(inner). | ||
| + | |||
| + | |||
| + | [[Image:OneToOneJoinFetchPrivateOwned.jpg]] | ||
| + | |||
| + | Private owned and join fetch widgets on a OneToOne | ||
| + | |||
| + | === Mutable === | ||
| + | [[Using%20EclipseLink%20JPA%20Extensions%20(ELUG)#How_to_Use_the_.40Mutable_Annotation|@Mutable]] annotation is supported on Id, Basic, Version, and Transformation mappings. The corresponding element in the eclipselink-orm.xml is mutable. | ||
| + | |||
| + | If attribute type is Serializable then mutable defaults to true, otherwise it defaults to false. If no Mutable annotation is specified | ||
| + | and the type is a Date or Calendar the default is taken from the persistence unit property eclipselink.temporal.mutable [http://bugs.eclipse.org/228042 228042]. Where should this setting go in the EclipseLink persistence.xml editor? | ||
| + | |||
| + | Possibly put a hyperlink from Mutable to the global setting in the persistence.xml editor, could do this for other settings as well. [http://bugs.eclipse.org/241265 241265] | ||
| + | |||
| + | [[Image:BasicMutable.jpg]] | ||
== API == | == API == | ||
Latest revision as of 16:13, 16 October 2008
Functional Specification: Dali Support for EclipseLink Attribute Mapping Options
bug 238441 - private owned support for java
bug 248756 - ... for eclipselink-orm.xml
bug 238455 - join fetch support for java
bug 249055 - ... for eclipselink-orm.xml
bug 238458 - mutable support for java
bug 249106 - ... for eclipselink-orm.xml
Document History
| Date | Author | Version Description & Notes |
|---|---|---|
| 6-25-2008 | Karen Butzke | Draft |
| 10-16-2008 | Paul Fullbright | Added eclipselink-orm.xml bug links |
Project overview
This feature is about adding the new attribute level annotations supported by the EclipseLink JPA extension.
Goals:
- Add JPA Details view widgets for the PrivateOwned, JoinFetch, and Mutable annotations
- Add JPA Details view widgets for eclipselink-orm.xml private-owned, join-fetch, mutable elements
- Provide the appropriate defaults and validation for these settings
Concepts
Present any concepts relevant to the feature.
EclipseLink PrivateOwned annotation documentation
EclipseLink JoinFetch annotation documentation
EclipseLink Mutable annotation documentation
Requirements / Functionality
Private Owned
@PrivateOwned annotation is supported on OneToOne, OneToMany and VariableOneToOne mappings. The corresponding element in the eclipselink-orm.xml is private-owned.
Private owned options, to be displayed as a check box:
- True
- False
Join Fetch
@JoinFetch annotation is supported on OneToOne, OneToMany, ManyToOne, ManyToMany, BasicCollection, and BasicMap mappings. The corresponding element in the eclipselink-orm.xml is join-fetch.
Join Fetch options, to be displayed as a combo box:
- Default (Inner)
- Inner
- Outer
A checkbox is used to enabled Join Fetch, if you check it the JoinFetch annotation is added and the combo box is enabled and displays Default(inner).
Private owned and join fetch widgets on a OneToOne
Mutable
@Mutable annotation is supported on Id, Basic, Version, and Transformation mappings. The corresponding element in the eclipselink-orm.xml is mutable.
If attribute type is Serializable then mutable defaults to true, otherwise it defaults to false. If no Mutable annotation is specified and the type is a Date or Calendar the default is taken from the persistence unit property eclipselink.temporal.mutable 228042. Where should this setting go in the EclipseLink persistence.xml editor?
Possibly put a hyperlink from Mutable to the global setting in the persistence.xml editor, could do this for other settings as well. 241265
API
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 | 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.