Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
EclipseLink/DesignDocs/277920
Contents
- 1 Design Specification: OXM XSD
- 1.1 Document History
- 1.2 Project overview
- 1.3 Concepts
- 1.4 Requirements
- 1.5 Design Constraints
- 1.6 Design / Functionality
- 1.6.1 XML Direct Mapping
- 1.6.2 XML Composite Direct Collection Mapping
- 1.6.3 XML Composite Object Mapping
- 1.6.4 XML Composite Collection Mapping
- 1.6.5 XML Object Reference Mapping
- 1.6.6 XML Collection Reference Mapping
- 1.6.7 XML Binary Data Mapping
- 1.6.8 XML Binary Data Collection Mapping
- 1.6.9 XML Any Object Mapping
- 1.6.10 XML Any Collection Mapping
- 1.6.11 XML Fragment Mapping
- 1.6.12 XML Fragment Collection
- 1.7 Testing
- 1.8 API
- 1.9 GUI
- 1.10 Config files
- 1.11 Documentation
- 1.12 Open Issues
- 1.13 Decisions
- 1.14 Future Considerations
Design Specification: OXM XSD
Document History
Date | Author | Version Description & Notes |
---|---|---|
2009/05/26 | Blaise Doughan | Skeleton |
Project overview
Overview of the project/feature. Why is it desired, what are its goals.
Goals:
- goal 1
- goal 2
Concepts
Present any concepts relevant to the feature.
Requirements
The following sections will expand the goals of this project into more concrete requirements.
Design Constraints
Design / Functionality
XML Direct Mapping
<xml-direct-mapping xmlns="http://www.eclipse.org/eclipselink/xsds/persistence"> <attribute-name>String</attribute-name> <read-only>false</read-only> <get-method>String</get-method> <set-method>String</set-method> <properties> <property name="String"> <value>Text</value> </property> <property name="String"> <value>Text</value> </property> </properties> <field name="String"/> <null-value>String</null-value> <converter/> <attribute-classification>String</attribute-classification> <is-cdata>1</is-cdata> <null-policy> <xsi-nil-represents-null>false</xsi-nil-represents-null> <empty-node-represents-null>false</empty-node-represents-null> <null-representation-for-xml>XSI_NIL</null-representation-for-xml> </null-policy> </xml-direct-mapping>
XML Composite Direct Collection Mapping
<xml-composite-direct-collection-mapping xmlns="http://www.eclipse.org/eclipselink/xsds/persistence" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.eclipse.org/eclipselink/xsds/persistence C:\Workspaces\EclipseLink-RT5\foundation\org.eclipse.persistence.core\resource\xsd\eclipselink_persistence_map_1.1.xsd"> <attribute-name>String</attribute-name> <read-only>false</read-only> <get-method>String</get-method> <set-method>String</set-method> <properties> <property name="String"> <value>Text</value> </property> <property name="String"> <value>Text</value> </property> </properties> <field name="String"/> <value-converter/> <value-converter-class>String</value-converter-class> <container> <collection-type>String</collection-type> </container> <is-cdata>1</is-cdata> </xml-composite-direct-collection-mapping>
XML Composite Object Mapping
<xml-composite-object-mapping xmlns="http://www.eclipse.org/eclipselink/xsds/persistence"> <attribute-name>String</attribute-name> <read-only>false</read-only> <get-method>String</get-method> <set-method>String</set-method> <properties> <property name="String"> <value>Text</value> </property> <property name="String"> <value>Text</value> </property> </properties> <reference-class>String</reference-class> <field name="String"/> <container-attribute>Text</container-attribute> <container-get-method>Text</container-get-method> <container-set-method>Text</container-set-method> <null-policy> <xsi-nil-represents-null>false</xsi-nil-represents-null> <empty-node-represents-null>false</empty-node-represents-null> <null-representation-for-xml>XSI_NIL</null-representation-for-xml> </null-policy> <keep-as-element-policy>String</keep-as-element-policy> </xml-composite-object-mapping>
XML Composite Collection Mapping
<xml-composite-collection-mapping xmlns="http://www.eclipse.org/eclipselink/xsds/persistence"> <attribute-name>String</attribute-name> <read-only>false</read-only> <get-method>String</get-method> <set-method>String</set-method> <properties> <property name="String"> <value>Text</value> </property> <property name="String"> <value>Text</value> </property> </properties> <reference-class>String</reference-class> <field name="String"/> <container> <collection-type>String</collection-type> </container> <container-attribute>Text</container-attribute> <container-get-method>Text</container-get-method> <container-set-method>Text</container-set-method> <keep-as-element-policy>String</keep-as-element-policy> </xml-composite-collection-mapping>
XML Object Reference Mapping
<xml-object-reference-mapping xmlns="http://www.eclipse.org/eclipselink/xsds/persistence" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.eclipse.org/eclipselink/xsds/persistence C:\Workspaces\EclipseLink-RT5\foundation\org.eclipse.persistence.core\resource\xsd\eclipselink_persistence_map_1.1.xsd"> <attribute-name>String</attribute-name> <read-only>false</read-only> <get-method>String</get-method> <set-method>String</set-method> <properties> <property name="String"> <value>Text</value> </property> <property name="String"> <value>Text</value> </property> </properties> <reference-class>String</reference-class> <allow-null>true</allow-null> <field-translations> <field-translation> <source-field name="String"/> <target-field name="String"/> </field-translation> <field-translation> <source-field name="String"/> <target-field name="String"/> </field-translation> </field-translations> <source-to-target-key-field-association> <field-reference> <source-field name="String"/> <target-field name="String"/> </field-reference> <field-reference> <source-field name="String"/> <target-field name="String"/> </field-reference> </source-to-target-key-field-association> <source-to-target-key-fields> <field name="String"/> <field name="String"/> </source-to-target-key-fields> </xml-object-reference-mapping>
XML Collection Reference Mapping
<xml-collection-reference-mapping xmlns="http://www.eclipse.org/eclipselink/xsds/persistence"> <attribute-name>String</attribute-name> <read-only>false</read-only> <get-method>String</get-method> <set-method>String</set-method> <properties> <property name="String"> <value>Text</value> </property> <property name="String"> <value>Text</value> </property> </properties> <reference-class>String</reference-class> <allow-null>true</allow-null> <field-translations> <field-translation> <source-field name="String"/> <target-field name="String"/> </field-translation> <field-translation> <source-field name="String"/> <target-field name="String"/> </field-translation> </field-translations> <source-to-target-key-field-association> <field-reference> <source-field name="String"/> <target-field name="String"/> </field-reference> <field-reference> <source-field name="String"/> <target-field name="String"/> </field-reference> </source-to-target-key-field-association> <source-to-target-key-fields> <field name="String"/> <field name="String"/> </source-to-target-key-fields> <containerpolicy> <collection-type>String</collection-type> </containerpolicy> <uses-single-node>1</uses-single-node> </xml-collection-reference-mapping>
XML Binary Data Mapping
<xml-binary-data-mapping xmlns="http://www.eclipse.org/eclipselink/xsds/persistence"> <attribute-name>String</attribute-name> <read-only>false</read-only> <get-method>String</get-method> <set-method>String</set-method> <properties> <property name="String"> <value>Text</value> </property> <property name="String"> <value>Text</value> </property> </properties> <field name="String"/> <null-value>String</null-value> <converter/> <attribute-classification>String</attribute-classification> <is-cdata>1</is-cdata> <null-policy> <xsi-nil-represents-null>false</xsi-nil-represents-null> <empty-node-represents-null>false</empty-node-represents-null> <null-representation-for-xml>XSI_NIL</null-representation-for-xml> </null-policy> <is-swa-ref>1</is-swa-ref> <mime-type>String</mime-type> <should-inline-data>1</should-inline-data> </xml-binary-data-mapping>
XML Binary Data Collection Mapping
XML Any Object Mapping
<xml-any-object-mapping xmlns="http://www.eclipse.org/eclipselink/xsds/persistence"> <attribute-name>String</attribute-name> <read-only>false</read-only> <get-method>String</get-method> <set-method>String</set-method> <properties> <property name="String"> <value>Text</value> </property> <property name="String"> <value>Text</value> </property> </properties> <field name="String"/> <use-xml-root>false</use-xml-root> <keep-as-element-policy>String</keep-as-element-policy> </xml-any-object-mapping>
XML Any Collection Mapping
<xml-any-collection-mapping xmlns="http://www.eclipse.org/eclipselink/xsds/persistence"> <attribute-name>String</attribute-name> <read-only>false</read-only> <get-method>String</get-method> <set-method>String</set-method> <properties> <property name="String"> <value>Text</value> </property> <property name="String"> <value>Text</value> </property> </properties> <field name="String"/> <container> <collection-type>String</collection-type> </container> <use-xml-root>false</use-xml-root> <keep-as-element-policy>String</keep-as-element-policy> </xml-any-collection-mapping>
XML Fragment Mapping
<xml-fragment-mapping xmlns="http://www.eclipse.org/eclipselink/xsds/persistence"> <attribute-name>String</attribute-name> <read-only>false</read-only> <get-method>String</get-method> <set-method>String</set-method> <properties> <property name="String"> <value>Text</value> </property> <property name="String"> <value>Text</value> </property> </properties> <field name="String"/> <null-value>String</null-value> <converter/> <attribute-classification>String</attribute-classification> <is-cdata>1</is-cdata> <null-policy> <xsi-nil-represents-null>false</xsi-nil-represents-null> <empty-node-represents-null>false</empty-node-represents-null> <null-representation-for-xml>XSI_NIL</null-representation-for-xml> </null-policy> </xml-fragment-mapping>
XML Fragment Collection
<xml-fragment-collection-mapping xmlns="http://www.eclipse.org/eclipselink/xsds/persistence"> <attribute-name>String</attribute-name> <read-only>false</read-only> <get-method>String</get-method> <set-method>String</set-method> <properties> <property name="String"> <value>Text</value> </property> <property name="String"> <value>Text</value> </property> </properties> <reference-class>String</reference-class> <field name="String"/> <container> <collection-type>String</collection-type> </container> </xml-fragment-collection-mapping>
Testing
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.
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.
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.