| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.10) on Mon Dec 05 10:27:04 MSK 2022 --> |
| <title>ObjEntity (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="ObjEntity (cayenne-doc: Cayenne Documentation 4.2.RC2 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":42,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"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}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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/ObjEntity.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 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: </li> |
| <li>Nested | </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 id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </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> <a href="package-summary.html">org.apache.cayenne.map</a></div> |
| <h2 title="Class ObjEntity" class="title">Class ObjEntity</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" class="externalLink">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="Entity.html" title="class in org.apache.cayenne.map">org.apache.cayenne.map.Entity</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.cayenne.map.ObjEntity</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a></code>, <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/EventListener.html?is-external=true" title="class or interface in java.util" class="externalLink">EventListener</a></code>, <code><a href="../configuration/ConfigurationNode.html" title="interface in org.apache.cayenne.configuration">ConfigurationNode</a></code>, <code><a href="event/ObjEntityListener.html" title="interface in org.apache.cayenne.map.event">ObjEntityListener</a></code>, <code><a href="../util/CayenneMapEntry.html" title="interface in org.apache.cayenne.util">CayenneMapEntry</a></code>, <code><a href="../util/XMLSerializable.html" title="interface in org.apache.cayenne.util">XMLSerializable</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">ObjEntity</span> |
| extends <a href="Entity.html" title="class in org.apache.cayenne.map">Entity</a> |
| implements <a href="event/ObjEntityListener.html" title="interface in org.apache.cayenne.map.event">ObjEntityListener</a>, <a href="../configuration/ConfigurationNode.html" title="interface in org.apache.cayenne.configuration">ConfigurationNode</a></pre> |
| <div class="block">ObjEntity is a mapping descriptor for a DataObject Java class. It contains |
| the information about the Java class itself, as well as its mapping to the |
| DbEntity layer.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../serialized-form.html#org.apache.cayenne.map.ObjEntity">Serialized Form</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_abstract">_abstract</a></span></code></th> |
| <td class="colLast"> </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" class="externalLink">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" class="externalLink">String</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" class="externalLink">String</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#attributeOverrides">attributeOverrides</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="CallbackMap.html" title="class in org.apache.cayenne.map">CallbackMap</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#callbacks">callbacks</a></span></code></th> |
| <td class="colLast"> </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" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#className">className</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <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" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clientClassName">clientClassName</a></span></code></th> |
| <td class="colLast"> </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" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clientSuperClassName">clientSuperClassName</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <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" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dbEntityName">dbEntityName</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected static <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><<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>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_GENERIC_CLASSES">DEFAULT_GENERIC_CLASSES</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">A collection of default "generic" entity classes excluded from class |
| generation.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#LOCK_TYPE_NONE">LOCK_TYPE_NONE</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#LOCK_TYPE_OPTIMISTIC">LOCK_TYPE_OPTIMISTIC</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#lockType">lockType</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <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="#qualifier">qualifier</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#readOnly">readOnly</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#serverOnly">serverOnly</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <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" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#superClassName">superClassName</a></span></code></th> |
| <td class="colLast"> </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" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#superEntityName">superEntityName</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.org.apache.cayenne.map.Entity"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.cayenne.map.<a href="Entity.html" title="class in org.apache.cayenne.map">Entity</a></h3> |
| <code><a href="Entity.html#attributes">attributes</a>, <a href="Entity.html#dataMap">dataMap</a>, <a href="Entity.html#name">name</a>, <a href="Entity.html#OUTER_JOIN_INDICATOR">OUTER_JOIN_INDICATOR</a>, <a href="Entity.html#PATH_SEPARATOR">PATH_SEPARATOR</a>, <a href="Entity.html#relationships">relationships</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">ObjEntity</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String)">ObjEntity</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" class="externalLink">String</a> name)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== 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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance 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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </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><T> T</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#acceptVisitor(org.apache.cayenne.configuration.ConfigurationNodeVisitor)">acceptVisitor</a></span>​(<a href="../configuration/ConfigurationNodeVisitor.html" title="interface in org.apache.cayenne.configuration">ConfigurationNodeVisitor</a><T> visitor)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addAttributeOverride(java.lang.String,java.lang.String)">addAttributeOverride</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" class="externalLink">String</a> attributeName, |
| <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> dbPath)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clearDbMapping()">clearDbMapping</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Clears all the mapping between this obj entity and its current db entity.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#encodeAsXML(org.apache.cayenne.util.XMLEncoder,org.apache.cayenne.configuration.ConfigurationNodeVisitor)">encodeAsXML</a></span>​(<a href="../util/XMLEncoder.html" title="class in org.apache.cayenne.util">XMLEncoder</a> encoder, |
| <a href="../configuration/ConfigurationNodeVisitor.html" title="interface in org.apache.cayenne.configuration">ConfigurationNodeVisitor</a> delegate)</code></th> |
| <td class="colLast"> |
| <div class="block">Prints itself as XML to the provided XMLEncoder.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="ObjAttribute.html" title="class in org.apache.cayenne.map">ObjAttribute</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAttribute(java.lang.String)">getAttribute</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" class="externalLink">String</a> name)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a named attribute that is either declared in this ObjEntity or is |
| inherited.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="ObjAttribute.html" title="class in org.apache.cayenne.map">ObjAttribute</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAttributeForDbAttribute(org.apache.cayenne.map.DbAttribute)">getAttributeForDbAttribute</a></span>​(<a href="DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</a> dbAttribute)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns ObjAttribute of this entity that maps to <code>dbAttribute</code> |
| parameter.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <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><<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>,​<a href="ObjAttribute.html" title="class in org.apache.cayenne.map">ObjAttribute</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAttributeMap()">getAttributeMap</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a Map of all attributes that either belong to this |
| ObjEntity or inherited.</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><<a href="ObjAttribute.html" title="class in org.apache.cayenne.map">ObjAttribute</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAttributes()">getAttributes</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a Collection of all attributes that either belong to this |
| ObjEntity or inherited.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="CallbackMap.html" title="class in org.apache.cayenne.map">CallbackMap</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCallbackMap()">getCallbackMap</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns an object that stores callback methods of this entity.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</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" class="externalLink">String</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCallbackMethods()">getCallbackMethods</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i10" 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" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getClassName()">getClassName</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the name of DataObject class described by this entity.</div> |
| </td> |
| </tr> |
| <tr id="i11" 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" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getClientClassName()">getClientClassName</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the name of ClientDataObject class described by this entity.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getClientEntity()">getClientEntity</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns an ObjEntity stripped of any server-side information, such as |
| DbEntity mapping.</div> |
| </td> |
| </tr> |
| <tr id="i13" 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" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getClientSuperClassName()">getClientSuperClassName</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a fully-qualified name of the client-side super class of the |
| DataObject class.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDbEntity()">getDbEntity</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a DbEntity associated with this ObjEntity.</div> |
| </td> |
| </tr> |
| <tr id="i15" 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" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDbEntityName()">getDbEntityName</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the name of the underlying DbEntity.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="ObjAttribute.html" title="class in org.apache.cayenne.map">ObjAttribute</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDeclaredAttribute(java.lang.String)">getDeclaredAttribute</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" class="externalLink">String</a> name)</code></th> |
| <td class="colLast"> |
| <div class="block">Finds attribute declared by this ObjEntity, |
| excluding inherited attributes.</div> |
| </td> |
| </tr> |
| <tr id="i17" 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><<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>,​<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>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDeclaredAttributeOverrides()">getDeclaredAttributeOverrides</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i18" 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><<a href="ObjAttribute.html" title="class in org.apache.cayenne.map">ObjAttribute</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDeclaredAttributes()">getDeclaredAttributes</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a Collection of all attributes that belong to this ObjEntity, |
| excluding inherited attributes.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDeclaredLockType()">getDeclaredLockType</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the type of lock used by this ObjEntity, regardless of what |
| locking type is used by super entities.</div> |
| </td> |
| </tr> |
| <tr id="i20" 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="#getDeclaredQualifier()">getDeclaredQualifier</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a qualifier that imposes a restriction on what objects belong to |
| this entity.</div> |
| </td> |
| </tr> |
| <tr id="i21" 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><<a href="ObjRelationship.html" title="class in org.apache.cayenne.map">ObjRelationship</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDeclaredRelationships()">getDeclaredRelationships</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a Collection of all relationships that belong to this ObjEntity, |
| excluding inherited attributes.</div> |
| </td> |
| </tr> |
| <tr id="i22" 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="externalLink">Class</a><?></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getJavaClass()">getJavaClass</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">since 4.0 this method based on statically defined class |
| loading algorithm is not going to work in environments like |
| OSGi.</div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i23" 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" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getJavaClassName()">getJavaClassName</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a non-null class name.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLockType()">getLockType</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the type of lock used by this ObjEntity.</div> |
| </td> |
| </tr> |
| <tr id="i25" 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><<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>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPrimaryKeyNames()">getPrimaryKeyNames</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the names of DbAtributes that comprise the primary key of the |
| parent DbEntity.</div> |
| </td> |
| </tr> |
| <tr id="i26" 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><<a href="ObjAttribute.html" title="class in org.apache.cayenne.map">ObjAttribute</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPrimaryKeys()">getPrimaryKeys</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns an unmodifiable collection of ObjAttributes representing the |
| primary key of the table described by this DbEntity.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code><a href="ObjRelationship.html" title="class in org.apache.cayenne.map">ObjRelationship</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRelationship(java.lang.String)">getRelationship</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" class="externalLink">String</a> name)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a named Relationship that either belongs to this ObjEntity or is |
| inherited.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code><a href="ObjRelationship.html" title="class in org.apache.cayenne.map">ObjRelationship</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRelationshipForDbRelationship(org.apache.cayenne.map.DbRelationship)">getRelationshipForDbRelationship</a></span>​(<a href="DbRelationship.html" title="class in org.apache.cayenne.map">DbRelationship</a> dbRelationship)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns ObjRelationship of this entity that maps to |
| <code>dbRelationship</code> parameter.</div> |
| </td> |
| </tr> |
| <tr id="i29" 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><<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>,​<a href="ObjRelationship.html" title="class in org.apache.cayenne.map">ObjRelationship</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRelationshipMap()">getRelationshipMap</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns an unmodifiable map of relationships sorted by name.</div> |
| </td> |
| </tr> |
| <tr id="i30" 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><<a href="ObjRelationship.html" title="class in org.apache.cayenne.map">ObjRelationship</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRelationships()">getRelationships</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns an unmodifiable collection of Relationships that exist in this entity.</div> |
| </td> |
| </tr> |
| <tr id="i31" 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" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSuperClassName()">getSuperClassName</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a fully-qualified name of the super class of the DataObject |
| class.</div> |
| </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code><a href="ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSuperEntity()">getSuperEntity</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a "super" entity in the entity inheritance hierarchy.</div> |
| </td> |
| </tr> |
| <tr id="i33" 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" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSuperEntityName()">getSuperEntityName</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns an entity name for a parent entity in the inheritance hierarchy.</div> |
| </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isAbstract()">isAbstract</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isClientAllowed()">isClientAllowed</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns true if this entity is allowed to be used on the client.</div> |
| </td> |
| </tr> |
| <tr id="i36" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isGeneric()">isGeneric</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns whether this entity is "generic", meaning it is not mapped to a |
| unique Java class.</div> |
| </td> |
| </tr> |
| <tr id="i37" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isReadOnly()">isReadOnly</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns <code>true</code> if this ObjEntity represents a set of read-only |
| objects.</div> |
| </td> |
| </tr> |
| <tr id="i38" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isServerOnly()">isServerOnly</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns true if this entity is not available on the client.</div> |
| </td> |
| </tr> |
| <tr id="i39" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isSubentityOf(org.apache.cayenne.map.ObjEntity)">isSubentityOf</a></span>​(<a href="ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</a> entity)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns true if this entity directly or indirectly inherits from a given |
| entity, false otherwise.</div> |
| </td> |
| </tr> |
| <tr id="i40" class="altColor"> |
| <td class="colFirst"><code><a href="PathComponent.html" title="interface in org.apache.cayenne.map">PathComponent</a><<a href="ObjAttribute.html" title="class in org.apache.cayenne.map">ObjAttribute</a>,​<a href="ObjRelationship.html" title="class in org.apache.cayenne.map">ObjRelationship</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#lastPathComponent(org.apache.cayenne.exp.Expression,java.util.Map)">lastPathComponent</a></span>​(<a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> path, |
| <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> aliasMap)</code></th> |
| <td class="colLast"> |
| <div class="block">Convenience method returning the last component in the path iterator.</div> |
| </td> |
| </tr> |
| <tr id="i41" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#objEntityAdded(org.apache.cayenne.map.event.EntityEvent)">objEntityAdded</a></span>​(<a href="event/EntityEvent.html" title="class in org.apache.cayenne.map.event">EntityEvent</a> e)</code></th> |
| <td class="colLast"> |
| <div class="block">New entity has been created/added.</div> |
| </td> |
| </tr> |
| <tr id="i42" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#objEntityChanged(org.apache.cayenne.map.event.EntityEvent)">objEntityChanged</a></span>​(<a href="event/EntityEvent.html" title="class in org.apache.cayenne.map.event">EntityEvent</a> e)</code></th> |
| <td class="colLast"> |
| <div class="block">ObjEntity property changed.</div> |
| </td> |
| </tr> |
| <tr id="i43" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#objEntityRemoved(org.apache.cayenne.map.event.EntityEvent)">objEntityRemoved</a></span>​(<a href="event/EntityEvent.html" title="class in org.apache.cayenne.map.event">EntityEvent</a> e)</code></th> |
| <td class="colLast"> |
| <div class="block">Entity has been removed.</div> |
| </td> |
| </tr> |
| <tr id="i44" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeAttributeOverride(java.lang.String)">removeAttributeOverride</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" class="externalLink">String</a> attributeName)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i45" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a><<a href="PathComponent.html" title="interface in org.apache.cayenne.map">PathComponent</a><<a href="ObjAttribute.html" title="class in org.apache.cayenne.map">ObjAttribute</a>,​<a href="ObjRelationship.html" title="class in org.apache.cayenne.map">ObjRelationship</a>>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resolvePath(org.apache.cayenne.exp.Expression,java.util.Map)">resolvePath</a></span>​(<a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> pathExp, |
| <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> aliasMap)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns an Iterable instance over expression path components based on |
| this entity.</div> |
| </td> |
| </tr> |
| <tr id="i46" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util" class="externalLink">Iterator</a><<a href="../util/CayenneMapEntry.html" title="interface in org.apache.cayenne.util">CayenneMapEntry</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resolvePathComponents(org.apache.cayenne.exp.Expression)">resolvePathComponents</a></span>​(<a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> pathExp)</code></th> |
| <td class="colLast"> |
| <div class="block">Processes expression <code>pathExp</code> and returns an Iterator of path |
| components that contains a sequence of Attributes and Relationships.</div> |
| </td> |
| </tr> |
| <tr id="i47" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setAbstract(boolean)">setAbstract</a></span>​(boolean isAbstract)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets whether this entity is abstract only.</div> |
| </td> |
| </tr> |
| <tr id="i48" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setClassName(java.lang.String)">setClassName</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" class="externalLink">String</a> className)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the name of the DataObject class described by this entity.</div> |
| </td> |
| </tr> |
| <tr id="i49" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setClientClassName(java.lang.String)">setClientClassName</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" class="externalLink">String</a> clientClassName)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the name of the ClientDataObject class described by this entity.</div> |
| </td> |
| </tr> |
| <tr id="i50" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setClientSuperClassName(java.lang.String)">setClientSuperClassName</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" class="externalLink">String</a> clientSuperClassName)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets a fully-qualified name of the client-side super class of the |
| ClientDataObject class.</div> |
| </td> |
| </tr> |
| <tr id="i51" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDbEntity(org.apache.cayenne.map.DbEntity)">setDbEntity</a></span>​(<a href="DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a> dbEntity)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the DbEntity used by this ObjEntity.</div> |
| </td> |
| </tr> |
| <tr id="i52" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDbEntityName(java.lang.String)">setDbEntityName</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" class="externalLink">String</a> string)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the name of underlying DbEntity.</div> |
| </td> |
| </tr> |
| <tr id="i53" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDeclaredLockType(int)">setDeclaredLockType</a></span>​(int i)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the type of lock used by this ObjEntity.</div> |
| </td> |
| </tr> |
| <tr id="i54" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDeclaredQualifier(org.apache.cayenne.exp.Expression)">setDeclaredQualifier</a></span>​(<a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets a qualifier that imposes a limit on what objects belong to this |
| entity.</div> |
| </td> |
| </tr> |
| <tr id="i55" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setReadOnly(boolean)">setReadOnly</a></span>​(boolean readOnly)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i56" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setServerOnly(boolean)">setServerOnly</a></span>​(boolean serverOnly)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets whether this entity is available on the client.</div> |
| </td> |
| </tr> |
| <tr id="i57" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSuperClassName(java.lang.String)">setSuperClassName</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" class="externalLink">String</a> superClassName)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets a fully-qualified name of the super class of the DataObject class.</div> |
| </td> |
| </tr> |
| <tr id="i58" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSuperEntityName(java.lang.String)">setSuperEntityName</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" class="externalLink">String</a> superEntityName)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets an entity name for a parent entity in the inheritance hierarchy.</div> |
| </td> |
| </tr> |
| <tr id="i59" class="rowColor"> |
| <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="#translateToDbPath(org.apache.cayenne.exp.Expression)">translateToDbPath</a></span>​(<a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> expression)</code></th> |
| <td class="colLast"> |
| <div class="block">Transforms an Expression to an analogous expression in terms of the |
| underlying DbEntity.</div> |
| </td> |
| </tr> |
| <tr id="i60" 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="#translateToRelatedEntity(org.apache.cayenne.exp.Expression,java.lang.String)">translateToRelatedEntity</a></span>​(<a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> expression, |
| <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> relationshipPath)</code></th> |
| <td class="colLast"> |
| <div class="block">Transforms an Expression rooted in this entity to an analogous expression |
| rooted in related entity.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.cayenne.map.Entity"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.cayenne.map.<a href="Entity.html" title="class in org.apache.cayenne.map">Entity</a></h3> |
| <code><a href="Entity.html#addAttribute(org.apache.cayenne.map.Attribute)">addAttribute</a>, <a href="Entity.html#addRelationship(org.apache.cayenne.map.Relationship)">addRelationship</a>, <a href="Entity.html#clearAttributes()">clearAttributes</a>, <a href="Entity.html#clearRelationships()">clearRelationships</a>, <a href="Entity.html#getAnyRelationship(org.apache.cayenne.map.Entity)">getAnyRelationship</a>, <a href="Entity.html#getDataMap()">getDataMap</a>, <a href="Entity.html#getName()">getName</a>, <a href="Entity.html#getParent()">getParent</a>, <a href="Entity.html#removeAttribute(java.lang.String)">removeAttribute</a>, <a href="Entity.html#removeRelationship(java.lang.String)">removeRelationship</a>, <a href="Entity.html#resolvePathComponents(java.lang.String)">resolvePathComponents</a>, <a href="Entity.html#setDataMap(org.apache.cayenne.map.DataMap)">setDataMap</a>, <a href="Entity.html#setName(java.lang.String)">setName</a>, <a href="Entity.html#setParent(java.lang.Object)">setParent</a>, <a href="Entity.html#toString()">toString</a>, <a href="Entity.html#updateAttribute(org.apache.cayenne.map.Attribute)">updateAttribute</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="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" class="externalLink">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" class="externalLink">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" class="externalLink">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" class="externalLink">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" class="externalLink">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" class="externalLink">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" class="externalLink">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" class="externalLink">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" class="externalLink">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" class="externalLink">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" class="externalLink">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a id="LOCK_TYPE_NONE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>LOCK_TYPE_NONE</h4> |
| <pre>public static final int LOCK_TYPE_NONE</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.cayenne.map.ObjEntity.LOCK_TYPE_NONE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="LOCK_TYPE_OPTIMISTIC"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>LOCK_TYPE_OPTIMISTIC</h4> |
| <pre>public static final int LOCK_TYPE_OPTIMISTIC</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.cayenne.map.ObjEntity.LOCK_TYPE_OPTIMISTIC">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="DEFAULT_GENERIC_CLASSES"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_GENERIC_CLASSES</h4> |
| <pre>protected static final <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><<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>> DEFAULT_GENERIC_CLASSES</pre> |
| <div class="block">A collection of default "generic" entity classes excluded from class |
| generation.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="superClassName"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>superClassName</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" class="externalLink">String</a> superClassName</pre> |
| </li> |
| </ul> |
| <a id="className"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>className</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" class="externalLink">String</a> className</pre> |
| </li> |
| </ul> |
| <a id="dbEntityName"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dbEntityName</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" class="externalLink">String</a> dbEntityName</pre> |
| </li> |
| </ul> |
| <a id="superEntityName"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>superEntityName</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" class="externalLink">String</a> superEntityName</pre> |
| </li> |
| </ul> |
| <a id="qualifier"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>qualifier</h4> |
| <pre>protected <a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier</pre> |
| </li> |
| </ul> |
| <a id="readOnly"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readOnly</h4> |
| <pre>protected boolean readOnly</pre> |
| </li> |
| </ul> |
| <a id="lockType"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>lockType</h4> |
| <pre>protected int lockType</pre> |
| </li> |
| </ul> |
| <a id="_abstract"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>_abstract</h4> |
| <pre>protected boolean _abstract</pre> |
| </li> |
| </ul> |
| <a id="serverOnly"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>serverOnly</h4> |
| <pre>protected boolean serverOnly</pre> |
| </li> |
| </ul> |
| <a id="clientClassName"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clientClassName</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" class="externalLink">String</a> clientClassName</pre> |
| </li> |
| </ul> |
| <a id="clientSuperClassName"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clientSuperClassName</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" class="externalLink">String</a> clientSuperClassName</pre> |
| </li> |
| </ul> |
| <a id="callbacks"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>callbacks</h4> |
| <pre>protected <a href="CallbackMap.html" title="class in org.apache.cayenne.map">CallbackMap</a> callbacks</pre> |
| </li> |
| </ul> |
| <a id="attributeOverrides"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>attributeOverrides</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" class="externalLink">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" class="externalLink">String</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" class="externalLink">String</a>> attributeOverrides</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ObjEntity</h4> |
| <pre>public ObjEntity()</pre> |
| </li> |
| </ul> |
| <a id="<init>(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ObjEntity</h4> |
| <pre>public ObjEntity​(<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> name)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="acceptVisitor(org.apache.cayenne.configuration.ConfigurationNodeVisitor)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>acceptVisitor</h4> |
| <pre class="methodSignature">public <T> T acceptVisitor​(<a href="../configuration/ConfigurationNodeVisitor.html" title="interface in org.apache.cayenne.configuration">ConfigurationNodeVisitor</a><T> visitor)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../configuration/ConfigurationNode.html#acceptVisitor(org.apache.cayenne.configuration.ConfigurationNodeVisitor)">acceptVisitor</a></code> in interface <code><a href="../configuration/ConfigurationNode.html" title="interface in org.apache.cayenne.configuration">ConfigurationNode</a></code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="encodeAsXML(org.apache.cayenne.util.XMLEncoder,org.apache.cayenne.configuration.ConfigurationNodeVisitor)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>encodeAsXML</h4> |
| <pre class="methodSignature">public void encodeAsXML​(<a href="../util/XMLEncoder.html" title="class in org.apache.cayenne.util">XMLEncoder</a> encoder, |
| <a href="../configuration/ConfigurationNodeVisitor.html" title="interface in org.apache.cayenne.configuration">ConfigurationNodeVisitor</a> delegate)</pre> |
| <div class="block">Prints itself as XML to the provided XMLEncoder.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../util/XMLSerializable.html#encodeAsXML(org.apache.cayenne.util.XMLEncoder,org.apache.cayenne.configuration.ConfigurationNodeVisitor)">encodeAsXML</a></code> in interface <code><a href="../util/XMLSerializable.html" title="interface in org.apache.cayenne.util">XMLSerializable</a></code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getClientEntity()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getClientEntity</h4> |
| <pre class="methodSignature">public <a href="ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</a> getClientEntity()</pre> |
| <div class="block">Returns an ObjEntity stripped of any server-side information, such as |
| DbEntity mapping. "clientClassName" property of this entity is used to |
| initialize "className" property of returned entity.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getJavaClassName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getJavaClassName</h4> |
| <pre class="methodSignature">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" class="externalLink">String</a> getJavaClassName()</pre> |
| <div class="block">Returns a non-null class name. For generic entities with no class |
| specified explicitly, default DataMap superclass is used, and if it is |
| not set - CayenneDataObject is used.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getJavaClass()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getJavaClass</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| 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="externalLink">Class</a><?> getJavaClass()</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">since 4.0 this method based on statically defined class |
| loading algorithm is not going to work in environments like |
| OSGi. <a href="../di/AdhocObjectFactory.html" title="interface in org.apache.cayenne.di"><code>AdhocObjectFactory</code></a> should be used as it can |
| provide the environment-specific class loading policy.</div> |
| </div> |
| <div class="block">Returns Java class of persistent objects described by this entity. For |
| generic entities with no class specified explicitly, default DataMap |
| superclass is used, and if it is not set - CayenneDataObject is used. |
| Casts any thrown exceptions into CayenneRuntimeException.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getCallbackMap()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCallbackMap</h4> |
| <pre class="methodSignature">public <a href="CallbackMap.html" title="class in org.apache.cayenne.map">CallbackMap</a> getCallbackMap()</pre> |
| <div class="block">Returns an object that stores callback methods of this entity.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getLockType()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLockType</h4> |
| <pre class="methodSignature">public int getLockType()</pre> |
| <div class="block">Returns the type of lock used by this ObjEntity. If this entity is not |
| locked, this method would look in a super entity recursively, until it |
| finds a lock somewhere in the inheritance hierarchy.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getDeclaredLockType()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDeclaredLockType</h4> |
| <pre class="methodSignature">public int getDeclaredLockType()</pre> |
| <div class="block">Returns the type of lock used by this ObjEntity, regardless of what |
| locking type is used by super entities.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setDeclaredLockType(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDeclaredLockType</h4> |
| <pre class="methodSignature">public void setDeclaredLockType​(int i)</pre> |
| <div class="block">Sets the type of lock used by this ObjEntity.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isGeneric()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isGeneric</h4> |
| <pre class="methodSignature">public boolean isGeneric()</pre> |
| <div class="block">Returns whether this entity is "generic", meaning it is not mapped to a |
| unique Java class. Criterion for generic entities is that it either has |
| no Java class mapped or its class is the same as DataMap's default |
| superclass, or it is CayenneDataObject.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isClientAllowed()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isClientAllowed</h4> |
| <pre class="methodSignature">public boolean isClientAllowed()</pre> |
| <div class="block">Returns true if this entity is allowed to be used on the client. Checks |
| that parent DataMap allows client entities and also that this entity is |
| not explicitly disabled for the client use.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isAbstract()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isAbstract</h4> |
| <pre class="methodSignature">public boolean isAbstract()</pre> |
| </li> |
| </ul> |
| <a id="setAbstract(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAbstract</h4> |
| <pre class="methodSignature">public void setAbstract​(boolean isAbstract)</pre> |
| <div class="block">Sets whether this entity is abstract only.</div> |
| </li> |
| </ul> |
| <a id="isServerOnly()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isServerOnly</h4> |
| <pre class="methodSignature">public boolean isServerOnly()</pre> |
| <div class="block">Returns true if this entity is not available on the client.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setServerOnly(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setServerOnly</h4> |
| <pre class="methodSignature">public void setServerOnly​(boolean serverOnly)</pre> |
| <div class="block">Sets whether this entity is available on the client.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getDeclaredQualifier()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDeclaredQualifier</h4> |
| <pre class="methodSignature">public <a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> getDeclaredQualifier()</pre> |
| <div class="block">Returns a qualifier that imposes a restriction on what objects belong to |
| this entity. Returned qualifier is the one declared in this entity, and |
| does not include qualifiers declared in super entities.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSuperEntityName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSuperEntityName</h4> |
| <pre class="methodSignature">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" class="externalLink">String</a> getSuperEntityName()</pre> |
| <div class="block">Returns an entity name for a parent entity in the inheritance hierarchy.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setDeclaredQualifier(org.apache.cayenne.exp.Expression)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDeclaredQualifier</h4> |
| <pre class="methodSignature">public void setDeclaredQualifier​(<a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier)</pre> |
| <div class="block">Sets a qualifier that imposes a limit on what objects belong to this |
| entity.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setSuperEntityName(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSuperEntityName</h4> |
| <pre class="methodSignature">public void setSuperEntityName​(<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> superEntityName)</pre> |
| <div class="block">Sets an entity name for a parent entity in the inheritance hierarchy.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getClassName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getClassName</h4> |
| <pre class="methodSignature">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" class="externalLink">String</a> getClassName()</pre> |
| <div class="block">Returns the name of DataObject class described by this entity.</div> |
| </li> |
| </ul> |
| <a id="setClassName(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setClassName</h4> |
| <pre class="methodSignature">public void setClassName​(<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> className)</pre> |
| <div class="block">Sets the name of the DataObject class described by this entity.</div> |
| </li> |
| </ul> |
| <a id="getClientClassName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getClientClassName</h4> |
| <pre class="methodSignature">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" class="externalLink">String</a> getClientClassName()</pre> |
| <div class="block">Returns the name of ClientDataObject class described by this entity.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setClientClassName(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setClientClassName</h4> |
| <pre class="methodSignature">public void setClientClassName​(<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> clientClassName)</pre> |
| <div class="block">Sets the name of the ClientDataObject class described by this entity.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSuperClassName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSuperClassName</h4> |
| <pre class="methodSignature">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" class="externalLink">String</a> getSuperClassName()</pre> |
| <div class="block">Returns a fully-qualified name of the super class of the DataObject |
| class. This value is used as a hint for class generation. If the entity |
| inherits from another entity, a superclass is the class of that entity.</div> |
| </li> |
| </ul> |
| <a id="setSuperClassName(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSuperClassName</h4> |
| <pre class="methodSignature">public void setSuperClassName​(<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> superClassName)</pre> |
| <div class="block">Sets a fully-qualified name of the super class of the DataObject class. |
| This value is used as a hint for class generation. |
| <p> |
| <i>An attempt to set superclass on an inherited entity has no effect, |
| since a class of the super entity is always used as a superclass.</i> |
| </p></div> |
| </li> |
| </ul> |
| <a id="getClientSuperClassName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getClientSuperClassName</h4> |
| <pre class="methodSignature">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" class="externalLink">String</a> getClientSuperClassName()</pre> |
| <div class="block">Returns a fully-qualified name of the client-side super class of the |
| DataObject class. This value is used as a hint for class generation. If |
| the entity inherits from another entity, a superclass is the class of |
| that entity.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setClientSuperClassName(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setClientSuperClassName</h4> |
| <pre class="methodSignature">public void setClientSuperClassName​(<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> clientSuperClassName)</pre> |
| <div class="block">Sets a fully-qualified name of the client-side super class of the |
| ClientDataObject class. This value is used as a hint for class |
| generation. |
| <p> |
| <i>An attempt to set superclass on an inherited entity has no effect, |
| since a class of the super entity is always used as a superclass. </i> |
| </p></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSuperEntity()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSuperEntity</h4> |
| <pre class="methodSignature">public <a href="ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</a> getSuperEntity()</pre> |
| <div class="block">Returns a "super" entity in the entity inheritance hierarchy.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getDbEntity()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDbEntity</h4> |
| <pre class="methodSignature">public <a href="DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a> getDbEntity()</pre> |
| <div class="block">Returns a DbEntity associated with this ObjEntity.</div> |
| </li> |
| </ul> |
| <a id="setDbEntity(org.apache.cayenne.map.DbEntity)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDbEntity</h4> |
| <pre class="methodSignature">public void setDbEntity​(<a href="DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a> dbEntity)</pre> |
| <div class="block">Sets the DbEntity used by this ObjEntity. |
| <p> |
| <i>Setting DbEntity on an inherited entity has no effect, since a class |
| of the super entity is always used as a superclass. </i> |
| </p></div> |
| </li> |
| </ul> |
| <a id="getPrimaryKeys()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPrimaryKeys</h4> |
| <pre class="methodSignature">public <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><<a href="ObjAttribute.html" title="class in org.apache.cayenne.map">ObjAttribute</a>> getPrimaryKeys()</pre> |
| <div class="block">Returns an unmodifiable collection of ObjAttributes representing the |
| primary key of the table described by this DbEntity. Note that since PK |
| is very often not an object property, the returned collection may contain |
| "synthetic" ObjAttributes that are created on the fly and are not a part |
| of ObjEntity and will not be a part of entity.getAttributes().</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getAttribute(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAttribute</h4> |
| <pre class="methodSignature">public <a href="ObjAttribute.html" title="class in org.apache.cayenne.map">ObjAttribute</a> getAttribute​(<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> name)</pre> |
| <div class="block">Returns a named attribute that is either declared in this ObjEntity or is |
| inherited. In any case returned attribute 'getEntity' method will return |
| this entity. Returns null if no matching attribute is found.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="Entity.html#getAttribute(java.lang.String)">getAttribute</a></code> in class <code><a href="Entity.html" title="class in org.apache.cayenne.map">Entity</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getAttributeMap()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAttributeMap</h4> |
| <pre class="methodSignature">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" class="externalLink">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" class="externalLink">String</a>,​<a href="ObjAttribute.html" title="class in org.apache.cayenne.map">ObjAttribute</a>> getAttributeMap()</pre> |
| <div class="block">Returns a Map of all attributes that either belong to this |
| ObjEntity or inherited.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="Entity.html#getAttributeMap()">getAttributeMap</a></code> in class <code><a href="Entity.html" title="class in org.apache.cayenne.map">Entity</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addAttributeOverride(java.lang.String,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addAttributeOverride</h4> |
| <pre class="methodSignature">public void addAttributeOverride​(<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> attributeName, |
| <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> dbPath)</pre> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="removeAttributeOverride(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeAttributeOverride</h4> |
| <pre class="methodSignature">public void removeAttributeOverride​(<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> attributeName)</pre> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getDeclaredAttributeOverrides()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDeclaredAttributeOverrides</h4> |
| <pre class="methodSignature">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" class="externalLink">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" class="externalLink">String</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" class="externalLink">String</a>> getDeclaredAttributeOverrides()</pre> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getAttributes()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAttributes</h4> |
| <pre class="methodSignature">public <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><<a href="ObjAttribute.html" title="class in org.apache.cayenne.map">ObjAttribute</a>> getAttributes()</pre> |
| <div class="block">Returns a Collection of all attributes that either belong to this |
| ObjEntity or inherited.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="Entity.html#getAttributes()">getAttributes</a></code> in class <code><a href="Entity.html" title="class in org.apache.cayenne.map">Entity</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getDeclaredAttributes()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDeclaredAttributes</h4> |
| <pre class="methodSignature">public <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><<a href="ObjAttribute.html" title="class in org.apache.cayenne.map">ObjAttribute</a>> getDeclaredAttributes()</pre> |
| <div class="block">Returns a Collection of all attributes that belong to this ObjEntity, |
| excluding inherited attributes.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getDeclaredAttribute(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDeclaredAttribute</h4> |
| <pre class="methodSignature">public <a href="ObjAttribute.html" title="class in org.apache.cayenne.map">ObjAttribute</a> getDeclaredAttribute​(<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> name)</pre> |
| <div class="block">Finds attribute declared by this ObjEntity, |
| excluding inherited attributes.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - of the attribute</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>declared attribute or null if no attribute is found</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#getAttribute(java.lang.String)"><code>getAttribute(String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getRelationship(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRelationship</h4> |
| <pre class="methodSignature">public <a href="ObjRelationship.html" title="class in org.apache.cayenne.map">ObjRelationship</a> getRelationship​(<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> name)</pre> |
| <div class="block">Returns a named Relationship that either belongs to this ObjEntity or is |
| inherited. Returns null if no matching attribute is found.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="Entity.html#getRelationship(java.lang.String)">getRelationship</a></code> in class <code><a href="Entity.html" title="class in org.apache.cayenne.map">Entity</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getRelationshipMap()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRelationshipMap</h4> |
| <pre class="methodSignature">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" class="externalLink">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" class="externalLink">String</a>,​<a href="ObjRelationship.html" title="class in org.apache.cayenne.map">ObjRelationship</a>> getRelationshipMap()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="Entity.html#getRelationshipMap()">Entity</a></code></span></div> |
| <div class="block">Returns an unmodifiable map of relationships sorted by name.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="Entity.html#getRelationshipMap()">getRelationshipMap</a></code> in class <code><a href="Entity.html" title="class in org.apache.cayenne.map">Entity</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getRelationships()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRelationships</h4> |
| <pre class="methodSignature">public <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><<a href="ObjRelationship.html" title="class in org.apache.cayenne.map">ObjRelationship</a>> getRelationships()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="Entity.html#getRelationships()">Entity</a></code></span></div> |
| <div class="block">Returns an unmodifiable collection of Relationships that exist in this entity.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="Entity.html#getRelationships()">getRelationships</a></code> in class <code><a href="Entity.html" title="class in org.apache.cayenne.map">Entity</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getDeclaredRelationships()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDeclaredRelationships</h4> |
| <pre class="methodSignature">public <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><<a href="ObjRelationship.html" title="class in org.apache.cayenne.map">ObjRelationship</a>> getDeclaredRelationships()</pre> |
| <div class="block">Returns a Collection of all relationships that belong to this ObjEntity, |
| excluding inherited attributes.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getAttributeForDbAttribute(org.apache.cayenne.map.DbAttribute)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAttributeForDbAttribute</h4> |
| <pre class="methodSignature">public <a href="ObjAttribute.html" title="class in org.apache.cayenne.map">ObjAttribute</a> getAttributeForDbAttribute​(<a href="DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</a> dbAttribute)</pre> |
| <div class="block">Returns ObjAttribute of this entity that maps to <code>dbAttribute</code> |
| parameter. Returns null if no such attribute is found.</div> |
| </li> |
| </ul> |
| <a id="getPrimaryKeyNames()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPrimaryKeyNames</h4> |
| <pre class="methodSignature">public <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><<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>> getPrimaryKeyNames()</pre> |
| <div class="block">Returns the names of DbAtributes that comprise the primary key of the |
| parent DbEntity.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getRelationshipForDbRelationship(org.apache.cayenne.map.DbRelationship)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRelationshipForDbRelationship</h4> |
| <pre class="methodSignature">public <a href="ObjRelationship.html" title="class in org.apache.cayenne.map">ObjRelationship</a> getRelationshipForDbRelationship​(<a href="DbRelationship.html" title="class in org.apache.cayenne.map">DbRelationship</a> dbRelationship)</pre> |
| <div class="block">Returns ObjRelationship of this entity that maps to |
| <code>dbRelationship</code> parameter. Returns null if no such |
| relationship is found.</div> |
| </li> |
| </ul> |
| <a id="clearDbMapping()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clearDbMapping</h4> |
| <pre class="methodSignature">public void clearDbMapping()</pre> |
| <div class="block">Clears all the mapping between this obj entity and its current db entity. |
| Clears mapping between entities, attributes and relationships.</div> |
| </li> |
| </ul> |
| <a id="isReadOnly()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isReadOnly</h4> |
| <pre class="methodSignature">public boolean isReadOnly()</pre> |
| <div class="block">Returns <code>true</code> if this ObjEntity represents a set of read-only |
| objects.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>boolean</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setReadOnly(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setReadOnly</h4> |
| <pre class="methodSignature">public void setReadOnly​(boolean readOnly)</pre> |
| </li> |
| </ul> |
| <a id="isSubentityOf(org.apache.cayenne.map.ObjEntity)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isSubentityOf</h4> |
| <pre class="methodSignature">public boolean isSubentityOf​(<a href="ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</a> entity)</pre> |
| <div class="block">Returns true if this entity directly or indirectly inherits from a given |
| entity, false otherwise.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="lastPathComponent(org.apache.cayenne.exp.Expression,java.util.Map)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>lastPathComponent</h4> |
| <pre class="methodSignature">public <a href="PathComponent.html" title="interface in org.apache.cayenne.map">PathComponent</a><<a href="ObjAttribute.html" title="class in org.apache.cayenne.map">ObjAttribute</a>,​<a href="ObjRelationship.html" title="class in org.apache.cayenne.map">ObjRelationship</a>> lastPathComponent​(<a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> path, |
| <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> aliasMap)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="Entity.html#lastPathComponent(org.apache.cayenne.exp.Expression,java.util.Map)">Entity</a></code></span></div> |
| <div class="block">Convenience method returning the last component in the path iterator. If the last |
| component is an alias, it is fully resolved down to the last ObjRelationship.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="Entity.html#lastPathComponent(org.apache.cayenne.exp.Expression,java.util.Map)">lastPathComponent</a></code> in class <code><a href="Entity.html" title="class in org.apache.cayenne.map">Entity</a></code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="resolvePath(org.apache.cayenne.exp.Expression,java.util.Map)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resolvePath</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a><<a href="PathComponent.html" title="interface in org.apache.cayenne.map">PathComponent</a><<a href="ObjAttribute.html" title="class in org.apache.cayenne.map">ObjAttribute</a>,​<a href="ObjRelationship.html" title="class in org.apache.cayenne.map">ObjRelationship</a>>> resolvePath​(<a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> pathExp, |
| <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> aliasMap)</pre> |
| <div class="block">Returns an Iterable instance over expression path components based on |
| this entity.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="Entity.html#resolvePath(org.apache.cayenne.exp.Expression,java.util.Map)">resolvePath</a></code> in class <code><a href="Entity.html" title="class in org.apache.cayenne.map">Entity</a></code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="resolvePathComponents(org.apache.cayenne.exp.Expression)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resolvePathComponents</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util" class="externalLink">Iterator</a><<a href="../util/CayenneMapEntry.html" title="interface in org.apache.cayenne.util">CayenneMapEntry</a>> resolvePathComponents​(<a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> pathExp) |
| throws <a href="../exp/ExpressionException.html" title="class in org.apache.cayenne.exp">ExpressionException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="Entity.html#resolvePathComponents(org.apache.cayenne.exp.Expression)">Entity</a></code></span></div> |
| <div class="block">Processes expression <code>pathExp</code> and returns an Iterator of path |
| components that contains a sequence of Attributes and Relationships. Note that if |
| path is invalid and can not be resolved from this entity, this method will still |
| return an Iterator, but an attempt to read the first invalid path component will |
| result in ExpressionException.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="Entity.html#resolvePathComponents(org.apache.cayenne.exp.Expression)">resolvePathComponents</a></code> in class <code><a href="Entity.html" title="class in org.apache.cayenne.map">Entity</a></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../exp/ExpressionException.html" title="class in org.apache.cayenne.exp">ExpressionException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="translateToDbPath(org.apache.cayenne.exp.Expression)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>translateToDbPath</h4> |
| <pre class="methodSignature">public <a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> translateToDbPath​(<a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> expression)</pre> |
| <div class="block">Transforms an Expression to an analogous expression in terms of the |
| underlying DbEntity.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="translateToRelatedEntity(org.apache.cayenne.exp.Expression,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>translateToRelatedEntity</h4> |
| <pre class="methodSignature">public <a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> translateToRelatedEntity​(<a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> expression, |
| <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> relationshipPath)</pre> |
| <div class="block">Transforms an Expression rooted in this entity to an analogous expression |
| rooted in related entity.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="Entity.html#translateToRelatedEntity(org.apache.cayenne.exp.Expression,java.lang.String)">translateToRelatedEntity</a></code> in class <code><a href="Entity.html" title="class in org.apache.cayenne.map">Entity</a></code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getCallbackMethods()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCallbackMethods</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</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" class="externalLink">String</a>> getCallbackMethods()</pre> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getDbEntityName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDbEntityName</h4> |
| <pre class="methodSignature">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" class="externalLink">String</a> getDbEntityName()</pre> |
| <div class="block">Returns the name of the underlying DbEntity.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setDbEntityName(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDbEntityName</h4> |
| <pre class="methodSignature">public void setDbEntityName​(<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> string)</pre> |
| <div class="block">Sets the name of underlying DbEntity.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="objEntityChanged(org.apache.cayenne.map.event.EntityEvent)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>objEntityChanged</h4> |
| <pre class="methodSignature">public void objEntityChanged​(<a href="event/EntityEvent.html" title="class in org.apache.cayenne.map.event">EntityEvent</a> e)</pre> |
| <div class="block">ObjEntity property changed. May be name, attribute or relationship added |
| or removed, etc. Attribute and relationship property changes are handled |
| in respective listeners.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="event/ObjEntityListener.html#objEntityChanged(org.apache.cayenne.map.event.EntityEvent)">objEntityChanged</a></code> in interface <code><a href="event/ObjEntityListener.html" title="interface in org.apache.cayenne.map.event">ObjEntityListener</a></code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="objEntityAdded(org.apache.cayenne.map.event.EntityEvent)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>objEntityAdded</h4> |
| <pre class="methodSignature">public void objEntityAdded​(<a href="event/EntityEvent.html" title="class in org.apache.cayenne.map.event">EntityEvent</a> e)</pre> |
| <div class="block">New entity has been created/added.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="event/ObjEntityListener.html#objEntityAdded(org.apache.cayenne.map.event.EntityEvent)">objEntityAdded</a></code> in interface <code><a href="event/ObjEntityListener.html" title="interface in org.apache.cayenne.map.event">ObjEntityListener</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="objEntityRemoved(org.apache.cayenne.map.event.EntityEvent)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>objEntityRemoved</h4> |
| <pre class="methodSignature">public void objEntityRemoved​(<a href="event/EntityEvent.html" title="class in org.apache.cayenne.map.event">EntityEvent</a> e)</pre> |
| <div class="block">Entity has been removed.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="event/ObjEntityListener.html#objEntityRemoved(org.apache.cayenne.map.event.EntityEvent)">objEntityRemoved</a></code> in interface <code><a href="event/ObjEntityListener.html" title="interface in org.apache.cayenne.map.event">ObjEntityListener</a></code></dd> |
| </dl> |
| </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/ObjEntity.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 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: </li> |
| <li>Nested | </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 id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2001–2022 <a href="https://cayenne.apache.org/">Apache Cayenne</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |