blob: 39ad6220bb97d635559bf9463e1dad08474ef90c [file] [log] [blame]
<!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:15 UTC 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.eclipse.persistence.oxm.mappings (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="org.eclipse.persistence.oxm.mappings (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 class="navBarCell1Rev">Package</li>
<li>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/json/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../org/eclipse/persistence/oxm/mappings/converters/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/persistence/oxm/mappings/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.eclipse.persistence.oxm.mappings</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/oxm/mappings/MimeTypePolicy.html" title="interface in org.eclipse.persistence.oxm.mappings">MimeTypePolicy</a></td>
<td class="colLast">
<div class="block">Purpose:</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/oxm/mappings/XMLMapping.html" title="interface in org.eclipse.persistence.oxm.mappings">XMLMapping</a></td>
<td class="colLast">
<div class="block">INTERNAL
All mappings which can be added to org.eclipse.persistence.oxm.XMLDescriptor must
implement this interface.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/oxm/mappings/XMLNillableMapping.html" title="interface in org.eclipse.persistence.oxm.mappings">XMLNillableMapping</a></td>
<td class="colLast">
<div class="block">INTERNAL
All nillable mappings which can be added to org.eclipse.persistence.oxm.XMLDescriptor must
implement this interface.<br>
The default policy is AbstractNullPolicy.<br></div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/oxm/mappings/BidirectionalPolicy.html" title="class in org.eclipse.persistence.oxm.mappings">BidirectionalPolicy</a></td>
<td class="colLast">
<div class="block"><b>Purpose:</b> Provides a means to configure bidirectional relationship
maintenance for OXM mappings.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/oxm/mappings/FixedMimeTypePolicy.html" title="class in org.eclipse.persistence.oxm.mappings">FixedMimeTypePolicy</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/oxm/mappings/XMLAbstractAnyMapping.html" title="class in org.eclipse.persistence.oxm.mappings">XMLAbstractAnyMapping</a></td>
<td class="colLast">
<div class="block"><b>Purpose:</b> An abstract superclass for XMLAnyObjectMapping and XMLAnyCollectionMapping.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/oxm/mappings/XMLAnyAttributeMapping.html" title="class in org.eclipse.persistence.oxm.mappings">XMLAnyAttributeMapping</a></td>
<td class="colLast">
<div class="block"><b>Purpose</b>:The XMLAnyAttributeMapping is used to map to an attribute in an object to any xml attributes contained
on a specific element in the XML Document.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/oxm/mappings/XMLAnyCollectionMapping.html" title="class in org.eclipse.persistence.oxm.mappings">XMLAnyCollectionMapping</a></td>
<td class="colLast">
<div class="block">Any collection XML mappings map an attribute that contains a heterogenous collection of
objects to multiple XML elements.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/oxm/mappings/XMLAnyObjectMapping.html" title="class in org.eclipse.persistence.oxm.mappings">XMLAnyObjectMapping</a></td>
<td class="colLast">
<div class="block">Any object XML mappings map an attribute that contains a single object to an XML element.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/oxm/mappings/XMLBinaryDataCollectionMapping.html" title="class in org.eclipse.persistence.oxm.mappings">XMLBinaryDataCollectionMapping</a></td>
<td class="colLast">
<div class="block"><b>Purpose:</b>Provide a mapping for a collection of binary data values that can be treated
as either inline binary values or as an attachment.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/oxm/mappings/XMLBinaryDataMapping.html" title="class in org.eclipse.persistence.oxm.mappings">XMLBinaryDataMapping</a></td>
<td class="colLast">
<div class="block"><b>Purpose:</b>Provide a mapping for binary data that can be treated as either inline or as
an attachment.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/oxm/mappings/XMLChoiceCollectionMapping.html" title="class in org.eclipse.persistence.oxm.mappings">XMLChoiceCollectionMapping</a></td>
<td class="colLast">
<div class="block">PUBLIC:</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/oxm/mappings/XMLChoiceObjectMapping.html" title="class in org.eclipse.persistence.oxm.mappings">XMLChoiceObjectMapping</a></td>
<td class="colLast">
<div class="block">PUBLIC:</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/oxm/mappings/XMLCollectionReferenceMapping.html" title="class in org.eclipse.persistence.oxm.mappings">XMLCollectionReferenceMapping</a></td>
<td class="colLast">
<div class="block">TopLink OXM version of a 1-M mapping.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/oxm/mappings/XMLCompositeCollectionMapping.html" title="class in org.eclipse.persistence.oxm.mappings">XMLCompositeCollectionMapping</a></td>
<td class="colLast">
<div class="block">Composite collection XML mappings map an attribute that contains a homogeneous collection of objects
to multiple XML elements.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/oxm/mappings/XMLCompositeDirectCollectionMapping.html" title="class in org.eclipse.persistence.oxm.mappings">XMLCompositeDirectCollectionMapping</a></td>
<td class="colLast">
<div class="block">Composite direct collection XML mappings map a collection of simple types (String, Number, Date,
etc.) to and from a sequence of composite XML nodes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/oxm/mappings/XMLCompositeObjectMapping.html" title="class in org.eclipse.persistence.oxm.mappings">XMLCompositeObjectMapping</a></td>
<td class="colLast">
<div class="block">Composite object XML mappings represent a relationship between two classes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/oxm/mappings/XMLDirectMapping.html" title="class in org.eclipse.persistence.oxm.mappings">XMLDirectMapping</a></td>
<td class="colLast">
<div class="block">XML Direct Mappings map a Java attribute directly to XML attribute or text node.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/oxm/mappings/XMLFragmentCollectionMapping.html" title="class in org.eclipse.persistence.oxm.mappings">XMLFragmentCollectionMapping</a></td>
<td class="colLast">
<div class="block"><b>Purpose: </b>This mapping provides a means to keep a part of the xml tree as a collection
of DOM elements.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/oxm/mappings/XMLFragmentMapping.html" title="class in org.eclipse.persistence.oxm.mappings">XMLFragmentMapping</a></td>
<td class="colLast">
<div class="block"><b>Purpose: </b>This mapping provides a means to keep a part of the xml tree as a DOM element.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/oxm/mappings/XMLInverseReferenceMapping.html" title="class in org.eclipse.persistence.oxm.mappings">XMLInverseReferenceMapping</a></td>
<td class="colLast">
<div class="block">This mapping is used to map a back-pointer.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/oxm/mappings/XMLObjectReferenceMapping.html" title="class in org.eclipse.persistence.oxm.mappings">XMLObjectReferenceMapping</a></td>
<td class="colLast">
<div class="block">TopLink OXM version of a 1-1 mapping.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/oxm/mappings/XMLTransformationMapping.html" title="class in org.eclipse.persistence.oxm.mappings">XMLTransformationMapping</a></td>
<td class="colLast">
<div class="block">Transformation XML mappings are used to create a custom mapping where one or more XML nodes can
be used to create the object to be stored in a Java class's attribute.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/oxm/mappings/XMLVariableXPathCollectionMapping.html" title="class in org.eclipse.persistence.oxm.mappings">XMLVariableXPathCollectionMapping</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/oxm/mappings/XMLVariableXPathObjectMapping.html" title="class in org.eclipse.persistence.oxm.mappings">XMLVariableXPathObjectMapping</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/oxm/mappings/UnmarshalKeepAsElementPolicy.html" title="enum in org.eclipse.persistence.oxm.mappings">UnmarshalKeepAsElementPolicy</a></td>
<td class="colLast">
<div class="block"><b>Purpose:</b> Used in conjunction with XMLAnyObject/CollectionMapping and XMLCompositeObject/CollectionMapping
to specify when (if at all) to keep parts of the unmarshalled document as nodes.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
<!-- ======= 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 class="navBarCell1Rev">Package</li>
<li>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/json/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../org/eclipse/persistence/oxm/mappings/converters/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/persistence/oxm/mappings/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2007&#x2013;2021 <a href="http://www.eclipse.org/eclipselink">Eclipse.org - EclipseLink Project</a>. All rights reserved.</small></p>
</body>
</html>