| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_252) on Fri Jul 16 09:39:10 UTC 2021 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>XmlReadTransformer (EclipseLink 3.0.2, API Reference)</title> |
| <meta name="date" content="2021-07-16"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="XmlReadTransformer (EclipseLink 3.0.2, API Reference)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage">EclipseLink 3.0.2, API Reference</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/eclipse/persistence/oxm/annotations/XmlReadOnly.html" title="annotation in org.eclipse.persistence.oxm.annotations"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/eclipse/persistence/oxm/annotations/XmlTransformation.html" title="annotation in org.eclipse.persistence.oxm.annotations"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/eclipse/persistence/oxm/annotations/XmlReadTransformer.html" target="_top">Frames</a></li> |
| <li><a href="XmlReadTransformer.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Field | </li> |
| <li>Required | </li> |
| <li><a href="#annotation.type.optional.element.summary">Optional</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#annotation.type.element.detail">Element</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.eclipse.persistence.oxm.annotations</div> |
| <h2 title="Annotation Type XmlReadTransformer" class="title">Annotation Type XmlReadTransformer</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>={<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#METHOD" title="class or interface in java.lang.annotation">METHOD</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#FIELD" title="class or interface in java.lang.annotation">FIELD</a>}) |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>) |
| public @interface <span class="memberNameLabel">XmlReadTransformer</span></pre> |
| <div class="block"><p><b>Purpose: </b>XmlReadTransformer is used to allow the user direct access to the XML in order to populate their |
| object model. XmlReadTransformer is used in conjunction with XmlWriteTransformers/XmlWriteTransformer to create a customised |
| mapping for a specific attribute. XmlReadTransformer specifies the transformer to be invoked on the |
| unmarshal. |
| |
| <p><b>Mapping a transformation</b>: A transformer can be configured to perform both the |
| XML instance-to-Java attribute transformation at unmarshall time (via attribute transformer) and |
| the Java attribute-to-XML instance transformation at marshal time (via field transformer). |
| <p><b>Example:</b> |
| <p><em>XML Schema</em><br> |
| <code> |
| <?xml version="1.0" encoding="UTF-8"?><br> |
| <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"><br> |
| <xsd:element name="employee" type="employee-type"/><br> |
| <xsd:complexType name="employee-type"><br> |
| <xsd:sequence><br> |
| <xsd:element name="name" type="xsd:string"/><br> |
| <xsd:element name="normal-hours" type="normal-hours-type"/><br> |
| </xsd:sequence><br> |
| </xsd:complexType><br> |
| <xsd:complexType name="normal-hours-type"><br> |
| <xsd:sequence><br> |
| <xsd:element name="start-time" type="xsd:string"/><br> |
| <xsd:element name="end-time" type="xsd:string"/><br> |
| </xsd:sequence><br> |
| </xsd:complexType><br> |
| </xsd:schema><br> |
| </code> |
| |
| <p><em>Employee Class</em><br> |
| |
| <pre> |
| @XmlRootElement(name="employee") |
| public class Employee { |
| public String name; |
| @XmlReadTransformer(transformerClass = NormalHoursTransformer.class) |
| @XmlWriteTransformers({ |
| @XmlWriteTransformer(transformerClass = StartTimeTransformer.class, xmlPath= "normal-hours/start-time/text()"), |
| @XmlWriteTransformer(transformerClass = EndTimeTransformer.class, xmlPath="normal-hours/end-time/text()") |
| }) |
| public String[] normalHours; |
| } |
| </pre> |
| |
| <p><em>Normal Hours Transformer</em><br> |
| <pre> |
| public class NormalHoursTransformer implements AttributeTransformer { |
| public String[] buildAttributeValue(Record record, Object object, Session session) { |
| String startTime = (String)record.get("normal-hours/start-time/text()"); |
| String endTime = (String)record.get("normal-hours/end-time/text()"); |
| return new String[]{startTime, endTime}; |
| } |
| public void initialize(AbstractTransformationMapping mapping) { |
| } |
| } |
| } |
| </pre></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/eclipse/persistence/mappings/transformers/AttributeTransformer.html" title="interface in org.eclipse.persistence.mappings.transformers"><code>AttributeTransformer</code></a>, |
| <a href="../../../../../org/eclipse/persistence/oxm/annotations/XmlWriteTransformer.html" title="annotation in org.eclipse.persistence.oxm.annotations"><code>XmlWriteTransformer</code></a>, |
| <a href="../../../../../org/eclipse/persistence/oxm/annotations/XmlWriteTransformers.html" title="annotation in org.eclipse.persistence.oxm.annotations"><code>XmlWriteTransformers</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="annotation.type.optional.element.summary"> |
| <!-- --> |
| </a> |
| <h3>Optional Element Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> |
| <caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Optional Element and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/oxm/annotations/XmlReadTransformer.html#method--">method</a></span></code> |
| <div class="block">The mapped class must have a method with this name which returns a value |
| to be assigned to the attribute (not assigns the value to the attribute).</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/eclipse/persistence/mappings/transformers/AttributeTransformer.html" title="interface in org.eclipse.persistence.mappings.transformers">AttributeTransformer</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/oxm/annotations/XmlReadTransformer.html#transformerClass--">transformerClass</a></span></code> |
| <div class="block">User-defined class that must implement the |
| org.eclipse.persistence.mappings.transformers.AttributeTransformer |
| interface.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="annotation.type.element.detail"> |
| <!-- --> |
| </a> |
| <h3>Element Detail</h3> |
| <a name="transformerClass--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>transformerClass</h4> |
| <pre>public abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/eclipse/persistence/mappings/transformers/AttributeTransformer.html" title="interface in org.eclipse.persistence.mappings.transformers">AttributeTransformer</a>> transformerClass</pre> |
| <div class="block">User-defined class that must implement the |
| org.eclipse.persistence.mappings.transformers.AttributeTransformer |
| interface. The class will be instantiated, its buildAttributeValue will |
| be used to create the value to be assigned to the attribute. |
| Either transformerClass or method must be specified, but not both.</div> |
| <dl> |
| <dt>Default:</dt> |
| <dd>org.eclipse.persistence.mappings.transformers.AttributeTransformer.class</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>method</h4> |
| <pre>public abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> method</pre> |
| <div class="block">The mapped class must have a method with this name which returns a value |
| to be assigned to the attribute (not assigns the value to the attribute). |
| Either transformerClass or method must be specified, but not both.</div> |
| <dl> |
| <dt>Default:</dt> |
| <dd>""</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage">EclipseLink 3.0.2, API Reference</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/eclipse/persistence/oxm/annotations/XmlReadOnly.html" title="annotation in org.eclipse.persistence.oxm.annotations"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/eclipse/persistence/oxm/annotations/XmlTransformation.html" title="annotation in org.eclipse.persistence.oxm.annotations"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/eclipse/persistence/oxm/annotations/XmlReadTransformer.html" target="_top">Frames</a></li> |
| <li><a href="XmlReadTransformer.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Field | </li> |
| <li>Required | </li> |
| <li><a href="#annotation.type.optional.element.summary">Optional</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#annotation.type.element.detail">Element</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2007–2021 <a href="http://www.eclipse.org/eclipselink">Eclipse.org - EclipseLink Project</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
