| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
| "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=us-ascii" /> |
| <meta http-equiv="Content-Style-Type" content="text/css" /> |
| <meta http-equiv="Content-Script-Type" content="text/javascript" /> |
| <title>Using XML Transformations | EclipseLink 2.7 EclipseLink MOXy</title> |
| <meta name="generator" content="Oracle DARB XHTML Converter (Mode = document) - Version 1.0.22 Build 1" /> |
| <meta name="date" content="2014-06-10T10:25:33Z" /> |
| <meta name="robots" content="noarchive" /> |
| <meta name="doctitle" content="Using XML Transformations" /> |
| <meta name="relnum" content="Release 2.7" /> |
| <meta name="partnum" content="" /> |
| <link rel="stylesheet" type="text/css" href="../../dcommon/style.css" media="screen" /> |
| <link rel="copyright" href="../../dcommon/html/cpyr.htm" title="Copyright" type="text/html" /> |
| <link rel="start" href="../../index.htm" title="Home" type="text/html" /> |
| <link rel="contents" href="toc.htm" title="Contents" type="text/html" /> |
| <link rel="prev" href="advanced_concepts006.htm" title="Previous" type="text/html" /> |
| <link rel="next" href="advanced_concepts008.htm" title="Next" type="text/html" /> |
| <!-- START: Disqus --><script type="text/javascript"> var disqus_developer = 0; </script><!-- END: Disqus --><!-- START: Sharethis --><script type="text/javascript">var switchTo5x=true;</script><script type="text/javascript" src="http://w.sharethis.com/button/buttons.js"></script><script type="text/javascript" src="http://s.sharethis.com/loader.js"></script> <!-- END: Sharethis --></head> |
| <body bgcolor="#FFFFFF"><iframe id="docheader" frameborder="0" framemargin="0" scrolling="no" src="../../dcommon/header.html"></iframe><script src="http://www.google.com/jsapi" type="text/javascript"></script><script type="text/javascript"> google.load('search', '1', {language : 'en'}); google.setOnLoadCallback(function() { var customSearchOptions = {}; var googleAnalyticsOptions = {}; googleAnalyticsOptions['queryParameter'] = 'q'; googleAnalyticsOptions['categoryParameter'] = ''; customSearchOptions['googleAnalyticsOptions'] = googleAnalyticsOptions; var customSearchControl = new google.search.CustomSearchControl( '016171230611334810008:1hjujor5_fg', customSearchOptions); customSearchControl.setResultSetSize(google.search.Search.FILTERED_CSE_RESULTSET); var options = new google.search.DrawOptions(); options.setSearchFormRoot('cse-search-form'); customSearchControl.draw('cse', options); }, true);</script><link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" /><div id="cse" style="width:100%;"></div> |
| <div class="header"><a id="top" name="top"></a> |
| <table class="simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="100%"> |
| <tr> |
| <td align="left" valign="top"><div class="booktitle">Developing JAXB Applications Using EclipseLink MOXy, |
| <b>Release 2.7</b><br /></font></td> |
| <td valign="bottom" align="right" width="144"> |
| <table class="simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="100%"> |
| <tr> |
| <td> </td> |
| <td align="center" valign="top"><a href="toc.htm"><img src="../../dcommon/images/contents.png" alt="Go To Table Of Contents" border="0" height="16" width="16" /><br /> |
| </td><td> </td><td align="center"><a href="../../" target="_top" class="external text" title="Search" rel="nofollow"><img src="../../dcommon/images/search.png" alt="Search" style="border:0;" /><br /><span class="mini"></span></a></td><td> </td><td align="center"><a href="../eclipselink_moxy.pdf" title="PDF" target="_blank"><img src="../../dcommon/images/pdf_icon.png" style="padding-right:5px;border:0" alt="PDF"></a></td> |
| </tr> |
| </table> |
| </td> |
| </tr> |
| </table> |
| <hr /> |
| <table class="navigation simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="100" align="center"> |
| <tr> |
| <td align="center"><a href="advanced_concepts006.htm"><img src="../../dcommon/images/larrow.png" alt="Previous" border="0" height="16" width="16" /></a></td> |
| <td align="center"><a href="advanced_concepts008.htm"><img src="../../dcommon/images/rarrow.png" alt="Next" border="0" height="16" width="16" /></a></td> |
| <td> </td> |
| </tr> |
| </table> |
| </div> |
| <!-- class="header" --> |
| <div class="ind"><!-- End Header --><a id="CHDFFEFF" name="CHDFFEFF"></a><a id="TLJAX429" name="TLJAX429"></a> |
| <div class="sect1"><!-- infolevel="all" infotype="General" --> |
| <h1 class="sect1"><font face="arial, helvetica, sans-serif" color="#330099">Using XML Transformations</font></h1> |
| <p>In many cases, you can use MOXy's <code>@XmlTransformation</code> annotation to give you considerably more control over the marshalling and unmarshalling of your objects. <code>@XmlTransformation</code> can be used to create a custom mapping where one or more XML nodes can be used to create the value for the Java attribute.</p> |
| <p>To handle the custom requirements at marshal (write) and unmarshall (read) time, <code>@XmlTransformation</code> uses instances of <code>org.eclipse.persistence.mappings.transformers</code> (such as <code>AttributeTransformer</code> and <code>FieldTransformer</code>), providing a non-intrusive solution that avoids the need for domain objects to implement any 'special' interfaces.</p> |
| <p>For example, if you wanted to map the following XML to objects and combine the values of <code>DATE</code> and <code>TIME</code> into a <code>single java.util.Date</code> object, you can use an <code>@XmlTransformation:</code></p> |
| <pre xml:space="preserve" class="oac_no_warn"> |
| <ELEM_B> |
| <B_DATE>20100825</B_DATE> |
| <B_TIME>153000</B_TIME> |
| <NUM>123</NUM> |
| <C_DATE>20100825</C_DATE> |
| <C_TIME>154500</C_TIME> |
| </ELEM_B> |
| </pre> |
| <div align="center"> |
| <div class="inftblnote"><br /> |
| <table class="Note oac_no_warn" summary="" border="1" width="80%" frame="hsides" rules="groups" cellpadding="3" cellspacing="0"> |
| <tbody> |
| <tr> |
| <td align="left"> |
| <p class="note"><img src="../../dcommon/images/note_icon.png" width="16" height="16" alt="Note" style="vertical-align:middle;padding-right:5px;" />Note:</p> |
| <p>Ordinarily, you would use <code>@XmlAdapter</code>. However:</p> |
| <ul> |
| <li> |
| <p>Although the <strong>DATE</strong>/<strong>TIME</strong> pairings are repeated throughout the document, the element name changes each time (such as <strong>B_DATE</strong>/<strong>B_TIME</strong>, <strong>C_DATE</strong>/<strong>C_TIME</strong>, and so on).</p> |
| </li> |
| <li> |
| <p>Because each pairing is missing a grouping element, you would need to adapt the <em>entire</em> <strong>ElemB</strong> class.</p> |
| </li> |
| </ul> |
| <p>Because of these issues, MOXy's transformation mapping is much easier to implement:</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <br /></div> |
| <!-- class="inftblnote" --></div> |
| <div class="example"><a id="TLJAX430" name="TLJAX430"></a><a id="sthref187" name="sthref187"></a> |
| <p><strong><em><font face="arial, helvetica, sans-serif">Example 8-38 Mapping Example</font></em></strong></p> |
| <pre xml:space="preserve" class="oac_no_warn"> |
| |
| package example; |
| |
| import java.util.Date; |
| |
| import javax.xml.bind.annotation.*; |
| import org.eclipse.persistence.oxm.annotations.*; |
| |
| @XmlAccessorType(XmlAccessType.FIELD) |
| @XmlRootElement(name="ELEM_B") |
| public class ElemB { |
| |
| @XmlTransformation |
| @XmlReadTransformer(transformerClass=DateAttributeTransformer.class) |
| @XmlWriteTransformers({ |
| @XmlWriteTransformer(xmlPath="B_DATE/text()", transformerClass=DateFieldTransformer.class), |
| @XmlWriteTransformer(xmlPath="B_TIME/text()", transformerClass=TimeFieldTransformer.class), |
| }) |
| private Date bDate; |
| |
| @XmlElement(name="NUM") |
| private int num; |
| |
| @XmlTransformation |
| @XmlReadTransformer(transformerClass=DateAttributeTransformer.class) |
| @XmlWriteTransformers({ |
| @XmlWriteTransformer(xmlPath="C_DATE/text()", transformerClass=DateFieldTransformer.class), |
| @XmlWriteTransformer(xmlPath="C_TIME/text()", transformerClass=TimeFieldTransformer.class), |
| }) |
| private Date cDate; |
| |
| } |
| |
| </pre></div> |
| <!-- class="example" --> |
| <a id="TLJAX431" name="TLJAX431"></a> |
| <div class="sect2"><a id="sthref188" name="sthref188"></a> |
| <h2 class="sect2"><font face="arial, helvetica, sans-serif" color="#330099">Using an AttributeTransformer</font></h2> |
| <p>Use an <code>AttributeTransformer</code> to construct the Java attribute value:</p> |
| <div class="example"><a id="TLJAX432" name="TLJAX432"></a><a id="sthref189" name="sthref189"></a> |
| <p><strong><em><font face="arial, helvetica, sans-serif">Example 8-39 Sample AttributeTransfomer</font></em></strong></p> |
| <pre xml:space="preserve" class="oac_no_warn"> |
| package example; |
| |
| import java.text.ParseException; |
| import java.text.SimpleDateFormat; |
| |
| import org.eclipse.persistence.internal.helper.DatabaseField; |
| import org.eclipse.persistence.mappings.foundation.AbstractTransformationMapping; |
| import org.eclipse.persistence.mappings.transformers.AttributeTransformer; |
| import org.eclipse.persistence.sessions.Record; |
| import org.eclipse.persistence.sessions.Session; |
| |
| public class DateAttributeTransformer implements <strong>AttributeTransformer </strong>{ |
| |
| private AbstractTransformationMapping mapping; |
| private SimpleDateFormat yyyyMMddHHmmss = new SimpleDateFormat("yyyyMMddHHmmss"); |
| |
| public void initialize(AbstractTransformationMapping mapping) { |
| this.mapping = mapping; |
| } |
| |
| public Object buildAttributeValue(Record record, Object instance, Session session) { |
| try { |
| String dateString = null; |
| String timeString = null; |
| |
| for (DatabaseField field : mapping.getFields()) { |
| if (field.getName().contains("DATE")) { |
| dateString = (String) record.get(field); |
| } else { |
| timeString = (String) record.get(field); |
| } |
| } |
| return yyyyMMddHHmmss.parseObject(dateString + timeString); |
| } catch(ParseException e) { |
| throw new RuntimeException(e); |
| } |
| } |
| |
| } |
| |
| </pre></div> |
| <!-- class="example" --></div> |
| <!-- class="sect2" --> |
| <a id="TLJAX433" name="TLJAX433"></a> |
| <div class="sect2"><a id="sthref190" name="sthref190"></a> |
| <h2 class="sect2"><font face="arial, helvetica, sans-serif" color="#330099">Using a FieldTransformer</font></h2> |
| <p>Use a <code>FieldTransformer</code> to construct the XML field value from the Java object.</p> |
| <p>Each transformation mapping may have multiple write transformers. In this example, you will need two:</p> |
| <ul> |
| <li> |
| <p>The first write transformer writes the year, month, and day in <strong>yyMMdd</strong> format:</p> |
| <div class="example"><a id="TLJAX434" name="TLJAX434"></a><a id="sthref191" name="sthref191"></a> |
| <p><strong><em><font face="arial, helvetica, sans-serif">Example 8-40 First Write Transformer</font></em></strong></p> |
| <pre xml:space="preserve" class="oac_no_warn"> |
| package example; |
| |
| import java.text.SimpleDateFormat; |
| import java.util.Date; |
| |
| import org.eclipse.persistence.mappings.foundation.AbstractTransformationMapping; |
| import org.eclipse.persistence.mappings.transformers.FieldTransformer; |
| import org.eclipse.persistence.sessions.Session; |
| |
| public class DateFieldTransformer implements FieldTransformer { |
| |
| private AbstractTransformationMapping mapping; |
| private SimpleDateFormat yyyyMMdd = new SimpleDateFormat("yyyyMMdd"); |
| |
| public void initialize(AbstractTransformationMapping mapping) { |
| this.mapping = mapping; |
| } |
| |
| public Object buildFieldValue(Object instance, String xPath, Session session) { |
| Date date = (Date) mapping.getAttributeValueFromObject(instance); |
| return yyyyMMdd.format(date); |
| } |
| |
| } |
| </pre></div> |
| <!-- class="example" --></li> |
| <li> |
| <p>The second write transformer writes out the hour, minutes, and seconds in <strong>HHmmss</strong> format.</p> |
| <div class="example"><a id="TLJAX435" name="TLJAX435"></a><a id="sthref192" name="sthref192"></a> |
| <p><strong><em><font face="arial, helvetica, sans-serif">Example 8-41 Second Write Transformer</font></em></strong></p> |
| <pre xml:space="preserve" class="oac_no_warn"> |
| package example; |
| |
| import java.text.SimpleDateFormat; |
| import java.util.Date; |
| |
| import org.eclipse.persistence.mappings.foundation.AbstractTransformationMapping; |
| import org.eclipse.persistence.mappings.transformers.FieldTransformer; |
| import org.eclipse.persistence.sessions.Session; |
| |
| public class TimeFieldTransformer implements FieldTransformer { |
| |
| private AbstractTransformationMapping mapping; |
| private SimpleDateFormat HHmmss = new SimpleDateFormat("HHmmss"); |
| |
| public void initialize(AbstractTransformationMapping mapping) { |
| this.mapping = mapping; |
| } |
| |
| public Object buildFieldValue(Object instance, String xPath, Session session) { |
| Date date = (Date) mapping.getAttributeValueFromObject(instance); |
| return HHmmss.format(date); |
| } |
| |
| } |
| </pre></div> |
| <!-- class="example" --></li> |
| </ul> |
| </div> |
| <!-- class="sect2" --></div> |
| <!-- class="sect1" --></div> |
| <!-- class="ind" --> |
| <!-- Start Footer --> |
| <div class="footer"> |
| <hr /> |
| <table class="simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="100%"> |
| <col width="33%" /> |
| <col width="*" /> |
| <col width="33%" /> |
| <tr> |
| <td valign="bottom"> |
| <table class="navigation simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="100" align="center"> |
| <col width="*" /> |
| <col width="48%" /> |
| <col width="48%" /> |
| <tr> |
| <td> </td> |
| <td align="center"><a href="advanced_concepts006.htm"><img src="../../dcommon/images/larrow.png" alt="Previous" border="0" height="16" width="16" /></a></td> |
| <td align="center"><a href="advanced_concepts008.htm"><img src="../../dcommon/images/rarrow.png" alt="Next" border="0" height="16" width="16" /></a></td> |
| </tr> |
| </table> |
| </td> |
| <td align="center" width="34%"><a href="http://www.eclipse.org/eclipselink/" title="EclipseLink home"><img src="../../dcommon/images/ellogo.png" alt="EclipseLink" width="150" border="0" /></a><br /> |
| |
| |
| <td valign="bottom" align="right"> |
| <table class="simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="225"> |
| <tr> |
| <td> </td> |
| <td align="center" valign="top"><a href="toc.htm"><img src="../../dcommon/images/contents.png" alt="Go To Table Of Contents" border="0" height="16" width="16" /><br /> |
| </td><td> </td><td align="center"><a href="../../" target="_top" class="external text" title="Search" rel="nofollow"><img src="../../dcommon/images/search.png" alt="Search" style="border:0;" /><br /><span class="mini"></span></a></td><td> </td><td align="center"><a href="../eclipselink_moxy.pdf" title="PDF" target="_blank"><img src="../../dcommon/images/pdf_icon.png" style="padding-right:5px;border:0" alt="PDF"></a></td> |
| </tr> |
| </table> |
| </td> |
| </tr> |
| </table> |
| </div> |
| <!-- class="footer" --> |
| <div id="copyright">Copyright © 2013 by The Eclipse Foundation under the <a href="http://www.eclipse.org/org/documents/epl-v10.php">Eclipse Public License (EPL)</a><br /> <script type="text/javascript">var LastUpdated = document.lastModified;document.writeln ("Updated: " + LastUpdated);</script> </div><!-- START: Analytics --><script type="text/javascript"> var _gaq = _gaq || []; _gaq.push(['_setAccount', 'UA-1608008-2']); _gaq.push(['_trackPageview']); (function() { var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); })(); </script><!-- END: Analytics --><!-- START: Sharethis --><script>var options={ "publisher": "e2fe9e07-fab6-4f84-83ea-0991b429842c", "position": "right", "ad": { "visible": false, "openDelay": 5, "closeDelay": 0}};var st_hover_widget = new sharethis.widgets.hoverbuttons(options);</script><!-- END: Sharethis --></body> |
| </html> |