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.
Difference between revisions of "Creating a Descriptor (ELUG)"
m |
m (→Generating Java Code for Descriptors) |
||
(2 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
<div style="float:right;border:1px solid #000000;padding:5px">__TOC__ | <div style="float:right;border:1px solid #000000;padding:5px">__TOC__ | ||
[[Special:Whatlinkshere/Creating a Descriptor (ELUG)|Related Topics]]</div> | [[Special:Whatlinkshere/Creating a Descriptor (ELUG)|Related Topics]]</div> | ||
− | This section describes how to create EclipseLink descriptors. For information on creating different types of descriptors, see | + | This section describes how to create EclipseLink descriptors. For information on creating different types of descriptors, see: |
* [[Creating%20a%20Relational%20Descriptor%20(ELUG)|Creating a Relational Descriptor]] | * [[Creating%20a%20Relational%20Descriptor%20(ELUG)|Creating a Relational Descriptor]] | ||
* [[Creating%20an%20EIS%20Descriptor%20(ELUG)|Creating an EIS Descriptor]] | * [[Creating%20an%20EIS%20Descriptor%20(ELUG)|Creating an EIS Descriptor]] | ||
* [[Creating%20an%20XML%20Descriptor%20(ELUG)|Creating an XML Descriptor]] | * [[Creating%20an%20XML%20Descriptor%20(ELUG)|Creating an XML Descriptor]] | ||
− | After you create a descriptor, you must | + | After you create a descriptor, you must [[Configuring%20a%20Descriptor%20(ELUG)|configure its various options]] and use it to define mappings. |
For complete information on the various types of mapping that EclipseLink supports, see [[Introduction%20to%20Mappings%20(ELUG)|Introduction to Mappings]] and [[Creating%20a%20Mapping%20(ELUG)|Creating a Mapping]]. | For complete information on the various types of mapping that EclipseLink supports, see [[Introduction%20to%20Mappings%20(ELUG)|Introduction to Mappings]] and [[Creating%20a%20Mapping%20(ELUG)|Creating a Mapping]]. | ||
− | For complete information on the various types of descriptor that EclipseLink supports, see [[Introduction%20to%20Descriptors%20(ELUG)|Descriptor Types]]. | + | For complete information on the various types of descriptor that EclipseLink supports, see [[Introduction%20to%20Descriptors%20(ELUG)#Descriptor Types|Descriptor Types]]. |
Line 17: | Line 17: | ||
You can validate descriptors in the following ways: | You can validate descriptors in the following ways: | ||
* Run the project in a test environment and watch for and interpret any exceptions that occur. | * Run the project in a test environment and watch for and interpret any exceptions that occur. | ||
− | * | + | * [[Introduction%20to%20EclipseLink%20Sessions%20(ELUG)#Integrity Checker|Run the EclipseLink integrity checker]]. |
− | * | + | * [[Creating%20a%20Project%20(ELUG)#How to Generate the Project Status Report|Review the project status report]]. |
Line 25: | Line 25: | ||
Typically, you capture descriptor configuration in the <tt>project.xml</tt> file and the EclipseLink runtime reads this information, and then creates and configures all necessary descriptor objects. | Typically, you capture descriptor configuration in the <tt>project.xml</tt> file and the EclipseLink runtime reads this information, and then creates and configures all necessary descriptor objects. | ||
− | Alternatively, for relational projects only, you can export | + | Alternatively, for relational projects only, you can export an EclipseLink project as a Java class (<tt>org.eclipse.persistence.sessions.Project</tt>) that contains all descriptor configuration in Java. This lets you use Workbench to quickly create and configure descriptors, and then, manually code features that Workbench does not support. This gives you the best of both Workbench and Java access to your descriptors. After configuring your Java project class, compile it and include it in your application's JAR file. |
For more information, see [[Creating%20a%20Relational%20Project%20(ELUG)#How to Export Project Java Source Using Workbench|How to Export Project Java Source Using Workbench]]. | For more information, see [[Creating%20a%20Relational%20Project%20(ELUG)#How to Export Project Java Source Using Workbench|How to Export Project Java Source Using Workbench]]. | ||
Line 36: | Line 36: | ||
[[Category: EclipseLink User's Guide]] | [[Category: EclipseLink User's Guide]] | ||
− | [[Category: | + | [[Category: Release 1]] |
[[Category: Task]] | [[Category: Task]] |
Latest revision as of 07:46, 20 August 2008
This section describes how to create EclipseLink descriptors. For information on creating different types of descriptors, see:
After you create a descriptor, you must configure its various options and use it to define mappings.
For complete information on the various types of mapping that EclipseLink supports, see Introduction to Mappings and Creating a Mapping.
For complete information on the various types of descriptor that EclipseLink supports, see Descriptor Types.
Validating Descriptors
You can validate descriptors in the following ways:
- Run the project in a test environment and watch for and interpret any exceptions that occur.
- Run the EclipseLink integrity checker.
- Review the project status report.
Generating Java Code for Descriptors
Typically, you capture descriptor configuration in the project.xml file and the EclipseLink runtime reads this information, and then creates and configures all necessary descriptor objects.
Alternatively, for relational projects only, you can export an EclipseLink project as a Java class (org.eclipse.persistence.sessions.Project) that contains all descriptor configuration in Java. This lets you use Workbench to quickly create and configure descriptors, and then, manually code features that Workbench does not support. This gives you the best of both Workbench and Java access to your descriptors. After configuring your Java project class, compile it and include it in your application's JAR file.
For more information, see How to Export Project Java Source Using Workbench.