Google Git
Sign in
eclipse / gerrit / www.eclipse.org / eclipselink / dc14875ef3f6d97d98bc0960309679ca74c81989 / . / api / 3.0 / org / eclipse / persistence / core / mappings / CoreMapping.html
blob: 56b91010750a01466327fdedcf0584d33a9c6555 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_222) on Tue Dec 08 12:28:29 UTC 2020 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CoreMapping (EclipseLink 3.0.0, API Reference)</title>
<meta name="date" content="2020-12-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="CoreMapping (EclipseLink 3.0.0, API Reference)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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.0, API Reference</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/eclipse/persistence/core/mappings/CoreAttributeAccessor.html" title="interface in org.eclipse.persistence.core.mappings"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/persistence/core/mappings/CoreMapping.html" target="_top">Frames</a></li>
<li><a href="CoreMapping.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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.core.mappings</div>
<h2 title="Class CoreMapping" class="title">Class CoreMapping&lt;ATTRIBUTE_ACCESSOR extends <a href="../../../../../org/eclipse/persistence/core/mappings/CoreAttributeAccessor.html" title="interface in org.eclipse.persistence.core.mappings">CoreAttributeAccessor</a>,ABSTRACT_SESSION extends org.eclipse.persistence.internal.core.sessions.CoreAbstractSession,CONTAINER_POLICY extends org.eclipse.persistence.internal.core.queries.CoreContainerPolicy,DESCRIPTOR extends <a href="../../../../../org/eclipse/persistence/core/descriptors/CoreDescriptor.html" title="class in org.eclipse.persistence.core.descriptors">CoreDescriptor</a>,FIELD extends org.eclipse.persistence.internal.core.helper.CoreField&gt;</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>org.eclipse.persistence.core.mappings.CoreMapping&lt;ATTRIBUTE_ACCESSOR,ABSTRACT_SESSION,CONTAINER_POLICY,DESCRIPTOR,FIELD&gt;</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">CoreMapping&lt;ATTRIBUTE_ACCESSOR extends <a href="../../../../../org/eclipse/persistence/core/mappings/CoreAttributeAccessor.html" title="interface in org.eclipse.persistence.core.mappings">CoreAttributeAccessor</a>,ABSTRACT_SESSION extends org.eclipse.persistence.internal.core.sessions.CoreAbstractSession,CONTAINER_POLICY extends org.eclipse.persistence.internal.core.queries.CoreContainerPolicy,DESCRIPTOR extends <a href="../../../../../org/eclipse/persistence/core/descriptors/CoreDescriptor.html" title="class in org.eclipse.persistence.core.descriptors">CoreDescriptor</a>,FIELD extends org.eclipse.persistence.internal.core.helper.CoreField&gt;</span>
extends <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></pre>
<div class="block">INTERNAL
A abstraction of mapping capturing behavior common to all persistence types.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== 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">&nbsp;</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/core/mappings/CoreMapping.html#CoreMapping--">CoreMapping</a></span>()</code>&nbsp;</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</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>abstract <a href="../../../../../org/eclipse/persistence/core/mappings/CoreMapping.html" title="type parameter in CoreMapping">ATTRIBUTE_ACCESSOR</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/core/mappings/CoreMapping.html#getAttributeAccessor--">getAttributeAccessor</a></span>()</code>
<div class="block">ADVANCED: Return the attributeAccessor.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/core/mappings/CoreMapping.html#getAttributeClassification--">getAttributeClassification</a></span>()</code>
<div class="block">PUBLIC: The classification type for the attribute this mapping represents</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/core/mappings/CoreMapping.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="i3" class="rowColor">
<td class="colFirst"><code>abstract <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/core/mappings/CoreMapping.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>&nbsp;object)</code>
<div class="block">INTERNAL: Return the value of an attribute which this mapping represents
for an object.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>abstract <a href="../../../../../org/eclipse/persistence/core/mappings/CoreMapping.html" title="type parameter in CoreMapping">CONTAINER_POLICY</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/core/mappings/CoreMapping.html#getContainerPolicy--">getContainerPolicy</a></span>()</code>
<div class="block">INTERNAL: Return the mapping's containerPolicy.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>abstract <a href="../../../../../org/eclipse/persistence/core/mappings/CoreMapping.html" title="type parameter in CoreMapping">DESCRIPTOR</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/core/mappings/CoreMapping.html#getDescriptor--">getDescriptor</a></span>()</code>
<div class="block">INTERNAL: Return the descriptor to which this mapping belongs</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>abstract <a href="../../../../../org/eclipse/persistence/core/mappings/CoreMapping.html" title="type parameter in CoreMapping">FIELD</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/core/mappings/CoreMapping.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="i7" class="rowColor">
<td class="colFirst"><code>abstract <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>&lt;<a href="../../../../../org/eclipse/persistence/core/mappings/CoreMapping.html" title="type parameter in CoreMapping">FIELD</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/core/mappings/CoreMapping.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="i8" class="altColor">
<td class="colFirst"><code>abstract <a href="../../../../../org/eclipse/persistence/core/mappings/CoreMapping.html" title="type parameter in CoreMapping">DESCRIPTOR</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/core/mappings/CoreMapping.html#getReferenceDescriptor--">getReferenceDescriptor</a></span>()</code>
<div class="block">PUBLIC:
Return the referenceDescriptor.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>abstract boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/core/mappings/CoreMapping.html#isAbstractCompositeCollectionMapping--">isAbstractCompositeCollectionMapping</a></span>()</code>
<div class="block">INTERNAL:
Related mapping should implement this method to return true.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>abstract boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/core/mappings/CoreMapping.html#isAbstractCompositeDirectCollectionMapping--">isAbstractCompositeDirectCollectionMapping</a></span>()</code>
<div class="block">INTERNAL:
Related mapping should implement this method to return true.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>abstract boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/core/mappings/CoreMapping.html#isAbstractCompositeObjectMapping--">isAbstractCompositeObjectMapping</a></span>()</code>
<div class="block">INTERNAL:
Related mapping should implement this method to return true.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>abstract boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/core/mappings/CoreMapping.html#isAbstractDirectMapping--">isAbstractDirectMapping</a></span>()</code>
<div class="block">INTERNAL:
Related mapping should implement this method to return true.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>abstract boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/core/mappings/CoreMapping.html#isCollectionMapping--">isCollectionMapping</a></span>()</code>
<div class="block">INTERNAL:
Related mapping should implement this method to return true.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>abstract boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/core/mappings/CoreMapping.html#isDirectToFieldMapping--">isDirectToFieldMapping</a></span>()</code>
<div class="block">INTERNAL:
Related mapping should implement this method to return true.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>abstract boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/core/mappings/CoreMapping.html#isReadOnly--">isReadOnly</a></span>()</code>
<div class="block">INTERNAL:
Returns true if mapping is read only else false.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>abstract boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/core/mappings/CoreMapping.html#isReferenceMapping--">isReferenceMapping</a></span>()</code>
<div class="block">INTERNAL:
Related mapping should implement this method to return true.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>abstract boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/core/mappings/CoreMapping.html#isTransformationMapping--">isTransformationMapping</a></span>()</code>
<div class="block">INTERNAL:
Related mapping should implement this method to return true.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>abstract boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/core/mappings/CoreMapping.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="i19" class="rowColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/core/mappings/CoreMapping.html#setAttributeAccessor-ATTRIBUTE_ACCESSOR-">setAttributeAccessor</a></span>(<a href="../../../../../org/eclipse/persistence/core/mappings/CoreMapping.html" title="type parameter in CoreMapping">ATTRIBUTE_ACCESSOR</a>&nbsp;attributeAccessor)</code>
<div class="block">ADVANCED: Set the attributeAccessor.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/core/mappings/CoreMapping.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>&nbsp;attributeName)</code>
<div class="block">PUBLIC:
Sets the name of the attribute in the mapping.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/core/mappings/CoreMapping.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>&nbsp;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>&nbsp;value)</code>
<div class="block">INTERNAL:
Set the value of the attribute mapped by this mapping.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/core/mappings/CoreMapping.html#setDescriptor-DESCRIPTOR-">setDescriptor</a></span>(<a href="../../../../../org/eclipse/persistence/core/mappings/CoreMapping.html" title="type parameter in CoreMapping">DESCRIPTOR</a>&nbsp;descriptor)</code>
<div class="block">INTERNAL:
Set the descriptor to which this mapping belongs</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>protected abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/core/mappings/CoreMapping.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>&lt;<a href="../../../../../org/eclipse/persistence/core/mappings/CoreMapping.html" title="type parameter in CoreMapping">FIELD</a>&gt;&nbsp;fields)</code>
<div class="block">INTERNAL:
Set the mapping's field collection.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>abstract <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/core/mappings/CoreMapping.html#valueFromObject-java.lang.Object-FIELD-ABSTRACT_SESSION-">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>&nbsp;anObject,
<a href="../../../../../org/eclipse/persistence/core/mappings/CoreMapping.html" title="type parameter in CoreMapping">FIELD</a>&nbsp;field,
<a href="../../../../../org/eclipse/persistence/core/mappings/CoreMapping.html" title="type parameter in CoreMapping">ABSTRACT_SESSION</a>&nbsp;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>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;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#clone--" title="class or interface in java.lang">clone</a>, <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#toString--" title="class or interface in java.lang">toString</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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="CoreMapping--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CoreMapping</h4>
<pre>public&nbsp;CoreMapping()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getAttributeAccessor--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttributeAccessor</h4>
<pre>public abstract&nbsp;<a href="../../../../../org/eclipse/persistence/core/mappings/CoreMapping.html" title="type parameter in CoreMapping">ATTRIBUTE_ACCESSOR</a>&nbsp;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>
</li>
</ul>
<a name="getAttributeClassification--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttributeClassification</h4>
<pre>public abstract&nbsp;<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>&nbsp;getAttributeClassification()</pre>
<div class="block">PUBLIC: The classification type for the attribute this mapping represents</div>
</li>
</ul>
<a name="getAttributeName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttributeName</h4>
<pre>public abstract&nbsp;<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>&nbsp;getAttributeName()</pre>
<div class="block">PUBLIC:
Return the name of the attribute set in the mapping.</div>
</li>
</ul>
<a name="getAttributeValueFromObject-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttributeValueFromObject</h4>
<pre>public abstract&nbsp;<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>&nbsp;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>&nbsp;object)</pre>
<div class="block">INTERNAL: Return the value of an attribute which this mapping represents
for an object.</div>
</li>
</ul>
<a name="getContainerPolicy--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContainerPolicy</h4>
<pre>public abstract&nbsp;<a href="../../../../../org/eclipse/persistence/core/mappings/CoreMapping.html" title="type parameter in CoreMapping">CONTAINER_POLICY</a>&nbsp;getContainerPolicy()</pre>
<div class="block">INTERNAL: Return the mapping's containerPolicy.</div>
</li>
</ul>
<a name="getDescriptor--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDescriptor</h4>
<pre>public abstract&nbsp;<a href="../../../../../org/eclipse/persistence/core/mappings/CoreMapping.html" title="type parameter in CoreMapping">DESCRIPTOR</a>&nbsp;getDescriptor()</pre>
<div class="block">INTERNAL: Return the descriptor to which this mapping belongs</div>
</li>
</ul>
<a name="getField--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getField</h4>
<pre>public abstract&nbsp;<a href="../../../../../org/eclipse/persistence/core/mappings/CoreMapping.html" title="type parameter in CoreMapping">FIELD</a>&nbsp;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>
</li>
</ul>
<a name="getFields--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFields</h4>
<pre>public abstract&nbsp;<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>&lt;<a href="../../../../../org/eclipse/persistence/core/mappings/CoreMapping.html" title="type parameter in CoreMapping">FIELD</a>&gt;&nbsp;getFields()</pre>
<div class="block">INTERNAL:
Returns a vector of all the fields this mapping represents.</div>
</li>
</ul>
<a name="getReferenceDescriptor--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReferenceDescriptor</h4>
<pre>public abstract&nbsp;<a href="../../../../../org/eclipse/persistence/core/mappings/CoreMapping.html" title="type parameter in CoreMapping">DESCRIPTOR</a>&nbsp;getReferenceDescriptor()</pre>
<div class="block">PUBLIC:
Return the referenceDescriptor. This is a descriptor which is associated with
the reference class.</div>
</li>
</ul>
<a name="isAbstractCompositeCollectionMapping--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAbstractCompositeCollectionMapping</h4>
<pre>public abstract&nbsp;boolean&nbsp;isAbstractCompositeCollectionMapping()</pre>
<div class="block">INTERNAL:
Related mapping should implement this method to return true.</div>
</li>
</ul>
<a name="isAbstractCompositeDirectCollectionMapping--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAbstractCompositeDirectCollectionMapping</h4>
<pre>public abstract&nbsp;boolean&nbsp;isAbstractCompositeDirectCollectionMapping()</pre>
<div class="block">INTERNAL:
Related mapping should implement this method to return true.</div>
</li>
</ul>
<a name="isAbstractCompositeObjectMapping--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAbstractCompositeObjectMapping</h4>
<pre>public abstract&nbsp;boolean&nbsp;isAbstractCompositeObjectMapping()</pre>
<div class="block">INTERNAL:
Related mapping 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 abstract&nbsp;boolean&nbsp;isAbstractDirectMapping()</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 abstract&nbsp;boolean&nbsp;isCollectionMapping()</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 abstract&nbsp;boolean&nbsp;isDirectToFieldMapping()</pre>
<div class="block">INTERNAL:
Related mapping should implement this method to return true.</div>
</li>
</ul>
<a name="isReadOnly--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isReadOnly</h4>
<pre>public abstract&nbsp;boolean&nbsp;isReadOnly()</pre>
<div class="block">INTERNAL:
Returns true if mapping is read only else false.</div>
</li>
</ul>
<a name="isReferenceMapping--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isReferenceMapping</h4>
<pre>public abstract&nbsp;boolean&nbsp;isReferenceMapping()</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 abstract&nbsp;boolean&nbsp;isTransformationMapping()</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 abstract&nbsp;boolean&nbsp;isWriteOnly()</pre>
<div class="block">INTERNAL:
Some mappings support no attribute (transformation and multitenant primary key).</div>
</li>
</ul>
<a name="setAttributeAccessor-org.eclipse.persistence.core.mappings.CoreAttributeAccessor-">
<!-- -->
</a><a name="setAttributeAccessor-ATTRIBUTE_ACCESSOR-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAttributeAccessor</h4>
<pre>public abstract&nbsp;void&nbsp;setAttributeAccessor(<a href="../../../../../org/eclipse/persistence/core/mappings/CoreMapping.html" title="type parameter in CoreMapping">ATTRIBUTE_ACCESSOR</a>&nbsp;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>
</li>
</ul>
<a name="setAttributeName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAttributeName</h4>
<pre>public abstract&nbsp;void&nbsp;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>&nbsp;attributeName)</pre>
<div class="block">PUBLIC:
Sets the name of the attribute in the mapping.</div>
</li>
</ul>
<a name="setAttributeValueInObject-java.lang.Object-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAttributeValueInObject</h4>
<pre>public abstract&nbsp;void&nbsp;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>&nbsp;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>&nbsp;value)</pre>
<div class="block">INTERNAL:
Set the value of the attribute mapped by this mapping.</div>
</li>
</ul>
<a name="setDescriptor-org.eclipse.persistence.core.descriptors.CoreDescriptor-">
<!-- -->
</a><a name="setDescriptor-DESCRIPTOR-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDescriptor</h4>
<pre>public abstract&nbsp;void&nbsp;setDescriptor(<a href="../../../../../org/eclipse/persistence/core/mappings/CoreMapping.html" title="type parameter in CoreMapping">DESCRIPTOR</a>&nbsp;descriptor)</pre>
<div class="block">INTERNAL:
Set the descriptor to which this mapping belongs</div>
</li>
</ul>
<a name="setFields-java.util.Vector-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFields</h4>
<pre>protected abstract&nbsp;void&nbsp;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>&lt;<a href="../../../../../org/eclipse/persistence/core/mappings/CoreMapping.html" title="type parameter in CoreMapping">FIELD</a>&gt;&nbsp;fields)</pre>
<div class="block">INTERNAL:
Set the mapping's field collection.</div>
</li>
</ul>
<a name="valueFromObject-java.lang.Object-org.eclipse.persistence.internal.core.helper.CoreField-org.eclipse.persistence.internal.core.sessions.CoreAbstractSession-">
<!-- -->
</a><a name="valueFromObject-java.lang.Object-FIELD-ABSTRACT_SESSION-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>valueFromObject</h4>
<pre>public abstract&nbsp;<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>&nbsp;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>&nbsp;anObject,
<a href="../../../../../org/eclipse/persistence/core/mappings/CoreMapping.html" title="type parameter in CoreMapping">FIELD</a>&nbsp;field,
<a href="../../../../../org/eclipse/persistence/core/mappings/CoreMapping.html" title="type parameter in CoreMapping">ABSTRACT_SESSION</a>&nbsp;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>
</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.0, API Reference</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/eclipse/persistence/core/mappings/CoreAttributeAccessor.html" title="interface in org.eclipse.persistence.core.mappings"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/persistence/core/mappings/CoreMapping.html" target="_top">Frames</a></li>
<li><a href="CoreMapping.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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 &#169; 2007&#x2013;2020 <a href="http://www.eclipse.org/eclipselink">Eclipse.org - EclipseLink Project</a>. All rights reserved.</small></p>
</body>
</html>