|
|
| Line 19: |
Line 19: |
| | | | |
| | ==Creating an XML Project from an XML Schema== | | ==Creating an XML Project from an XML Schema== |
| − | If you have an existing data model (XML schema document), but you do not have a corresponding object model (Java classes for domain objects), use this procedure to create your EclipseLink project and automatically generate the corresponding object model.
| + | EclipseLink 1.x supports JAXB 2.0 and uses the JAXB 2.0 schema compiler. You can use this JAXB compiler to generate POJO (Plain Old Java Objects) annotated with JAXB 2.0 mapping metadata. You can define and edit this JAXB metadata by embedding these annotations in your source code -- not the Eclipse Workbench. |
| | | | |
| | + | To use the Eclipse Workbench to define XPath based mappings: |
| | + | #Create an XML project. |
| | + | #Import your schema and classes into the project. |
| | + | #Define the mappings between your classes and schema. |
| | | | |
| − | {| class="Note oac_no_warn" width="80%" border="1" frame="hsides" rules="groups" cellpadding="3" frame="hsides" rules="groups"
| |
| − | | align="left" |
| |
| − | '''Note:''' If you have both XSD and object model classes, you can create an XML project using the procedure described in [[Creating%20a%20Project%20(ELUG)#How to Create a Project Using the Workbench|How to Create a Project Using the Workbench]].
| |
| − | |}
| |
| − |
| |
| − |
| |
| − | Using the EclipseLink JAXB compiler simplifies JAXB application development with EclipseLink by automatically generating both the required JAXB files and the EclipseLink files from your XML schema (XSD) document. Once generated, you can open the Workbench project to fine-tune XML mappings without having to recompile your JAXB object model.
| |
| − |
| |
| − | You can use the EclipseLink JAXB compiler from [[#How to Create an XML Project from an XML Schema Using Workbench|the Workbench]] or from the [[#How to Create an XML Project from an XML Schema Using the Command Line|command line ]].
| |
| − |
| |
| − |
| |
| − | {| class="Note oac_no_warn" width="80%" border="1" frame="hsides" rules="groups" cellpadding="3" frame="hsides" rules="groups"
| |
| − | | align="left" |
| |
| − | '''Note:''' Before you compile your generated classes, be sure to configure your IDE classpath to include <tt><</tt>''<tt>ECLIPSELINK_HOME</tt>''<tt>>\jlib\moxy\javax.xml.bind_2.0.0.jar</tt>. For example, see [[Using%20an%20Integrated%20Development%20Environment%20(ELUG)|Using an Integrated Development Environment]].
| |
| − | |}
| |
| − |
| |
| − |
| |
| − | For more information, see the following:
| |
| − | * [[Introduction%20to%20XML%20Projects%20(ELUG)#EclipseLink Support for Java Architecture for XML Binding (JAXB)|EclipseLink Support for Java Architecture for XML Binding (JAXB)]]
| |
| − | * [[Introduction%20to%20XML%20Projects%20(ELUG)#Using EclipseLink JAXB Compiler Generated Files at Run Time|Using EclipseLink JAXB Compiler Generated Files at Run Time]]
| |
| − |
| |
| − |
| |
| − | ===How to Create an XML Project from an XML Schema Using Workbench===
| |
| − | To create a new, mapped Workbench project from an XML schema using JAXB, use this procedure:
| |
| − | # From Workbench, select '''File > New > Project > From XML Schema (JAXB)'''.<br><span id="Figure 53-1"></span>''''' Create Workbench Project using JAXB Dialog Box'''''<br>[[Image:creatjaxb.gif|Create Workbench Project using JAXB Dialog Box]]
| |
| − | # Complete each field on the Create Workbench Project using JAXB dialog box, and then click '''OK'''.
| |
| − |
| |
| − | Use the following information to enter data in each field of this dialog box:
| |
| − |
| |
| − |
| |
| − | {| class="HRuleInformalWide" dir="ltr" title="This table identifies each field on the Create Workbench Project using JAXB dialog." summary="This table identifies each field on the Create Workbench Project using JAXB dialog." width="100%" border="1" frame="hsides" rules="rows" cellpadding="3" frame="hsides" rules="rows"
| |
| − | |- align="left" valign="top"
| |
| − | ! id="r1c1-t4" align="left" valign="bottom" | '''Field'''
| |
| − | ! id="r1c2-t4" align="left" valign="bottom" | '''Description'''
| |
| − | |- align="left" valign="top"
| |
| − | | id="r2c1-t4" headers="r1c1-t4" align="left" | '''From'''
| |
| − | | headers="r2c1-t4 r1c2-t4" align="left" | Use these fields to specify your existing JAXB information.
| |
| − | |- align="left" valign="top"
| |
| − | | id="r3c1-t4" headers="r1c1-t4" align="left" | <blockquote>'''Schema File'''</blockquote>
| |
| − | | headers="r3c1-t4 r1c2-t4" align="left" | Click '''Browse''' and select the fully qualified path to your XSD file.
| |
| − | |- align="left" valign="top"
| |
| − | | id="r4c1-t4" headers="r1c1-t4" align="left" | <blockquote>'''JAXB Customization File'''</blockquote>
| |
| − | | headers="r4c1-t4 r1c2-t4" align="left" | This in an optional setting. It can be used if you have a standard JAXB configuration file that you wish to use to override the default JAXB compiler behavior. The JAXB customization file contains binding declarations for customizing the default binding between an XSD component and its Java representation.
| |
| − | |- align="left" valign="top"
| |
| − | | id="r5c1-t4" headers="r1c1-t4" align="left" | '''To'''
| |
| − | | headers="r5c1-t4 r1c2-t4" align="left" | Use these fields to specify the location and options of the Workbench project.
| |
| − | |- align="left" valign="top"
| |
| − | | id="r6c1-t4" headers="r1c1-t4" align="left" |<blockquote>''' Output Directory'''</blockquote>
| |
| − | | headers="r6c1-t4 r1c2-t4" align="left" | Click '''Browse''' and select the path to the directory into which generated files are written. All paths used in the project are relative to this directory.
| |
| − | |- align="left" valign="top"
| |
| − | | id="r7c1-t4" headers="r1c1-t4" align="left" | <blockquote>'''Output Source Directory'''</blockquote>
| |
| − | | headers="r7c1-t4 r1c2-t4" align="left" | Click '''Browse''' and select the path to the directory (relative to the '''Output Directory''') into which generated interfaces, implementation classes, and deployment files are written. Default: directory named <tt>source</tt> in the specified output directory.
| |
| − | |- align="left" valign="top"
| |
| − | | id="r8c1-t4" headers="r1c1-t4" align="left" | <blockquote>'''Output Workbench Project Directory'''</blockquote>
| |
| − | | headers="r8c1-t4 r1c2-t4" align="left" | Click Browse and select the path to the directory (relative to the '''Output Directory''') into which the Workbench project files are written. Default: directory named <tt>mw</tt> in the specified output directory.
| |
| − | |- align="left" valign="top"
| |
| − | | id="r9c1-t4" headers="r1c1-t4" align="left" | <blockquote>''' Package Name for Generated Interfaces'''</blockquote>
| |
| − | | headers="r9c1-t4 r1c2-t4" align="left" | The optional name of the package to which generated interfaces belong. This defines your context path. If it is not specified, a package name of <tt>jaxbderived.<schema name></tt> is used where <tt><schema name></tt> is the name of the schema specified by the '''Schema File''' field.
| |
| − | |- align="left" valign="top"
| |
| − | | id="r10c1-t4" headers="r1c1-t4" align="left" | <blockquote>'''Package Name for Generated Implementation Classes'''</blockquote>
| |
| − | | headers="r10c1-t4 r1c2-t4" align="left" | The optional name of the package to which generated implementation classes belong. This defines your context path. If it is not specified, a package name of <tt>jaxbderived.<schema name></tt> is used where <tt><schema name></tt> is the name of the schema specified by the '''Schema File''' field.
| |
| − | |}
| |
| − |
| |
| − |
| |
| − | The EclipseLink JAXB compiler generates [[Introduction%20to%20XML%20Projects%20(ELUG)#Working with JAXB-Specific Generated Files|JAXB-specific files ]] and [[Introduction%20to%20XML%20Projects%20(ELUG)#Working with EclipseLink-Specific Generated Files|EclipseLink-specific files]].
| |
| − |
| |
| − | Optionally, open the generated [[Introduction%20to%20XML%20Projects%20(ELUG)#Workbench Project|workbench project]]), customize the generated mappings and descriptors, and reexport the EclipseLink project XML.
| |
| − |
| |
| − |
| |
| − | {| class="Note oac_no_warn" width="80%" border="1" frame="hsides" rules="groups" cellpadding="3" frame="hsides" rules="groups"
| |
| − | | align="left" |
| |
| − | '''Note:''' Before you compile your generated classes, be sure to configure your IDE classpath to include <tt><</tt>''<tt>ECLIPSELINK_HOME</tt>''<tt>>\jlib\moxy\javax.xml.bind_2.0.0.jar</tt>. For example, see [[Using%20an%20Integrated%20Development%20Environment%20(ELUG)|Using an Integrated Development Environment]].
| |
| − | |}
| |
| − |
| |
| − | ===How to Create an XML Project from an XML Schema Using the Command Line===
| |
| − | To create a new, mapped Workbench project from an XML schema using JAXB from the command line, use the <tt>jaxb-compiler.cmd</tt> or <tt>jaxb-compiler.sh</tt> file (located in the ''<tt><ECLIPSELINK_HOME></tt>''<tt>/bin</tt> directory) as follows:
| |
| − | <ol>
| |
| − | <li> Using a text editor, edit the <tt>jaxb-compiler.cmd</tt> or <tt>jaxb-compiler.sh</tt> file to set proxy settings (if required).<br>If you are using a schema that imports another schema by URL and you are operating behind a proxy, then you must uncomment the lines shown in the [[#Example 53-1|Proxy Settings in jaxb-compiler.cmd]] or [[#Example 53-2|Proxy Settings in jaxb-compiler.sh]] examples and edit them to set your proxy host (name or IP address) and port:
| |
| − | <br><span id="Example 53-1"></span>
| |
| − | ''''' Proxy Settings in jaxb-compiler.cmd'''''
| |
| − | <div class="pre">
| |
| − | @REM set JVM_ARGS=%JVM_ARGS% -DproxySet=true -Dhttp.proxyHost= -Dhttp.proxyPort=
| |
| − | </div>
| |
| − | <br><span id="Example 53-2"></span>
| |
| − | ''''' Proxy Settings in jaxb-compiler.sh'''''
| |
| − | <div class="pre">
| |
| − | # JVM_ARGS="${JVM_ARGS} -DproxySet=true -Dhttp.proxyHost= -Dhttp.proxyPort="
| |
| − | </div>
| |
| − | </li>
| |
| − | <li> Execute the <tt>jaxb-compiler.cmd</tt> or <tt>jaxb-compiler.sh</tt> file (located in the ''<tt><ECLIPSELINK_HOME></tt>''<tt>/bin</tt> directory).<br>The EclipseLink JAXB compiler generates JAXB-specific files (see [[Introduction%20to%20XML%20Projects%20(ELUG)|Working with JAXB-Specific Generated Files]]) and EclipseLink-specific files (see [[Introduction%20to%20XML%20Projects%20(ELUG)|Working with EclipseLink-Specific Generated Files]]).<br>The [[#Example 53-3|Generating an Object Model from a Schema with jaxb-compiler.cmd]] example illustrates how to generate an object model from a schema using the EclipseLink JAXB compiler. The [[#Table 53-1|EclipseLink JAXB Binding Compiler Arguments]] table lists the compiler arguments.
| |
| − | <br><span id="Example 53-3"></span>
| |
| − | ''''' Generating an Object Model from a Schema with jaxb-compiler.cmd'''''
| |
| − | <div class="pre">
| |
| − | jaxb-compiler.cmd -sourceDir ./app/src -generateWorkbench -workbenchDir ./app/mw -schema purchaseOrder.xsd<br> -targetPkg examples.ox.model.if -implClassPkg examples.ox.model.impl
| |
| − | </div>
| |
| − | <br>
| |
| − | <span id="Table 53-1"></span>
| |
| − | ''''' EclipseLink JAXB Binding Compiler Arguments'''''
| |
| − |
| |
| − | {| class="HRuleFormalMax" dir="ltr" title="EclipseLink JAXB Binding Compiler Arguments" summary="This table describes the mandatory and optional arguments used with the EclipseLink JAXB binding compiler." width="100%" border="1" frame="hsides" rules="rows" cellpadding="3" frame="hsides" rules="rows"
| |
| − | |- align="left" valign="top"
| |
| − | ! id="r1c1-t6" align="left" valign="bottom" | '''Argument'''
| |
| − | ! id="r1c2-t6" align="left" valign="bottom" | '''Description'''
| |
| − | ! id="r1c3-t6" align="left" valign="bottom" | '''Optional?'''
| |
| − | |- align="left" valign="top"
| |
| − | | id="r2c1-t6" headers="r1c1-t6" align="left" |
| |
| − | <tt>-help</tt>
| |
| − | | headers="r2c1-t6 r1c2-t6" align="left" |
| |
| − | Prints this usage information.
| |
| − | | headers="r2c1-t6 r1c3-t6" align="left" |
| |
| − | Yes
| |
| − | |- align="left" valign="top"
| |
| − | | id="r3c1-t6" headers="r1c1-t6" align="left" |
| |
| − | <tt>-version</tt>
| |
| − | | headers="r3c1-t6 r1c2-t6" align="left" |
| |
| − | Prints the release version of the EclipseLink JAXB compiler.
| |
| − | | headers="r3c1-t6 r1c3-t6" align="left" |
| |
| − | Yes
| |
| − | |- align="left" valign="top"
| |
| − | | id="r4c1-t6" headers="r1c1-t6" align="left" |
| |
| − | <tt>-sourceDir</tt>
| |
| − | | headers="r4c1-t6 r1c2-t6" align="left" |
| |
| − | The path to the directory into which generated interfaces, implementation classes, and deployment files are written.
| |
| − |
| |
| − | Default: directory named <tt>source</tt> in the specified output directory.
| |
| − | | headers="r4c1-t6 r1c3-t6" align="left" |
| |
| − | Yes
| |
| − | |- align="left" valign="top"
| |
| − | | id="r5c1-t6" headers="r1c1-t6" align="left" |
| |
| − | <tt>-generateWorkbench</tt>
| |
| − | | headers="r5c1-t6 r1c2-t6" align="left" |
| |
| − | Generate a Workbench project and necessary project files. If omitted, only runtime information is generated.
| |
| − | | headers="r5c1-t6 r1c3-t6" align="left" |
| |
| − | Yes
| |
| − | |- align="left" valign="top"
| |
| − | | id="r6c1-t6" headers="r1c1-t6" align="left" |
| |
| − | <tt>-workbenchDir</tt>
| |
| − | | headers="r6c1-t6 r1c2-t6" align="left" |
| |
| − | The path to the directory into which the Workbench project files are written. This argument requires the <tt>-generateWorkbench</tt> argument.
| |
| − |
| |
| − | Default: directory named <tt>mw</tt> in the specified output directory.
| |
| − | | headers="r6c1-t6 r1c3-t6" align="left" |
| |
| − | Yes
| |
| − | |- align="left" valign="top"
| |
| − | | id="r7c1-t6" headers="r1c1-t6" align="left" |
| |
| − | <tt>-schema</tt>
| |
| − | | headers="r7c1-t6 r1c2-t6" align="left" |
| |
| − | The fully qualified path to your XSD file.
| |
| − | | headers="r7c1-t6 r1c3-t6" align="left" |
| |
| − | No
| |
| − | |- align="left" valign="top"
| |
| − | | id="r8c1-t6" headers="r1c1-t6" align="left" |
| |
| − | <tt>-targetPkg</tt>
| |
| − | | headers="r8c1-t6 r1c2-t6" align="left" |
| |
| − | The name of the package to which both generated interfaces and classes belong. This defines your context path. To specify a different package for implementation classes, set the <tt>-implClassPkg</tt> argument.
| |
| − |
| |
| − | Default: a package name of <tt>jaxbderived.<schema name></tt> where <tt><schema name></tt> is the name of the schema specified by the <tt>-schema</tt> argument.
| |
| − | | headers="r8c1-t6 r1c3-t6" align="left" |
| |
| − | Yes
| |
| − | |- align="left" valign="top"
| |
| − | | id="r9c1-t6" headers="r1c1-t6" align="left" |
| |
| − | <tt>-implClassPkg</tt>
| |
| − | | headers="r9c1-t6 r1c2-t6" align="left" |
| |
| − | The name of the package to which generated implementation classes belong. If this option is set, interfaces belong to the package specified by the <tt>-targetPkg</tt> argument. This defines your context path.
| |
| − | | headers="r9c1-t6 r1c3-t6" align="left" |
| |
| − | Yes
| |
| − | |- align="left" valign="top"
| |
| − | | id="r10c1-t6" headers="r1c1-t6" align="left" |
| |
| − | <tt>-interface</tt>
| |
| − | | headers="r10c1-t6 r1c2-t6" align="left" |
| |
| − | Generate only interfaces. This argument is optional.
| |
| − |
| |
| − | Default: generate both interfaces and implementation classes.
| |
| − | | headers="r10c1-t6 r1c3-t6" align="left" |
| |
| − | Yes
| |
| − | |- align="left" valign="top"
| |
| − | | id="r11c1-t6" headers="r1c1-t6" align="left" |
| |
| − | <tt>-verbose</tt>
| |
| − | | headers="r11c1-t6 r1c2-t6" align="left" |
| |
| − | The interfaces and classes generated. This argument is optional.
| |
| − |
| |
| − | Default: not verbose.
| |
| − | | headers="r11c1-t6 r1c3-t6" align="left" |
| |
| − | Yes
| |
| − | |- align="left" valign="top"
| |
| − | | id="r12c1-t6" headers="r1c1-t6" align="left" |
| |
| − | <tt>-customize</tt>
| |
| − | | headers="r12c1-t6 r1c2-t6" align="left" |
| |
| − | The fully qualified path and file name of a standard JAXB customization file that you can use to override default JAXB compiler behavior.
| |
| − | | headers="r12c1-t6 r1c3-t6" align="left" |
| |
| − | Yes
| |
| − | |}
| |
| − | <br>
| |
| − | </li>
| |
| − | <li> Optionally, open the generated [[Introduction%20to%20XML%20Projects%20(ELUG)#Workbench Project|Workbench project]] in Workbench, customize the generated mappings and descriptors, and reexport the EclipseLink project XML.
| |
| − |
| |
| − | {| class="Note oac_no_warn" width="80%" border="1" frame="hsides" rules="groups" cellpadding="3" frame="hsides" rules="groups"
| |
| − | | align="left" |
| |
| − | '''Note:''' Before you compile your generated classes, be sure to configure your IDE classpath to include <tt><</tt>''<tt>ECLIPSELINK_HOME</tt>''<tt>>\jlib\moxy\javax.xml.bind_2.0.0.jar</tt>. For example, see [[Using%20an%20Integrated%20Development%20Environment%20(ELUG)|Using an Integrated Development Environment]].
| |
| − | |}
| |
| − | </li>
| |
| − | </ol>
| |
| | | | |
| | | | |
| Line 233: |
Line 35: |
| | | | |
| | [[Category: EclipseLink User's Guide]] | | [[Category: EclipseLink User's Guide]] |
| − | [[Category: Release 1]] | + | [[Category: Release 1.1]] |
| | [[Category: Task]] | | [[Category: Task]] |
| | [[Category: XML]] | | [[Category: XML]] |
This section describes the various components that you must configure in order to create an XML project.
For information on how to create more than one type of EclipseLink projects, see Creating a Project.
We recommend using the Workbench to create projects and generate deployment XML or Java source versions of the project for use at run time. For more information on how to create a project using Workbench, see How to Create a Project Using the Workbench. For information on how to create a project using Java, see How to Create a Project Using Java.
EclipseLink 1.x supports JAXB 2.0 and uses the JAXB 2.0 schema compiler. You can use this JAXB compiler to generate POJO (Plain Old Java Objects) annotated with JAXB 2.0 mapping metadata. You can define and edit this JAXB metadata by embedding these annotations in your source code -- not the Eclipse Workbench.
