| <!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:14 UTC 2021 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>org.eclipse.persistence.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.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/logging/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../org/eclipse/persistence/mappings/converters/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/eclipse/persistence/mappings/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.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> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="header"> |
| <h1 title="Package" class="title">Package org.eclipse.persistence.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"> </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/mappings/ContainerMapping.html" title="interface in org.eclipse.persistence.mappings">ContainerMapping</a></td> |
| <td class="colLast"> |
| <div class="block">Interface used by clients to interact |
| with the assorted mappings that use <code>ContainerPolicy</code>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/eclipse/persistence/mappings/EmbeddableMapping.html" title="interface in org.eclipse.persistence.mappings">EmbeddableMapping</a></td> |
| <td class="colLast"> |
| <div class="block">INTERNAL |
| Common interface to those mappings that are used to map JPA Embedded objects.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/eclipse/persistence/mappings/RelationalMapping.html" title="interface in org.eclipse.persistence.mappings">RelationalMapping</a></td> |
| <td class="colLast"> |
| <div class="block">INTERNAL |
| All mappings which can be added to org.eclipse.persistence.mappings.Descriptor must |
| implement this interface.</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"> </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/mappings/AggregateCollectionMapping.html" title="class in org.eclipse.persistence.mappings">AggregateCollectionMapping</a></td> |
| <td class="colLast"> |
| <div class="block"><b>Purpose</b>: The aggregate collection mapping is used to represent the aggregate relationship between a single |
| source object and a collection of target objects.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/eclipse/persistence/mappings/AggregateMapping.html" title="class in org.eclipse.persistence.mappings">AggregateMapping</a></td> |
| <td class="colLast"> |
| <div class="block"><b>Purpose</b>: Two objects can be considered to be related by aggregation if there is a strict |
| 1:1 relationship between the objects.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/eclipse/persistence/mappings/AggregateObjectMapping.html" title="class in org.eclipse.persistence.mappings">AggregateObjectMapping</a></td> |
| <td class="colLast"> |
| <div class="block"><b>Purpose</b>:Two objects can be considered to be related by aggregation if there is a strict |
| 1:1 relationship between the objects.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/eclipse/persistence/mappings/Association.html" title="class in org.eclipse.persistence.mappings">Association</a></td> |
| <td class="colLast"> |
| <div class="block"><b>Purpose</b>: Generic association object.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/eclipse/persistence/mappings/AttributeAccessor.html" title="class in org.eclipse.persistence.mappings">AttributeAccessor</a></td> |
| <td class="colLast"> |
| <div class="block"><b>Purpose</b>: This provides an abstract class for setting and retrieving |
| the attribute value for the mapping from an object.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/eclipse/persistence/mappings/CollectionMapping.html" title="class in org.eclipse.persistence.mappings">CollectionMapping</a></td> |
| <td class="colLast"> |
| <div class="block"><b>Purpose</b>: Abstract class for relationship mappings which store collection of objects</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a></td> |
| <td class="colLast"> |
| <div class="block"><b>Purpose</b>: Defines how an attribute of an object maps to and from the database</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/eclipse/persistence/mappings/DirectCollectionMapping.html" title="class in org.eclipse.persistence.mappings">DirectCollectionMapping</a></td> |
| <td class="colLast"> |
| <div class="block"><b>Purpose</b>: This mapping is used to store a collection of simple types (String, Number, Date, etc.) |
| into a single table.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/eclipse/persistence/mappings/DirectMapMapping.html" title="class in org.eclipse.persistence.mappings">DirectMapMapping</a></td> |
| <td class="colLast"> |
| <div class="block">Mapping for a collection of key-value pairs.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/eclipse/persistence/mappings/DirectToFieldMapping.html" title="class in org.eclipse.persistence.mappings">DirectToFieldMapping</a></td> |
| <td class="colLast"> |
| <div class="block"><b>Purpose</b>: Maps an attribute to the corresponding database field type.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html" title="class in org.eclipse.persistence.mappings">ForeignReferenceMapping</a></td> |
| <td class="colLast"> |
| <div class="block"><b>Purpose</b>: Abstract class for relationship mappings</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/eclipse/persistence/mappings/ManyToManyMapping.html" title="class in org.eclipse.persistence.mappings">ManyToManyMapping</a></td> |
| <td class="colLast"> |
| <div class="block"><b>Purpose</b>: Many to many mappings are used to represent the relationships |
| between a collection of source objects and a collection of target objects.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/eclipse/persistence/mappings/ManyToOneMapping.html" title="class in org.eclipse.persistence.mappings">ManyToOneMapping</a></td> |
| <td class="colLast"> |
| <div class="block"><b>Purpose</b>: Define the relationship to be a ManyToOne.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/eclipse/persistence/mappings/MultitenantPrimaryKeyMapping.html" title="class in org.eclipse.persistence.mappings">MultitenantPrimaryKeyMapping</a></td> |
| <td class="colLast"> |
| <div class="block"><b>Purpose</b>: Maps a multitenant property to the corresponding database |
| field type.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/eclipse/persistence/mappings/ObjectReferenceMapping.html" title="class in org.eclipse.persistence.mappings">ObjectReferenceMapping</a></td> |
| <td class="colLast"> |
| <div class="block"><b>Purpose</b>: Abstract class for 1:1, variable 1:1 and reference mappings</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/eclipse/persistence/mappings/OneToManyMapping.html" title="class in org.eclipse.persistence.mappings">OneToManyMapping</a></td> |
| <td class="colLast"> |
| <div class="block"><b>Purpose</b>: This mapping is used to represent the |
| typical RDBMS relationship between a single |
| source object and collection of target objects; where, |
| on the database, the target objects have references |
| (foreign keys) to the source object.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/eclipse/persistence/mappings/OneToOneMapping.html" title="class in org.eclipse.persistence.mappings">OneToOneMapping</a></td> |
| <td class="colLast"> |
| <div class="block"><b>Purpose</b>: One to one mappings are used to represent a pointer references |
| between two java objects.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/eclipse/persistence/mappings/PropertyAssociation.html" title="class in org.eclipse.persistence.mappings">PropertyAssociation</a></td> |
| <td class="colLast"> |
| <div class="block"><b>Purpose</b>: Generic association object.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/eclipse/persistence/mappings/RelationTableMechanism.html" title="class in org.eclipse.persistence.mappings">RelationTableMechanism</a></td> |
| <td class="colLast"> |
| <div class="block"><b>Purpose</b>: Contains relation table functionality |
| that was originally defined in ManyToManyMapping |
| and now is shared with OneToOneMapping.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/eclipse/persistence/mappings/TransformationMapping.html" title="class in org.eclipse.persistence.mappings">TransformationMapping</a></td> |
| <td class="colLast"> |
| <div class="block"><b>Purpose</b>: A transformation mapping is used for a specialized translation between how |
| a value is represented in Java and its representation on the databae.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/eclipse/persistence/mappings/TypedAssociation.html" title="class in org.eclipse.persistence.mappings">TypedAssociation</a></td> |
| <td class="colLast"> |
| <div class="block"><b>Purpose</b>: Generic association object.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/eclipse/persistence/mappings/UnidirectionalOneToManyMapping.html" title="class in org.eclipse.persistence.mappings">UnidirectionalOneToManyMapping</a></td> |
| <td class="colLast"> |
| <div class="block"><b>Purpose</b>: UnidirectionalOneToManyMapping doesn't have 1:1 back reference mapping.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/eclipse/persistence/mappings/VariableOneToOneMapping.html" title="class in org.eclipse.persistence.mappings">VariableOneToOneMapping</a></td> |
| <td class="colLast"> |
| <div class="block"><b>Purpose</b>: Variable one to one mappings are used to represent a pointer references |
| between a java object and an implementer of an interface.</div> |
| </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"> </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/mappings/DatabaseMapping.WriteType.html" title="enum in org.eclipse.persistence.mappings">DatabaseMapping.WriteType</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/eclipse/persistence/mappings/OneToOneMapping.ShallowMode.html" title="enum in org.eclipse.persistence.mappings">OneToOneMapping.ShallowMode</a></td> |
| <td class="colLast"> |
| <div class="block">Mode for writeFromObjectIntoRowInternal method</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/logging/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../org/eclipse/persistence/mappings/converters/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/eclipse/persistence/mappings/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.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> |
| <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> |
