Google Git
Sign in
apache / cayenne-website / 626d8c1d90628349118d991467d8b423be9e228e / . / src / main / site / static / docs / 4.2 / api / org / apache / cayenne / reflect / ClassDescriptor.html
blob: 7c0edb22e471893444355bd6e618198cd5ea4e41 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.10) on Mon Dec 05 10:27:04 MSK 2022 -->
<title>ClassDescriptor (cayenne-doc: Cayenne Documentation 4.2.RC2 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-12-05">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ClassDescriptor (cayenne-doc: Cayenne Documentation 4.2.RC2 API)";
}
}
catch(err) {
}
//-->
var data = {"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};
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";
var pathtoroot = "../../../../";
var useModuleDirectories = false;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ClassDescriptor.html">Use</a></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"><a href="http://cayenne.apache.org" target="top">Apache Cayenne</a></div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.cayenne.reflect</a></div>
<h2 title="Interface ClassDescriptor" class="title">Interface ClassDescriptor</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="LazyClassDescriptorDecorator.html" title="class in org.apache.cayenne.reflect">LazyClassDescriptorDecorator</a></code>, <code><a href="PersistentDescriptor.html" title="class in org.apache.cayenne.reflect">PersistentDescriptor</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">ClassDescriptor</span></pre>
<div class="block">A runtime descriptor of an persistent class.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<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="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" 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" class="externalLink">Object</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createObject()">createObject</a></span>()</code></th>
<td class="colLast">
<div class="block">Creates a new instance of a class described by this object.</div>
</td>
</tr>
<tr id="i1" 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" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;<a href="../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAdditionalDbEntities()">getAdditionalDbEntities</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns information about additional db entities that is used for this ObjEntity (i.e.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="PropertyDescriptor.html" title="interface in org.apache.cayenne.reflect">PropertyDescriptor</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDeclaredProperty(java.lang.String)">getDeclaredProperty</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;propertyName)</code></th>
<td class="colLast">
<div class="block">Returns a Java Bean property descriptor matching property name or null if no such
property is found.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&lt;<a href="../map/ObjAttribute.html" title="class in org.apache.cayenne.map">ObjAttribute</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDiscriminatorColumns()">getDiscriminatorColumns</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a collection of ObjAttribute for the described class, its superclasses and
subclasses, that participate in inheritance qualifier.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../map/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEntity()">getEntity</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns an ObjEntity associated with this descriptor.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../map/EntityInheritanceTree.html" title="class in org.apache.cayenne.map">EntityInheritanceTree</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEntityInheritanceTree()">getEntityInheritanceTree</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEntityQualifier()">getEntityQualifier</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns entity qualifier as a Cayenne expression that includes qualifiers for this
entity and all subentities.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&lt;<a href="AttributeProperty.html" title="interface in org.apache.cayenne.reflect">AttributeProperty</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIdProperties()">getIdProperties</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a collection of the properties mapped to id columns.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&lt;<a href="ArcProperty.html" title="interface in org.apache.cayenne.reflect">ArcProperty</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMapArcProperties()">getMapArcProperties</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a collection over the arc properties whose reverse arcs are to-many maps.</div>
</td>
</tr>
<tr id="i9" 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="externalLink">Class</a>&lt;?&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getObjectClass()">getObjectClass</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a class mapped by this descriptor.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="PropertyDescriptor.html" title="interface in org.apache.cayenne.reflect">PropertyDescriptor</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getProperty(java.lang.String)">getProperty</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;propertyName)</code></th>
<td class="colLast">
<div class="block">Returns a property descriptor matching property name, or null if no such property
is found.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&lt;<a href="../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRootDbEntities()">getRootDbEntities</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a collection of DbEntities that are the root tables for this descriptor's
ObjEntity.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="ClassDescriptor.html" title="interface in org.apache.cayenne.reflect">ClassDescriptor</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSubclassDescriptor(java.lang.Class)">getSubclassDescriptor</a></span>&#8203;(<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="externalLink">Class</a>&lt;?&gt;&nbsp;objectClass)</code></th>
<td class="colLast">
<div class="block">Returns the most "specialized" descriptor for a given class.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="ClassDescriptor.html" title="interface in org.apache.cayenne.reflect">ClassDescriptor</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSuperclassDescriptor()">getSuperclassDescriptor</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a descriptor of the mapped superclass or null if the descriptor's entity
sits at the top of inheritance hierarchy or no inheritance is mapped.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasSubclasses()">hasSubclasses</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns whether this class has persistent subclasses.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#injectValueHolders(java.lang.Object)">injectValueHolders</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;object)</code></th>
<td class="colLast">
<div class="block">Prepares object properties for access.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isFault(java.lang.Object)">isFault</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;object)</code></th>
<td class="colLast">
<div class="block">Returns true if an object is not fully resolved.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#shallowMerge(java.lang.Object,java.lang.Object)">shallowMerge</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;from,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;to)</code></th>
<td class="colLast">
<div class="block">Merges object properties from one object to another, avoiding traversal of the
ArcProperties.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#visitAllProperties(org.apache.cayenne.reflect.PropertyVisitor)">visitAllProperties</a></span>&#8203;(<a href="PropertyVisitor.html" title="interface in org.apache.cayenne.reflect">PropertyVisitor</a>&nbsp;visitor)</code></th>
<td class="colLast">
<div class="block">Passes the visitor to the properties "visit" method for a combination of all
properties, including properties declared in this descriptor, its super
descriptors, and all subdescriptors.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#visitDeclaredProperties(org.apache.cayenne.reflect.PropertyVisitor)">visitDeclaredProperties</a></span>&#8203;(<a href="PropertyVisitor.html" title="interface in org.apache.cayenne.reflect">PropertyVisitor</a>&nbsp;visitor)</code></th>
<td class="colLast">
<div class="block">Passes the visitor to the properties "visit" method for all properties declared in
this descriptor.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#visitProperties(org.apache.cayenne.reflect.PropertyVisitor)">visitProperties</a></span>&#8203;(<a href="PropertyVisitor.html" title="interface in org.apache.cayenne.reflect">PropertyVisitor</a>&nbsp;visitor)</code></th>
<td class="colLast">
<div class="block">Passes the visitor to the properties "visit" method for all properties declared in
this descriptor and all its super-decsriptors.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getEntity()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEntity</h4>
<pre class="methodSignature"><a href="../map/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</a>&nbsp;getEntity()</pre>
<div class="block">Returns an ObjEntity associated with this descriptor.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
</dl>
</li>
</ul>
<a id="getRootDbEntities()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRootDbEntities</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&lt;<a href="../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a>&gt;&nbsp;getRootDbEntities()</pre>
<div class="block">Returns a collection of DbEntities that are the root tables for this descriptor's
ObjEntity. Usually such collection would contain only one entity, however in cases
involving subclass horizontal inheritance, it will be more than one, and in cases
of abstract entities with no subclasses, the collection will be empty.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
</dl>
</li>
</ul>
<a id="getAdditionalDbEntities()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAdditionalDbEntities</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;<a href="../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a>&gt;&nbsp;getAdditionalDbEntities()</pre>
<div class="block">Returns information about additional db entities that is used for this ObjEntity (i.e. for flattened attributes).
<p>
Keys are full paths for corresponding flattened attributes.
<p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>information about additional db entities</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>4.1</dd>
</dl>
</li>
</ul>
<a id="getEntityInheritanceTree()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEntityInheritanceTree</h4>
<pre class="methodSignature"><a href="../map/EntityInheritanceTree.html" title="class in org.apache.cayenne.map">EntityInheritanceTree</a>&nbsp;getEntityInheritanceTree()</pre>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
</dl>
</li>
</ul>
<a id="hasSubclasses()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasSubclasses</h4>
<pre class="methodSignature">boolean&nbsp;hasSubclasses()</pre>
<div class="block">Returns whether this class has persistent subclasses.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.1</dd>
</dl>
</li>
</ul>
<a id="getObjectClass()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getObjectClass</h4>
<pre class="methodSignature"><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="externalLink">Class</a>&lt;?&gt;&nbsp;getObjectClass()</pre>
<div class="block">Returns a class mapped by this descriptor.</div>
</li>
</ul>
<a id="getSuperclassDescriptor()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSuperclassDescriptor</h4>
<pre class="methodSignature"><a href="ClassDescriptor.html" title="interface in org.apache.cayenne.reflect">ClassDescriptor</a>&nbsp;getSuperclassDescriptor()</pre>
<div class="block">Returns a descriptor of the mapped superclass or null if the descriptor's entity
sits at the top of inheritance hierarchy or no inheritance is mapped.</div>
</li>
</ul>
<a id="getSubclassDescriptor(java.lang.Class)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSubclassDescriptor</h4>
<pre class="methodSignature"><a href="ClassDescriptor.html" title="interface in org.apache.cayenne.reflect">ClassDescriptor</a>&nbsp;getSubclassDescriptor&#8203;(<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="externalLink">Class</a>&lt;?&gt;&nbsp;objectClass)</pre>
<div class="block">Returns the most "specialized" descriptor for a given class. This method assumes
that the following is true:
<pre>
this.getObjectClass().isAssignableFrom(objectClass)
</pre></div>
</li>
</ul>
<a id="createObject()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createObject</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;createObject()</pre>
<div class="block">Creates a new instance of a class described by this object.</div>
</li>
</ul>
<a id="injectValueHolders(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>injectValueHolders</h4>
<pre class="methodSignature">void&nbsp;injectValueHolders&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;object)
throws <a href="PropertyException.html" title="class in org.apache.cayenne.reflect">PropertyException</a></pre>
<div class="block">Prepares object properties for access. This may include injection of value holders
into the object and such.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="PropertyException.html" title="class in org.apache.cayenne.reflect">PropertyException</a></code></dd>
</dl>
</li>
</ul>
<a id="shallowMerge(java.lang.Object,java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shallowMerge</h4>
<pre class="methodSignature">void&nbsp;shallowMerge&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;from,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;to)
throws <a href="PropertyException.html" title="class in org.apache.cayenne.reflect">PropertyException</a></pre>
<div class="block">Merges object properties from one object to another, avoiding traversal of the
ArcProperties.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="PropertyException.html" title="class in org.apache.cayenne.reflect">PropertyException</a></code></dd>
</dl>
</li>
</ul>
<a id="getProperty(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProperty</h4>
<pre class="methodSignature"><a href="PropertyDescriptor.html" title="interface in org.apache.cayenne.reflect">PropertyDescriptor</a>&nbsp;getProperty&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;propertyName)</pre>
<div class="block">Returns a property descriptor matching property name, or null if no such property
is found. Lookup includes properties from this descriptor and all its superclass
descriptors. Returned property can be any one of <a href="AttributeProperty.html" title="interface in org.apache.cayenne.reflect"><code>AttributeProperty</code></a>,
<a href="ToManyProperty.html" title="interface in org.apache.cayenne.reflect"><code>ToManyProperty</code></a>, <a href="ToOneProperty.html" title="interface in org.apache.cayenne.reflect"><code>ToOneProperty</code></a>.</div>
</li>
</ul>
<a id="getDeclaredProperty(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDeclaredProperty</h4>
<pre class="methodSignature"><a href="PropertyDescriptor.html" title="interface in org.apache.cayenne.reflect">PropertyDescriptor</a>&nbsp;getDeclaredProperty&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;propertyName)</pre>
<div class="block">Returns a Java Bean property descriptor matching property name or null if no such
property is found. Lookup DOES NOT including properties from the superclass
descriptors. Returned property can be any one of <a href="AttributeProperty.html" title="interface in org.apache.cayenne.reflect"><code>AttributeProperty</code></a>,
<a href="ToManyProperty.html" title="interface in org.apache.cayenne.reflect"><code>ToManyProperty</code></a>, <a href="ToOneProperty.html" title="interface in org.apache.cayenne.reflect"><code>ToOneProperty</code></a>.</div>
</li>
</ul>
<a id="getIdProperties()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIdProperties</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&lt;<a href="AttributeProperty.html" title="interface in org.apache.cayenne.reflect">AttributeProperty</a>&gt;&nbsp;getIdProperties()</pre>
<div class="block">Returns a collection of the properties mapped to id columns.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.1</dd>
</dl>
</li>
</ul>
<a id="getDiscriminatorColumns()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDiscriminatorColumns</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&lt;<a href="../map/ObjAttribute.html" title="class in org.apache.cayenne.map">ObjAttribute</a>&gt;&nbsp;getDiscriminatorColumns()</pre>
<div class="block">Returns a collection of ObjAttribute for the described class, its superclasses and
subclasses, that participate in inheritance qualifier. If a discriminator
expression specifies a DbAttribute instead of an ObjAttribute, a synthetic
ObjAttribute is created and returned.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.1</dd>
</dl>
</li>
</ul>
<a id="getEntityQualifier()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEntityQualifier</h4>
<pre class="methodSignature"><a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a>&nbsp;getEntityQualifier()</pre>
<div class="block">Returns entity qualifier as a Cayenne expression that includes qualifiers for this
entity and all subentities.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
</dl>
</li>
</ul>
<a id="getMapArcProperties()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMapArcProperties</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&lt;<a href="ArcProperty.html" title="interface in org.apache.cayenne.reflect">ArcProperty</a>&gt;&nbsp;getMapArcProperties()</pre>
<div class="block">Returns a collection over the arc properties whose reverse arcs are to-many maps.
I.e. for each ArcProperty in returned collection, the following is true:
<pre>
arc.getComplimentaryReverseArc() instanceof ToManyMapProperty
</pre></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.1</dd>
</dl>
</li>
</ul>
<a id="visitProperties(org.apache.cayenne.reflect.PropertyVisitor)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>visitProperties</h4>
<pre class="methodSignature">boolean&nbsp;visitProperties&#8203;(<a href="PropertyVisitor.html" title="interface in org.apache.cayenne.reflect">PropertyVisitor</a>&nbsp;visitor)</pre>
<div class="block">Passes the visitor to the properties "visit" method for all properties declared in
this descriptor and all its super-decsriptors. Properties that are overridden in
subdescriptors will include overridden information. Walkthrough is terminated in
case one of the properties returns false. Returns true if all visited properties
returned true, false - if one property returned false.</div>
</li>
</ul>
<a id="visitDeclaredProperties(org.apache.cayenne.reflect.PropertyVisitor)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>visitDeclaredProperties</h4>
<pre class="methodSignature">boolean&nbsp;visitDeclaredProperties&#8203;(<a href="PropertyVisitor.html" title="interface in org.apache.cayenne.reflect">PropertyVisitor</a>&nbsp;visitor)</pre>
<div class="block">Passes the visitor to the properties "visit" method for all properties declared in
this descriptor. This property set excludes inherited properties, even those that
got overridden in this subclass. Walkthrough is terminated in case one of the
properties returns false. Returns true if all visited properties returned true,
false - if one property returned false.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
</dl>
</li>
</ul>
<a id="visitAllProperties(org.apache.cayenne.reflect.PropertyVisitor)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>visitAllProperties</h4>
<pre class="methodSignature">boolean&nbsp;visitAllProperties&#8203;(<a href="PropertyVisitor.html" title="interface in org.apache.cayenne.reflect">PropertyVisitor</a>&nbsp;visitor)</pre>
<div class="block">Passes the visitor to the properties "visit" method for a combination of all
properties, including properties declared in this descriptor, its super
descriptors, and all subdescriptors. Walkthrough is terminated in case one of the
properties returns false. Returns true if all visited properties returned true,
false - if one property returned false.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.0</dd>
</dl>
</li>
</ul>
<a id="isFault(java.lang.Object)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isFault</h4>
<pre class="methodSignature">boolean&nbsp;isFault&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;object)</pre>
<div class="block">Returns true if an object is not fully resolved.</div>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ClassDescriptor.html">Use</a></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"><a href="http://cayenne.apache.org" target="top">Apache Cayenne</a></div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2001&#x2013;2022 <a href="https://cayenne.apache.org/">Apache Cayenne</a>. All rights reserved.</small></p>
</footer>
</body>
</html>