| <!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 Thu Apr 08 02:07:31 UTC 2021 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>DatabaseMapping (EclipseLink 3.0.1, API Reference)</title> |
| <meta name="date" content="2021-04-08"> |
| <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="DatabaseMapping (EclipseLink 3.0.1, API Reference)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":6,"i2":10,"i3":10,"i4":6,"i5":10,"i6":6,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":6,"i16":10,"i17":6,"i18":10,"i19":10,"i20":10,"i21":10,"i22":6,"i23":6,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":6,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10,"i47":10,"i48":10,"i49":10,"i50":10,"i51":10,"i52":10,"i53":10,"i54":10,"i55":10,"i56":10,"i57":10,"i58":10,"i59":10,"i60":10,"i61":10,"i62":10,"i63":10,"i64":10,"i65":10,"i66":10,"i67":10,"i68":10,"i69":10,"i70":10,"i71":10,"i72":10,"i73":10,"i74":10,"i75":10,"i76":10,"i77":10,"i78":10,"i79":10,"i80":10,"i81":10,"i82":10,"i83":10,"i84":10,"i85":10,"i86":10,"i87":10,"i88":10,"i89":10,"i90":10,"i91":10,"i92":10,"i93":10,"i94":10,"i95":10,"i96":10,"i97":10,"i98":10,"i99":10,"i100":10,"i101":10,"i102":10,"i103":10,"i104":10,"i105":10,"i106":10,"i107":10,"i108":10,"i109":10,"i110":10,"i111":10,"i112":10,"i113":10,"i114":10,"i115":10,"i116":10,"i117":10,"i118":10,"i119":10,"i120":10,"i121":10,"i122":10,"i123":10,"i124":6,"i125":10,"i126":10,"i127":10,"i128":6,"i129":6,"i130":10,"i131":10,"i132":10,"i133":10,"i134":10,"i135":10,"i136":10,"i137":10,"i138":10,"i139":10,"i140":10,"i141":10,"i142":10,"i143":10,"i144":10,"i145":10,"i146":10,"i147":10,"i148":10,"i149":10,"i150":10,"i151":10,"i152":10,"i153":10,"i154":10,"i155":10,"i156":10,"i157":10,"i158":10,"i159":10,"i160":10,"i161":10,"i162":10,"i163":10,"i164":10,"i165":10,"i166":10,"i167":10,"i168":10,"i169":10,"i170":10,"i171":10,"i172":10,"i173":10,"i174":10,"i175":10,"i176":10,"i177":10,"i178":10,"i179":10,"i180":10,"i181":10,"i182":10,"i183":10,"i184":10,"i185":10,"i186":10,"i187":10,"i188":10,"i189":10,"i190":10,"i191":10,"i192":10,"i193":10,"i194":10,"i195":10,"i196":10,"i197":10,"i198":10,"i199":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </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.1, API Reference</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/eclipse/persistence/mappings/ContainerMapping.html" title="interface in org.eclipse.persistence.mappings"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.WriteType.html" title="enum in org.eclipse.persistence.mappings"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/eclipse/persistence/mappings/DatabaseMapping.html" target="_top">Frames</a></li> |
| <li><a href="DatabaseMapping.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</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.mappings</div> |
| <h2 title="Class DatabaseMapping" class="title">Class DatabaseMapping</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../org/eclipse/persistence/core/mappings/CoreMapping.html" title="class in org.eclipse.persistence.core.mappings">org.eclipse.persistence.core.mappings.CoreMapping</a><<a href="../../../../org/eclipse/persistence/mappings/AttributeAccessor.html" title="class in org.eclipse.persistence.mappings">AttributeAccessor</a>,org.eclipse.persistence.internal.sessions.AbstractSession,org.eclipse.persistence.internal.queries.ContainerPolicy,<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a>,org.eclipse.persistence.internal.helper.DatabaseField></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.persistence.mappings.DatabaseMapping</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../org/eclipse/persistence/mappings/foundation/AbstractColumnMapping.html" title="class in org.eclipse.persistence.mappings.foundation">AbstractColumnMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/foundation/AbstractCompositeDirectCollectionMapping.html" title="class in org.eclipse.persistence.mappings.foundation">AbstractCompositeDirectCollectionMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/foundation/AbstractTransformationMapping.html" title="class in org.eclipse.persistence.mappings.foundation">AbstractTransformationMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/AggregateMapping.html" title="class in org.eclipse.persistence.mappings">AggregateMapping</a>, <a href="../../../../org/eclipse/persistence/mappings/ForeignReferenceMapping.html" title="class in org.eclipse.persistence.mappings">ForeignReferenceMapping</a>, <a href="../../../../org/eclipse/persistence/oxm/mappings/XMLAbstractAnyMapping.html" title="class in org.eclipse.persistence.oxm.mappings">XMLAbstractAnyMapping</a>, <a href="../../../../org/eclipse/persistence/oxm/mappings/XMLAnyAttributeMapping.html" title="class in org.eclipse.persistence.oxm.mappings">XMLAnyAttributeMapping</a>, <a href="../../../../org/eclipse/persistence/oxm/mappings/XMLChoiceCollectionMapping.html" title="class in org.eclipse.persistence.oxm.mappings">XMLChoiceCollectionMapping</a>, <a href="../../../../org/eclipse/persistence/oxm/mappings/XMLChoiceObjectMapping.html" title="class in org.eclipse.persistence.oxm.mappings">XMLChoiceObjectMapping</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">DatabaseMapping</span> |
| extends <a href="../../../../org/eclipse/persistence/core/mappings/CoreMapping.html" title="class in org.eclipse.persistence.core.mappings">CoreMapping</a><<a href="../../../../org/eclipse/persistence/mappings/AttributeAccessor.html" title="class in org.eclipse.persistence.mappings">AttributeAccessor</a>,org.eclipse.persistence.internal.sessions.AbstractSession,org.eclipse.persistence.internal.queries.ContainerPolicy,<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a>,org.eclipse.persistence.internal.helper.DatabaseField> |
| implements <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre> |
| <div class="block"><p><b>Purpose</b>: Defines how an attribute of an object maps to and from the database |
| |
| <p><b>Responsibilities</b>:<ul> |
| <li> Define type of relationship (1:1/1:M/M:M/etc.) |
| <li> Define instance variable name and fields names required |
| <li> Define any additional properties (ownership, indirection, read only, etc.) |
| <li> Control building the value for the instance variable from the database row |
| <li> Control building the database fields from the object |
| <li> Control any pre/post updating/inserting/deleting required to maintain the relationship |
| <li> Merges object changes for unit of work. |
| <li> Clones objects for unit of work. |
| <li> cache computed information to optimize performance |
| </ul></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../serialized-form.html#org.eclipse.persistence.mappings.DatabaseMapping">Serialized Form</a></dd> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd>Sati</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>TOPLink/Java 1.0</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.WriteType.html" title="enum in org.eclipse.persistence.mappings">DatabaseMapping.WriteType</a></span></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/eclipse/persistence/mappings/AttributeAccessor.html" title="class in org.eclipse.persistence.mappings">AttributeAccessor</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#attributeAccessor">attributeAccessor</a></span></code> |
| <div class="block">Wrapper to store the reference objects.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <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/mappings/DatabaseMapping.html#attributeName">attributeName</a></span></code> |
| <div class="block">PERF: Cache the mappings attribute name.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#derivedIdMapping">derivedIdMapping</a></span></code> |
| <div class="block">The id mapping this mapping derives.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#derivesId">derivesId</a></span></code> |
| <div class="block">Used by the CMP3Policy to see if this mapping should be used in |
| processing pk classes for find methods</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#descriptor">descriptor</a></span></code> |
| <div class="block">ClassDescriptor to which this mapping belongs to</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a><org.eclipse.persistence.internal.helper.DatabaseField></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#fields">fields</a></span></code> |
| <div class="block">Fields associated with the mappings are cached</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isCacheable">isCacheable</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isInSopObject">isInSopObject</a></span></code> |
| <div class="block">Irrelevant (and not set) unless descriptor has SerializedObjectPolicy (SOP).</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isJPAId">isJPAId</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isLazy">isLazy</a></span></code> |
| <div class="block">Specifies whether this mapping is lazy, this means not included in the default fetch group.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isMapKeyMapping">isMapKeyMapping</a></span></code> |
| <div class="block">Records if this mapping is being used as a MapKeyMapping.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isOptional">isOptional</a></span></code> |
| <div class="block">Specifies whether this mapping is optional (i.e.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isPrimaryKeyMapping">isPrimaryKeyMapping</a></span></code> |
| <div class="block">PERF: Used as a quick check to see if this mapping is a primary key mapping, |
| set by the object builder during initialization.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isReadOnly">isReadOnly</a></span></code> |
| <div class="block">Makes this mapping read only.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isRemotelyInitialized">isRemotelyInitialized</a></span></code> |
| <div class="block">It is needed only in remote initialization and mapping is in parent descriptor</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <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/mappings/DatabaseMapping.html#mapsIdValue">mapsIdValue</a></span></code> |
| <div class="block">A mapsId value.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#NO_FIELDS">NO_FIELDS</a></span></code> |
| <div class="block">Used to reduce memory for mappings with no fields.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#NO_WEIGHT">NO_WEIGHT</a></span></code> |
| <div class="block">Used to share integer instance to reduce memory.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#properties">properties</a></span></code> |
| <div class="block">Allow user defined properties.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<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>,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<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/mappings/DatabaseMapping.html#unconvertedProperties">unconvertedProperties</a></span></code> |
| <div class="block">Allow the user to defined un-converted properties which will be initialized at runtime.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#weight">weight</a></span></code> |
| <div class="block">This is a TopLink defined attribute that allows us to sort the mappings</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#WEIGHT_AGGREGATE">WEIGHT_AGGREGATE</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#WEIGHT_DIRECT">WEIGHT_DIRECT</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#WEIGHT_TO_ONE">WEIGHT_TO_ONE</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#WEIGHT_TRANSFORM">WEIGHT_TRANSFORM</a></span></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#DatabaseMapping--">DatabaseMapping</a></span>()</code> |
| <div class="block">PUBLIC: |
| Default constructor.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#addUnconvertedProperty-java.lang.String-java.lang.String-java.lang.String-">addUnconvertedProperty</a></span>(<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> propertyName, |
| <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> propertyValue, |
| <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> propertyType)</code> |
| <div class="block">PUBLIC: |
| Add an unconverted property (to be initialiazed at runtime)</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#buildBackupClone-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-">buildBackupClone</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> clone, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> backup, |
| org.eclipse.persistence.internal.sessions.UnitOfWorkImpl unitOfWork)</code> |
| <div class="block">INTERNAL: |
| Clone the attribute from the clone and assign it to the backup.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#buildBackupCloneForPartObject-java.lang.Object-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-">buildBackupCloneForPartObject</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> attributeValue, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> clone, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> backup, |
| org.eclipse.persistence.internal.sessions.UnitOfWorkImpl unitOfWork)</code> |
| <div class="block">INTERNAL: |
| Require for cloning, the part must be cloned.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>org.eclipse.persistence.internal.sessions.ChangeRecord</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#buildChangeRecord-java.lang.Object-org.eclipse.persistence.internal.sessions.ObjectChangeSet-org.eclipse.persistence.internal.sessions.AbstractSession-">buildChangeRecord</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> newValue, |
| org.eclipse.persistence.internal.sessions.ObjectChangeSet owner, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</code> |
| <div class="block">INTERNAL: |
| Directly build a change record without comparison</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#buildClone-java.lang.Object-org.eclipse.persistence.internal.identitymaps.CacheKey-java.lang.Object-java.lang.Integer-org.eclipse.persistence.internal.sessions.AbstractSession-">buildClone</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> original, |
| org.eclipse.persistence.internal.identitymaps.CacheKey cacheKey, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> clone, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> refreshCascade, |
| org.eclipse.persistence.internal.sessions.AbstractSession cloningSession)</code> |
| <div class="block">INTERNAL: |
| Clone the attribute from the original and assign it to the clone.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#buildCloneForPartObject-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.identitymaps.CacheKey-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-java.lang.Integer-boolean-boolean-">buildCloneForPartObject</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> attributeValue, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> original, |
| org.eclipse.persistence.internal.identitymaps.CacheKey cacheKey, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> clone, |
| org.eclipse.persistence.internal.sessions.AbstractSession cloningSession, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> refreshCascade, |
| boolean isExisting, |
| boolean isFromSharedCache)</code> |
| <div class="block">INTERNAL: |
| Require for cloning, the part must be cloned.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#buildCloneFromRow-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.queries.JoinedAttributeManager-java.lang.Object-org.eclipse.persistence.internal.identitymaps.CacheKey-org.eclipse.persistence.queries.ObjectBuildingQuery-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-org.eclipse.persistence.internal.sessions.AbstractSession-">buildCloneFromRow</a></span>(org.eclipse.persistence.internal.sessions.AbstractRecord databaseRow, |
| org.eclipse.persistence.internal.queries.JoinedAttributeManager joinManager, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> clone, |
| org.eclipse.persistence.internal.identitymaps.CacheKey sharedCacheKey, |
| <a href="../../../../org/eclipse/persistence/queries/ObjectBuildingQuery.html" title="class in org.eclipse.persistence.queries">ObjectBuildingQuery</a> sourceQuery, |
| org.eclipse.persistence.internal.sessions.UnitOfWorkImpl unitOfWork, |
| org.eclipse.persistence.internal.sessions.AbstractSession executionSession)</code> |
| <div class="block">INTERNAL: |
| A combination of readFromRowIntoObject and buildClone.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#buildContainerClone-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-">buildContainerClone</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> attributeValue, |
| org.eclipse.persistence.internal.sessions.AbstractSession cloningSession)</code> |
| <div class="block">INTERNAL: |
| Performs a first level clone of the attribute.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#buildCopy-java.lang.Object-java.lang.Object-org.eclipse.persistence.sessions.CopyGroup-">buildCopy</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> copy, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> original, |
| <a href="../../../../org/eclipse/persistence/sessions/CopyGroup.html" title="class in org.eclipse.persistence.sessions">CopyGroup</a> group)</code> |
| <div class="block">INTERNAL: |
| Copy of the attribute of the object.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#buildExpression-java.lang.Object-org.eclipse.persistence.queries.QueryByExamplePolicy-org.eclipse.persistence.expressions.Expression-java.util.Map-org.eclipse.persistence.internal.sessions.AbstractSession-">buildExpression</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> queryObject, |
| <a href="../../../../org/eclipse/persistence/queries/QueryByExamplePolicy.html" title="class in org.eclipse.persistence.queries">QueryByExamplePolicy</a> policy, |
| <a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a> expressionBuilder, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> processedObjects, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</code> |
| <div class="block">INTERNAL: |
| In case Query By Example is used, this method builds and returns an expression that |
| corresponds to a single attribue and it's value.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#buildObjectJoinExpression-org.eclipse.persistence.expressions.Expression-org.eclipse.persistence.expressions.Expression-org.eclipse.persistence.internal.sessions.AbstractSession-">buildObjectJoinExpression</a></span>(<a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a> base, |
| <a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a> argument, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</code> |
| <div class="block">INTERNAL: |
| Used to allow object level comparisons.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#buildObjectJoinExpression-org.eclipse.persistence.expressions.Expression-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-">buildObjectJoinExpression</a></span>(<a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a> base, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</code> |
| <div class="block">INTERNAL: |
| Used to allow object level comparisons.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#buildShallowOriginalFromRow-org.eclipse.persistence.internal.sessions.AbstractRecord-java.lang.Object-org.eclipse.persistence.internal.queries.JoinedAttributeManager-org.eclipse.persistence.queries.ObjectBuildingQuery-org.eclipse.persistence.internal.sessions.AbstractSession-">buildShallowOriginalFromRow</a></span>(org.eclipse.persistence.internal.sessions.AbstractRecord databaseRow, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> original, |
| org.eclipse.persistence.internal.queries.JoinedAttributeManager joinManager, |
| <a href="../../../../org/eclipse/persistence/queries/ObjectBuildingQuery.html" title="class in org.eclipse.persistence.queries">ObjectBuildingQuery</a> query, |
| org.eclipse.persistence.internal.sessions.AbstractSession executionSession)</code> |
| <div class="block">INTERNAL: |
| Builds a shallow original object.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#calculateDeferredChanges-org.eclipse.persistence.internal.sessions.ChangeRecord-org.eclipse.persistence.internal.sessions.AbstractSession-">calculateDeferredChanges</a></span>(org.eclipse.persistence.internal.sessions.ChangeRecord changeRecord, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</code> |
| <div class="block">INTERNAL: |
| Used by AttributeLevelChangeTracking to update a changeRecord with calculated changes |
| as apposed to detected changes.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#cascadeDiscoverAndPersistUnregisteredNewObjects-java.lang.Object-java.util.Map-java.util.Map-java.util.Map-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-java.util.Set-">cascadeDiscoverAndPersistUnregisteredNewObjects</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> newObjects, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> unregisteredExistingObjects, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> visitedObjects, |
| org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a> cascadeErrors)</code> |
| <div class="block">INTERNAL: |
| Cascade discover and persist new objects during commit.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#cascadePerformRemoveIfRequired-java.lang.Object-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-java.util.Map-">cascadePerformRemoveIfRequired</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object, |
| org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> visitedObjects)</code> |
| <div class="block">INTERNAL: |
| Cascade registerNew for Create through mappings that require the cascade</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#cascadePerformRemovePrivateOwnedObjectFromChangeSetIfRequired-java.lang.Object-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-java.util.Map-">cascadePerformRemovePrivateOwnedObjectFromChangeSetIfRequired</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object, |
| org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> visitedObjects)</code> |
| <div class="block">INTERNAL: |
| Cascade removal of orphaned private owned objects from the UnitOfWorkChangeSet</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#cascadeRegisterNewIfRequired-java.lang.Object-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-java.util.Map-">cascadeRegisterNewIfRequired</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object, |
| org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> visitedObjects)</code> |
| <div class="block">INTERNAL: |
| Cascade registerNew for Create through mappings that require the cascade</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#clone--">clone</a></span>()</code> |
| <div class="block">INTERNAL: |
| Clones itself.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#cloneFields-java.util.Vector-">cloneFields</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a> fields)</code> |
| <div class="block">INTERNAL: |
| Helper method to clone vector of fields (used in aggregate initialization cloning).</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a><org.eclipse.persistence.internal.helper.DatabaseField></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#collectFields--">collectFields</a></span>()</code> |
| <div class="block">This method must be overwritten in the subclasses to return a vector of all the |
| fields this mapping represents.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#collectQueryParameters-java.util.Set-">collectQueryParameters</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><org.eclipse.persistence.internal.helper.DatabaseField> record)</code> |
| <div class="block">INTERNAL: |
| This method is used to store the FK fields that can be cached that correspond to noncacheable mappings |
| the FK field values will be used to re-issue the query when cloning the shared cache entity</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>abstract org.eclipse.persistence.internal.sessions.ChangeRecord</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#compareForChange-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.ObjectChangeSet-org.eclipse.persistence.internal.sessions.AbstractSession-">compareForChange</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> clone, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> backup, |
| org.eclipse.persistence.internal.sessions.ObjectChangeSet owner, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</code> |
| <div class="block">INTERNAL: |
| This method was created in VisualAge.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>abstract boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#compareObjects-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-">compareObjects</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> firstObject, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> secondObject, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</code> |
| <div class="block">INTERNAL: |
| Compare the attributes belonging to this mapping for the objects.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#convertClassNamesToClasses-java.lang.ClassLoader-">convertClassNamesToClasses</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> classLoader)</code> |
| <div class="block">INTERNAL: |
| Convert all the class-name-based settings in this mapping to actual class-based |
| settings |
| This method is implemented by subclasses as necessary.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#convertConverterClassNamesToClasses-org.eclipse.persistence.mappings.converters.Converter-java.lang.ClassLoader-">convertConverterClassNamesToClasses</a></span>(<a href="../../../../org/eclipse/persistence/mappings/converters/Converter.html" title="interface in org.eclipse.persistence.mappings.converters">Converter</a> converter, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> classLoader)</code> |
| <div class="block">Convenience method to ensure converters have an opportunity to convert |
| any class names to classes during project setup.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>org.eclipse.persistence.internal.indirection.DatabaseValueHolder</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#createCloneValueHolder-org.eclipse.persistence.indirection.ValueHolderInterface-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractSession-boolean-">createCloneValueHolder</a></span>(<a href="../../../../org/eclipse/persistence/indirection/ValueHolderInterface.html" title="interface in org.eclipse.persistence.indirection">ValueHolderInterface</a> attributeValue, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> original, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> clone, |
| org.eclipse.persistence.internal.sessions.AbstractRecord row, |
| org.eclipse.persistence.internal.sessions.AbstractSession cloningSession, |
| boolean buildDirectlyFromRow)</code> |
| <div class="block">INTERNAL: |
| Builder the unit of work value holder.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#derivesId--">derivesId</a></span>()</code> |
| <div class="block">ADVANCED: |
| Returns true if the mapping references a JPA ID attribute for the CMP3Policy and JPA ID classes.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#earlyPreDelete-org.eclipse.persistence.queries.DeleteObjectQuery-java.lang.Object-">earlyPreDelete</a></span>(<a href="../../../../org/eclipse/persistence/queries/DeleteObjectQuery.html" title="class in org.eclipse.persistence.queries">DeleteObjectQuery</a> query, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object)</code> |
| <div class="block">INTERNAL: |
| This method is called to update collection tables prior to commit.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#extractNestedExpressions-java.util.List-org.eclipse.persistence.expressions.ExpressionBuilder-">extractNestedExpressions</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a>> expressions, |
| <a href="../../../../org/eclipse/persistence/expressions/ExpressionBuilder.html" title="class in org.eclipse.persistence.expressions">ExpressionBuilder</a> newRoot)</code> |
| <div class="block">INTERNAL: |
| Extract the nested attribute expressions that apply to this mapping.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#extractNestedNonAggregateExpressions-java.util.List-org.eclipse.persistence.expressions.ExpressionBuilder-boolean-">extractNestedNonAggregateExpressions</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a>> expressions, |
| <a href="../../../../org/eclipse/persistence/expressions/ExpressionBuilder.html" title="class in org.eclipse.persistence.expressions">ExpressionBuilder</a> newRoot, |
| boolean rootExpressionsAllowed)</code> |
| <div class="block">INTERNAL: |
| Extract the nested attribute expressions that apply to this mapping.</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#fixObjectReferences-java.lang.Object-java.util.Map-java.util.Map-org.eclipse.persistence.queries.ObjectLevelReadQuery-org.eclipse.persistence.sessions.remote.DistributedSession-">fixObjectReferences</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> objectDescriptors, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> processedObjects, |
| <a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html" title="class in org.eclipse.persistence.queries">ObjectLevelReadQuery</a> query, |
| <a href="../../../../org/eclipse/persistence/sessions/remote/DistributedSession.html" title="class in org.eclipse.persistence.sessions.remote">DistributedSession</a> session)</code> |
| <div class="block">INTERNAL: |
| An object has been serialized from the server to the client.</div> |
| </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#fixRealObjectReferences-java.lang.Object-java.util.Map-java.util.Map-org.eclipse.persistence.queries.ObjectLevelReadQuery-org.eclipse.persistence.sessions.remote.DistributedSession-">fixRealObjectReferences</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> objectInformation, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> processedObjects, |
| <a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html" title="class in org.eclipse.persistence.queries">ObjectLevelReadQuery</a> query, |
| <a href="../../../../org/eclipse/persistence/sessions/remote/DistributedSession.html" title="class in org.eclipse.persistence.sessions.remote">DistributedSession</a> session)</code> |
| <div class="block">INTERNAL: |
| At this point, we realize we don't have indirection; |
| so we need to replace the reference object(s) with |
| the corresponding object(s) from the remote session.</div> |
| </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/eclipse/persistence/mappings/AttributeAccessor.html" title="class in org.eclipse.persistence.mappings">AttributeAccessor</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#getAttributeAccessor--">getAttributeAccessor</a></span>()</code> |
| <div class="block">ADVANCED: |
| Return the attributeAccessor.</div> |
| </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#getAttributeClassification--">getAttributeClassification</a></span>()</code> |
| <div class="block">PUBLIC: |
| The classification type for the attribute this mapping represents</div> |
| </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <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/mappings/DatabaseMapping.html#getAttributeName--">getAttributeName</a></span>()</code> |
| <div class="block">PUBLIC: |
| Return the name of the attribute set in the mapping.</div> |
| </td> |
| </tr> |
| <tr id="i36" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#getAttributeValueFromObject-java.lang.Object-">getAttributeValueFromObject</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object)</code> |
| <div class="block">INTERNAL: |
| Return the value of an attribute which this mapping represents for an object.</div> |
| </td> |
| </tr> |
| <tr id="i37" class="rowColor"> |
| <td class="colFirst"><code>org.eclipse.persistence.internal.queries.ContainerPolicy</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#getContainerPolicy--">getContainerPolicy</a></span>()</code> |
| <div class="block">INTERNAL: |
| Return the mapping's containerPolicy.</div> |
| </td> |
| </tr> |
| <tr id="i38" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#getDerivedIdMapping--">getDerivedIdMapping</a></span>()</code> |
| <div class="block">ADVANCED: |
| Set the maps id value</div> |
| </td> |
| </tr> |
| <tr id="i39" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#getDescriptor--">getDescriptor</a></span>()</code> |
| <div class="block">INTERNAL: |
| Return the descriptor to which this mapping belongs</div> |
| </td> |
| </tr> |
| <tr id="i40" class="altColor"> |
| <td class="colFirst"><code>org.eclipse.persistence.internal.helper.DatabaseField</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#getField--">getField</a></span>()</code> |
| <div class="block">INTERNAL: |
| Return the field associated with this mapping if there is exactly one.</div> |
| </td> |
| </tr> |
| <tr id="i41" 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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#getFieldClassification-org.eclipse.persistence.internal.helper.DatabaseField-">getFieldClassification</a></span>(org.eclipse.persistence.internal.helper.DatabaseField fieldToClassify)</code> |
| <div class="block">INTERNAL: |
| Return the classification for the field contained in the mapping.</div> |
| </td> |
| </tr> |
| <tr id="i42" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a><org.eclipse.persistence.internal.helper.DatabaseField></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#getFields--">getFields</a></span>()</code> |
| <div class="block">INTERNAL: |
| Returns a vector of all the fields this mapping represents.</div> |
| </td> |
| </tr> |
| <tr id="i43" class="rowColor"> |
| <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/mappings/DatabaseMapping.html#getGetMethodName--">getGetMethodName</a></span>()</code> |
| <div class="block">PUBLIC: |
| This method is invoked reflectively on the reference object to return the value of the |
| attribute in the object.</div> |
| </td> |
| </tr> |
| <tr id="i44" 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/mappings/DatabaseMapping.html#getMapsIdValue--">getMapsIdValue</a></span>()</code> |
| <div class="block">ADVANCED: |
| Set the mapped by id value</div> |
| </td> |
| </tr> |
| <tr id="i45" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#getObjectCorrespondingTo-java.lang.Object-org.eclipse.persistence.sessions.remote.DistributedSession-java.util.Map-java.util.Map-org.eclipse.persistence.queries.ObjectLevelReadQuery-">getObjectCorrespondingTo</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object, |
| <a href="../../../../org/eclipse/persistence/sessions/remote/DistributedSession.html" title="class in org.eclipse.persistence.sessions.remote">DistributedSession</a> session, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> objectDescriptors, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> processedObjects, |
| <a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html" title="class in org.eclipse.persistence.queries">ObjectLevelReadQuery</a> query)</code> |
| <div class="block">INTERNAL: |
| return the object on the client corresponding to the specified object.</div> |
| </td> |
| </tr> |
| <tr id="i46" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#getOrderByNormalizedExpressions-org.eclipse.persistence.expressions.Expression-">getOrderByNormalizedExpressions</a></span>(<a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a> base)</code> |
| <div class="block">INTERNAL: |
| Return the list of fields that should be used if this mapping is used in an order by.</div> |
| </td> |
| </tr> |
| <tr id="i47" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#getProperties--">getProperties</a></span>()</code> |
| <div class="block">INTERNAL: |
| used as a temporary store for custom SDK usage</div> |
| </td> |
| </tr> |
| <tr id="i48" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#getProperty-java.lang.Object-">getProperty</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> property)</code> |
| <div class="block">ADVANCED: |
| Allow user defined properties.</div> |
| </td> |
| </tr> |
| <tr id="i49" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#getRealAttributeValueFromAttribute-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-">getRealAttributeValueFromAttribute</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> attributeValue, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</code> |
| <div class="block">INTERNAL: |
| Return the value of an attribute unwrapping value holders if required.</div> |
| </td> |
| </tr> |
| <tr id="i50" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#getRealAttributeValueFromObject-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-">getRealAttributeValueFromObject</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</code> |
| <div class="block">INTERNAL: |
| Return the value of an attribute unwrapping value holders if required.</div> |
| </td> |
| </tr> |
| <tr id="i51" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#getRealCollectionAttributeValueFromObject-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-">getRealCollectionAttributeValueFromObject</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</code> |
| <div class="block">INTERNAL: |
| Return the value of an attribute, unwrapping value holders if necessary.</div> |
| </td> |
| </tr> |
| <tr id="i52" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#getReferenceDescriptor--">getReferenceDescriptor</a></span>()</code> |
| <div class="block">PUBLIC: |
| Return the referenceDescriptor.</div> |
| </td> |
| </tr> |
| <tr id="i53" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#getRelationshipPartner--">getRelationshipPartner</a></span>()</code> |
| <div class="block">INTERNAL: |
| Return the relationshipPartner mapping for this bi-directional mapping.</div> |
| </td> |
| </tr> |
| <tr id="i54" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#getSelectFields--">getSelectFields</a></span>()</code> |
| <div class="block">INTERNAL: |
| Returns the set of fields that should be selected to build this mapping's value(s).</div> |
| </td> |
| </tr> |
| <tr id="i55" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#getSelectTables--">getSelectTables</a></span>()</code> |
| <div class="block">INTERNAL: |
| Returns the table(s) that should be selected to build this mapping's value(s).</div> |
| </td> |
| </tr> |
| <tr id="i56" 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/mappings/DatabaseMapping.html#getSetMethodName--">getSetMethodName</a></span>()</code> |
| <div class="block">PUBLIC: |
| This method is invoked reflectively on the reference object to set the value of the |
| attribute in the object.</div> |
| </td> |
| </tr> |
| <tr id="i57" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<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>,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<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/mappings/DatabaseMapping.html#getUnconvertedProperties--">getUnconvertedProperties</a></span>()</code> |
| <div class="block">INTERNAL: |
| Used to store un-converted properties, which are subsequenctly converted |
| at runtime (through the convertClassNamesToClasses method.</div> |
| </td> |
| </tr> |
| <tr id="i58" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#getValueFromRemoteValueHolder-org.eclipse.persistence.internal.sessions.remote.RemoteValueHolder-">getValueFromRemoteValueHolder</a></span>(org.eclipse.persistence.internal.sessions.remote.RemoteValueHolder remoteValueHolder)</code> |
| <div class="block">INTERNAL: |
| extract and return the appropriate value from the |
| specified remote value holder</div> |
| </td> |
| </tr> |
| <tr id="i59" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#getWeight--">getWeight</a></span>()</code> |
| <div class="block">INTERNAL: |
| Return the weight of the mapping, used to sort mappings to ensure that |
| DirectToField Mappings get merged first</div> |
| </td> |
| </tr> |
| <tr id="i60" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#hasConstraintDependency--">hasConstraintDependency</a></span>()</code> |
| <div class="block">INTERNAL: |
| The returns if the mapping has any constraint dependencies, such as foreign keys and join tables.</div> |
| </td> |
| </tr> |
| <tr id="i61" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#hasDependency--">hasDependency</a></span>()</code> |
| <div class="block">INTERNAL: |
| Return if the mapping has any ownership or other dependency over its target object(s).</div> |
| </td> |
| </tr> |
| <tr id="i62" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#hasInverseConstraintDependency--">hasInverseConstraintDependency</a></span>()</code> |
| <div class="block">INTERNAL: |
| The returns if the mapping has any inverse constraint dependencies, such as foreign keys and join tables.</div> |
| </td> |
| </tr> |
| <tr id="i63" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#hasMapsIdValue--">hasMapsIdValue</a></span>()</code> |
| <div class="block">ADVANCED: |
| Set the mapped by id value</div> |
| </td> |
| </tr> |
| <tr id="i64" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#hasNestedIdentityReference--">hasNestedIdentityReference</a></span>()</code> |
| <div class="block">INTERNAL: |
| Indicates whether the mapping (or at least one of its nested mappings, at any nested depth) |
| references an entity.</div> |
| </td> |
| </tr> |
| <tr id="i65" class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#hasRootExpressionThatShouldUseOuterJoin-java.util.List-">hasRootExpressionThatShouldUseOuterJoin</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a> expressions)</code> |
| <div class="block">INTERNAL: |
| If there is root expression in the list then indicates whether it shouldUseOuterJoin, |
| otherwise return false.</div> |
| </td> |
| </tr> |
| <tr id="i66" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#hasUnconvertedProperties--">hasUnconvertedProperties</a></span>()</code> |
| <div class="block">INTERNAL: |
| Used to store un-converted properties, which are subsequenctly converted |
| at runtime (through the convertClassNamesToClasses method.</div> |
| </td> |
| </tr> |
| <tr id="i67" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#initialize-org.eclipse.persistence.internal.sessions.AbstractSession-">initialize</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession session)</code> |
| <div class="block">INTERNAL: |
| Allow for initialization of properties and validation.</div> |
| </td> |
| </tr> |
| <tr id="i68" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#instantiateAttribute-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-">instantiateAttribute</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</code> |
| <div class="block">INTERNAL: |
| Trigger the instantiation of the attribute if lazy.</div> |
| </td> |
| </tr> |
| <tr id="i69" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isAbstractColumnMapping--">isAbstractColumnMapping</a></span>()</code> |
| <div class="block">INTERNAL:</div> |
| </td> |
| </tr> |
| <tr id="i70" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isAbstractCompositeCollectionMapping--">isAbstractCompositeCollectionMapping</a></span>()</code> |
| <div class="block">INTERNAL: |
| Related mapping should implement this method to return true.</div> |
| </td> |
| </tr> |
| <tr id="i71" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isAbstractCompositeDirectCollectionMapping--">isAbstractCompositeDirectCollectionMapping</a></span>()</code> |
| <div class="block">INTERNAL: |
| Related mapping should implement this method to return true.</div> |
| </td> |
| </tr> |
| <tr id="i72" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isAbstractCompositeObjectMapping--">isAbstractCompositeObjectMapping</a></span>()</code> |
| <div class="block">INTERNAL: |
| Related mapping should implement this method to return true.</div> |
| </td> |
| </tr> |
| <tr id="i73" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isAbstractDirectMapping--">isAbstractDirectMapping</a></span>()</code> |
| <div class="block">INTERNAL: |
| Related mapping should implement this method to return true.</div> |
| </td> |
| </tr> |
| <tr id="i74" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isAggregateCollectionMapping--">isAggregateCollectionMapping</a></span>()</code> |
| <div class="block">INTERNAL: |
| Related mapping should implement this method to return true.</div> |
| </td> |
| </tr> |
| <tr id="i75" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isAggregateMapping--">isAggregateMapping</a></span>()</code> |
| <div class="block">INTERNAL: |
| Related mapping should implement this method to return true.</div> |
| </td> |
| </tr> |
| <tr id="i76" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isAggregateObjectMapping--">isAggregateObjectMapping</a></span>()</code> |
| <div class="block">INTERNAL: |
| Related mapping should implement this method to return true.</div> |
| </td> |
| </tr> |
| <tr id="i77" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isAttributeValueFromObjectInstantiated-java.lang.Object-">isAttributeValueFromObjectInstantiated</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object)</code> |
| <div class="block">INTERNAL: |
| Return whether the specified object is instantiated.</div> |
| </td> |
| </tr> |
| <tr id="i78" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isCacheable--">isCacheable</a></span>()</code> |
| <div class="block">Used to signal that this mapping references a protected/isolated entity and requires |
| special merge/object building behaviour.</div> |
| </td> |
| </tr> |
| <tr id="i79" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isCandidateForPrivateOwnedRemoval--">isCandidateForPrivateOwnedRemoval</a></span>()</code> |
| <div class="block">INTERNAL: |
| Returns true if the mapping should be added to the UnitOfWork's list of private owned |
| objects for private owned orphan removal.</div> |
| </td> |
| </tr> |
| <tr id="i80" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isCascadedLockingSupported--">isCascadedLockingSupported</a></span>()</code> |
| <div class="block">INTERNAL: |
| Used when determining if a mapping supports cascaded version optimistic |
| locking.</div> |
| </td> |
| </tr> |
| <tr id="i81" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isChangeTrackingSupported-org.eclipse.persistence.sessions.Project-">isChangeTrackingSupported</a></span>(<a href="../../../../org/eclipse/persistence/sessions/Project.html" title="class in org.eclipse.persistence.sessions">Project</a> project)</code> |
| <div class="block">INTERNAL: |
| Return if this mapping supports change tracking.</div> |
| </td> |
| </tr> |
| <tr id="i82" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isCloningRequired--">isCloningRequired</a></span>()</code> |
| <div class="block">INTERNAL: |
| Return if this mapping requires its attribute value to be cloned.</div> |
| </td> |
| </tr> |
| <tr id="i83" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isCollectionMapping--">isCollectionMapping</a></span>()</code> |
| <div class="block">INTERNAL: |
| Related mapping should implement this method to return true.</div> |
| </td> |
| </tr> |
| <tr id="i84" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isDatabaseMapping--">isDatabaseMapping</a></span>()</code> |
| <div class="block">INTERNAL:</div> |
| </td> |
| </tr> |
| <tr id="i85" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isDirectCollectionMapping--">isDirectCollectionMapping</a></span>()</code> |
| <div class="block">INTERNAL: |
| Related mapping should implement this method to return true.</div> |
| </td> |
| </tr> |
| <tr id="i86" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isDirectMapMapping--">isDirectMapMapping</a></span>()</code> |
| <div class="block">INTERNAL: |
| Related mapping should implement this method to return true.</div> |
| </td> |
| </tr> |
| <tr id="i87" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isDirectToFieldMapping--">isDirectToFieldMapping</a></span>()</code> |
| <div class="block">INTERNAL: |
| Related mapping should implement this method to return true.</div> |
| </td> |
| </tr> |
| <tr id="i88" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isDirectToXMLTypeMapping--">isDirectToXMLTypeMapping</a></span>()</code> |
| <div class="block">INTERNAL: |
| Related mapping should implement this method to return true.</div> |
| </td> |
| </tr> |
| <tr id="i89" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isEISMapping--">isEISMapping</a></span>()</code> |
| <div class="block">INTERNAL: |
| All EIS mappings should implement this method to return true.</div> |
| </td> |
| </tr> |
| <tr id="i90" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isElementCollectionMapping--">isElementCollectionMapping</a></span>()</code> |
| <div class="block">INTERNAL: |
| Related mapping should implement this method to return true.</div> |
| </td> |
| </tr> |
| <tr id="i91" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isForeignReferenceMapping--">isForeignReferenceMapping</a></span>()</code> |
| <div class="block">INTERNAL: |
| Related mapping should implement this method to return true.</div> |
| </td> |
| </tr> |
| <tr id="i92" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isInAndOutSopObject--">isInAndOutSopObject</a></span>()</code> |
| <div class="block">INTERNAL: |
| Indicates whether the mapping is both in and out of SerializedObjectPolicy's sopObject.</div> |
| </td> |
| </tr> |
| <tr id="i93" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isInOnlySopObject--">isInOnlySopObject</a></span>()</code> |
| <div class="block">INTERNAL: |
| Indicates whether the mapping is in SerializedObjectPolicy's sopObject and not out of it.</div> |
| </td> |
| </tr> |
| <tr id="i94" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isInSopObject--">isInSopObject</a></span>()</code> |
| <div class="block">INTERNAL: |
| Indicates whether the mapping is in SerializedObjectPolicy's sopObject.</div> |
| </td> |
| </tr> |
| <tr id="i95" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isJoiningSupported--">isJoiningSupported</a></span>()</code> |
| <div class="block">INTERNAL: |
| Return if this mapping support joining.</div> |
| </td> |
| </tr> |
| <tr id="i96" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isJPAId--">isJPAId</a></span>()</code> |
| <div class="block">INTERNAL: |
| Flags that this mapping is part of a JPA id mapping.</div> |
| </td> |
| </tr> |
| <tr id="i97" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isLazy--">isLazy</a></span>()</code> |
| <div class="block">Return if this mapping is lazy.</div> |
| </td> |
| </tr> |
| <tr id="i98" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isLockableMapping--">isLockableMapping</a></span>()</code> |
| <div class="block">INTERNAL: |
| Return whether this mapping should be traversed when we are locking</div> |
| </td> |
| </tr> |
| <tr id="i99" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isManyToManyMapping--">isManyToManyMapping</a></span>()</code> |
| <div class="block">INTERNAL: |
| Related mapping should implement this method to return true.</div> |
| </td> |
| </tr> |
| <tr id="i100" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isManyToOneMapping--">isManyToOneMapping</a></span>()</code> |
| <div class="block">INTERNAL: |
| Related mapping should implement this method to return true.</div> |
| </td> |
| </tr> |
| <tr id="i101" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isMapKeyMapping--">isMapKeyMapping</a></span>()</code> </td> |
| </tr> |
| <tr id="i102" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isMultitenantPrimaryKeyMapping--">isMultitenantPrimaryKeyMapping</a></span>()</code> |
| <div class="block">INTERNAL</div> |
| </td> |
| </tr> |
| <tr id="i103" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isNestedTableMapping--">isNestedTableMapping</a></span>()</code> |
| <div class="block">INTERNAL: |
| Related mapping should implement this method to return true.</div> |
| </td> |
| </tr> |
| <tr id="i104" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isObjectReferenceMapping--">isObjectReferenceMapping</a></span>()</code> |
| <div class="block">INTERNAL: |
| Related mapping should implement this method to return true.</div> |
| </td> |
| </tr> |
| <tr id="i105" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isOneToManyMapping--">isOneToManyMapping</a></span>()</code> |
| <div class="block">INTERNAL: |
| Related mapping should implement this method to return true.</div> |
| </td> |
| </tr> |
| <tr id="i106" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isOneToOneMapping--">isOneToOneMapping</a></span>()</code> |
| <div class="block">INTERNAL: |
| Related mapping should implement this method to return true.</div> |
| </td> |
| </tr> |
| <tr id="i107" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isOptional--">isOptional</a></span>()</code> |
| <div class="block">Return whether the value of this mapping is optional (that is, can be |
| null).</div> |
| </td> |
| </tr> |
| <tr id="i108" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isOutOnlySopObject--">isOutOnlySopObject</a></span>()</code> |
| <div class="block">INTERNAL: |
| Indicates whether the mapping is out of SerializedObjectPolicy's sopObject and not in it.</div> |
| </td> |
| </tr> |
| <tr id="i109" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isOutSopObject--">isOutSopObject</a></span>()</code> |
| <div class="block">INTERNAL: |
| Indicates whether the mapping is out of SerializedObjectPolicy's sopObject.</div> |
| </td> |
| </tr> |
| <tr id="i110" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isOwned--">isOwned</a></span>()</code> |
| <div class="block">Returns true if this mapping is owned by the parent descriptor.</div> |
| </td> |
| </tr> |
| <tr id="i111" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isPrimaryKeyMapping--">isPrimaryKeyMapping</a></span>()</code> |
| <div class="block">INTERNAL: |
| Set by the Object builder during initialization returns true if this mapping |
| is used as a primary key mapping.</div> |
| </td> |
| </tr> |
| <tr id="i112" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isPrivateOwned--">isPrivateOwned</a></span>()</code> |
| <div class="block">INTERNAL: |
| Return if the mapping has ownership over its target object(s).</div> |
| </td> |
| </tr> |
| <tr id="i113" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isReadOnly--">isReadOnly</a></span>()</code> |
| <div class="block">INTERNAL: |
| Returns true if mapping is read only else false.</div> |
| </td> |
| </tr> |
| <tr id="i114" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isReferenceMapping--">isReferenceMapping</a></span>()</code> |
| <div class="block">INTERNAL: |
| Related mapping should implement this method to return true.</div> |
| </td> |
| </tr> |
| <tr id="i115" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isRelationalMapping--">isRelationalMapping</a></span>()</code> |
| <div class="block">INTERNAL: |
| All relational mappings should implement this method to return true.</div> |
| </td> |
| </tr> |
| <tr id="i116" class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isRemotelyInitialized--">isRemotelyInitialized</a></span>()</code> </td> |
| </tr> |
| <tr id="i117" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isStructureMapping--">isStructureMapping</a></span>()</code> |
| <div class="block">INTERNAL: |
| Related mapping should implement this method to return true.</div> |
| </td> |
| </tr> |
| <tr id="i118" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isTransformationMapping--">isTransformationMapping</a></span>()</code> |
| <div class="block">INTERNAL: |
| Related mapping should implement this method to return true.</div> |
| </td> |
| </tr> |
| <tr id="i119" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isUnidirectionalOneToManyMapping--">isUnidirectionalOneToManyMapping</a></span>()</code> |
| <div class="block">INTERNAL:</div> |
| </td> |
| </tr> |
| <tr id="i120" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isUsingMethodAccess--">isUsingMethodAccess</a></span>()</code> |
| <div class="block">PUBLIC: |
| Return if method access is used.</div> |
| </td> |
| </tr> |
| <tr id="i121" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isVariableOneToOneMapping--">isVariableOneToOneMapping</a></span>()</code> |
| <div class="block">INTERNAL: |
| Related mapping should implement this method to return true.</div> |
| </td> |
| </tr> |
| <tr id="i122" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isWriteOnly--">isWriteOnly</a></span>()</code> |
| <div class="block">INTERNAL: |
| Some mappings support no attribute (transformation and multitenant primary key).</div> |
| </td> |
| </tr> |
| <tr id="i123" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#isXMLMapping--">isXMLMapping</a></span>()</code> |
| <div class="block">INTERNAL: |
| All relational mappings should implement this method to return true.</div> |
| </td> |
| </tr> |
| <tr id="i124" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#iterate-org.eclipse.persistence.internal.descriptors.DescriptorIterator-">iterate</a></span>(org.eclipse.persistence.internal.descriptors.DescriptorIterator iterator)</code> |
| <div class="block">INTERNAL: |
| Iterate on the appropriate attribute value.</div> |
| </td> |
| </tr> |
| <tr id="i125" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#iterateOnRealAttributeValue-org.eclipse.persistence.internal.descriptors.DescriptorIterator-java.lang.Object-">iterateOnRealAttributeValue</a></span>(org.eclipse.persistence.internal.descriptors.DescriptorIterator iterator, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> realAttributeValue)</code> |
| <div class="block">INTERNAL: |
| Iterate on the attribute value.</div> |
| </td> |
| </tr> |
| <tr id="i126" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#load-java.lang.Object-org.eclipse.persistence.internal.queries.AttributeItem-org.eclipse.persistence.internal.sessions.AbstractSession-boolean-">load</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object, |
| org.eclipse.persistence.internal.queries.AttributeItem item, |
| org.eclipse.persistence.internal.sessions.AbstractSession session, |
| boolean fromFetchGroup)</code> |
| <div class="block">Force instantiation of the load group.</div> |
| </td> |
| </tr> |
| <tr id="i127" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#loadAll-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-org.eclipse.persistence.internal.helper.IdentityHashSet-">loadAll</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object, |
| org.eclipse.persistence.internal.sessions.AbstractSession session, |
| org.eclipse.persistence.internal.helper.IdentityHashSet loaded)</code> |
| <div class="block">Force instantiation of all indirections.</div> |
| </td> |
| </tr> |
| <tr id="i128" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#mergeChangesIntoObject-java.lang.Object-org.eclipse.persistence.internal.sessions.ChangeRecord-java.lang.Object-org.eclipse.persistence.internal.sessions.MergeManager-org.eclipse.persistence.internal.sessions.AbstractSession-">mergeChangesIntoObject</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> target, |
| org.eclipse.persistence.internal.sessions.ChangeRecord changeRecord, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> source, |
| org.eclipse.persistence.internal.sessions.MergeManager mergeManager, |
| org.eclipse.persistence.internal.sessions.AbstractSession targetSession)</code> |
| <div class="block">INTERNAL: |
| Merge changes from the source to the target object.</div> |
| </td> |
| </tr> |
| <tr id="i129" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#mergeIntoObject-java.lang.Object-boolean-java.lang.Object-org.eclipse.persistence.internal.sessions.MergeManager-org.eclipse.persistence.internal.sessions.AbstractSession-">mergeIntoObject</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> target, |
| boolean isTargetUninitialized, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> source, |
| org.eclipse.persistence.internal.sessions.MergeManager mergeManager, |
| org.eclipse.persistence.internal.sessions.AbstractSession targetSession)</code> |
| <div class="block">INTERNAL: |
| Merge changes from the source to the target object.</div> |
| </td> |
| </tr> |
| <tr id="i130" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#performDataModificationEvent-java.lang.Object:A-org.eclipse.persistence.internal.sessions.AbstractSession-">performDataModificationEvent</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>[] event, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</code> |
| <div class="block">INTERNAL: |
| Perform the commit event.</div> |
| </td> |
| </tr> |
| <tr id="i131" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#postCalculateChanges-org.eclipse.persistence.sessions.changesets.ChangeRecord-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-">postCalculateChanges</a></span>(<a href="../../../../org/eclipse/persistence/sessions/changesets/ChangeRecord.html" title="interface in org.eclipse.persistence.sessions.changesets">ChangeRecord</a> changeRecord, |
| org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow)</code> |
| <div class="block">INTERNAL: |
| Overridden by mappings that require additional processing of the change record after the record has been calculated.</div> |
| </td> |
| </tr> |
| <tr id="i132" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#postCalculateChangesOnDeleted-java.lang.Object-org.eclipse.persistence.internal.sessions.UnitOfWorkChangeSet-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-">postCalculateChangesOnDeleted</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> deletedObject, |
| org.eclipse.persistence.internal.sessions.UnitOfWorkChangeSet uowChangeSet, |
| org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow)</code> |
| <div class="block">INTERNAL: |
| Overridden by mappings that require objects to be deleted contribute to change set creation.</div> |
| </td> |
| </tr> |
| <tr id="i133" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#postDelete-org.eclipse.persistence.queries.DeleteObjectQuery-">postDelete</a></span>(<a href="../../../../org/eclipse/persistence/queries/DeleteObjectQuery.html" title="class in org.eclipse.persistence.queries">DeleteObjectQuery</a> query)</code> |
| <div class="block">INTERNAL: |
| A subclass should implement this method if it wants different behavior.</div> |
| </td> |
| </tr> |
| <tr id="i134" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#postInitialize-org.eclipse.persistence.internal.sessions.AbstractSession-">postInitialize</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession session)</code> |
| <div class="block">INTERNAL: |
| Allow for initialization of properties and validation that have dependecies no the descriptor |
| being initialized.</div> |
| </td> |
| </tr> |
| <tr id="i135" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#postInitializeSourceAndTargetExpressions--">postInitializeSourceAndTargetExpressions</a></span>()</code> |
| <div class="block">INTERNAL: |
| Mapping callback for post-initialization of source and target expression fields |
| created when a mapping's selectionCriteria is created early with uninitialized fields.</div> |
| </td> |
| </tr> |
| <tr id="i136" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#postInsert-org.eclipse.persistence.queries.WriteObjectQuery-">postInsert</a></span>(<a href="../../../../org/eclipse/persistence/queries/WriteObjectQuery.html" title="class in org.eclipse.persistence.queries">WriteObjectQuery</a> query)</code> |
| <div class="block">INTERNAL: |
| A subclass should implement this method if it wants different behavior.</div> |
| </td> |
| </tr> |
| <tr id="i137" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#postUpdate-org.eclipse.persistence.queries.WriteObjectQuery-">postUpdate</a></span>(<a href="../../../../org/eclipse/persistence/queries/WriteObjectQuery.html" title="class in org.eclipse.persistence.queries">WriteObjectQuery</a> query)</code> |
| <div class="block">INTERNAL: |
| A subclass should implement this method if it wants different behavior.</div> |
| </td> |
| </tr> |
| <tr id="i138" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#preDelete-org.eclipse.persistence.queries.DeleteObjectQuery-">preDelete</a></span>(<a href="../../../../org/eclipse/persistence/queries/DeleteObjectQuery.html" title="class in org.eclipse.persistence.queries">DeleteObjectQuery</a> query)</code> |
| <div class="block">INTERNAL: |
| A subclass should implement this method if it wants different behavior.</div> |
| </td> |
| </tr> |
| <tr id="i139" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#preInitialize-org.eclipse.persistence.internal.sessions.AbstractSession-">preInitialize</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession session)</code> |
| <div class="block">INTERNAL: |
| Allow for initialization of properties and validation.</div> |
| </td> |
| </tr> |
| <tr id="i140" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#preInsert-org.eclipse.persistence.queries.WriteObjectQuery-">preInsert</a></span>(<a href="../../../../org/eclipse/persistence/queries/WriteObjectQuery.html" title="class in org.eclipse.persistence.queries">WriteObjectQuery</a> query)</code> |
| <div class="block">INTERNAL: |
| A subclass should implement this method if it wants different behavior.</div> |
| </td> |
| </tr> |
| <tr id="i141" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#prepareCascadeLockingPolicy--">prepareCascadeLockingPolicy</a></span>()</code> |
| <div class="block">INTERNAL: |
| A subclass that supports cascade version optimistic locking should |
| implement this method to properly prepare the locking policy for their |
| mapping type.</div> |
| </td> |
| </tr> |
| <tr id="i142" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#preUpdate-org.eclipse.persistence.queries.WriteObjectQuery-">preUpdate</a></span>(<a href="../../../../org/eclipse/persistence/queries/WriteObjectQuery.html" title="class in org.eclipse.persistence.queries">WriteObjectQuery</a> query)</code> |
| <div class="block">INTERNAL: |
| A subclass should implement this method if it wants different behavior.</div> |
| </td> |
| </tr> |
| <tr id="i143" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#readFromResultSetIntoObject-java.sql.ResultSet-java.lang.Object-org.eclipse.persistence.queries.ObjectBuildingQuery-org.eclipse.persistence.internal.sessions.AbstractSession-org.eclipse.persistence.internal.databaseaccess.DatabaseAccessor-java.sql.ResultSetMetaData-int-org.eclipse.persistence.internal.databaseaccess.DatabasePlatform-">readFromResultSetIntoObject</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSet.html?is-external=true" title="class or interface in java.sql">ResultSet</a> resultSet, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> targetObject, |
| <a href="../../../../org/eclipse/persistence/queries/ObjectBuildingQuery.html" title="class in org.eclipse.persistence.queries">ObjectBuildingQuery</a> query, |
| org.eclipse.persistence.internal.sessions.AbstractSession session, |
| org.eclipse.persistence.internal.databaseaccess.DatabaseAccessor accessor, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSetMetaData.html?is-external=true" title="class or interface in java.sql">ResultSetMetaData</a> metaData, |
| int columnNumber, |
| org.eclipse.persistence.internal.databaseaccess.DatabasePlatform platform)</code> |
| <div class="block">INTERNAL: |
| Extract values directly from the result-set.</div> |
| </td> |
| </tr> |
| <tr id="i144" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#readFromRowIntoObject-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.queries.JoinedAttributeManager-java.lang.Object-org.eclipse.persistence.internal.identitymaps.CacheKey-org.eclipse.persistence.queries.ObjectBuildingQuery-org.eclipse.persistence.internal.sessions.AbstractSession-boolean-">readFromRowIntoObject</a></span>(org.eclipse.persistence.internal.sessions.AbstractRecord databaseRow, |
| org.eclipse.persistence.internal.queries.JoinedAttributeManager joinManager, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> targetObject, |
| org.eclipse.persistence.internal.identitymaps.CacheKey parentCacheKey, |
| <a href="../../../../org/eclipse/persistence/queries/ObjectBuildingQuery.html" title="class in org.eclipse.persistence.queries">ObjectBuildingQuery</a> sourceQuery, |
| org.eclipse.persistence.internal.sessions.AbstractSession executionSession, |
| boolean isTargetProtected)</code> |
| <div class="block">INTERNAL: |
| Extract value from the row and set the attribute to this value in the object.</div> |
| </td> |
| </tr> |
| <tr id="i145" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#readOnly--">readOnly</a></span>()</code> |
| <div class="block">PUBLIC: |
| To make mapping read only.</div> |
| </td> |
| </tr> |
| <tr id="i146" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#readWrite--">readWrite</a></span>()</code> |
| <div class="block">PUBLIC: |
| The mapping can be dynamically made either readOnly or readWriteOnly.</div> |
| </td> |
| </tr> |
| <tr id="i147" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#recordPrivateOwnedRemovals-java.lang.Object-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-">recordPrivateOwnedRemovals</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object, |
| org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow)</code> |
| <div class="block">INTERNAL: |
| Overridden by mappings that require objects to be deleted contribute to change set creation.</div> |
| </td> |
| </tr> |
| <tr id="i148" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#rehashFieldDependancies-org.eclipse.persistence.internal.sessions.AbstractSession-">rehashFieldDependancies</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession session)</code> |
| <div class="block">INTERNAL: |
| Rehash any hashtables based on fields.</div> |
| </td> |
| </tr> |
| <tr id="i149" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#remoteInitialization-org.eclipse.persistence.sessions.remote.DistributedSession-">remoteInitialization</a></span>(<a href="../../../../org/eclipse/persistence/sessions/remote/DistributedSession.html" title="class in org.eclipse.persistence.sessions.remote">DistributedSession</a> session)</code> |
| <div class="block">INTERNAL: |
| Once descriptors are serialized to the remote session.</div> |
| </td> |
| </tr> |
| <tr id="i150" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#remotelyInitialized--">remotelyInitialized</a></span>()</code> |
| <div class="block">Set the mapping to be initialized for the remote session.</div> |
| </td> |
| </tr> |
| <tr id="i151" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#replaceValueHoldersIn-java.lang.Object-org.eclipse.persistence.internal.sessions.remote.RemoteSessionController-">replaceValueHoldersIn</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object, |
| org.eclipse.persistence.internal.sessions.remote.RemoteSessionController controller)</code> |
| <div class="block">INTERNAL: |
| replace the value holders in the specified reference object(s)</div> |
| </td> |
| </tr> |
| <tr id="i152" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#setAttributeAccessor-org.eclipse.persistence.mappings.AttributeAccessor-">setAttributeAccessor</a></span>(<a href="../../../../org/eclipse/persistence/mappings/AttributeAccessor.html" title="class in org.eclipse.persistence.mappings">AttributeAccessor</a> attributeAccessor)</code> |
| <div class="block">ADVANCED: |
| Set the attributeAccessor.</div> |
| </td> |
| </tr> |
| <tr id="i153" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#setAttributeName-java.lang.String-">setAttributeName</a></span>(<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> attributeName)</code> |
| <div class="block">PUBLIC: |
| Sets the name of the attribute in the mapping.</div> |
| </td> |
| </tr> |
| <tr id="i154" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#setAttributeValueInObject-java.lang.Object-java.lang.Object-">setAttributeValueInObject</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</code> |
| <div class="block">INTERNAL: |
| Set the value of the attribute mapped by this mapping.</div> |
| </td> |
| </tr> |
| <tr id="i155" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#setChangeListener-java.lang.Object-java.beans.PropertyChangeListener-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-">setChangeListener</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> clone, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeListener.html?is-external=true" title="class or interface in java.beans">PropertyChangeListener</a> listener, |
| org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow)</code> |
| <div class="block">INTERNAL: |
| Set the change listener if required.</div> |
| </td> |
| </tr> |
| <tr id="i156" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#setDerivedIdMapping-org.eclipse.persistence.mappings.DatabaseMapping-">setDerivedIdMapping</a></span>(<a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a> derivedIdMapping)</code> |
| <div class="block">ADVANCED: |
| Used to indicate the mapping references a JPA ID or MapsId attribute |
| for the CMP3Policy and JPA Id classes (as well as Embeddable Id classes).</div> |
| </td> |
| </tr> |
| <tr id="i157" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#setDerivesId-boolean-">setDerivesId</a></span>(boolean derivesId)</code> |
| <div class="block">ADVANCED: |
| Used to indicate the mapping references a JPA ID or MapsId attribute |
| for the CMP3Policy and JPA Id classes (as well as Embeddable Id classes).</div> |
| </td> |
| </tr> |
| <tr id="i158" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#setDescriptor-org.eclipse.persistence.descriptors.ClassDescriptor-">setDescriptor</a></span>(<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a> descriptor)</code> |
| <div class="block">INTERNAL: |
| Set the descriptor to which this mapping belongs</div> |
| </td> |
| </tr> |
| <tr id="i159" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#setFields-java.util.Vector-">setFields</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a><org.eclipse.persistence.internal.helper.DatabaseField> fields)</code> |
| <div class="block">INTERNAL: |
| Set the mapping's field collection.</div> |
| </td> |
| </tr> |
| <tr id="i160" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#setGetMethodName-java.lang.String-">setGetMethodName</a></span>(<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> methodName)</code> |
| <div class="block">PUBLIC: |
| This method is invoked reflectively on the reference object to return the value of the |
| attribute in the object.</div> |
| </td> |
| </tr> |
| <tr id="i161" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#setIsCacheable-boolean-">setIsCacheable</a></span>(boolean cacheable)</code> |
| <div class="block">Used to signal that this mapping references a protected/isolated entity and requires |
| special merge/object building behaviour.</div> |
| </td> |
| </tr> |
| <tr id="i162" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#setIsInAndOutSopObject--">setIsInAndOutSopObject</a></span>()</code> |
| <div class="block">INTERNAL: |
| Set the mapping is both in and out of SerializedObjectPolicy's sopObject</div> |
| </td> |
| </tr> |
| <tr id="i163" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#setIsInSopObject--">setIsInSopObject</a></span>()</code> |
| <div class="block">INTERNAL: |
| Set the mapping is in SerializedObjectPolicy's sopObject.</div> |
| </td> |
| </tr> |
| <tr id="i164" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#setIsJPAId--">setIsJPAId</a></span>()</code> |
| <div class="block">INTERNAL: |
| Flags that this mapping is part of a JPA id mapping.</div> |
| </td> |
| </tr> |
| <tr id="i165" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#setIsLazy-boolean-">setIsLazy</a></span>(boolean isLazy)</code> |
| <div class="block">Set if this mapping is lazy.</div> |
| </td> |
| </tr> |
| <tr id="i166" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#setIsMapKeyMapping-boolean-">setIsMapKeyMapping</a></span>(boolean isMapKeyMapping)</code> </td> |
| </tr> |
| <tr id="i167" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#setIsOptional-boolean-">setIsOptional</a></span>(boolean isOptional)</code> |
| <div class="block">Used to specify whether the value of this mapping may be null.</div> |
| </td> |
| </tr> |
| <tr id="i168" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#setIsOutSopObject--">setIsOutSopObject</a></span>()</code> |
| <div class="block">INTERNAL: |
| Set the mapping is out of SerializedObjectPolicy's sopObject.</div> |
| </td> |
| </tr> |
| <tr id="i169" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#setIsPrimaryKeyMapping-boolean-">setIsPrimaryKeyMapping</a></span>(boolean isPrimaryKeyMapping)</code> |
| <div class="block">INTERNAL: |
| Set by the Object builder during initialization returns true if this mapping |
| is used as a primary key mapping.</div> |
| </td> |
| </tr> |
| <tr id="i170" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#setIsReadOnly-boolean-">setIsReadOnly</a></span>(boolean aBoolean)</code> |
| <div class="block">PUBLIC: |
| Set this mapping to be read only.</div> |
| </td> |
| </tr> |
| <tr id="i171" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#setMapsIdValue-java.lang.String-">setMapsIdValue</a></span>(<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> mapsIdValue)</code> |
| <div class="block">ADVANCED: |
| Set the maps id value</div> |
| </td> |
| </tr> |
| <tr id="i172" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#setProperties-java.util.Map-">setProperties</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> properties)</code> |
| <div class="block">INTERNAL: |
| Allow user defined properties.</div> |
| </td> |
| </tr> |
| <tr id="i173" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#setProperty-java.lang.Object-java.lang.Object-">setProperty</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> property, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</code> |
| <div class="block">ADVANCED: |
| Allow user defined properties.</div> |
| </td> |
| </tr> |
| <tr id="i174" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#setRealAttributeValueInObject-java.lang.Object-java.lang.Object-">setRealAttributeValueInObject</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</code> |
| <div class="block">INTERNAL: |
| Set the value of the attribute mapped by this mapping, |
| placing it inside a value holder if necessary.</div> |
| </td> |
| </tr> |
| <tr id="i175" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#setSetMethodName-java.lang.String-">setSetMethodName</a></span>(<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> methodName)</code> |
| <div class="block">PUBLIC: |
| Set the methodName used to set the value for the mapping's attribute into the object.</div> |
| </td> |
| </tr> |
| <tr id="i176" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#setWeight-java.lang.Integer-">setWeight</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> newWeight)</code> |
| <div class="block">ADVANCED: |
| Set the weight of the mapping, used to sort mappings |
| DirectToField Mappings have a default weight of 1 while all other Mappings have a |
| default weight of MAXINT.</div> |
| </td> |
| </tr> |
| <tr id="i177" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#simpleAddToCollectionChangeRecord-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.ObjectChangeSet-org.eclipse.persistence.internal.sessions.AbstractSession-">simpleAddToCollectionChangeRecord</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> referenceKey, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> changeSetToAdd, |
| org.eclipse.persistence.internal.sessions.ObjectChangeSet changeSet, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</code> |
| <div class="block">ADVANCED: |
| This method is used to add an object to a collection once the changeSet is applied.</div> |
| </td> |
| </tr> |
| <tr id="i178" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#simpleRemoveFromCollectionChangeRecord-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.ObjectChangeSet-org.eclipse.persistence.internal.sessions.AbstractSession-">simpleRemoveFromCollectionChangeRecord</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> referenceKey, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> changeSetToAdd, |
| org.eclipse.persistence.internal.sessions.ObjectChangeSet changeSet, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</code> |
| <div class="block">ADVANCED: |
| This method is used to remove an object from a collection once the changeSet is applied.</div> |
| </td> |
| </tr> |
| <tr id="i179" class="rowColor"> |
| <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/mappings/DatabaseMapping.html#toString--">toString</a></span>()</code> |
| <div class="block">INTERNAL: |
| Print the mapping attribute name, this is used in error messages.</div> |
| </td> |
| </tr> |
| <tr id="i180" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#updateChangeRecord-java.lang.Object-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.ObjectChangeSet-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-">updateChangeRecord</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> clone, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> newValue, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> oldValue, |
| org.eclipse.persistence.internal.sessions.ObjectChangeSet objectChangeSet, |
| org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow)</code> |
| <div class="block">INTERNAL: |
| Either create a new change record or update the change record with the new value.</div> |
| </td> |
| </tr> |
| <tr id="i181" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#updateCollectionChangeRecord-org.eclipse.persistence.descriptors.changetracking.CollectionChangeEvent-org.eclipse.persistence.internal.sessions.ObjectChangeSet-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-">updateCollectionChangeRecord</a></span>(<a href="../../../../org/eclipse/persistence/descriptors/changetracking/CollectionChangeEvent.html" title="class in org.eclipse.persistence.descriptors.changetracking">CollectionChangeEvent</a> event, |
| org.eclipse.persistence.internal.sessions.ObjectChangeSet objectChangeSet, |
| org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow)</code> |
| <div class="block">INTERNAL: |
| Add or removes a new value and its change set to the collection change record based on the event passed in.</div> |
| </td> |
| </tr> |
| <tr id="i182" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#validateAfterInitialization-org.eclipse.persistence.internal.sessions.AbstractSession-">validateAfterInitialization</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession session)</code> |
| <div class="block">INTERNAL: |
| Allow for subclasses to perform validation.</div> |
| </td> |
| </tr> |
| <tr id="i183" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#validateBeforeInitialization-org.eclipse.persistence.internal.sessions.AbstractSession-">validateBeforeInitialization</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession session)</code> |
| <div class="block">INTERNAL: |
| Allow for subclasses to perform validation.</div> |
| </td> |
| </tr> |
| <tr id="i184" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#valueFromObject-java.lang.Object-org.eclipse.persistence.internal.helper.DatabaseField-org.eclipse.persistence.internal.sessions.AbstractSession-">valueFromObject</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> anObject, |
| org.eclipse.persistence.internal.helper.DatabaseField field, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</code> |
| <div class="block">INTERNAL: |
| A subclass should extract the value from the object for the field, if it does not map the field then |
| it should return null.</div> |
| </td> |
| </tr> |
| <tr id="i185" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#valueFromResultSet-java.sql.ResultSet-org.eclipse.persistence.queries.ObjectBuildingQuery-org.eclipse.persistence.internal.sessions.AbstractSession-org.eclipse.persistence.internal.databaseaccess.DatabaseAccessor-java.sql.ResultSetMetaData-int-org.eclipse.persistence.internal.databaseaccess.DatabasePlatform-">valueFromResultSet</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSet.html?is-external=true" title="class or interface in java.sql">ResultSet</a> resultSet, |
| <a href="../../../../org/eclipse/persistence/queries/ObjectBuildingQuery.html" title="class in org.eclipse.persistence.queries">ObjectBuildingQuery</a> query, |
| org.eclipse.persistence.internal.sessions.AbstractSession session, |
| org.eclipse.persistence.internal.databaseaccess.DatabaseAccessor accessor, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSetMetaData.html?is-external=true" title="class or interface in java.sql">ResultSetMetaData</a> metaData, |
| int columnNumber, |
| org.eclipse.persistence.internal.databaseaccess.DatabasePlatform platform)</code> |
| <div class="block">INTERNAL: |
| Returns the value for the mapping directly from the result-set.</div> |
| </td> |
| </tr> |
| <tr id="i186" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#valueFromRow-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.queries.JoinedAttributeManager-org.eclipse.persistence.queries.ObjectBuildingQuery-boolean-">valueFromRow</a></span>(org.eclipse.persistence.internal.sessions.AbstractRecord row, |
| org.eclipse.persistence.internal.queries.JoinedAttributeManager joinManager, |
| <a href="../../../../org/eclipse/persistence/queries/ObjectBuildingQuery.html" title="class in org.eclipse.persistence.queries">ObjectBuildingQuery</a> query, |
| boolean isTargetProtected)</code> |
| <div class="block">INTERNAL: |
| A subclass should implement this method if it wants different behavior.</div> |
| </td> |
| </tr> |
| <tr id="i187" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#valueFromRow-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.queries.JoinedAttributeManager-org.eclipse.persistence.queries.ObjectBuildingQuery-org.eclipse.persistence.internal.identitymaps.CacheKey-org.eclipse.persistence.internal.sessions.AbstractSession-boolean-java.lang.Boolean:A-">valueFromRow</a></span>(org.eclipse.persistence.internal.sessions.AbstractRecord row, |
| org.eclipse.persistence.internal.queries.JoinedAttributeManager joinManager, |
| <a href="../../../../org/eclipse/persistence/queries/ObjectBuildingQuery.html" title="class in org.eclipse.persistence.queries">ObjectBuildingQuery</a> query, |
| org.eclipse.persistence.internal.identitymaps.CacheKey cacheKey, |
| org.eclipse.persistence.internal.sessions.AbstractSession session, |
| boolean isTargetProtected, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>[] wasCacheUsed)</code> |
| <div class="block">INTERNAL: |
| A subclass should implement this method if it wants different behavior.</div> |
| </td> |
| </tr> |
| <tr id="i188" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#verifyDelete-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-">verifyDelete</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</code> |
| <div class="block">INTERNAL: |
| To verify if the specified object has been deleted or not.</div> |
| </td> |
| </tr> |
| <tr id="i189" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#writeFromAttributeIntoRow-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractSession-">writeFromAttributeIntoRow</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> attribute, |
| org.eclipse.persistence.internal.sessions.AbstractRecord row, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</code> |
| <div class="block">INTERNAL: |
| A subclass should implement this method if it wants different behavior.</div> |
| </td> |
| </tr> |
| <tr id="i190" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#writeFromObjectIntoRow-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractSession-org.eclipse.persistence.mappings.DatabaseMapping.WriteType-">writeFromObjectIntoRow</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object, |
| org.eclipse.persistence.internal.sessions.AbstractRecord row, |
| org.eclipse.persistence.internal.sessions.AbstractSession session, |
| <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.WriteType.html" title="enum in org.eclipse.persistence.mappings">DatabaseMapping.WriteType</a> writeType)</code> |
| <div class="block">INTERNAL: |
| A subclass should implement this method if it wants different behavior.</div> |
| </td> |
| </tr> |
| <tr id="i191" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#writeFromObjectIntoRowForShallowInsert-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractSession-">writeFromObjectIntoRowForShallowInsert</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object, |
| org.eclipse.persistence.internal.sessions.AbstractRecord row, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</code> |
| <div class="block">INTERNAL: |
| This row is built for shallow insert which happens in case of bidirectional inserts.</div> |
| </td> |
| </tr> |
| <tr id="i192" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#writeFromObjectIntoRowForShallowInsertWithChangeRecord-org.eclipse.persistence.internal.sessions.ChangeRecord-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractSession-">writeFromObjectIntoRowForShallowInsertWithChangeRecord</a></span>(org.eclipse.persistence.internal.sessions.ChangeRecord changeRecord, |
| org.eclipse.persistence.internal.sessions.AbstractRecord row, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</code> |
| <div class="block">INTERNAL: |
| This row is built for shallow insert which happens in case of bidirectional inserts.</div> |
| </td> |
| </tr> |
| <tr id="i193" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#writeFromObjectIntoRowForUpdate-org.eclipse.persistence.queries.WriteObjectQuery-org.eclipse.persistence.internal.sessions.AbstractRecord-">writeFromObjectIntoRowForUpdate</a></span>(<a href="../../../../org/eclipse/persistence/queries/WriteObjectQuery.html" title="class in org.eclipse.persistence.queries">WriteObjectQuery</a> query, |
| org.eclipse.persistence.internal.sessions.AbstractRecord row)</code> |
| <div class="block">INTERNAL:</div> |
| </td> |
| </tr> |
| <tr id="i194" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#writeFromObjectIntoRowForUpdateAfterShallowInsert-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractSession-org.eclipse.persistence.internal.helper.DatabaseTable-">writeFromObjectIntoRowForUpdateAfterShallowInsert</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object, |
| org.eclipse.persistence.internal.sessions.AbstractRecord databaseRow, |
| org.eclipse.persistence.internal.sessions.AbstractSession session, |
| org.eclipse.persistence.internal.helper.DatabaseTable table)</code> |
| <div class="block">INTERNAL: |
| This row is built for update after shallow insert which happens in case of bidirectional inserts.</div> |
| </td> |
| </tr> |
| <tr id="i195" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#writeFromObjectIntoRowForUpdateBeforeShallowDelete-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractSession-org.eclipse.persistence.internal.helper.DatabaseTable-">writeFromObjectIntoRowForUpdateBeforeShallowDelete</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object, |
| org.eclipse.persistence.internal.sessions.AbstractRecord databaseRow, |
| org.eclipse.persistence.internal.sessions.AbstractSession session, |
| org.eclipse.persistence.internal.helper.DatabaseTable table)</code> |
| <div class="block">INTERNAL: |
| This row is built for update before shallow delete which happens in case of bidirectional inserts.</div> |
| </td> |
| </tr> |
| <tr id="i196" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#writeFromObjectIntoRowForWhereClause-org.eclipse.persistence.queries.ObjectLevelModifyQuery-org.eclipse.persistence.internal.sessions.AbstractRecord-">writeFromObjectIntoRowForWhereClause</a></span>(<a href="../../../../org/eclipse/persistence/queries/ObjectLevelModifyQuery.html" title="class in org.eclipse.persistence.queries">ObjectLevelModifyQuery</a> query, |
| org.eclipse.persistence.internal.sessions.AbstractRecord row)</code> |
| <div class="block">INTERNAL: |
| A subclass should implement this method if it wants different behavior.</div> |
| </td> |
| </tr> |
| <tr id="i197" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#writeFromObjectIntoRowWithChangeRecord-org.eclipse.persistence.internal.sessions.ChangeRecord-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractSession-org.eclipse.persistence.mappings.DatabaseMapping.WriteType-">writeFromObjectIntoRowWithChangeRecord</a></span>(org.eclipse.persistence.internal.sessions.ChangeRecord changeRecord, |
| org.eclipse.persistence.internal.sessions.AbstractRecord row, |
| org.eclipse.persistence.internal.sessions.AbstractSession session, |
| <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.WriteType.html" title="enum in org.eclipse.persistence.mappings">DatabaseMapping.WriteType</a> writeType)</code> |
| <div class="block">INTERNAL: |
| A subclass should implement this method if it wants different behavior.</div> |
| </td> |
| </tr> |
| <tr id="i198" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#writeInsertFieldsIntoRow-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractSession-">writeInsertFieldsIntoRow</a></span>(org.eclipse.persistence.internal.sessions.AbstractRecord databaseRow, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</code> |
| <div class="block">INTERNAL: |
| Write fields needed for insert into the template for with null values.</div> |
| </td> |
| </tr> |
| <tr id="i199" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html#writeUpdateFieldsIntoRow-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractSession-">writeUpdateFieldsIntoRow</a></span>(org.eclipse.persistence.internal.sessions.AbstractRecord databaseRow, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</code> |
| <div class="block">INTERNAL: |
| Write fields needed for update into the template for with null values.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="NO_FIELDS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>NO_FIELDS</h4> |
| <pre>protected static final <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a> NO_FIELDS</pre> |
| <div class="block">Used to reduce memory for mappings with no fields.</div> |
| </li> |
| </ul> |
| <a name="NO_WEIGHT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>NO_WEIGHT</h4> |
| <pre>protected static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> NO_WEIGHT</pre> |
| <div class="block">Used to share integer instance to reduce memory.</div> |
| </li> |
| </ul> |
| <a name="WEIGHT_DIRECT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>WEIGHT_DIRECT</h4> |
| <pre>protected static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> WEIGHT_DIRECT</pre> |
| </li> |
| </ul> |
| <a name="WEIGHT_TRANSFORM"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>WEIGHT_TRANSFORM</h4> |
| <pre>protected static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> WEIGHT_TRANSFORM</pre> |
| </li> |
| </ul> |
| <a name="WEIGHT_AGGREGATE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>WEIGHT_AGGREGATE</h4> |
| <pre>protected static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> WEIGHT_AGGREGATE</pre> |
| </li> |
| </ul> |
| <a name="WEIGHT_TO_ONE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>WEIGHT_TO_ONE</h4> |
| <pre>protected static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> WEIGHT_TO_ONE</pre> |
| </li> |
| </ul> |
| <a name="descriptor"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>descriptor</h4> |
| <pre>protected <a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a> descriptor</pre> |
| <div class="block">ClassDescriptor to which this mapping belongs to</div> |
| </li> |
| </ul> |
| <a name="attributeAccessor"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>attributeAccessor</h4> |
| <pre>protected <a href="../../../../org/eclipse/persistence/mappings/AttributeAccessor.html" title="class in org.eclipse.persistence.mappings">AttributeAccessor</a> attributeAccessor</pre> |
| <div class="block">Wrapper to store the reference objects.</div> |
| </li> |
| </ul> |
| <a name="isReadOnly"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isReadOnly</h4> |
| <pre>protected boolean isReadOnly</pre> |
| <div class="block">Makes this mapping read only. No write are performed on it. Default is false</div> |
| </li> |
| </ul> |
| <a name="isOptional"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isOptional</h4> |
| <pre>protected boolean isOptional</pre> |
| <div class="block">Specifies whether this mapping is optional (i.e. field may be null). Used for DDL generation.</div> |
| </li> |
| </ul> |
| <a name="isLazy"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isLazy</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> isLazy</pre> |
| <div class="block">Specifies whether this mapping is lazy, this means not included in the default fetch group.</div> |
| </li> |
| </ul> |
| <a name="fields"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fields</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a><org.eclipse.persistence.internal.helper.DatabaseField> fields</pre> |
| <div class="block">Fields associated with the mappings are cached</div> |
| </li> |
| </ul> |
| <a name="isRemotelyInitialized"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isRemotelyInitialized</h4> |
| <pre>protected boolean isRemotelyInitialized</pre> |
| <div class="block">It is needed only in remote initialization and mapping is in parent descriptor</div> |
| </li> |
| </ul> |
| <a name="weight"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>weight</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> weight</pre> |
| <div class="block">This is a TopLink defined attribute that allows us to sort the mappings</div> |
| </li> |
| </ul> |
| <a name="properties"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>properties</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> properties</pre> |
| <div class="block">Allow user defined properties.</div> |
| </li> |
| </ul> |
| <a name="unconvertedProperties"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unconvertedProperties</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<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>,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<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>>> unconvertedProperties</pre> |
| <div class="block">Allow the user to defined un-converted properties which will be initialized at runtime.</div> |
| </li> |
| </ul> |
| <a name="derivesId"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>derivesId</h4> |
| <pre>protected boolean derivesId</pre> |
| <div class="block">Used by the CMP3Policy to see if this mapping should be used in |
| processing pk classes for find methods</div> |
| </li> |
| </ul> |
| <a name="isJPAId"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isJPAId</h4> |
| <pre>protected boolean isJPAId</pre> |
| </li> |
| </ul> |
| <a name="mapsIdValue"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>mapsIdValue</h4> |
| <pre>protected <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> mapsIdValue</pre> |
| <div class="block">A mapsId value.</div> |
| </li> |
| </ul> |
| <a name="derivedIdMapping"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>derivedIdMapping</h4> |
| <pre>protected <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a> derivedIdMapping</pre> |
| <div class="block">The id mapping this mapping derives. Used by the CMP3Policy to see if |
| this mapping should be used in processing pk classes for find methods.</div> |
| </li> |
| </ul> |
| <a name="isPrimaryKeyMapping"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isPrimaryKeyMapping</h4> |
| <pre>protected boolean isPrimaryKeyMapping</pre> |
| <div class="block">PERF: Used as a quick check to see if this mapping is a primary key mapping, |
| set by the object builder during initialization.</div> |
| </li> |
| </ul> |
| <a name="attributeName"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>attributeName</h4> |
| <pre>protected <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> attributeName</pre> |
| <div class="block">PERF: Cache the mappings attribute name.</div> |
| </li> |
| </ul> |
| <a name="isMapKeyMapping"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isMapKeyMapping</h4> |
| <pre>protected boolean isMapKeyMapping</pre> |
| <div class="block">Records if this mapping is being used as a MapKeyMapping. This is important for recording main mappings</div> |
| </li> |
| </ul> |
| <a name="isCacheable"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isCacheable</h4> |
| <pre>protected boolean isCacheable</pre> |
| </li> |
| </ul> |
| <a name="isInSopObject"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>isInSopObject</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> isInSopObject</pre> |
| <div class="block">Irrelevant (and not set) unless descriptor has SerializedObjectPolicy (SOP). |
| If descriptor has SOP, then ObjectLevelReadQuery (with shouldUseSerializedObjectPolicy flag set to true) |
| reads in row that contain both field/value pairs and sopObject. |
| This flag indicates whether the data for this mapping is contained in the row's sopObject or in fields/values. |
| Boolean.TRUE - sopObject (in sopObject) |
| Boolean.FALSE - fields/values (out sopObject); |
| null - both sopObject and fields/values (both in and out sopObject). |
| While writing to the data base the mapping will be used for writing into sopObject unless this flag is set to Boolean.FALSE;</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="DatabaseMapping--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DatabaseMapping</h4> |
| <pre>public DatabaseMapping()</pre> |
| <div class="block">PUBLIC: |
| Default constructor.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="addUnconvertedProperty-java.lang.String-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addUnconvertedProperty</h4> |
| <pre>public void addUnconvertedProperty(<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> propertyName, |
| <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> propertyValue, |
| <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> propertyType)</pre> |
| <div class="block">PUBLIC: |
| Add an unconverted property (to be initialiazed at runtime)</div> |
| </li> |
| </ul> |
| <a name="buildBackupClone-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>buildBackupClone</h4> |
| <pre>public abstract void buildBackupClone(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> clone, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> backup, |
| org.eclipse.persistence.internal.sessions.UnitOfWorkImpl unitOfWork)</pre> |
| <div class="block">INTERNAL: |
| Clone the attribute from the clone and assign it to the backup.</div> |
| </li> |
| </ul> |
| <a name="buildBackupCloneForPartObject-java.lang.Object-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>buildBackupCloneForPartObject</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> buildBackupCloneForPartObject(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> attributeValue, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> clone, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> backup, |
| org.eclipse.persistence.internal.sessions.UnitOfWorkImpl unitOfWork)</pre> |
| <div class="block">INTERNAL: |
| Require for cloning, the part must be cloned.</div> |
| </li> |
| </ul> |
| <a name="buildClone-java.lang.Object-org.eclipse.persistence.internal.identitymaps.CacheKey-java.lang.Object-java.lang.Integer-org.eclipse.persistence.internal.sessions.AbstractSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>buildClone</h4> |
| <pre>public abstract void buildClone(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> original, |
| org.eclipse.persistence.internal.identitymaps.CacheKey cacheKey, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> clone, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> refreshCascade, |
| org.eclipse.persistence.internal.sessions.AbstractSession cloningSession)</pre> |
| <div class="block">INTERNAL: |
| Clone the attribute from the original and assign it to the clone.</div> |
| </li> |
| </ul> |
| <a name="buildCloneFromRow-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.queries.JoinedAttributeManager-java.lang.Object-org.eclipse.persistence.internal.identitymaps.CacheKey-org.eclipse.persistence.queries.ObjectBuildingQuery-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-org.eclipse.persistence.internal.sessions.AbstractSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>buildCloneFromRow</h4> |
| <pre>public abstract void buildCloneFromRow(org.eclipse.persistence.internal.sessions.AbstractRecord databaseRow, |
| org.eclipse.persistence.internal.queries.JoinedAttributeManager joinManager, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> clone, |
| org.eclipse.persistence.internal.identitymaps.CacheKey sharedCacheKey, |
| <a href="../../../../org/eclipse/persistence/queries/ObjectBuildingQuery.html" title="class in org.eclipse.persistence.queries">ObjectBuildingQuery</a> sourceQuery, |
| org.eclipse.persistence.internal.sessions.UnitOfWorkImpl unitOfWork, |
| org.eclipse.persistence.internal.sessions.AbstractSession executionSession)</pre> |
| <div class="block">INTERNAL: |
| A combination of readFromRowIntoObject and buildClone. |
| <p> |
| buildClone assumes the attribute value exists on the original and can |
| simply be copied. |
| <p> |
| readFromRowIntoObject assumes that one is building an original. |
| <p> |
| Both of the above assumptions are false in this method, and actually |
| attempts to do both at the same time. |
| <p> |
| Extract value from the row and set the attribute to this value in the |
| working copy clone. |
| In order to bypass the shared cache when in transaction a UnitOfWork must |
| be able to populate working copies directly from the row.</div> |
| </li> |
| </ul> |
| <a name="buildShallowOriginalFromRow-org.eclipse.persistence.internal.sessions.AbstractRecord-java.lang.Object-org.eclipse.persistence.internal.queries.JoinedAttributeManager-org.eclipse.persistence.queries.ObjectBuildingQuery-org.eclipse.persistence.internal.sessions.AbstractSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>buildShallowOriginalFromRow</h4> |
| <pre>public void buildShallowOriginalFromRow(org.eclipse.persistence.internal.sessions.AbstractRecord databaseRow, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> original, |
| org.eclipse.persistence.internal.queries.JoinedAttributeManager joinManager, |
| <a href="../../../../org/eclipse/persistence/queries/ObjectBuildingQuery.html" title="class in org.eclipse.persistence.queries">ObjectBuildingQuery</a> query, |
| org.eclipse.persistence.internal.sessions.AbstractSession executionSession)</pre> |
| <div class="block">INTERNAL: |
| Builds a shallow original object. Only direct attributes and primary |
| keys are populated. In this way the minimum original required for |
| instantiating a working copy clone can be built without placing it in |
| the shared cache (no concern over cycles).</div> |
| </li> |
| </ul> |
| <a name="buildCloneForPartObject-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.identitymaps.CacheKey-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-java.lang.Integer-boolean-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>buildCloneForPartObject</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> buildCloneForPartObject(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> attributeValue, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> original, |
| org.eclipse.persistence.internal.identitymaps.CacheKey cacheKey, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> clone, |
| org.eclipse.persistence.internal.sessions.AbstractSession cloningSession, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> refreshCascade, |
| boolean isExisting, |
| boolean isFromSharedCache)</pre> |
| <div class="block">INTERNAL: |
| Require for cloning, the part must be cloned.</div> |
| </li> |
| </ul> |
| <a name="buildContainerClone-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>buildContainerClone</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> buildContainerClone(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> attributeValue, |
| org.eclipse.persistence.internal.sessions.AbstractSession cloningSession)</pre> |
| <div class="block">INTERNAL: |
| Performs a first level clone of the attribute. This generally means on the container will be cloned.</div> |
| </li> |
| </ul> |
| <a name="buildCopy-java.lang.Object-java.lang.Object-org.eclipse.persistence.sessions.CopyGroup-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>buildCopy</h4> |
| <pre>public void buildCopy(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> copy, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> original, |
| <a href="../../../../org/eclipse/persistence/sessions/CopyGroup.html" title="class in org.eclipse.persistence.sessions">CopyGroup</a> group)</pre> |
| <div class="block">INTERNAL: |
| Copy of the attribute of the object. |
| This is NOT used for unit of work but for templatizing an object.</div> |
| </li> |
| </ul> |
| <a name="buildExpression-java.lang.Object-org.eclipse.persistence.queries.QueryByExamplePolicy-org.eclipse.persistence.expressions.Expression-java.util.Map-org.eclipse.persistence.internal.sessions.AbstractSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>buildExpression</h4> |
| <pre>public <a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a> buildExpression(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> queryObject, |
| <a href="../../../../org/eclipse/persistence/queries/QueryByExamplePolicy.html" title="class in org.eclipse.persistence.queries">QueryByExamplePolicy</a> policy, |
| <a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a> expressionBuilder, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> processedObjects, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</pre> |
| <div class="block">INTERNAL: |
| In case Query By Example is used, this method builds and returns an expression that |
| corresponds to a single attribue and it's value.</div> |
| </li> |
| </ul> |
| <a name="buildObjectJoinExpression-org.eclipse.persistence.expressions.Expression-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>buildObjectJoinExpression</h4> |
| <pre>public <a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a> buildObjectJoinExpression(<a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a> base, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</pre> |
| <div class="block">INTERNAL: |
| Used to allow object level comparisons.</div> |
| </li> |
| </ul> |
| <a name="buildObjectJoinExpression-org.eclipse.persistence.expressions.Expression-org.eclipse.persistence.expressions.Expression-org.eclipse.persistence.internal.sessions.AbstractSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>buildObjectJoinExpression</h4> |
| <pre>public <a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a> buildObjectJoinExpression(<a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a> base, |
| <a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a> argument, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</pre> |
| <div class="block">INTERNAL: |
| Used to allow object level comparisons.</div> |
| </li> |
| </ul> |
| <a name="cascadePerformRemoveIfRequired-java.lang.Object-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cascadePerformRemoveIfRequired</h4> |
| <pre>public abstract void cascadePerformRemoveIfRequired(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object, |
| org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> visitedObjects)</pre> |
| <div class="block">INTERNAL: |
| Cascade registerNew for Create through mappings that require the cascade</div> |
| </li> |
| </ul> |
| <a name="cascadePerformRemovePrivateOwnedObjectFromChangeSetIfRequired-java.lang.Object-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cascadePerformRemovePrivateOwnedObjectFromChangeSetIfRequired</h4> |
| <pre>public void cascadePerformRemovePrivateOwnedObjectFromChangeSetIfRequired(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object, |
| org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> visitedObjects)</pre> |
| <div class="block">INTERNAL: |
| Cascade removal of orphaned private owned objects from the UnitOfWorkChangeSet</div> |
| </li> |
| </ul> |
| <a name="cascadeRegisterNewIfRequired-java.lang.Object-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cascadeRegisterNewIfRequired</h4> |
| <pre>public abstract void cascadeRegisterNewIfRequired(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object, |
| org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> visitedObjects)</pre> |
| <div class="block">INTERNAL: |
| Cascade registerNew for Create through mappings that require the cascade</div> |
| </li> |
| </ul> |
| <a name="cascadeDiscoverAndPersistUnregisteredNewObjects-java.lang.Object-java.util.Map-java.util.Map-java.util.Map-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-java.util.Set-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cascadeDiscoverAndPersistUnregisteredNewObjects</h4> |
| <pre>public void cascadeDiscoverAndPersistUnregisteredNewObjects(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> newObjects, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> unregisteredExistingObjects, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> visitedObjects, |
| org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a> cascadeErrors)</pre> |
| <div class="block">INTERNAL: |
| Cascade discover and persist new objects during commit.</div> |
| </li> |
| </ul> |
| <a name="calculateDeferredChanges-org.eclipse.persistence.internal.sessions.ChangeRecord-org.eclipse.persistence.internal.sessions.AbstractSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>calculateDeferredChanges</h4> |
| <pre>public void calculateDeferredChanges(org.eclipse.persistence.internal.sessions.ChangeRecord changeRecord, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</pre> |
| <div class="block">INTERNAL: |
| Used by AttributeLevelChangeTracking to update a changeRecord with calculated changes |
| as apposed to detected changes. If an attribute can not be change tracked it's |
| changes can be detected through this process.</div> |
| </li> |
| </ul> |
| <a name="clone--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clone</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> clone()</pre> |
| <div class="block">INTERNAL: |
| Clones itself.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="cloneFields-java.util.Vector-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cloneFields</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a> cloneFields(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a> fields)</pre> |
| <div class="block">INTERNAL: |
| Helper method to clone vector of fields (used in aggregate initialization cloning).</div> |
| </li> |
| </ul> |
| <a name="collectFields--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>collectFields</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a><org.eclipse.persistence.internal.helper.DatabaseField> collectFields()</pre> |
| <div class="block">This method must be overwritten in the subclasses to return a vector of all the |
| fields this mapping represents.</div> |
| </li> |
| </ul> |
| <a name="collectQueryParameters-java.util.Set-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>collectQueryParameters</h4> |
| <pre>public void collectQueryParameters(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><org.eclipse.persistence.internal.helper.DatabaseField> record)</pre> |
| <div class="block">INTERNAL: |
| This method is used to store the FK fields that can be cached that correspond to noncacheable mappings |
| the FK field values will be used to re-issue the query when cloning the shared cache entity</div> |
| </li> |
| </ul> |
| <a name="postInitializeSourceAndTargetExpressions--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>postInitializeSourceAndTargetExpressions</h4> |
| <pre>public void postInitializeSourceAndTargetExpressions()</pre> |
| <div class="block">INTERNAL: |
| Mapping callback for post-initialization of source and target expression fields |
| created when a mapping's selectionCriteria is created early with uninitialized fields.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/persistence/mappings/OneToOneMapping.html#postInitializeSourceAndTargetExpressions--"><code>OneToOneMapping.postInitializeSourceAndTargetExpressions()</code></a>, |
| <a href="../../../../org/eclipse/persistence/mappings/OneToManyMapping.html#postInitializeSourceAndTargetExpressions--"><code>OneToManyMapping.postInitializeSourceAndTargetExpressions()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="compareForChange-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.ObjectChangeSet-org.eclipse.persistence.internal.sessions.AbstractSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>compareForChange</h4> |
| <pre>public abstract org.eclipse.persistence.internal.sessions.ChangeRecord compareForChange(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> clone, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> backup, |
| org.eclipse.persistence.internal.sessions.ObjectChangeSet owner, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</pre> |
| <div class="block">INTERNAL: |
| This method was created in VisualAge.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>prototype.changeset.ChangeRecord</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="compareObjects-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>compareObjects</h4> |
| <pre>public abstract boolean compareObjects(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> firstObject, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> secondObject, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</pre> |
| <div class="block">INTERNAL: |
| Compare the attributes belonging to this mapping for the objects.</div> |
| </li> |
| </ul> |
| <a name="convertClassNamesToClasses-java.lang.ClassLoader-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>convertClassNamesToClasses</h4> |
| <pre>public void convertClassNamesToClasses(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> classLoader)</pre> |
| <div class="block">INTERNAL: |
| Convert all the class-name-based settings in this mapping to actual class-based |
| settings |
| This method is implemented by subclasses as necessary.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>classLoader</code> - </dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="convertConverterClassNamesToClasses-org.eclipse.persistence.mappings.converters.Converter-java.lang.ClassLoader-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>convertConverterClassNamesToClasses</h4> |
| <pre>protected void convertConverterClassNamesToClasses(<a href="../../../../org/eclipse/persistence/mappings/converters/Converter.html" title="interface in org.eclipse.persistence.mappings.converters">Converter</a> converter, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> classLoader)</pre> |
| <div class="block">Convenience method to ensure converters have an opportunity to convert |
| any class names to classes during project setup.</div> |
| </li> |
| </ul> |
| <a name="createCloneValueHolder-org.eclipse.persistence.indirection.ValueHolderInterface-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractSession-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createCloneValueHolder</h4> |
| <pre>public org.eclipse.persistence.internal.indirection.DatabaseValueHolder createCloneValueHolder(<a href="../../../../org/eclipse/persistence/indirection/ValueHolderInterface.html" title="interface in org.eclipse.persistence.indirection">ValueHolderInterface</a> attributeValue, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> original, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> clone, |
| org.eclipse.persistence.internal.sessions.AbstractRecord row, |
| org.eclipse.persistence.internal.sessions.AbstractSession cloningSession, |
| boolean buildDirectlyFromRow)</pre> |
| <div class="block">INTERNAL: |
| Builder the unit of work value holder.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>buildDirectlyFromRow</code> - indicates that we are building the clone directly |
| from a row as opposed to building the original from the row, putting it in |
| the shared cache, and then cloning the original.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="derivesId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>derivesId</h4> |
| <pre>public boolean derivesId()</pre> |
| <div class="block">ADVANCED: |
| Returns true if the mapping references a JPA ID attribute for the CMP3Policy and JPA ID classes.</div> |
| </li> |
| </ul> |
| <a name="earlyPreDelete-org.eclipse.persistence.queries.DeleteObjectQuery-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>earlyPreDelete</h4> |
| <pre>public void earlyPreDelete(<a href="../../../../org/eclipse/persistence/queries/DeleteObjectQuery.html" title="class in org.eclipse.persistence.queries">DeleteObjectQuery</a> query, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object)</pre> |
| <div class="block">INTERNAL: |
| This method is called to update collection tables prior to commit.</div> |
| </li> |
| </ul> |
| <a name="extractNestedExpressions-java.util.List-org.eclipse.persistence.expressions.ExpressionBuilder-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>extractNestedExpressions</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a>> extractNestedExpressions(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a>> expressions, |
| <a href="../../../../org/eclipse/persistence/expressions/ExpressionBuilder.html" title="class in org.eclipse.persistence.expressions">ExpressionBuilder</a> newRoot)</pre> |
| <div class="block">INTERNAL: |
| Extract the nested attribute expressions that apply to this mapping. |
| This is used for partial objects, and batch fetching.</div> |
| </li> |
| </ul> |
| <a name="extractNestedNonAggregateExpressions-java.util.List-org.eclipse.persistence.expressions.ExpressionBuilder-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>extractNestedNonAggregateExpressions</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a>> extractNestedNonAggregateExpressions(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a>> expressions, |
| <a href="../../../../org/eclipse/persistence/expressions/ExpressionBuilder.html" title="class in org.eclipse.persistence.expressions">ExpressionBuilder</a> newRoot, |
| boolean rootExpressionsAllowed)</pre> |
| <div class="block">INTERNAL: |
| Extract the nested attribute expressions that apply to this mapping. |
| This is used for joining, and locking. |
| For aggregates return the nested foreign reference mapping, not the aggregate, as the aggregates are not joined, |
| and share their parent's query.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rootExpressionsAllowed</code> - true if newRoot itself can be one of the |
| expressions returned (used for locking)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hasRootExpressionThatShouldUseOuterJoin-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasRootExpressionThatShouldUseOuterJoin</h4> |
| <pre>protected boolean hasRootExpressionThatShouldUseOuterJoin(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a> expressions)</pre> |
| <div class="block">INTERNAL: |
| If there is root expression in the list then indicates whether it shouldUseOuterJoin, |
| otherwise return false.</div> |
| </li> |
| </ul> |
| <a name="hasUnconvertedProperties--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasUnconvertedProperties</h4> |
| <pre>public boolean hasUnconvertedProperties()</pre> |
| <div class="block">INTERNAL: |
| Used to store un-converted properties, which are subsequenctly converted |
| at runtime (through the convertClassNamesToClasses method.</div> |
| </li> |
| </ul> |
| <a name="fixObjectReferences-java.lang.Object-java.util.Map-java.util.Map-org.eclipse.persistence.queries.ObjectLevelReadQuery-org.eclipse.persistence.sessions.remote.DistributedSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fixObjectReferences</h4> |
| <pre>public abstract void fixObjectReferences(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> objectDescriptors, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> processedObjects, |
| <a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html" title="class in org.eclipse.persistence.queries">ObjectLevelReadQuery</a> query, |
| <a href="../../../../org/eclipse/persistence/sessions/remote/DistributedSession.html" title="class in org.eclipse.persistence.sessions.remote">DistributedSession</a> session)</pre> |
| <div class="block">INTERNAL: |
| An object has been serialized from the server to the client. |
| Replace the transient attributes of the remote value holders |
| with client-side objects.</div> |
| </li> |
| </ul> |
| <a name="fixRealObjectReferences-java.lang.Object-java.util.Map-java.util.Map-org.eclipse.persistence.queries.ObjectLevelReadQuery-org.eclipse.persistence.sessions.remote.DistributedSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fixRealObjectReferences</h4> |
| <pre>public void fixRealObjectReferences(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> objectInformation, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> processedObjects, |
| <a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html" title="class in org.eclipse.persistence.queries">ObjectLevelReadQuery</a> query, |
| <a href="../../../../org/eclipse/persistence/sessions/remote/DistributedSession.html" title="class in org.eclipse.persistence.sessions.remote">DistributedSession</a> session)</pre> |
| <div class="block">INTERNAL: |
| At this point, we realize we don't have indirection; |
| so we need to replace the reference object(s) with |
| the corresponding object(s) from the remote session. |
| The default is to do nothing.</div> |
| </li> |
| </ul> |
| <a name="getAttributeAccessor--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAttributeAccessor</h4> |
| <pre>public <a href="../../../../org/eclipse/persistence/mappings/AttributeAccessor.html" title="class in org.eclipse.persistence.mappings">AttributeAccessor</a> getAttributeAccessor()</pre> |
| <div class="block">ADVANCED: |
| Return the attributeAccessor. |
| The attribute accessor is responsible for setting and retrieving the attribute value |
| from the object for this mapping.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/core/mappings/CoreMapping.html#getAttributeAccessor--">getAttributeAccessor</a></code> in class <code><a href="../../../../org/eclipse/persistence/core/mappings/CoreMapping.html" title="class in org.eclipse.persistence.core.mappings">CoreMapping</a><<a href="../../../../org/eclipse/persistence/mappings/AttributeAccessor.html" title="class in org.eclipse.persistence.mappings">AttributeAccessor</a>,org.eclipse.persistence.internal.sessions.AbstractSession,org.eclipse.persistence.internal.queries.ContainerPolicy,<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a>,org.eclipse.persistence.internal.helper.DatabaseField></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAttributeClassification--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAttributeClassification</h4> |
| <pre>public <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> getAttributeClassification()</pre> |
| <div class="block">PUBLIC: |
| The classification type for the attribute this mapping represents</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/core/mappings/CoreMapping.html#getAttributeClassification--">getAttributeClassification</a></code> in class <code><a href="../../../../org/eclipse/persistence/core/mappings/CoreMapping.html" title="class in org.eclipse.persistence.core.mappings">CoreMapping</a><<a href="../../../../org/eclipse/persistence/mappings/AttributeAccessor.html" title="class in org.eclipse.persistence.mappings">AttributeAccessor</a>,org.eclipse.persistence.internal.sessions.AbstractSession,org.eclipse.persistence.internal.queries.ContainerPolicy,<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a>,org.eclipse.persistence.internal.helper.DatabaseField></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAttributeName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAttributeName</h4> |
| <pre>public <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> getAttributeName()</pre> |
| <div class="block">PUBLIC: |
| Return the name of the attribute set in the mapping.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/core/mappings/CoreMapping.html#getAttributeName--">getAttributeName</a></code> in class <code><a href="../../../../org/eclipse/persistence/core/mappings/CoreMapping.html" title="class in org.eclipse.persistence.core.mappings">CoreMapping</a><<a href="../../../../org/eclipse/persistence/mappings/AttributeAccessor.html" title="class in org.eclipse.persistence.mappings">AttributeAccessor</a>,org.eclipse.persistence.internal.sessions.AbstractSession,org.eclipse.persistence.internal.queries.ContainerPolicy,<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a>,org.eclipse.persistence.internal.helper.DatabaseField></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAttributeValueFromObject-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAttributeValueFromObject</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> getAttributeValueFromObject(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object) |
| throws <a href="../../../../org/eclipse/persistence/exceptions/DescriptorException.html" title="class in org.eclipse.persistence.exceptions">DescriptorException</a></pre> |
| <div class="block">INTERNAL: |
| Return the value of an attribute which this mapping represents for an object.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/core/mappings/CoreMapping.html#getAttributeValueFromObject-java.lang.Object-">getAttributeValueFromObject</a></code> in class <code><a href="../../../../org/eclipse/persistence/core/mappings/CoreMapping.html" title="class in org.eclipse.persistence.core.mappings">CoreMapping</a><<a href="../../../../org/eclipse/persistence/mappings/AttributeAccessor.html" title="class in org.eclipse.persistence.mappings">AttributeAccessor</a>,org.eclipse.persistence.internal.sessions.AbstractSession,org.eclipse.persistence.internal.queries.ContainerPolicy,<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a>,org.eclipse.persistence.internal.helper.DatabaseField></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/exceptions/DescriptorException.html" title="class in org.eclipse.persistence.exceptions">DescriptorException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getContainerPolicy--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getContainerPolicy</h4> |
| <pre>public org.eclipse.persistence.internal.queries.ContainerPolicy getContainerPolicy()</pre> |
| <div class="block">INTERNAL: |
| Return the mapping's containerPolicy.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/core/mappings/CoreMapping.html#getContainerPolicy--">getContainerPolicy</a></code> in class <code><a href="../../../../org/eclipse/persistence/core/mappings/CoreMapping.html" title="class in org.eclipse.persistence.core.mappings">CoreMapping</a><<a href="../../../../org/eclipse/persistence/mappings/AttributeAccessor.html" title="class in org.eclipse.persistence.mappings">AttributeAccessor</a>,org.eclipse.persistence.internal.sessions.AbstractSession,org.eclipse.persistence.internal.queries.ContainerPolicy,<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a>,org.eclipse.persistence.internal.helper.DatabaseField></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDerivedIdMapping--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDerivedIdMapping</h4> |
| <pre>public <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a> getDerivedIdMapping()</pre> |
| <div class="block">ADVANCED: |
| Set the maps id value</div> |
| </li> |
| </ul> |
| <a name="getDescriptor--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDescriptor</h4> |
| <pre>public <a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a> getDescriptor()</pre> |
| <div class="block">INTERNAL: |
| Return the descriptor to which this mapping belongs</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/core/mappings/CoreMapping.html#getDescriptor--">getDescriptor</a></code> in class <code><a href="../../../../org/eclipse/persistence/core/mappings/CoreMapping.html" title="class in org.eclipse.persistence.core.mappings">CoreMapping</a><<a href="../../../../org/eclipse/persistence/mappings/AttributeAccessor.html" title="class in org.eclipse.persistence.mappings">AttributeAccessor</a>,org.eclipse.persistence.internal.sessions.AbstractSession,org.eclipse.persistence.internal.queries.ContainerPolicy,<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a>,org.eclipse.persistence.internal.helper.DatabaseField></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getField--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getField</h4> |
| <pre>public org.eclipse.persistence.internal.helper.DatabaseField getField()</pre> |
| <div class="block">INTERNAL: |
| Return the field associated with this mapping if there is exactly one. |
| This is required for object relational mapping to print them, but because |
| they are defined in in an Enterprise context they cannot be cast to. |
| Mappings that have a field include direct mappings and object relational mappings.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/core/mappings/CoreMapping.html#getField--">getField</a></code> in class <code><a href="../../../../org/eclipse/persistence/core/mappings/CoreMapping.html" title="class in org.eclipse.persistence.core.mappings">CoreMapping</a><<a href="../../../../org/eclipse/persistence/mappings/AttributeAccessor.html" title="class in org.eclipse.persistence.mappings">AttributeAccessor</a>,org.eclipse.persistence.internal.sessions.AbstractSession,org.eclipse.persistence.internal.queries.ContainerPolicy,<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a>,org.eclipse.persistence.internal.helper.DatabaseField></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFieldClassification-org.eclipse.persistence.internal.helper.DatabaseField-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFieldClassification</h4> |
| <pre>public <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> getFieldClassification(org.eclipse.persistence.internal.helper.DatabaseField fieldToClassify)</pre> |
| <div class="block">INTERNAL: |
| Return the classification for the field contained in the mapping. |
| This is used to convert the row value to a consistent java value. |
| By default this is unknown.</div> |
| </li> |
| </ul> |
| <a name="getSelectFields--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSelectFields</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a> getSelectFields()</pre> |
| <div class="block">INTERNAL: |
| Returns the set of fields that should be selected to build this mapping's value(s). |
| This is used by expressions to determine which fields to include in the select clause for non-object expressions.</div> |
| </li> |
| </ul> |
| <a name="getSelectTables--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSelectTables</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a> getSelectTables()</pre> |
| <div class="block">INTERNAL: |
| Returns the table(s) that should be selected to build this mapping's value(s). |
| This is used by expressions to determine which tables to include in the from clause for non-object expressions.</div> |
| </li> |
| </ul> |
| <a name="getFields--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFields</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a><org.eclipse.persistence.internal.helper.DatabaseField> getFields()</pre> |
| <div class="block">INTERNAL: |
| Returns a vector of all the fields this mapping represents.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/core/mappings/CoreMapping.html#getFields--">getFields</a></code> in class <code><a href="../../../../org/eclipse/persistence/core/mappings/CoreMapping.html" title="class in org.eclipse.persistence.core.mappings">CoreMapping</a><<a href="../../../../org/eclipse/persistence/mappings/AttributeAccessor.html" title="class in org.eclipse.persistence.mappings">AttributeAccessor</a>,org.eclipse.persistence.internal.sessions.AbstractSession,org.eclipse.persistence.internal.queries.ContainerPolicy,<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a>,org.eclipse.persistence.internal.helper.DatabaseField></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getOrderByNormalizedExpressions-org.eclipse.persistence.expressions.Expression-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOrderByNormalizedExpressions</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a>> getOrderByNormalizedExpressions(<a href="../../../../org/eclipse/persistence/expressions/Expression.html" title="class in org.eclipse.persistence.expressions">Expression</a> base)</pre> |
| <div class="block">INTERNAL: |
| Return the list of fields that should be used if this mapping is used in an order by. |
| null means this mapping does not need to normalize it fields (it is a field).</div> |
| </li> |
| </ul> |
| <a name="getGetMethodName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getGetMethodName</h4> |
| <pre>public <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> getGetMethodName()</pre> |
| <div class="block">PUBLIC: |
| This method is invoked reflectively on the reference object to return the value of the |
| attribute in the object. This method returns the name of the getMethodName or null if not using method access.</div> |
| </li> |
| </ul> |
| <a name="hasMapsIdValue--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasMapsIdValue</h4> |
| <pre>public boolean hasMapsIdValue()</pre> |
| <div class="block">ADVANCED: |
| Set the mapped by id value</div> |
| </li> |
| </ul> |
| <a name="getMapsIdValue--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMapsIdValue</h4> |
| <pre>public <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> getMapsIdValue()</pre> |
| <div class="block">ADVANCED: |
| Set the mapped by id value</div> |
| </li> |
| </ul> |
| <a name="getObjectCorrespondingTo-java.lang.Object-org.eclipse.persistence.sessions.remote.DistributedSession-java.util.Map-java.util.Map-org.eclipse.persistence.queries.ObjectLevelReadQuery-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getObjectCorrespondingTo</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> getObjectCorrespondingTo(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object, |
| <a href="../../../../org/eclipse/persistence/sessions/remote/DistributedSession.html" title="class in org.eclipse.persistence.sessions.remote">DistributedSession</a> session, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> objectDescriptors, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> processedObjects, |
| <a href="../../../../org/eclipse/persistence/queries/ObjectLevelReadQuery.html" title="class in org.eclipse.persistence.queries">ObjectLevelReadQuery</a> query)</pre> |
| <div class="block">INTERNAL: |
| return the object on the client corresponding to the specified object. |
| The default is to simply return the object itself, without worrying about |
| maintaining object identity.</div> |
| </li> |
| </ul> |
| <a name="getProperties--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProperties</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> getProperties()</pre> |
| <div class="block">INTERNAL: |
| used as a temporary store for custom SDK usage</div> |
| </li> |
| </ul> |
| <a name="getProperty-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProperty</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> getProperty(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> property)</pre> |
| <div class="block">ADVANCED: |
| Allow user defined properties.</div> |
| </li> |
| </ul> |
| <a name="getRealAttributeValueFromObject-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRealAttributeValueFromObject</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> getRealAttributeValueFromObject(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object, |
| org.eclipse.persistence.internal.sessions.AbstractSession session) |
| throws <a href="../../../../org/eclipse/persistence/exceptions/DescriptorException.html" title="class in org.eclipse.persistence.exceptions">DescriptorException</a></pre> |
| <div class="block">INTERNAL: |
| Return the value of an attribute unwrapping value holders if required.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/exceptions/DescriptorException.html" title="class in org.eclipse.persistence.exceptions">DescriptorException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRealAttributeValueFromAttribute-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRealAttributeValueFromAttribute</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> getRealAttributeValueFromAttribute(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> attributeValue, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object, |
| org.eclipse.persistence.internal.sessions.AbstractSession session) |
| throws <a href="../../../../org/eclipse/persistence/exceptions/DescriptorException.html" title="class in org.eclipse.persistence.exceptions">DescriptorException</a></pre> |
| <div class="block">INTERNAL: |
| Return the value of an attribute unwrapping value holders if required.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/exceptions/DescriptorException.html" title="class in org.eclipse.persistence.exceptions">DescriptorException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="instantiateAttribute-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>instantiateAttribute</h4> |
| <pre>public void instantiateAttribute(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</pre> |
| <div class="block">INTERNAL: |
| Trigger the instantiation of the attribute if lazy.</div> |
| </li> |
| </ul> |
| <a name="isAttributeValueFromObjectInstantiated-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isAttributeValueFromObjectInstantiated</h4> |
| <pre>public boolean isAttributeValueFromObjectInstantiated(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object)</pre> |
| <div class="block">INTERNAL: |
| Return whether the specified object is instantiated.</div> |
| </li> |
| </ul> |
| <a name="getRealCollectionAttributeValueFromObject-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRealCollectionAttributeValueFromObject</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> getRealCollectionAttributeValueFromObject(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object, |
| org.eclipse.persistence.internal.sessions.AbstractSession session) |
| throws <a href="../../../../org/eclipse/persistence/exceptions/DescriptorException.html" title="class in org.eclipse.persistence.exceptions">DescriptorException</a></pre> |
| <div class="block">INTERNAL: |
| Return the value of an attribute, unwrapping value holders if necessary. |
| If the value is null, build a new container.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/exceptions/DescriptorException.html" title="class in org.eclipse.persistence.exceptions">DescriptorException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getReferenceDescriptor--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getReferenceDescriptor</h4> |
| <pre>public <a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a> getReferenceDescriptor()</pre> |
| <div class="block">PUBLIC: |
| Return the referenceDescriptor. This is a descriptor which is associated with |
| the reference class.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/core/mappings/CoreMapping.html#getReferenceDescriptor--">getReferenceDescriptor</a></code> in class <code><a href="../../../../org/eclipse/persistence/core/mappings/CoreMapping.html" title="class in org.eclipse.persistence.core.mappings">CoreMapping</a><<a href="../../../../org/eclipse/persistence/mappings/AttributeAccessor.html" title="class in org.eclipse.persistence.mappings">AttributeAccessor</a>,org.eclipse.persistence.internal.sessions.AbstractSession,org.eclipse.persistence.internal.queries.ContainerPolicy,<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a>,org.eclipse.persistence.internal.helper.DatabaseField></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRelationshipPartner--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRelationshipPartner</h4> |
| <pre>public <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a> getRelationshipPartner()</pre> |
| <div class="block">INTERNAL: |
| Return the relationshipPartner mapping for this bi-directional mapping. If the relationshipPartner is null then |
| this is a uni-directional mapping.</div> |
| </li> |
| </ul> |
| <a name="getSetMethodName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSetMethodName</h4> |
| <pre>public <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> getSetMethodName()</pre> |
| <div class="block">PUBLIC: |
| This method is invoked reflectively on the reference object to set the value of the |
| attribute in the object. This method returns the name of the setMethodName or null if not using method access.</div> |
| </li> |
| </ul> |
| <a name="getUnconvertedProperties--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUnconvertedProperties</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<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>,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<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>>> getUnconvertedProperties()</pre> |
| <div class="block">INTERNAL: |
| Used to store un-converted properties, which are subsequenctly converted |
| at runtime (through the convertClassNamesToClasses method.</div> |
| </li> |
| </ul> |
| <a name="getValueFromRemoteValueHolder-org.eclipse.persistence.internal.sessions.remote.RemoteValueHolder-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValueFromRemoteValueHolder</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> getValueFromRemoteValueHolder(org.eclipse.persistence.internal.sessions.remote.RemoteValueHolder remoteValueHolder)</pre> |
| <div class="block">INTERNAL: |
| extract and return the appropriate value from the |
| specified remote value holder</div> |
| </li> |
| </ul> |
| <a name="getWeight--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getWeight</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> getWeight()</pre> |
| <div class="block">INTERNAL: |
| Return the weight of the mapping, used to sort mappings to ensure that |
| DirectToField Mappings get merged first</div> |
| </li> |
| </ul> |
| <a name="hasConstraintDependency--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasConstraintDependency</h4> |
| <pre>public boolean hasConstraintDependency()</pre> |
| <div class="block">INTERNAL: |
| The returns if the mapping has any constraint dependencies, such as foreign keys and join tables.</div> |
| </li> |
| </ul> |
| <a name="isUsingMethodAccess--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isUsingMethodAccess</h4> |
| <pre>public boolean isUsingMethodAccess()</pre> |
| <div class="block">PUBLIC: |
| Return if method access is used.</div> |
| </li> |
| </ul> |
| <a name="hasDependency--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasDependency</h4> |
| <pre>public boolean hasDependency()</pre> |
| <div class="block">INTERNAL: |
| Return if the mapping has any ownership or other dependency over its target object(s).</div> |
| </li> |
| </ul> |
| <a name="hasInverseConstraintDependency--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasInverseConstraintDependency</h4> |
| <pre>public boolean hasInverseConstraintDependency()</pre> |
| <div class="block">INTERNAL: |
| The returns if the mapping has any inverse constraint dependencies, such as foreign keys and join tables.</div> |
| </li> |
| </ul> |
| <a name="initialize-org.eclipse.persistence.internal.sessions.AbstractSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>initialize</h4> |
| <pre>public void initialize(org.eclipse.persistence.internal.sessions.AbstractSession session) |
| throws <a href="../../../../org/eclipse/persistence/exceptions/DescriptorException.html" title="class in org.eclipse.persistence.exceptions">DescriptorException</a></pre> |
| <div class="block">INTERNAL: |
| Allow for initialization of properties and validation.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/exceptions/DescriptorException.html" title="class in org.eclipse.persistence.exceptions">DescriptorException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isAggregateCollectionMapping--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isAggregateCollectionMapping</h4> |
| <pre>public boolean isAggregateCollectionMapping()</pre> |
| <div class="block">INTERNAL: |
| Related mapping should implement this method to return true.</div> |
| </li> |
| </ul> |
| <a name="isAggregateMapping--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isAggregateMapping</h4> |
| <pre>public boolean isAggregateMapping()</pre> |
| <div class="block">INTERNAL: |
| Related mapping should implement this method to return true.</div> |
| </li> |
| </ul> |
| <a name="isAggregateObjectMapping--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isAggregateObjectMapping</h4> |
| <pre>public boolean isAggregateObjectMapping()</pre> |
| <div class="block">INTERNAL: |
| Related mapping should implement this method to return true.</div> |
| </li> |
| </ul> |
| <a name="isCollectionMapping--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isCollectionMapping</h4> |
| <pre>public boolean isCollectionMapping()</pre> |
| <div class="block">INTERNAL: |
| Related mapping should implement this method to return true.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/core/mappings/CoreMapping.html#isCollectionMapping--">isCollectionMapping</a></code> in class <code><a href="../../../../org/eclipse/persistence/core/mappings/CoreMapping.html" title="class in org.eclipse.persistence.core.mappings">CoreMapping</a><<a href="../../../../org/eclipse/persistence/mappings/AttributeAccessor.html" title="class in org.eclipse.persistence.mappings">AttributeAccessor</a>,org.eclipse.persistence.internal.sessions.AbstractSession,org.eclipse.persistence.internal.queries.ContainerPolicy,<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a>,org.eclipse.persistence.internal.helper.DatabaseField></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isDatabaseMapping--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDatabaseMapping</h4> |
| <pre>public boolean isDatabaseMapping()</pre> |
| <div class="block">INTERNAL:</div> |
| </li> |
| </ul> |
| <a name="isDirectCollectionMapping--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDirectCollectionMapping</h4> |
| <pre>public boolean isDirectCollectionMapping()</pre> |
| <div class="block">INTERNAL: |
| Related mapping should implement this method to return true.</div> |
| </li> |
| </ul> |
| <a name="isDirectMapMapping--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDirectMapMapping</h4> |
| <pre>public boolean isDirectMapMapping()</pre> |
| <div class="block">INTERNAL: |
| Related mapping should implement this method to return true.</div> |
| </li> |
| </ul> |
| <a name="isDirectToFieldMapping--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDirectToFieldMapping</h4> |
| <pre>public boolean isDirectToFieldMapping()</pre> |
| <div class="block">INTERNAL: |
| Related mapping should implement this method to return true.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/core/mappings/CoreMapping.html#isDirectToFieldMapping--">isDirectToFieldMapping</a></code> in class <code><a href="../../../../org/eclipse/persistence/core/mappings/CoreMapping.html" title="class in org.eclipse.persistence.core.mappings">CoreMapping</a><<a href="../../../../org/eclipse/persistence/mappings/AttributeAccessor.html" title="class in org.eclipse.persistence.mappings">AttributeAccessor</a>,org.eclipse.persistence.internal.sessions.AbstractSession,org.eclipse.persistence.internal.queries.ContainerPolicy,<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a>,org.eclipse.persistence.internal.helper.DatabaseField></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isElementCollectionMapping--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isElementCollectionMapping</h4> |
| <pre>public boolean isElementCollectionMapping()</pre> |
| <div class="block">INTERNAL: |
| Related mapping should implement this method to return true.</div> |
| </li> |
| </ul> |
| <a name="isForeignReferenceMapping--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isForeignReferenceMapping</h4> |
| <pre>public boolean isForeignReferenceMapping()</pre> |
| <div class="block">INTERNAL: |
| Related mapping should implement this method to return true.</div> |
| </li> |
| </ul> |
| <a name="isLockableMapping--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isLockableMapping</h4> |
| <pre>public boolean isLockableMapping()</pre> |
| <div class="block">INTERNAL: |
| Return whether this mapping should be traversed when we are locking</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| </dl> |
| </li> |
| </ul> |
| <a name="isManyToManyMapping--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isManyToManyMapping</h4> |
| <pre>public boolean isManyToManyMapping()</pre> |
| <div class="block">INTERNAL: |
| Related mapping should implement this method to return true.</div> |
| </li> |
| </ul> |
| <a name="isMapKeyMapping--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isMapKeyMapping</h4> |
| <pre>public boolean isMapKeyMapping()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the isMapKeyMapping</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isMultitenantPrimaryKeyMapping--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isMultitenantPrimaryKeyMapping</h4> |
| <pre>public boolean isMultitenantPrimaryKeyMapping()</pre> |
| <div class="block">INTERNAL</div> |
| </li> |
| </ul> |
| <a name="setIsMapKeyMapping-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIsMapKeyMapping</h4> |
| <pre>public void setIsMapKeyMapping(boolean isMapKeyMapping)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>isMapKeyMapping</code> - the isMapKeyMapping to set</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isNestedTableMapping--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isNestedTableMapping</h4> |
| <pre>public boolean isNestedTableMapping()</pre> |
| <div class="block">INTERNAL: |
| Related mapping should implement this method to return true.</div> |
| </li> |
| </ul> |
| <a name="isObjectReferenceMapping--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isObjectReferenceMapping</h4> |
| <pre>public boolean isObjectReferenceMapping()</pre> |
| <div class="block">INTERNAL: |
| Related mapping should implement this method to return true.</div> |
| </li> |
| </ul> |
| <a name="isOneToManyMapping--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isOneToManyMapping</h4> |
| <pre>public boolean isOneToManyMapping()</pre> |
| <div class="block">INTERNAL: |
| Related mapping should implement this method to return true.</div> |
| </li> |
| </ul> |
| <a name="isOneToOneMapping--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isOneToOneMapping</h4> |
| <pre>public boolean isOneToOneMapping()</pre> |
| <div class="block">INTERNAL: |
| Related mapping should implement this method to return true.</div> |
| </li> |
| </ul> |
| <a name="isManyToOneMapping--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isManyToOneMapping</h4> |
| <pre>public boolean isManyToOneMapping()</pre> |
| <div class="block">INTERNAL: |
| Related mapping should implement this method to return true.</div> |
| </li> |
| </ul> |
| <a name="isOptional--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isOptional</h4> |
| <pre>public boolean isOptional()</pre> |
| <div class="block">Return whether the value of this mapping is optional (that is, can be |
| null). This is a hint and is used when generating DDL.</div> |
| </li> |
| </ul> |
| <a name="isOwned--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isOwned</h4> |
| <pre>public boolean isOwned()</pre> |
| <div class="block">Returns true if this mapping is owned by the parent descriptor. This is generally based on mapping type</div> |
| </li> |
| </ul> |
| <a name="isJPAId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isJPAId</h4> |
| <pre>public boolean isJPAId()</pre> |
| <div class="block">INTERNAL: |
| Flags that this mapping is part of a JPA id mapping. It should be |
| temporary though, as the CMP3Policy should be able to figure things |
| out on its own. The problem being that the JPA mapped superclass |
| descriptors are not initialized and do not have a CMP3Policy set by |
| default.</div> |
| </li> |
| </ul> |
| <a name="isLazy--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isLazy</h4> |
| <pre>public boolean isLazy()</pre> |
| <div class="block">Return if this mapping is lazy. |
| Lazy has different meaning for different mappings. |
| For basic/direct mappings, this can be used exclude it from the descriptor's |
| default fetch group. This means that queries will not include the field(s) required |
| by this mapping by default. |
| This can only be used if the descriptor has a FetchGroupManager and class implements |
| the FetchGroupTracker interface (or is weaved). |
| <p> |
| For relationship mappings this should normally be the same value as indirection, |
| however for eager relationships this can be used with indirection to allow |
| indirection locking and change tracking, but still always force instantiation.</div> |
| </li> |
| </ul> |
| <a name="setIsJPAId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIsJPAId</h4> |
| <pre>public void setIsJPAId()</pre> |
| <div class="block">INTERNAL: |
| Flags that this mapping is part of a JPA id mapping. It should be |
| temporary though, as the CMP3Policy should be able to figure things |
| out on its own. The problem being that the JPA mapped superclass |
| descriptors are not initialized and do not have a CMP3Policy set by |
| default.</div> |
| </li> |
| </ul> |
| <a name="setIsLazy-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIsLazy</h4> |
| <pre>public void setIsLazy(boolean isLazy)</pre> |
| <div class="block">Set if this mapping is lazy. |
| This can be used for any mapping type to exclude it from the descriptor's |
| default fetch group. This means that queries will not include the field(s) required |
| by this mapping by default. |
| This can only be used if the descriptor has a FetchGroupManager and class implements |
| the FetchGroupTracker interface (or is weaved). |
| This is not the same as indirection on relationships (lazy relationships), |
| as it defers the loading of the source object fields, not the relationship.</div> |
| </li> |
| </ul> |
| <a name="isEISMapping--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isEISMapping</h4> |
| <pre>public boolean isEISMapping()</pre> |
| <div class="block">INTERNAL: |
| All EIS mappings should implement this method to return true.</div> |
| </li> |
| </ul> |
| <a name="isRelationalMapping--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isRelationalMapping</h4> |
| <pre>public boolean isRelationalMapping()</pre> |
| <div class="block">INTERNAL: |
| All relational mappings should implement this method to return true.</div> |
| </li> |
| </ul> |
| <a name="isXMLMapping--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isXMLMapping</h4> |
| <pre>public boolean isXMLMapping()</pre> |
| <div class="block">INTERNAL: |
| All relational mappings should implement this method to return true.</div> |
| </li> |
| </ul> |
| <a name="isAbstractDirectMapping--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isAbstractDirectMapping</h4> |
| <pre>public boolean isAbstractDirectMapping()</pre> |
| <div class="block">INTERNAL: |
| Related mapping should implement this method to return true.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/core/mappings/CoreMapping.html#isAbstractDirectMapping--">isAbstractDirectMapping</a></code> in class <code><a href="../../../../org/eclipse/persistence/core/mappings/CoreMapping.html" title="class in org.eclipse.persistence.core.mappings">CoreMapping</a><<a href="../../../../org/eclipse/persistence/mappings/AttributeAccessor.html" title="class in org.eclipse.persistence.mappings">AttributeAccessor</a>,org.eclipse.persistence.internal.sessions.AbstractSession,org.eclipse.persistence.internal.queries.ContainerPolicy,<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a>,org.eclipse.persistence.internal.helper.DatabaseField></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isAbstractColumnMapping--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isAbstractColumnMapping</h4> |
| <pre>public boolean isAbstractColumnMapping()</pre> |
| <div class="block">INTERNAL:</div> |
| </li> |
| </ul> |
| <a name="isAbstractCompositeDirectCollectionMapping--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isAbstractCompositeDirectCollectionMapping</h4> |
| <pre>public boolean isAbstractCompositeDirectCollectionMapping()</pre> |
| <div class="block">INTERNAL: |
| Related mapping should implement this method to return true.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/core/mappings/CoreMapping.html#isAbstractCompositeDirectCollectionMapping--">isAbstractCompositeDirectCollectionMapping</a></code> in class <code><a href="../../../../org/eclipse/persistence/core/mappings/CoreMapping.html" title="class in org.eclipse.persistence.core.mappings">CoreMapping</a><<a href="../../../../org/eclipse/persistence/mappings/AttributeAccessor.html" title="class in org.eclipse.persistence.mappings">AttributeAccessor</a>,org.eclipse.persistence.internal.sessions.AbstractSession,org.eclipse.persistence.internal.queries.ContainerPolicy,<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a>,org.eclipse.persistence.internal.helper.DatabaseField></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isAbstractCompositeObjectMapping--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isAbstractCompositeObjectMapping</h4> |
| <pre>public boolean isAbstractCompositeObjectMapping()</pre> |
| <div class="block">INTERNAL: |
| Related mapping should implement this method to return true.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/core/mappings/CoreMapping.html#isAbstractCompositeObjectMapping--">isAbstractCompositeObjectMapping</a></code> in class <code><a href="../../../../org/eclipse/persistence/core/mappings/CoreMapping.html" title="class in org.eclipse.persistence.core.mappings">CoreMapping</a><<a href="../../../../org/eclipse/persistence/mappings/AttributeAccessor.html" title="class in org.eclipse.persistence.mappings">AttributeAccessor</a>,org.eclipse.persistence.internal.sessions.AbstractSession,org.eclipse.persistence.internal.queries.ContainerPolicy,<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a>,org.eclipse.persistence.internal.helper.DatabaseField></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isAbstractCompositeCollectionMapping--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isAbstractCompositeCollectionMapping</h4> |
| <pre>public boolean isAbstractCompositeCollectionMapping()</pre> |
| <div class="block">INTERNAL: |
| Related mapping should implement this method to return true.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/core/mappings/CoreMapping.html#isAbstractCompositeCollectionMapping--">isAbstractCompositeCollectionMapping</a></code> in class <code><a href="../../../../org/eclipse/persistence/core/mappings/CoreMapping.html" title="class in org.eclipse.persistence.core.mappings">CoreMapping</a><<a href="../../../../org/eclipse/persistence/mappings/AttributeAccessor.html" title="class in org.eclipse.persistence.mappings">AttributeAccessor</a>,org.eclipse.persistence.internal.sessions.AbstractSession,org.eclipse.persistence.internal.queries.ContainerPolicy,<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a>,org.eclipse.persistence.internal.helper.DatabaseField></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isJoiningSupported--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isJoiningSupported</h4> |
| <pre>public boolean isJoiningSupported()</pre> |
| <div class="block">INTERNAL: |
| Return if this mapping support joining.</div> |
| </li> |
| </ul> |
| <a name="isCloningRequired--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isCloningRequired</h4> |
| <pre>public boolean isCloningRequired()</pre> |
| <div class="block">INTERNAL: |
| Return if this mapping requires its attribute value to be cloned.</div> |
| </li> |
| </ul> |
| <a name="isPrimaryKeyMapping--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isPrimaryKeyMapping</h4> |
| <pre>public boolean isPrimaryKeyMapping()</pre> |
| <div class="block">INTERNAL: |
| Set by the Object builder during initialization returns true if this mapping |
| is used as a primary key mapping.</div> |
| </li> |
| </ul> |
| <a name="isCandidateForPrivateOwnedRemoval--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isCandidateForPrivateOwnedRemoval</h4> |
| <pre>public boolean isCandidateForPrivateOwnedRemoval()</pre> |
| <div class="block">INTERNAL: |
| Returns true if the mapping should be added to the UnitOfWork's list of private owned |
| objects for private owned orphan removal.</div> |
| </li> |
| </ul> |
| <a name="isCascadedLockingSupported--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isCascadedLockingSupported</h4> |
| <pre>public boolean isCascadedLockingSupported()</pre> |
| <div class="block">INTERNAL: |
| Used when determining if a mapping supports cascaded version optimistic |
| locking.</div> |
| </li> |
| </ul> |
| <a name="isChangeTrackingSupported-org.eclipse.persistence.sessions.Project-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isChangeTrackingSupported</h4> |
| <pre>public boolean isChangeTrackingSupported(<a href="../../../../org/eclipse/persistence/sessions/Project.html" title="class in org.eclipse.persistence.sessions">Project</a> project)</pre> |
| <div class="block">INTERNAL: |
| Return if this mapping supports change tracking.</div> |
| </li> |
| </ul> |
| <a name="isPrivateOwned--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isPrivateOwned</h4> |
| <pre>public boolean isPrivateOwned()</pre> |
| <div class="block">INTERNAL: |
| Return if the mapping has ownership over its target object(s).</div> |
| </li> |
| </ul> |
| <a name="isCacheable--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isCacheable</h4> |
| <pre>public boolean isCacheable()</pre> |
| <div class="block">Used to signal that this mapping references a protected/isolated entity and requires |
| special merge/object building behaviour.</div> |
| </li> |
| </ul> |
| <a name="setIsCacheable-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIsCacheable</h4> |
| <pre>public void setIsCacheable(boolean cacheable)</pre> |
| <div class="block">Used to signal that this mapping references a protected/isolated entity and requires |
| special merge/object building behaviour.</div> |
| </li> |
| </ul> |
| <a name="isReadOnly--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isReadOnly</h4> |
| <pre>public boolean isReadOnly()</pre> |
| <div class="block">INTERNAL: |
| Returns true if mapping is read only else false.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/core/mappings/CoreMapping.html#isReadOnly--">isReadOnly</a></code> in class <code><a href="../../../../org/eclipse/persistence/core/mappings/CoreMapping.html" title="class in org.eclipse.persistence.core.mappings">CoreMapping</a><<a href="../../../../org/eclipse/persistence/mappings/AttributeAccessor.html" title="class in org.eclipse.persistence.mappings">AttributeAccessor</a>,org.eclipse.persistence.internal.sessions.AbstractSession,org.eclipse.persistence.internal.queries.ContainerPolicy,<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a>,org.eclipse.persistence.internal.helper.DatabaseField></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isReferenceMapping--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isReferenceMapping</h4> |
| <pre>public boolean isReferenceMapping()</pre> |
| <div class="block">INTERNAL: |
| Related mapping should implement this method to return true.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/core/mappings/CoreMapping.html#isReferenceMapping--">isReferenceMapping</a></code> in class <code><a href="../../../../org/eclipse/persistence/core/mappings/CoreMapping.html" title="class in org.eclipse.persistence.core.mappings">CoreMapping</a><<a href="../../../../org/eclipse/persistence/mappings/AttributeAccessor.html" title="class in org.eclipse.persistence.mappings">AttributeAccessor</a>,org.eclipse.persistence.internal.sessions.AbstractSession,org.eclipse.persistence.internal.queries.ContainerPolicy,<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a>,org.eclipse.persistence.internal.helper.DatabaseField></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isRemotelyInitialized--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isRemotelyInitialized</h4> |
| <pre>protected boolean isRemotelyInitialized()</pre> |
| </li> |
| </ul> |
| <a name="isStructureMapping--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isStructureMapping</h4> |
| <pre>public boolean isStructureMapping()</pre> |
| <div class="block">INTERNAL: |
| Related mapping should implement this method to return true.</div> |
| </li> |
| </ul> |
| <a name="isTransformationMapping--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isTransformationMapping</h4> |
| <pre>public boolean isTransformationMapping()</pre> |
| <div class="block">INTERNAL: |
| Related mapping should implement this method to return true.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/core/mappings/CoreMapping.html#isTransformationMapping--">isTransformationMapping</a></code> in class <code><a href="../../../../org/eclipse/persistence/core/mappings/CoreMapping.html" title="class in org.eclipse.persistence.core.mappings">CoreMapping</a><<a href="../../../../org/eclipse/persistence/mappings/AttributeAccessor.html" title="class in org.eclipse.persistence.mappings">AttributeAccessor</a>,org.eclipse.persistence.internal.sessions.AbstractSession,org.eclipse.persistence.internal.queries.ContainerPolicy,<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a>,org.eclipse.persistence.internal.helper.DatabaseField></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isUnidirectionalOneToManyMapping--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isUnidirectionalOneToManyMapping</h4> |
| <pre>public boolean isUnidirectionalOneToManyMapping()</pre> |
| <div class="block">INTERNAL:</div> |
| </li> |
| </ul> |
| <a name="isVariableOneToOneMapping--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isVariableOneToOneMapping</h4> |
| <pre>public boolean isVariableOneToOneMapping()</pre> |
| <div class="block">INTERNAL: |
| Related mapping should implement this method to return true.</div> |
| </li> |
| </ul> |
| <a name="isDirectToXMLTypeMapping--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDirectToXMLTypeMapping</h4> |
| <pre>public boolean isDirectToXMLTypeMapping()</pre> |
| <div class="block">INTERNAL: |
| Related mapping should implement this method to return true.</div> |
| </li> |
| </ul> |
| <a name="isWriteOnly--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isWriteOnly</h4> |
| <pre>public boolean isWriteOnly()</pre> |
| <div class="block">INTERNAL: |
| Some mappings support no attribute (transformation and multitenant primary key).</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/core/mappings/CoreMapping.html#isWriteOnly--">isWriteOnly</a></code> in class <code><a href="../../../../org/eclipse/persistence/core/mappings/CoreMapping.html" title="class in org.eclipse.persistence.core.mappings">CoreMapping</a><<a href="../../../../org/eclipse/persistence/mappings/AttributeAccessor.html" title="class in org.eclipse.persistence.mappings">AttributeAccessor</a>,org.eclipse.persistence.internal.sessions.AbstractSession,org.eclipse.persistence.internal.queries.ContainerPolicy,<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a>,org.eclipse.persistence.internal.helper.DatabaseField></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="iterate-org.eclipse.persistence.internal.descriptors.DescriptorIterator-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>iterate</h4> |
| <pre>public abstract void iterate(org.eclipse.persistence.internal.descriptors.DescriptorIterator iterator)</pre> |
| <div class="block">INTERNAL: |
| Iterate on the appropriate attribute value.</div> |
| </li> |
| </ul> |
| <a name="iterateOnRealAttributeValue-org.eclipse.persistence.internal.descriptors.DescriptorIterator-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>iterateOnRealAttributeValue</h4> |
| <pre>public void iterateOnRealAttributeValue(org.eclipse.persistence.internal.descriptors.DescriptorIterator iterator, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> realAttributeValue)</pre> |
| <div class="block">INTERNAL: |
| Iterate on the attribute value. |
| The value holder has already been processed.</div> |
| </li> |
| </ul> |
| <a name="load-java.lang.Object-org.eclipse.persistence.internal.queries.AttributeItem-org.eclipse.persistence.internal.sessions.AbstractSession-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>load</h4> |
| <pre>public void load(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object, |
| org.eclipse.persistence.internal.queries.AttributeItem item, |
| org.eclipse.persistence.internal.sessions.AbstractSession session, |
| boolean fromFetchGroup)</pre> |
| <div class="block">Force instantiation of the load group.</div> |
| </li> |
| </ul> |
| <a name="loadAll-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-org.eclipse.persistence.internal.helper.IdentityHashSet-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>loadAll</h4> |
| <pre>public void loadAll(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object, |
| org.eclipse.persistence.internal.sessions.AbstractSession session, |
| org.eclipse.persistence.internal.helper.IdentityHashSet loaded)</pre> |
| <div class="block">Force instantiation of all indirections.</div> |
| </li> |
| </ul> |
| <a name="mergeChangesIntoObject-java.lang.Object-org.eclipse.persistence.internal.sessions.ChangeRecord-java.lang.Object-org.eclipse.persistence.internal.sessions.MergeManager-org.eclipse.persistence.internal.sessions.AbstractSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>mergeChangesIntoObject</h4> |
| <pre>public abstract void mergeChangesIntoObject(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> target, |
| org.eclipse.persistence.internal.sessions.ChangeRecord changeRecord, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> source, |
| org.eclipse.persistence.internal.sessions.MergeManager mergeManager, |
| org.eclipse.persistence.internal.sessions.AbstractSession targetSession)</pre> |
| <div class="block">INTERNAL: |
| Merge changes from the source to the target object.</div> |
| </li> |
| </ul> |
| <a name="mergeIntoObject-java.lang.Object-boolean-java.lang.Object-org.eclipse.persistence.internal.sessions.MergeManager-org.eclipse.persistence.internal.sessions.AbstractSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>mergeIntoObject</h4> |
| <pre>public abstract void mergeIntoObject(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> target, |
| boolean isTargetUninitialized, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> source, |
| org.eclipse.persistence.internal.sessions.MergeManager mergeManager, |
| org.eclipse.persistence.internal.sessions.AbstractSession targetSession)</pre> |
| <div class="block">INTERNAL: |
| Merge changes from the source to the target object.</div> |
| </li> |
| </ul> |
| <a name="performDataModificationEvent-java.lang.Object:A-org.eclipse.persistence.internal.sessions.AbstractSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>performDataModificationEvent</h4> |
| <pre>public void performDataModificationEvent(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>[] event, |
| org.eclipse.persistence.internal.sessions.AbstractSession session) |
| throws <a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a>, |
| <a href="../../../../org/eclipse/persistence/exceptions/DescriptorException.html" title="class in org.eclipse.persistence.exceptions">DescriptorException</a></pre> |
| <div class="block">INTERNAL: |
| Perform the commit event. |
| This is used in the uow to delay data modifications.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></code></dd> |
| <dd><code><a href="../../../../org/eclipse/persistence/exceptions/DescriptorException.html" title="class in org.eclipse.persistence.exceptions">DescriptorException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="postDelete-org.eclipse.persistence.queries.DeleteObjectQuery-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>postDelete</h4> |
| <pre>public void postDelete(<a href="../../../../org/eclipse/persistence/queries/DeleteObjectQuery.html" title="class in org.eclipse.persistence.queries">DeleteObjectQuery</a> query) |
| throws <a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></pre> |
| <div class="block">INTERNAL: |
| A subclass should implement this method if it wants different behavior. |
| Recurse thru the parts to delete the reference objects after the actual object is deleted.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="postInitialize-org.eclipse.persistence.internal.sessions.AbstractSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>postInitialize</h4> |
| <pre>public void postInitialize(org.eclipse.persistence.internal.sessions.AbstractSession session) |
| throws <a href="../../../../org/eclipse/persistence/exceptions/DescriptorException.html" title="class in org.eclipse.persistence.exceptions">DescriptorException</a></pre> |
| <div class="block">INTERNAL: |
| Allow for initialization of properties and validation that have dependecies no the descriptor |
| being initialized.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/exceptions/DescriptorException.html" title="class in org.eclipse.persistence.exceptions">DescriptorException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="postInsert-org.eclipse.persistence.queries.WriteObjectQuery-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>postInsert</h4> |
| <pre>public void postInsert(<a href="../../../../org/eclipse/persistence/queries/WriteObjectQuery.html" title="class in org.eclipse.persistence.queries">WriteObjectQuery</a> query) |
| throws <a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></pre> |
| <div class="block">INTERNAL: |
| A subclass should implement this method if it wants different behavior. |
| Recurse thru the parts to insert the reference objects after the actual object is inserted.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="postUpdate-org.eclipse.persistence.queries.WriteObjectQuery-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>postUpdate</h4> |
| <pre>public void postUpdate(<a href="../../../../org/eclipse/persistence/queries/WriteObjectQuery.html" title="class in org.eclipse.persistence.queries">WriteObjectQuery</a> query) |
| throws <a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></pre> |
| <div class="block">INTERNAL: |
| A subclass should implement this method if it wants different behavior. |
| Recurse thru the parts to update the reference objects after the actual object is updated.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="preDelete-org.eclipse.persistence.queries.DeleteObjectQuery-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>preDelete</h4> |
| <pre>public void preDelete(<a href="../../../../org/eclipse/persistence/queries/DeleteObjectQuery.html" title="class in org.eclipse.persistence.queries">DeleteObjectQuery</a> query) |
| throws <a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></pre> |
| <div class="block">INTERNAL: |
| A subclass should implement this method if it wants different behavior. |
| Recurse thru the parts to delete the reference objects before the actual object is deleted.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="preInitialize-org.eclipse.persistence.internal.sessions.AbstractSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>preInitialize</h4> |
| <pre>public void preInitialize(org.eclipse.persistence.internal.sessions.AbstractSession session) |
| throws <a href="../../../../org/eclipse/persistence/exceptions/DescriptorException.html" title="class in org.eclipse.persistence.exceptions">DescriptorException</a></pre> |
| <div class="block">INTERNAL: |
| Allow for initialization of properties and validation.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/exceptions/DescriptorException.html" title="class in org.eclipse.persistence.exceptions">DescriptorException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="preInsert-org.eclipse.persistence.queries.WriteObjectQuery-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>preInsert</h4> |
| <pre>public void preInsert(<a href="../../../../org/eclipse/persistence/queries/WriteObjectQuery.html" title="class in org.eclipse.persistence.queries">WriteObjectQuery</a> query) |
| throws <a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></pre> |
| <div class="block">INTERNAL: |
| A subclass should implement this method if it wants different behavior. |
| Recurse thru the parts to insert the reference objects before the actual object is inserted.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="prepareCascadeLockingPolicy--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>prepareCascadeLockingPolicy</h4> |
| <pre>public void prepareCascadeLockingPolicy()</pre> |
| <div class="block">INTERNAL: |
| A subclass that supports cascade version optimistic locking should |
| implement this method to properly prepare the locking policy for their |
| mapping type.</div> |
| </li> |
| </ul> |
| <a name="preUpdate-org.eclipse.persistence.queries.WriteObjectQuery-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>preUpdate</h4> |
| <pre>public void preUpdate(<a href="../../../../org/eclipse/persistence/queries/WriteObjectQuery.html" title="class in org.eclipse.persistence.queries">WriteObjectQuery</a> query) |
| throws <a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></pre> |
| <div class="block">INTERNAL: |
| A subclass should implement this method if it wants different behavior. |
| Recurse thru the parts to update the reference objects before the actual object is updated.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="readFromRowIntoObject-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.queries.JoinedAttributeManager-java.lang.Object-org.eclipse.persistence.internal.identitymaps.CacheKey-org.eclipse.persistence.queries.ObjectBuildingQuery-org.eclipse.persistence.internal.sessions.AbstractSession-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readFromRowIntoObject</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> readFromRowIntoObject(org.eclipse.persistence.internal.sessions.AbstractRecord databaseRow, |
| org.eclipse.persistence.internal.queries.JoinedAttributeManager joinManager, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> targetObject, |
| org.eclipse.persistence.internal.identitymaps.CacheKey parentCacheKey, |
| <a href="../../../../org/eclipse/persistence/queries/ObjectBuildingQuery.html" title="class in org.eclipse.persistence.queries">ObjectBuildingQuery</a> sourceQuery, |
| org.eclipse.persistence.internal.sessions.AbstractSession executionSession, |
| boolean isTargetProtected) |
| throws <a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></pre> |
| <div class="block">INTERNAL: |
| Extract value from the row and set the attribute to this value in the object. |
| return value as this value will have been converted to the appropriate type for |
| the object.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="readFromResultSetIntoObject-java.sql.ResultSet-java.lang.Object-org.eclipse.persistence.queries.ObjectBuildingQuery-org.eclipse.persistence.internal.sessions.AbstractSession-org.eclipse.persistence.internal.databaseaccess.DatabaseAccessor-java.sql.ResultSetMetaData-int-org.eclipse.persistence.internal.databaseaccess.DatabasePlatform-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readFromResultSetIntoObject</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> readFromResultSetIntoObject(<a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSet.html?is-external=true" title="class or interface in java.sql">ResultSet</a> resultSet, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> targetObject, |
| <a href="../../../../org/eclipse/persistence/queries/ObjectBuildingQuery.html" title="class in org.eclipse.persistence.queries">ObjectBuildingQuery</a> query, |
| org.eclipse.persistence.internal.sessions.AbstractSession session, |
| org.eclipse.persistence.internal.databaseaccess.DatabaseAccessor accessor, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSetMetaData.html?is-external=true" title="class or interface in java.sql">ResultSetMetaData</a> metaData, |
| int columnNumber, |
| org.eclipse.persistence.internal.databaseaccess.DatabasePlatform platform) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></pre> |
| <div class="block">INTERNAL: |
| Extract values directly from the result-set. |
| PERF: This is used for optimized object building directly from the result-set.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="readOnly--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readOnly</h4> |
| <pre>public void readOnly()</pre> |
| <div class="block">PUBLIC: |
| To make mapping read only. |
| Read-only mappings can be used if two attributes map to the same field. |
| Read-only mappings cannot be used for the primary key or other required fields.</div> |
| </li> |
| </ul> |
| <a name="readWrite--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readWrite</h4> |
| <pre>public void readWrite()</pre> |
| <div class="block">PUBLIC: |
| The mapping can be dynamically made either readOnly or readWriteOnly. This makes mapping go back to |
| default mode.</div> |
| </li> |
| </ul> |
| <a name="rehashFieldDependancies-org.eclipse.persistence.internal.sessions.AbstractSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>rehashFieldDependancies</h4> |
| <pre>public void rehashFieldDependancies(org.eclipse.persistence.internal.sessions.AbstractSession session)</pre> |
| <div class="block">INTERNAL: |
| Rehash any hashtables based on fields. |
| This is used to clone descriptors for aggregates, which hammer field names, |
| it is probably better not to hammer the field name and this should be refactored.</div> |
| </li> |
| </ul> |
| <a name="remoteInitialization-org.eclipse.persistence.sessions.remote.DistributedSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>remoteInitialization</h4> |
| <pre>public void remoteInitialization(<a href="../../../../org/eclipse/persistence/sessions/remote/DistributedSession.html" title="class in org.eclipse.persistence.sessions.remote">DistributedSession</a> session)</pre> |
| <div class="block">INTERNAL: |
| Once descriptors are serialized to the remote session. All its mappings and reference descriptors are traversed. Usually |
| mappings are initilaized and serialized reference descriptors are replaced with local descriptors if they already exist on the |
| remote session.</div> |
| </li> |
| </ul> |
| <a name="remotelyInitialized--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>remotelyInitialized</h4> |
| <pre>protected void remotelyInitialized()</pre> |
| <div class="block">Set the mapping to be initialized for the remote session.</div> |
| </li> |
| </ul> |
| <a name="replaceValueHoldersIn-java.lang.Object-org.eclipse.persistence.internal.sessions.remote.RemoteSessionController-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replaceValueHoldersIn</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> replaceValueHoldersIn(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object, |
| org.eclipse.persistence.internal.sessions.remote.RemoteSessionController controller)</pre> |
| <div class="block">INTERNAL: |
| replace the value holders in the specified reference object(s)</div> |
| </li> |
| </ul> |
| <a name="setAttributeAccessor-org.eclipse.persistence.mappings.AttributeAccessor-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAttributeAccessor</h4> |
| <pre>public void setAttributeAccessor(<a href="../../../../org/eclipse/persistence/mappings/AttributeAccessor.html" title="class in org.eclipse.persistence.mappings">AttributeAccessor</a> attributeAccessor)</pre> |
| <div class="block">ADVANCED: |
| Set the attributeAccessor. |
| The attribute accessor is responsible for setting and retrieving the attribute value |
| from the object for this mapping. |
| This can be set to an implementor of AttributeAccessor if the attribute |
| requires advanced conversion of the mapping value, or a real attribute does not exist.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/core/mappings/CoreMapping.html#setAttributeAccessor-ATTRIBUTE_ACCESSOR-">setAttributeAccessor</a></code> in class <code><a href="../../../../org/eclipse/persistence/core/mappings/CoreMapping.html" title="class in org.eclipse.persistence.core.mappings">CoreMapping</a><<a href="../../../../org/eclipse/persistence/mappings/AttributeAccessor.html" title="class in org.eclipse.persistence.mappings">AttributeAccessor</a>,org.eclipse.persistence.internal.sessions.AbstractSession,org.eclipse.persistence.internal.queries.ContainerPolicy,<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a>,org.eclipse.persistence.internal.helper.DatabaseField></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setAttributeName-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAttributeName</h4> |
| <pre>public void setAttributeName(<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> attributeName)</pre> |
| <div class="block">PUBLIC: |
| Sets the name of the attribute in the mapping.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/core/mappings/CoreMapping.html#setAttributeName-java.lang.String-">setAttributeName</a></code> in class <code><a href="../../../../org/eclipse/persistence/core/mappings/CoreMapping.html" title="class in org.eclipse.persistence.core.mappings">CoreMapping</a><<a href="../../../../org/eclipse/persistence/mappings/AttributeAccessor.html" title="class in org.eclipse.persistence.mappings">AttributeAccessor</a>,org.eclipse.persistence.internal.sessions.AbstractSession,org.eclipse.persistence.internal.queries.ContainerPolicy,<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a>,org.eclipse.persistence.internal.helper.DatabaseField></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setAttributeValueInObject-java.lang.Object-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAttributeValueInObject</h4> |
| <pre>public void setAttributeValueInObject(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value) |
| throws <a href="../../../../org/eclipse/persistence/exceptions/DescriptorException.html" title="class in org.eclipse.persistence.exceptions">DescriptorException</a></pre> |
| <div class="block">INTERNAL: |
| Set the value of the attribute mapped by this mapping.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/core/mappings/CoreMapping.html#setAttributeValueInObject-java.lang.Object-java.lang.Object-">setAttributeValueInObject</a></code> in class <code><a href="../../../../org/eclipse/persistence/core/mappings/CoreMapping.html" title="class in org.eclipse.persistence.core.mappings">CoreMapping</a><<a href="../../../../org/eclipse/persistence/mappings/AttributeAccessor.html" title="class in org.eclipse.persistence.mappings">AttributeAccessor</a>,org.eclipse.persistence.internal.sessions.AbstractSession,org.eclipse.persistence.internal.queries.ContainerPolicy,<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a>,org.eclipse.persistence.internal.helper.DatabaseField></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/exceptions/DescriptorException.html" title="class in org.eclipse.persistence.exceptions">DescriptorException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setRealAttributeValueInObject-java.lang.Object-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRealAttributeValueInObject</h4> |
| <pre>public void setRealAttributeValueInObject(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value) |
| throws <a href="../../../../org/eclipse/persistence/exceptions/DescriptorException.html" title="class in org.eclipse.persistence.exceptions">DescriptorException</a></pre> |
| <div class="block">INTERNAL: |
| Set the value of the attribute mapped by this mapping, |
| placing it inside a value holder if necessary.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/exceptions/DescriptorException.html" title="class in org.eclipse.persistence.exceptions">DescriptorException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setDescriptor-org.eclipse.persistence.descriptors.ClassDescriptor-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDescriptor</h4> |
| <pre>public void setDescriptor(<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a> descriptor)</pre> |
| <div class="block">INTERNAL: |
| Set the descriptor to which this mapping belongs</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/core/mappings/CoreMapping.html#setDescriptor-DESCRIPTOR-">setDescriptor</a></code> in class <code><a href="../../../../org/eclipse/persistence/core/mappings/CoreMapping.html" title="class in org.eclipse.persistence.core.mappings">CoreMapping</a><<a href="../../../../org/eclipse/persistence/mappings/AttributeAccessor.html" title="class in org.eclipse.persistence.mappings">AttributeAccessor</a>,org.eclipse.persistence.internal.sessions.AbstractSession,org.eclipse.persistence.internal.queries.ContainerPolicy,<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a>,org.eclipse.persistence.internal.helper.DatabaseField></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setFields-java.util.Vector-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFields</h4> |
| <pre>protected void setFields(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a><org.eclipse.persistence.internal.helper.DatabaseField> fields)</pre> |
| <div class="block">INTERNAL: |
| Set the mapping's field collection.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/core/mappings/CoreMapping.html#setFields-java.util.Vector-">setFields</a></code> in class <code><a href="../../../../org/eclipse/persistence/core/mappings/CoreMapping.html" title="class in org.eclipse.persistence.core.mappings">CoreMapping</a><<a href="../../../../org/eclipse/persistence/mappings/AttributeAccessor.html" title="class in org.eclipse.persistence.mappings">AttributeAccessor</a>,org.eclipse.persistence.internal.sessions.AbstractSession,org.eclipse.persistence.internal.queries.ContainerPolicy,<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a>,org.eclipse.persistence.internal.helper.DatabaseField></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setGetMethodName-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setGetMethodName</h4> |
| <pre>public void setGetMethodName(<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> methodName)</pre> |
| <div class="block">PUBLIC: |
| This method is invoked reflectively on the reference object to return the value of the |
| attribute in the object. This method sets the name of the getMethodName.</div> |
| </li> |
| </ul> |
| <a name="setIsOptional-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIsOptional</h4> |
| <pre>public void setIsOptional(boolean isOptional)</pre> |
| <div class="block">Used to specify whether the value of this mapping may be null. |
| This is used when generating DDL.</div> |
| </li> |
| </ul> |
| <a name="setIsPrimaryKeyMapping-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIsPrimaryKeyMapping</h4> |
| <pre>public void setIsPrimaryKeyMapping(boolean isPrimaryKeyMapping)</pre> |
| <div class="block">INTERNAL: |
| Set by the Object builder during initialization returns true if this mapping |
| is used as a primary key mapping.</div> |
| </li> |
| </ul> |
| <a name="setIsReadOnly-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIsReadOnly</h4> |
| <pre>public void setIsReadOnly(boolean aBoolean)</pre> |
| <div class="block">PUBLIC: |
| Set this mapping to be read only. |
| Read-only mappings can be used if two attributes map to the same field. |
| Read-only mappings cannot be used for the primary key or other required fields.</div> |
| </li> |
| </ul> |
| <a name="setMapsIdValue-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMapsIdValue</h4> |
| <pre>public void setMapsIdValue(<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> mapsIdValue)</pre> |
| <div class="block">ADVANCED: |
| Set the maps id value</div> |
| </li> |
| </ul> |
| <a name="setProperties-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setProperties</h4> |
| <pre>public void setProperties(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> properties)</pre> |
| <div class="block">INTERNAL: |
| Allow user defined properties.</div> |
| </li> |
| </ul> |
| <a name="setProperty-java.lang.Object-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setProperty</h4> |
| <pre>public void setProperty(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> property, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</pre> |
| <div class="block">ADVANCED: |
| Allow user defined properties.</div> |
| </li> |
| </ul> |
| <a name="setSetMethodName-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSetMethodName</h4> |
| <pre>public void setSetMethodName(<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> methodName)</pre> |
| <div class="block">PUBLIC: |
| Set the methodName used to set the value for the mapping's attribute into the object.</div> |
| </li> |
| </ul> |
| <a name="setWeight-java.lang.Integer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setWeight</h4> |
| <pre>public void setWeight(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a> newWeight)</pre> |
| <div class="block">ADVANCED: |
| Set the weight of the mapping, used to sort mappings |
| DirectToField Mappings have a default weight of 1 while all other Mappings have a |
| default weight of MAXINT. Ordering of Mappings can be achieved by setting the weight of |
| a particular mapping to a value within the above mentioned limits. By ordering mappings |
| the user can control what order relationships are processed by TopLink.</div> |
| </li> |
| </ul> |
| <a name="simpleAddToCollectionChangeRecord-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.ObjectChangeSet-org.eclipse.persistence.internal.sessions.AbstractSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>simpleAddToCollectionChangeRecord</h4> |
| <pre>public void simpleAddToCollectionChangeRecord(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> referenceKey, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> changeSetToAdd, |
| org.eclipse.persistence.internal.sessions.ObjectChangeSet changeSet, |
| org.eclipse.persistence.internal.sessions.AbstractSession session) |
| throws <a href="../../../../org/eclipse/persistence/exceptions/DescriptorException.html" title="class in org.eclipse.persistence.exceptions">DescriptorException</a></pre> |
| <div class="block">ADVANCED: |
| This method is used to add an object to a collection once the changeSet is applied. |
| The referenceKey parameter should only be used for direct Maps.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/exceptions/DescriptorException.html" title="class in org.eclipse.persistence.exceptions">DescriptorException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="simpleRemoveFromCollectionChangeRecord-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.ObjectChangeSet-org.eclipse.persistence.internal.sessions.AbstractSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>simpleRemoveFromCollectionChangeRecord</h4> |
| <pre>public void simpleRemoveFromCollectionChangeRecord(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> referenceKey, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> changeSetToAdd, |
| org.eclipse.persistence.internal.sessions.ObjectChangeSet changeSet, |
| org.eclipse.persistence.internal.sessions.AbstractSession session) |
| throws <a href="../../../../org/eclipse/persistence/exceptions/DescriptorException.html" title="class in org.eclipse.persistence.exceptions">DescriptorException</a></pre> |
| <div class="block">ADVANCED: |
| This method is used to remove an object from a collection once the changeSet is applied. |
| The referenceKey parameter should only be used for direct Maps.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/exceptions/DescriptorException.html" title="class in org.eclipse.persistence.exceptions">DescriptorException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public <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> toString()</pre> |
| <div class="block">INTERNAL: |
| Print the mapping attribute name, this is used in error messages.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="validateAfterInitialization-org.eclipse.persistence.internal.sessions.AbstractSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validateAfterInitialization</h4> |
| <pre>public void validateAfterInitialization(org.eclipse.persistence.internal.sessions.AbstractSession session) |
| throws <a href="../../../../org/eclipse/persistence/exceptions/DescriptorException.html" title="class in org.eclipse.persistence.exceptions">DescriptorException</a></pre> |
| <div class="block">INTERNAL: |
| Allow for subclasses to perform validation.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/exceptions/DescriptorException.html" title="class in org.eclipse.persistence.exceptions">DescriptorException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="validateBeforeInitialization-org.eclipse.persistence.internal.sessions.AbstractSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validateBeforeInitialization</h4> |
| <pre>public void validateBeforeInitialization(org.eclipse.persistence.internal.sessions.AbstractSession session) |
| throws <a href="../../../../org/eclipse/persistence/exceptions/DescriptorException.html" title="class in org.eclipse.persistence.exceptions">DescriptorException</a></pre> |
| <div class="block">INTERNAL: |
| Allow for subclasses to perform validation.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/exceptions/DescriptorException.html" title="class in org.eclipse.persistence.exceptions">DescriptorException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="valueFromObject-java.lang.Object-org.eclipse.persistence.internal.helper.DatabaseField-org.eclipse.persistence.internal.sessions.AbstractSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>valueFromObject</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> valueFromObject(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> anObject, |
| org.eclipse.persistence.internal.helper.DatabaseField field, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</pre> |
| <div class="block">INTERNAL: |
| A subclass should extract the value from the object for the field, if it does not map the field then |
| it should return null. |
| Return the Value from the object.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/core/mappings/CoreMapping.html#valueFromObject-java.lang.Object-FIELD-ABSTRACT_SESSION-">valueFromObject</a></code> in class <code><a href="../../../../org/eclipse/persistence/core/mappings/CoreMapping.html" title="class in org.eclipse.persistence.core.mappings">CoreMapping</a><<a href="../../../../org/eclipse/persistence/mappings/AttributeAccessor.html" title="class in org.eclipse.persistence.mappings">AttributeAccessor</a>,org.eclipse.persistence.internal.sessions.AbstractSession,org.eclipse.persistence.internal.queries.ContainerPolicy,<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a>,org.eclipse.persistence.internal.helper.DatabaseField></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="valueFromRow-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.queries.JoinedAttributeManager-org.eclipse.persistence.queries.ObjectBuildingQuery-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>valueFromRow</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> valueFromRow(org.eclipse.persistence.internal.sessions.AbstractRecord row, |
| org.eclipse.persistence.internal.queries.JoinedAttributeManager joinManager, |
| <a href="../../../../org/eclipse/persistence/queries/ObjectBuildingQuery.html" title="class in org.eclipse.persistence.queries">ObjectBuildingQuery</a> query, |
| boolean isTargetProtected) |
| throws <a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></pre> |
| <div class="block">INTERNAL: |
| A subclass should implement this method if it wants different behavior. |
| Returns the value for the mapping from the database row.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="valueFromRow-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.queries.JoinedAttributeManager-org.eclipse.persistence.queries.ObjectBuildingQuery-org.eclipse.persistence.internal.identitymaps.CacheKey-org.eclipse.persistence.internal.sessions.AbstractSession-boolean-java.lang.Boolean:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>valueFromRow</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> valueFromRow(org.eclipse.persistence.internal.sessions.AbstractRecord row, |
| org.eclipse.persistence.internal.queries.JoinedAttributeManager joinManager, |
| <a href="../../../../org/eclipse/persistence/queries/ObjectBuildingQuery.html" title="class in org.eclipse.persistence.queries">ObjectBuildingQuery</a> query, |
| org.eclipse.persistence.internal.identitymaps.CacheKey cacheKey, |
| org.eclipse.persistence.internal.sessions.AbstractSession session, |
| boolean isTargetProtected, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>[] wasCacheUsed) |
| throws <a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></pre> |
| <div class="block">INTERNAL: |
| A subclass should implement this method if it wants different behavior. |
| Returns the value for the mapping from the database row. |
| The execution session is the session the query was executed on, |
| and its platform should be used for data conversion.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isInSopObject--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isInSopObject</h4> |
| <pre>public boolean isInSopObject()</pre> |
| <div class="block">INTERNAL: |
| Indicates whether the mapping is in SerializedObjectPolicy's sopObject.</div> |
| </li> |
| </ul> |
| <a name="isInOnlySopObject--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isInOnlySopObject</h4> |
| <pre>public boolean isInOnlySopObject()</pre> |
| <div class="block">INTERNAL: |
| Indicates whether the mapping is in SerializedObjectPolicy's sopObject and not out of it.</div> |
| </li> |
| </ul> |
| <a name="isOutSopObject--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isOutSopObject</h4> |
| <pre>public boolean isOutSopObject()</pre> |
| <div class="block">INTERNAL: |
| Indicates whether the mapping is out of SerializedObjectPolicy's sopObject.</div> |
| </li> |
| </ul> |
| <a name="isOutOnlySopObject--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isOutOnlySopObject</h4> |
| <pre>public boolean isOutOnlySopObject()</pre> |
| <div class="block">INTERNAL: |
| Indicates whether the mapping is out of SerializedObjectPolicy's sopObject and not in it.</div> |
| </li> |
| </ul> |
| <a name="isInAndOutSopObject--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isInAndOutSopObject</h4> |
| <pre>public boolean isInAndOutSopObject()</pre> |
| <div class="block">INTERNAL: |
| Indicates whether the mapping is both in and out of SerializedObjectPolicy's sopObject.</div> |
| </li> |
| </ul> |
| <a name="setIsInSopObject--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIsInSopObject</h4> |
| <pre>public void setIsInSopObject()</pre> |
| <div class="block">INTERNAL: |
| Set the mapping is in SerializedObjectPolicy's sopObject.</div> |
| </li> |
| </ul> |
| <a name="setIsOutSopObject--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIsOutSopObject</h4> |
| <pre>public void setIsOutSopObject()</pre> |
| <div class="block">INTERNAL: |
| Set the mapping is out of SerializedObjectPolicy's sopObject.</div> |
| </li> |
| </ul> |
| <a name="setIsInAndOutSopObject--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIsInAndOutSopObject</h4> |
| <pre>public void setIsInAndOutSopObject()</pre> |
| <div class="block">INTERNAL: |
| Set the mapping is both in and out of SerializedObjectPolicy's sopObject</div> |
| </li> |
| </ul> |
| <a name="hasNestedIdentityReference--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasNestedIdentityReference</h4> |
| <pre>public boolean hasNestedIdentityReference()</pre> |
| <div class="block">INTERNAL: |
| Indicates whether the mapping (or at least one of its nested mappings, at any nested depth) |
| references an entity. |
| To return true the mapping (or nested mapping) should be ForeignReferenceMapping with non-null and non-aggregate reference descriptor.</div> |
| </li> |
| </ul> |
| <a name="valueFromResultSet-java.sql.ResultSet-org.eclipse.persistence.queries.ObjectBuildingQuery-org.eclipse.persistence.internal.sessions.AbstractSession-org.eclipse.persistence.internal.databaseaccess.DatabaseAccessor-java.sql.ResultSetMetaData-int-org.eclipse.persistence.internal.databaseaccess.DatabasePlatform-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>valueFromResultSet</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> valueFromResultSet(<a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSet.html?is-external=true" title="class or interface in java.sql">ResultSet</a> resultSet, |
| <a href="../../../../org/eclipse/persistence/queries/ObjectBuildingQuery.html" title="class in org.eclipse.persistence.queries">ObjectBuildingQuery</a> query, |
| org.eclipse.persistence.internal.sessions.AbstractSession session, |
| org.eclipse.persistence.internal.databaseaccess.DatabaseAccessor accessor, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSetMetaData.html?is-external=true" title="class or interface in java.sql">ResultSetMetaData</a> metaData, |
| int columnNumber, |
| org.eclipse.persistence.internal.databaseaccess.DatabasePlatform platform) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></pre> |
| <div class="block">INTERNAL: |
| Returns the value for the mapping directly from the result-set. |
| PERF: Used for optimized object building.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="verifyDelete-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>verifyDelete</h4> |
| <pre>public boolean verifyDelete(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object, |
| org.eclipse.persistence.internal.sessions.AbstractSession session) |
| throws <a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></pre> |
| <div class="block">INTERNAL: |
| To verify if the specified object has been deleted or not.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="writeFromAttributeIntoRow-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeFromAttributeIntoRow</h4> |
| <pre>public void writeFromAttributeIntoRow(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> attribute, |
| org.eclipse.persistence.internal.sessions.AbstractRecord row, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</pre> |
| <div class="block">INTERNAL: |
| A subclass should implement this method if it wants different behavior. |
| Write the foreign key values from the attribute to the row.</div> |
| </li> |
| </ul> |
| <a name="writeFromObjectIntoRow-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractSession-org.eclipse.persistence.mappings.DatabaseMapping.WriteType-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeFromObjectIntoRow</h4> |
| <pre>public void writeFromObjectIntoRow(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object, |
| org.eclipse.persistence.internal.sessions.AbstractRecord row, |
| org.eclipse.persistence.internal.sessions.AbstractSession session, |
| <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.WriteType.html" title="enum in org.eclipse.persistence.mappings">DatabaseMapping.WriteType</a> writeType)</pre> |
| <div class="block">INTERNAL: |
| A subclass should implement this method if it wants different behavior. |
| Write the attribute value from the object to the row.</div> |
| </li> |
| </ul> |
| <a name="writeFromObjectIntoRowForShallowInsert-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeFromObjectIntoRowForShallowInsert</h4> |
| <pre>public void writeFromObjectIntoRowForShallowInsert(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object, |
| org.eclipse.persistence.internal.sessions.AbstractRecord row, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</pre> |
| <div class="block">INTERNAL: |
| This row is built for shallow insert which happens in case of bidirectional inserts. |
| If mapping overrides this method it must override writeFromObjectIntoRowForUpdateAfterShallowInsert method, too.</div> |
| </li> |
| </ul> |
| <a name="writeFromObjectIntoRowForUpdateAfterShallowInsert-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractSession-org.eclipse.persistence.internal.helper.DatabaseTable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeFromObjectIntoRowForUpdateAfterShallowInsert</h4> |
| <pre>public void writeFromObjectIntoRowForUpdateAfterShallowInsert(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object, |
| org.eclipse.persistence.internal.sessions.AbstractRecord databaseRow, |
| org.eclipse.persistence.internal.sessions.AbstractSession session, |
| org.eclipse.persistence.internal.helper.DatabaseTable table)</pre> |
| <div class="block">INTERNAL: |
| This row is built for update after shallow insert which happens in case of bidirectional inserts. |
| It contains the foreign keys with non null values that were set to null for shallow insert. |
| If mapping overrides writeFromObjectIntoRowForShallowInsert method it must override this one, too.</div> |
| </li> |
| </ul> |
| <a name="writeFromObjectIntoRowForUpdateBeforeShallowDelete-java.lang.Object-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractSession-org.eclipse.persistence.internal.helper.DatabaseTable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeFromObjectIntoRowForUpdateBeforeShallowDelete</h4> |
| <pre>public void writeFromObjectIntoRowForUpdateBeforeShallowDelete(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object, |
| org.eclipse.persistence.internal.sessions.AbstractRecord databaseRow, |
| org.eclipse.persistence.internal.sessions.AbstractSession session, |
| org.eclipse.persistence.internal.helper.DatabaseTable table)</pre> |
| <div class="block">INTERNAL: |
| This row is built for update before shallow delete which happens in case of bidirectional inserts. |
| It contains the same fields as the row built by writeFromObjectIntoRowForUpdateAfterShallowInsert, but all the values are null.</div> |
| </li> |
| </ul> |
| <a name="writeFromObjectIntoRowWithChangeRecord-org.eclipse.persistence.internal.sessions.ChangeRecord-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractSession-org.eclipse.persistence.mappings.DatabaseMapping.WriteType-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeFromObjectIntoRowWithChangeRecord</h4> |
| <pre>public void writeFromObjectIntoRowWithChangeRecord(org.eclipse.persistence.internal.sessions.ChangeRecord changeRecord, |
| org.eclipse.persistence.internal.sessions.AbstractRecord row, |
| org.eclipse.persistence.internal.sessions.AbstractSession session, |
| <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.WriteType.html" title="enum in org.eclipse.persistence.mappings">DatabaseMapping.WriteType</a> writeType)</pre> |
| <div class="block">INTERNAL: |
| A subclass should implement this method if it wants different behavior. |
| Write the attribute value from the object to the row.</div> |
| </li> |
| </ul> |
| <a name="writeFromObjectIntoRowForShallowInsertWithChangeRecord-org.eclipse.persistence.internal.sessions.ChangeRecord-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeFromObjectIntoRowForShallowInsertWithChangeRecord</h4> |
| <pre>public void writeFromObjectIntoRowForShallowInsertWithChangeRecord(org.eclipse.persistence.internal.sessions.ChangeRecord changeRecord, |
| org.eclipse.persistence.internal.sessions.AbstractRecord row, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</pre> |
| <div class="block">INTERNAL: |
| This row is built for shallow insert which happens in case of bidirectional inserts.</div> |
| </li> |
| </ul> |
| <a name="writeFromObjectIntoRowForUpdate-org.eclipse.persistence.queries.WriteObjectQuery-org.eclipse.persistence.internal.sessions.AbstractRecord-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeFromObjectIntoRowForUpdate</h4> |
| <pre>public void writeFromObjectIntoRowForUpdate(<a href="../../../../org/eclipse/persistence/queries/WriteObjectQuery.html" title="class in org.eclipse.persistence.queries">WriteObjectQuery</a> query, |
| org.eclipse.persistence.internal.sessions.AbstractRecord row)</pre> |
| <div class="block">INTERNAL:</div> |
| </li> |
| </ul> |
| <a name="writeFromObjectIntoRowForWhereClause-org.eclipse.persistence.queries.ObjectLevelModifyQuery-org.eclipse.persistence.internal.sessions.AbstractRecord-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeFromObjectIntoRowForWhereClause</h4> |
| <pre>public void writeFromObjectIntoRowForWhereClause(<a href="../../../../org/eclipse/persistence/queries/ObjectLevelModifyQuery.html" title="class in org.eclipse.persistence.queries">ObjectLevelModifyQuery</a> query, |
| org.eclipse.persistence.internal.sessions.AbstractRecord row)</pre> |
| <div class="block">INTERNAL: |
| A subclass should implement this method if it wants different behavior. |
| Write the attribute value from the object to the row.</div> |
| </li> |
| </ul> |
| <a name="writeInsertFieldsIntoRow-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeInsertFieldsIntoRow</h4> |
| <pre>public void writeInsertFieldsIntoRow(org.eclipse.persistence.internal.sessions.AbstractRecord databaseRow, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</pre> |
| <div class="block">INTERNAL: |
| Write fields needed for insert into the template for with null values.</div> |
| </li> |
| </ul> |
| <a name="writeUpdateFieldsIntoRow-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeUpdateFieldsIntoRow</h4> |
| <pre>public void writeUpdateFieldsIntoRow(org.eclipse.persistence.internal.sessions.AbstractRecord databaseRow, |
| org.eclipse.persistence.internal.sessions.AbstractSession session)</pre> |
| <div class="block">INTERNAL: |
| Write fields needed for update into the template for with null values. |
| By default inserted fields are used.</div> |
| </li> |
| </ul> |
| <a name="updateChangeRecord-java.lang.Object-java.lang.Object-java.lang.Object-org.eclipse.persistence.internal.sessions.ObjectChangeSet-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>updateChangeRecord</h4> |
| <pre>public void updateChangeRecord(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> clone, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> newValue, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> oldValue, |
| org.eclipse.persistence.internal.sessions.ObjectChangeSet objectChangeSet, |
| org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow) |
| throws <a href="../../../../org/eclipse/persistence/exceptions/DescriptorException.html" title="class in org.eclipse.persistence.exceptions">DescriptorException</a></pre> |
| <div class="block">INTERNAL: |
| Either create a new change record or update the change record with the new value. |
| This is used by attribute change tracking.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/exceptions/DescriptorException.html" title="class in org.eclipse.persistence.exceptions">DescriptorException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="updateCollectionChangeRecord-org.eclipse.persistence.descriptors.changetracking.CollectionChangeEvent-org.eclipse.persistence.internal.sessions.ObjectChangeSet-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>updateCollectionChangeRecord</h4> |
| <pre>public void updateCollectionChangeRecord(<a href="../../../../org/eclipse/persistence/descriptors/changetracking/CollectionChangeEvent.html" title="class in org.eclipse.persistence.descriptors.changetracking">CollectionChangeEvent</a> event, |
| org.eclipse.persistence.internal.sessions.ObjectChangeSet objectChangeSet, |
| org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow) |
| throws <a href="../../../../org/eclipse/persistence/exceptions/DescriptorException.html" title="class in org.eclipse.persistence.exceptions">DescriptorException</a></pre> |
| <div class="block">INTERNAL: |
| Add or removes a new value and its change set to the collection change record based on the event passed in. This is used by |
| attribute change tracking.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/exceptions/DescriptorException.html" title="class in org.eclipse.persistence.exceptions">DescriptorException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setChangeListener-java.lang.Object-java.beans.PropertyChangeListener-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setChangeListener</h4> |
| <pre>public void setChangeListener(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> clone, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/beans/PropertyChangeListener.html?is-external=true" title="class or interface in java.beans">PropertyChangeListener</a> listener, |
| org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow)</pre> |
| <div class="block">INTERNAL: |
| Set the change listener if required. |
| This is required for collections and aggregates or other change tracked mutable objects. |
| This is used for resuming or flushing units of work.</div> |
| </li> |
| </ul> |
| <a name="setDerivesId-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDerivesId</h4> |
| <pre>public void setDerivesId(boolean derivesId)</pre> |
| <div class="block">ADVANCED: |
| Used to indicate the mapping references a JPA ID or MapsId attribute |
| for the CMP3Policy and JPA Id classes (as well as Embeddable Id classes). |
| This is different from isPrimaryKeyMapping, as an ID mapping is user |
| specified and can be read only, as long as another writable mapping for |
| the field exists.</div> |
| </li> |
| </ul> |
| <a name="setDerivedIdMapping-org.eclipse.persistence.mappings.DatabaseMapping-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDerivedIdMapping</h4> |
| <pre>public void setDerivedIdMapping(<a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a> derivedIdMapping)</pre> |
| <div class="block">ADVANCED: |
| Used to indicate the mapping references a JPA ID or MapsId attribute |
| for the CMP3Policy and JPA Id classes (as well as Embeddable Id classes). |
| This is different from isPrimaryKeyMapping, as an ID mapping is user |
| specified and can be read only, as long as another writable mapping for |
| the field exists.</div> |
| </li> |
| </ul> |
| <a name="buildChangeRecord-java.lang.Object-org.eclipse.persistence.internal.sessions.ObjectChangeSet-org.eclipse.persistence.internal.sessions.AbstractSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>buildChangeRecord</h4> |
| <pre>public org.eclipse.persistence.internal.sessions.ChangeRecord buildChangeRecord(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> newValue, |
| org.eclipse.persistence.internal.sessions.ObjectChangeSet owner, |
| org.eclipse.persistence.internal.sessions.AbstractSession session) |
| throws <a href="../../../../org/eclipse/persistence/exceptions/DescriptorException.html" title="class in org.eclipse.persistence.exceptions">DescriptorException</a></pre> |
| <div class="block">INTERNAL: |
| Directly build a change record without comparison</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/exceptions/DescriptorException.html" title="class in org.eclipse.persistence.exceptions">DescriptorException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="postCalculateChanges-org.eclipse.persistence.sessions.changesets.ChangeRecord-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>postCalculateChanges</h4> |
| <pre>public void postCalculateChanges(<a href="../../../../org/eclipse/persistence/sessions/changesets/ChangeRecord.html" title="interface in org.eclipse.persistence.sessions.changesets">ChangeRecord</a> changeRecord, |
| org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow)</pre> |
| <div class="block">INTERNAL: |
| Overridden by mappings that require additional processing of the change record after the record has been calculated.</div> |
| </li> |
| </ul> |
| <a name="postCalculateChangesOnDeleted-java.lang.Object-org.eclipse.persistence.internal.sessions.UnitOfWorkChangeSet-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>postCalculateChangesOnDeleted</h4> |
| <pre>public void postCalculateChangesOnDeleted(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> deletedObject, |
| org.eclipse.persistence.internal.sessions.UnitOfWorkChangeSet uowChangeSet, |
| org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow)</pre> |
| <div class="block">INTERNAL: |
| Overridden by mappings that require objects to be deleted contribute to change set creation.</div> |
| </li> |
| </ul> |
| <a name="recordPrivateOwnedRemovals-java.lang.Object-org.eclipse.persistence.internal.sessions.UnitOfWorkImpl-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>recordPrivateOwnedRemovals</h4> |
| <pre>public void recordPrivateOwnedRemovals(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object, |
| org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow)</pre> |
| <div class="block">INTERNAL: |
| Overridden by mappings that require objects to be deleted contribute to change set creation.</div> |
| </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.1, API Reference</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/eclipse/persistence/mappings/ContainerMapping.html" title="interface in org.eclipse.persistence.mappings"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.WriteType.html" title="enum in org.eclipse.persistence.mappings"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/eclipse/persistence/mappings/DatabaseMapping.html" target="_top">Frames</a></li> |
| <li><a href="DatabaseMapping.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</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> |