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.
Creating a Descriptor (ELUG)
Contents
This section describes how to create EclipseLink descriptors.
Introduction to Descriptor Creation
For information on creating different types of descriptors, see the following:
After you create a descriptor, you must configure its various options (see Configuring a Descriptor) 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. For more information, see Integrity Checker.
- Review the project status report. For more information, see How to Generate 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 a 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.