| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.10) on Mon Dec 05 10:27:04 MSK 2022 --> |
| <title>DbEntity (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="DbEntity (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":10,"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}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/DbEntity.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 DbEntity" class="title">Class DbEntity</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.DbEntity</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/DbAttributeListener.html" title="interface in org.apache.cayenne.map.event">DbAttributeListener</a></code>, <code><a href="event/DbEntityListener.html" title="interface in org.apache.cayenne.map.event">DbEntityListener</a></code>, <code><a href="event/DbRelationshipListener.html" title="interface in org.apache.cayenne.map.event">DbRelationshipListener</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">DbEntity</span> |
| extends <a href="Entity.html" title="class in org.apache.cayenne.map">Entity</a> |
| implements <a href="../configuration/ConfigurationNode.html" title="interface in org.apache.cayenne.configuration">ConfigurationNode</a>, <a href="event/DbEntityListener.html" title="interface in org.apache.cayenne.map.event">DbEntityListener</a>, <a href="event/DbAttributeListener.html" title="interface in org.apache.cayenne.map.event">DbAttributeListener</a>, <a href="event/DbRelationshipListener.html" title="interface in org.apache.cayenne.map.event">DbRelationshipListener</a></pre> |
| <div class="block">A DbEntity is a mapping descriptor that defines a structure of a database |
| table.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../serialized-form.html#org.apache.cayenne.map.DbEntity">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 <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="#catalog">catalog</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/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#generatedAttributes">generatedAttributes</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/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#primaryKey">primaryKey</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="DbKeyGenerator.html" title="class in org.apache.cayenne.map">DbKeyGenerator</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#primaryKeyGenerator">primaryKeyGenerator</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <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"> |
| <div class="block">Qualifier, that will be applied to all select queries and joins with this |
| DbEntity</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#schema">schema</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()">DbEntity</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Creates an unnamed DbEntity.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String)">DbEntity</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">Creates a named DbEntity.</div> |
| </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></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="#addAttribute(org.apache.cayenne.map.DbAttribute)">addAttribute</a></span>​(<a href="DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</a> attr)</code></th> |
| <td class="colLast"> |
| <div class="block">Adds a new attribute to this entity.</div> |
| </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="#clearAttributes()">clearAttributes</a></span>()</code></th> |
| <td class="colLast"> </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="#dbAttributeAdded(org.apache.cayenne.map.event.AttributeEvent)">dbAttributeAdded</a></span>​(<a href="event/AttributeEvent.html" title="class in org.apache.cayenne.map.event">AttributeEvent</a> e)</code></th> |
| <td class="colLast"> |
| <div class="block">New attribute has been created/added.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dbAttributeChanged(org.apache.cayenne.map.event.AttributeEvent)">dbAttributeChanged</a></span>​(<a href="event/AttributeEvent.html" title="class in org.apache.cayenne.map.event">AttributeEvent</a> e)</code></th> |
| <td class="colLast"> |
| <div class="block">Attribute property changed.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dbAttributeRemoved(org.apache.cayenne.map.event.AttributeEvent)">dbAttributeRemoved</a></span>​(<a href="event/AttributeEvent.html" title="class in org.apache.cayenne.map.event">AttributeEvent</a> e)</code></th> |
| <td class="colLast"> |
| <div class="block">Attribute has been removed.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dbEntityAdded(org.apache.cayenne.map.event.EntityEvent)">dbEntityAdded</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="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dbEntityChanged(org.apache.cayenne.map.event.EntityEvent)">dbEntityChanged</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">DbEntity property changed event.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dbEntityRemoved(org.apache.cayenne.map.event.EntityEvent)">dbEntityRemoved</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="i9" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dbRelationshipAdded(org.apache.cayenne.map.event.RelationshipEvent)">dbRelationshipAdded</a></span>​(<a href="event/RelationshipEvent.html" title="class in org.apache.cayenne.map.event">RelationshipEvent</a> e)</code></th> |
| <td class="colLast"> |
| <div class="block">Relationship has been created/added.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dbRelationshipChanged(org.apache.cayenne.map.event.RelationshipEvent)">dbRelationshipChanged</a></span>​(<a href="event/RelationshipEvent.html" title="class in org.apache.cayenne.map.event">RelationshipEvent</a> e)</code></th> |
| <td class="colLast"> |
| <div class="block">Relationship property changed.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dbRelationshipRemoved(org.apache.cayenne.map.event.RelationshipEvent)">dbRelationshipRemoved</a></span>​(<a href="event/RelationshipEvent.html" title="class in org.apache.cayenne.map.event">RelationshipEvent</a> e)</code></th> |
| <td class="colLast"> |
| <div class="block">Relationship has been removed.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <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="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</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> attributeName)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns attribute with name <code>attributeName</code> or null if no attribute |
| with this name exists.</div> |
| </td> |
| </tr> |
| <tr id="i14" 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="DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</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 |
| DbEntity or inherited.</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="#getCatalog()">getCatalog</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the catalog name of the table described by this DbEntity.</div> |
| </td> |
| </tr> |
| <tr id="i16" 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="#getFullyQualifiedName()">getFullyQualifiedName</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns table name including catalog and schema, if any of those are |
| present.</div> |
| </td> |
| </tr> |
| <tr id="i17" 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="DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getGeneratedAttributes()">getGeneratedAttributes</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns an unmodifiable collection of DbAttributes that are generated by |
| the database.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="DbKeyGenerator.html" title="class in org.apache.cayenne.map">DbKeyGenerator</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPrimaryKeyGenerator()">getPrimaryKeyGenerator</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return the primary key generator for this entity.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</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 DbAttributes representing the |
| primary key of the table described by this DbEntity.</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="#getQualifier()">getQualifier</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code><a href="DbRelationship.html" title="class in org.apache.cayenne.map">DbRelationship</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> relName)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns relationship with name <code>relName</code>.</div> |
| </td> |
| </tr> |
| <tr id="i22" 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="DbRelationship.html" title="class in org.apache.cayenne.map">DbRelationship</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="i23" 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="DbRelationship.html" title="class in org.apache.cayenne.map">DbRelationship</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 a Collection of relationships from this entity or inherited.</div> |
| </td> |
| </tr> |
| <tr id="i24" 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="#getSchema()">getSchema</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns database schema of this table.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isFullReplacementIdAttached(org.apache.cayenne.ObjectId)">isFullReplacementIdAttached</a></span>​(<a href="../ObjectId.html" title="interface in org.apache.cayenne">ObjectId</a> id)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns true if there is full replacement id is attached to an ObjectId.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code><a href="PathComponent.html" title="interface in org.apache.cayenne.map">PathComponent</a><<a href="DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</a>,​<a href="DbRelationship.html" title="class in org.apache.cayenne.map">DbRelationship</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="i27" 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="ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#mappedObjEntities()">mappedObjEntities</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeAttribute(java.lang.String)">removeAttribute</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> attrName)</code></th> |
| <td class="colLast"> |
| <div class="block">Removes attribute from the entity, removes any relationship joins |
| containing this attribute.</div> |
| </td> |
| </tr> |
| <tr id="i29" 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="DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</a>,​<a href="DbRelationship.html" title="class in org.apache.cayenne.map">DbRelationship</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="i30" 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="i31" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCatalog(java.lang.String)">setCatalog</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> catalog)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the catalog name of the table described by this DbEntity.</div> |
| </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setPrimaryKeyGenerator(org.apache.cayenne.map.DbKeyGenerator)">setPrimaryKeyGenerator</a></span>​(<a href="DbKeyGenerator.html" title="class in org.apache.cayenne.map">DbKeyGenerator</a> primaryKeyGenerator)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the primary key generator for this entity.</div> |
| </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setQualifier(org.apache.cayenne.exp.Expression)">setQualifier</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 qualifier for this entity</div> |
| </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSchema(java.lang.String)">setSchema</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> schema)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the database schema name of the table described by this DbEntity.</div> |
| </td> |
| </tr> |
| <tr id="i35" 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="#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 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#clearRelationships()">clearRelationships</a>, <a href="Entity.html#getAnyRelationship(org.apache.cayenne.map.Entity)">getAnyRelationship</a>, <a href="Entity.html#getAttributeMap()">getAttributeMap</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#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="catalog"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>catalog</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> catalog</pre> |
| </li> |
| </ul> |
| <a id="schema"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>schema</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> schema</pre> |
| </li> |
| </ul> |
| <a id="primaryKey"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>primaryKey</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</a>> primaryKey</pre> |
| </li> |
| </ul> |
| <a id="generatedAttributes"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>generatedAttributes</h4> |
| <pre>protected <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="DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</a>> generatedAttributes</pre> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="primaryKeyGenerator"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>primaryKeyGenerator</h4> |
| <pre>protected <a href="DbKeyGenerator.html" title="class in org.apache.cayenne.map">DbKeyGenerator</a> primaryKeyGenerator</pre> |
| </li> |
| </ul> |
| <a id="qualifier"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>qualifier</h4> |
| <pre>protected <a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier</pre> |
| <div class="block">Qualifier, that will be applied to all select queries and joins with this |
| DbEntity</div> |
| </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>DbEntity</h4> |
| <pre>public DbEntity()</pre> |
| <div class="block">Creates an unnamed DbEntity.</div> |
| </li> |
| </ul> |
| <a id="<init>(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DbEntity</h4> |
| <pre>public DbEntity​(<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">Creates a named DbEntity.</div> |
| </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="getRelationship(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRelationship</h4> |
| <pre class="methodSignature">public <a href="DbRelationship.html" title="class in org.apache.cayenne.map">DbRelationship</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> relName)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="Entity.html#getRelationship(java.lang.String)">Entity</a></code></span></div> |
| <div class="block">Returns relationship with name <code>relName</code>. Will return null if no |
| relationship with this name exists in the entity.</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="getAttribute(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAttribute</h4> |
| <pre class="methodSignature">public <a href="DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</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> attributeName)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="Entity.html#getAttribute(java.lang.String)">Entity</a></code></span></div> |
| <div class="block">Returns attribute with name <code>attributeName</code> or null if no attribute |
| with this name exists.</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="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="getFullyQualifiedName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFullyQualifiedName</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> getFullyQualifiedName()</pre> |
| <div class="block">Returns table name including catalog and schema, if any of those are |
| present.</div> |
| </li> |
| </ul> |
| <a id="getSchema()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSchema</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> getSchema()</pre> |
| <div class="block">Returns database schema of this table.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>table's schema, null if not set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setSchema(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSchema</h4> |
| <pre class="methodSignature">public void setSchema​(<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> schema)</pre> |
| <div class="block">Sets the database schema name of the table described by this DbEntity.</div> |
| </li> |
| </ul> |
| <a id="getCatalog()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCatalog</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> getCatalog()</pre> |
| <div class="block">Returns the catalog name of the table described by this DbEntity.</div> |
| </li> |
| </ul> |
| <a id="setCatalog(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCatalog</h4> |
| <pre class="methodSignature">public void setCatalog​(<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> catalog)</pre> |
| <div class="block">Sets the catalog name of the table described by this DbEntity.</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/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</a>> getPrimaryKeys()</pre> |
| <div class="block">Returns an unmodifiable collection of DbAttributes representing the |
| primary key of the table described by this DbEntity.</div> |
| <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="DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</a>> getAttributes()</pre> |
| <div class="block">Returns a Collection of all attributes that either belong to this |
| DbEntity 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="getGeneratedAttributes()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getGeneratedAttributes</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="DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</a>> getGeneratedAttributes()</pre> |
| <div class="block">Returns an unmodifiable collection of DbAttributes that are generated by |
| the database.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addAttribute(org.apache.cayenne.map.DbAttribute)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addAttribute</h4> |
| <pre class="methodSignature">public void addAttribute​(<a href="DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</a> attr)</pre> |
| <div class="block">Adds a new attribute to this entity.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalArgumentException</a></code> - if Attribute has no name or there is an existing attribute |
| with the same name</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalArgumentException</a></code> - if a relationship has the same name as this attribute</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="removeAttribute(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeAttribute</h4> |
| <pre class="methodSignature">public void removeAttribute​(<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> attrName)</pre> |
| <div class="block">Removes attribute from the entity, removes any relationship joins |
| containing this attribute. Does nothing if the attribute name is not |
| found.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="Entity.html#removeAttribute(java.lang.String)">removeAttribute</a></code> in class <code><a href="Entity.html" title="class in org.apache.cayenne.map">Entity</a></code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="Entity.html#removeAttribute(java.lang.String)"><code>Entity.removeAttribute(String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="clearAttributes()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clearAttributes</h4> |
| <pre class="methodSignature">public void clearAttributes()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="Entity.html#clearAttributes()">clearAttributes</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="DbRelationship.html" title="class in org.apache.cayenne.map">DbRelationship</a>> getRelationships()</pre> |
| <div class="block">Returns a Collection of relationships from this entity or inherited.</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="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="DbRelationship.html" title="class in org.apache.cayenne.map">DbRelationship</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="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="DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</a>,​<a href="DbRelationship.html" title="class in org.apache.cayenne.map">DbRelationship</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="DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</a>,​<a href="DbRelationship.html" title="class in org.apache.cayenne.map">DbRelationship</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="setPrimaryKeyGenerator(org.apache.cayenne.map.DbKeyGenerator)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPrimaryKeyGenerator</h4> |
| <pre class="methodSignature">public void setPrimaryKeyGenerator​(<a href="DbKeyGenerator.html" title="class in org.apache.cayenne.map">DbKeyGenerator</a> primaryKeyGenerator)</pre> |
| <div class="block">Set the primary key generator for this entity. If null is passed, nothing |
| is changed.</div> |
| </li> |
| </ul> |
| <a id="getPrimaryKeyGenerator()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPrimaryKeyGenerator</h4> |
| <pre class="methodSignature">public <a href="DbKeyGenerator.html" title="class in org.apache.cayenne.map">DbKeyGenerator</a> getPrimaryKeyGenerator()</pre> |
| <div class="block">Return the primary key generator for this entity.</div> |
| </li> |
| </ul> |
| <a id="dbEntityChanged(org.apache.cayenne.map.event.EntityEvent)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dbEntityChanged</h4> |
| <pre class="methodSignature">public void dbEntityChanged​(<a href="event/EntityEvent.html" title="class in org.apache.cayenne.map.event">EntityEvent</a> e)</pre> |
| <div class="block">DbEntity property changed event. 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/DbEntityListener.html#dbEntityChanged(org.apache.cayenne.map.event.EntityEvent)">dbEntityChanged</a></code> in interface <code><a href="event/DbEntityListener.html" title="interface in org.apache.cayenne.map.event">DbEntityListener</a></code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="dbEntityAdded(org.apache.cayenne.map.event.EntityEvent)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dbEntityAdded</h4> |
| <pre class="methodSignature">public void dbEntityAdded​(<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/DbEntityListener.html#dbEntityAdded(org.apache.cayenne.map.event.EntityEvent)">dbEntityAdded</a></code> in interface <code><a href="event/DbEntityListener.html" title="interface in org.apache.cayenne.map.event">DbEntityListener</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="dbEntityRemoved(org.apache.cayenne.map.event.EntityEvent)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dbEntityRemoved</h4> |
| <pre class="methodSignature">public void dbEntityRemoved​(<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/DbEntityListener.html#dbEntityRemoved(org.apache.cayenne.map.event.EntityEvent)">dbEntityRemoved</a></code> in interface <code><a href="event/DbEntityListener.html" title="interface in org.apache.cayenne.map.event">DbEntityListener</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="dbAttributeAdded(org.apache.cayenne.map.event.AttributeEvent)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dbAttributeAdded</h4> |
| <pre class="methodSignature">public void dbAttributeAdded​(<a href="event/AttributeEvent.html" title="class in org.apache.cayenne.map.event">AttributeEvent</a> e)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="event/DbAttributeListener.html#dbAttributeAdded(org.apache.cayenne.map.event.AttributeEvent)">DbAttributeListener</a></code></span></div> |
| <div class="block">New attribute has been created/added.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="event/DbAttributeListener.html#dbAttributeAdded(org.apache.cayenne.map.event.AttributeEvent)">dbAttributeAdded</a></code> in interface <code><a href="event/DbAttributeListener.html" title="interface in org.apache.cayenne.map.event">DbAttributeListener</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="dbAttributeChanged(org.apache.cayenne.map.event.AttributeEvent)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dbAttributeChanged</h4> |
| <pre class="methodSignature">public void dbAttributeChanged​(<a href="event/AttributeEvent.html" title="class in org.apache.cayenne.map.event">AttributeEvent</a> e)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="event/DbAttributeListener.html#dbAttributeChanged(org.apache.cayenne.map.event.AttributeEvent)">DbAttributeListener</a></code></span></div> |
| <div class="block">Attribute property changed.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="event/DbAttributeListener.html#dbAttributeChanged(org.apache.cayenne.map.event.AttributeEvent)">dbAttributeChanged</a></code> in interface <code><a href="event/DbAttributeListener.html" title="interface in org.apache.cayenne.map.event">DbAttributeListener</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="dbAttributeRemoved(org.apache.cayenne.map.event.AttributeEvent)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dbAttributeRemoved</h4> |
| <pre class="methodSignature">public void dbAttributeRemoved​(<a href="event/AttributeEvent.html" title="class in org.apache.cayenne.map.event">AttributeEvent</a> e)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="event/DbAttributeListener.html#dbAttributeRemoved(org.apache.cayenne.map.event.AttributeEvent)">DbAttributeListener</a></code></span></div> |
| <div class="block">Attribute has been removed.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="event/DbAttributeListener.html#dbAttributeRemoved(org.apache.cayenne.map.event.AttributeEvent)">dbAttributeRemoved</a></code> in interface <code><a href="event/DbAttributeListener.html" title="interface in org.apache.cayenne.map.event">DbAttributeListener</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="dbRelationshipChanged(org.apache.cayenne.map.event.RelationshipEvent)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dbRelationshipChanged</h4> |
| <pre class="methodSignature">public void dbRelationshipChanged​(<a href="event/RelationshipEvent.html" title="class in org.apache.cayenne.map.event">RelationshipEvent</a> e)</pre> |
| <div class="block">Relationship property changed.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="event/DbRelationshipListener.html#dbRelationshipChanged(org.apache.cayenne.map.event.RelationshipEvent)">dbRelationshipChanged</a></code> in interface <code><a href="event/DbRelationshipListener.html" title="interface in org.apache.cayenne.map.event">DbRelationshipListener</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="dbRelationshipAdded(org.apache.cayenne.map.event.RelationshipEvent)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dbRelationshipAdded</h4> |
| <pre class="methodSignature">public void dbRelationshipAdded​(<a href="event/RelationshipEvent.html" title="class in org.apache.cayenne.map.event">RelationshipEvent</a> e)</pre> |
| <div class="block">Relationship has been created/added.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="event/DbRelationshipListener.html#dbRelationshipAdded(org.apache.cayenne.map.event.RelationshipEvent)">dbRelationshipAdded</a></code> in interface <code><a href="event/DbRelationshipListener.html" title="interface in org.apache.cayenne.map.event">DbRelationshipListener</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="dbRelationshipRemoved(org.apache.cayenne.map.event.RelationshipEvent)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dbRelationshipRemoved</h4> |
| <pre class="methodSignature">public void dbRelationshipRemoved​(<a href="event/RelationshipEvent.html" title="class in org.apache.cayenne.map.event">RelationshipEvent</a> e)</pre> |
| <div class="block">Relationship has been removed.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="event/DbRelationshipListener.html#dbRelationshipRemoved(org.apache.cayenne.map.event.RelationshipEvent)">dbRelationshipRemoved</a></code> in interface <code><a href="event/DbRelationshipListener.html" title="interface in org.apache.cayenne.map.event">DbRelationshipListener</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getQualifier()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQualifier</h4> |
| <pre class="methodSignature">public <a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> getQualifier()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>qualifier that will be ANDed to all select queries with this |
| entity</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setQualifier(org.apache.cayenne.exp.Expression)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setQualifier</h4> |
| <pre class="methodSignature">public void setQualifier​(<a href="../exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> qualifier)</pre> |
| <div class="block">Sets qualifier for this entity</div> |
| </li> |
| </ul> |
| <a id="isFullReplacementIdAttached(org.apache.cayenne.ObjectId)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isFullReplacementIdAttached</h4> |
| <pre class="methodSignature">public boolean isFullReplacementIdAttached​(<a href="../ObjectId.html" title="interface in org.apache.cayenne">ObjectId</a> id)</pre> |
| <div class="block">Returns true if there is full replacement id is attached to an ObjectId. |
| "Full" means that all PK columns are present and only PK columns are |
| present.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="mappedObjEntities()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>mappedObjEntities</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="ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</a>> mappedObjEntities()</pre> |
| </li> |
| </ul> |
| <a id="translateToRelatedEntity(org.apache.cayenne.exp.Expression,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <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 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> |
| </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/DbEntity.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> |