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 "User:Rick.barkhouse.oracle.com/Test2"
| Line 92: | Line 92: | ||
} | } | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
</source> | </source> | ||
| Line 136: | Line 121: | ||
| − | == XML | + | == XML Ouput == |
| + | |||
| + | Without any customization, JAXB's default naming algorithm will produce XML that looks like the following: | ||
| + | |||
| + | <source lang="xml"> | ||
| + | <?xml version="1.0" encoding="UTF-8"?> | ||
| + | <Customer id="123"> | ||
| + | <fullName>Jane Doe</fullName> | ||
| + | <shippingAddress type="residential"> | ||
| + | <street>1 Any Street</street> | ||
| + | </shippingAddress> | ||
| + | </Customer> | ||
| + | </source> | ||
By leveraging our customized naming algorithm we can get the following output without specifying any additional metadata on our domain classes: | By leveraging our customized naming algorithm we can get the following output without specifying any additional metadata on our domain classes: | ||
| Line 148: | Line 145: | ||
</shipping-address> | </shipping-address> | ||
</Customer> | </Customer> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
</source> | </source> | ||
Revision as of 13:56, 17 June 2011
| EclipseLink | |
| Website | |
| Download | |
| Community | |
| Mailing List • Forums • IRC • mattermost | |
| Issues | |
| Open • Help Wanted • Bug Day | |
| Contribute | |
| Browse Source |
Key API
Contents
Customizing XML Name Conversions
JAXB has well-established rules for converting Java names to XML names, which can be overridden through the use of annotations. This can become burdensome if your names follow common rules (such as making everything upper case). EclipseLink MOXy 2.3 introduces a new feature to allow you to override the default naming algorithm.
This example will create an implementation of org.eclipse.persistence.oxm.XMLNameTransformer to provide a naming algorithm to MOXy:
Implementation
package example; public class NameGenerator implements org.eclipse.persistence.oxm.XMLNameTransformer { // Use the unqualified class name as our root element name. public String transformRootElementName(String name) { return name.substring(name.lastIndexOf('.') + 1); } // The same algorithm as root element name plus "Type" appended to the end. public String transformTypeName(String name) { return transformRootElementName(name) + "Type"; } // The name will be lower case with word breaks represented by '-'. // Note: A capital letter in the original name represents the start of a new word. public String transformElementName(String name) { StringBuilder strBldr = new StringBuilder(); for (char character : name.toCharArray()) { if (Character.isUpperCase(character)) { strBldr.append('-'); strBldr.append(Character.toLowerCase(character)); } else { strBldr.append(character); } } return strBldr.toString(); } //The original name converted to upper case. public String transformAttributeName(String name) { return name.toUpperCase(); } }
Java Model
The following domain model will be used. To save space the accessors have been omitted.
Customer
import javax.xml.bind.annotation.*; @XmlRootElement @XmlType(propOrder={"fullName", "shippingAddress"}) @XmlAccessorType(XmlAccessType.FIELD) public class Customer { @XmlAttribute private long id; private String fullName; private Address shippingAddress; }
Address.java
import javax.xml.bind.annotation.*; @XmlAccessorType(XmlAccessType.FIELD) public class Address { @XmlAttribute private String type; private String street; }
Specifying the naming algorithm
Our implementation of the naming algorithm can be provided via the @XmlNameTransformer annotation (package or type level) or via the external bindings file in XML.
1. At the type level:
@XmlNameTransformer(example.NameGenerator.class) public class Customer
2. At the package level (package-info.java):
@XmlNameTransformer(example.NameGenerator.class) package examples;
3. External bindings file:
<?xml version='1.0' encoding='UTF-8'?> <xml-bindings xmlns='http://www.eclipse.org/eclipselink/xsds/persistence/oxm' xml-name-transformer='example.NameGenerator'> <xml-schema/> <java-types/> </xml-bindings>
XML Ouput
Without any customization, JAXB's default naming algorithm will produce XML that looks like the following:
<?xml version="1.0" encoding="UTF-8"?> <Customer id="123"> <fullName>Jane Doe</fullName> <shippingAddress type="residential"> <street>1 Any Street</street> </shippingAddress> </Customer>
By leveraging our customized naming algorithm we can get the following output without specifying any additional metadata on our domain classes:
<?xml version="1.0" encoding="UTF-8"?> <Customer ID="123"> <full-name>Jane Doe</full-name> <shipping-address TYPE="residential"> <street>1 Any Street</street> </shipping-address> </Customer>