| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.10) on Mon Dec 05 10:27:04 MSK 2022 --> |
| <title>org.apache.cayenne.map (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="org.apache.cayenne.map (cayenne-doc: Cayenne Documentation 4.2.RC2 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| 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 class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.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> |
| <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> |
| <main role="main"> |
| <div class="header"> |
| <h1 title="Package" class="title">Package org.apache.cayenne.map</h1> |
| </div> |
| <div class="contentContainer"> |
| <section role="region"><a id="package.description"> |
| <!-- --> |
| </a> |
| <div class="block">Contains O/R mapping classes that store relational database |
| metadata information and map it to Java classes.</div> |
| </section> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="EntitySorter.html" title="interface in org.apache.cayenne.map">EntitySorter</a></th> |
| <td class="colLast"> |
| <div class="block">Defines API for sorting of Cayenne entities based on their mutual dependencies.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="MappingNamespace.html" title="interface in org.apache.cayenne.map">MappingNamespace</a></th> |
| <td class="colLast"> |
| <div class="block">Defines API of a container of DbEntities, ObjEntities, Procedures, Queries |
| and other mapping objects.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="PathComponent.html" title="interface in org.apache.cayenne.map">PathComponent</a><T extends <a href="Attribute.html" title="class in org.apache.cayenne.map">Attribute</a>,​U extends <a href="Relationship.html" title="class in org.apache.cayenne.map">Relationship</a>></th> |
| <td class="colLast"> |
| <div class="block">A component in a path chain.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="Attribute.html" title="class in org.apache.cayenne.map">Attribute</a></th> |
| <td class="colLast"> |
| <div class="block">Defines a property descriptor that is a part of an Entity.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="CallbackDescriptor.html" title="class in org.apache.cayenne.map">CallbackDescriptor</a></th> |
| <td class="colLast"> |
| <div class="block">A mapping descriptor of a single callback event.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="CallbackMap.html" title="class in org.apache.cayenne.map">CallbackMap</a></th> |
| <td class="colLast"> |
| <div class="block">A generic descriptor of a set of standard lifecycle callbacks.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="DataMap.html" title="class in org.apache.cayenne.map">DataMap</a></th> |
| <td class="colLast"> |
| <div class="block">Stores a collection of related mapping objects that describe database and |
| object layers of an application.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</a></th> |
| <td class="colLast"> |
| <div class="block">A DbAttribute defines a descriptor for a single database table column.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a></th> |
| <td class="colLast"> |
| <div class="block">A DbEntity is a mapping descriptor that defines a structure of a database |
| table.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="DbJoin.html" title="class in org.apache.cayenne.map">DbJoin</a></th> |
| <td class="colLast"> |
| <div class="block">Defines a join between two attributes of a given relationship.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="DbKeyGenerator.html" title="class in org.apache.cayenne.map">DbKeyGenerator</a></th> |
| <td class="colLast"> |
| <div class="block">DbKeyGenerator is an abstraction of a primary key generator It configures the primary |
| key generation per DbEntity in a RDBMS independent manner.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="DbRelationship.html" title="class in org.apache.cayenne.map">DbRelationship</a></th> |
| <td class="colLast"> |
| <div class="block">A DbRelationship is a descriptor of a database inter-table relationship based |
| on one or more primary key/foreign key pairs.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="DefaultEntityResultSegment.html" title="class in org.apache.cayenne.map">DefaultEntityResultSegment</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="DefaultScalarResultSegment.html" title="class in org.apache.cayenne.map">DefaultScalarResultSegment</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="DeleteRule.html" title="class in org.apache.cayenne.map">DeleteRule</a></th> |
| <td class="colLast"> |
| <div class="block">Defines constants for the possible values of ObjRelationship delete rules.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="EJBQLQueryDescriptor.html" title="class in org.apache.cayenne.map">EJBQLQueryDescriptor</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="Embeddable.html" title="class in org.apache.cayenne.map">Embeddable</a></th> |
| <td class="colLast"> |
| <div class="block">A mapping descriptor of an embeddable class.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="EmbeddableAttribute.html" title="class in org.apache.cayenne.map">EmbeddableAttribute</a></th> |
| <td class="colLast"> |
| <div class="block">A persistent attribute of an embeddable object.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="EmbeddedAttribute.html" title="class in org.apache.cayenne.map">EmbeddedAttribute</a></th> |
| <td class="colLast"> |
| <div class="block">An attribute of the ObjEntity that maps to an embeddable class.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="EmbeddedResult.html" title="class in org.apache.cayenne.map">EmbeddedResult</a></th> |
| <td class="colLast"> |
| <div class="block">A metadata object that provides mapping of a set of result columns to an Embeddable object.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="Entity.html" title="class in org.apache.cayenne.map">Entity</a></th> |
| <td class="colLast"> |
| <div class="block">An Entity is an abstract descriptor for an entity mapping concept.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="EntityInheritanceTree.html" title="class in org.apache.cayenne.map">EntityInheritanceTree</a></th> |
| <td class="colLast"> |
| <div class="block">A tree structure representing inheritance hierarchy of an ObjEntity and its |
| subentities.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</a></th> |
| <td class="colLast"> |
| <div class="block">Represents a virtual shared namespace for zero or more DataMaps.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="EntityResult.html" title="class in org.apache.cayenne.map">EntityResult</a></th> |
| <td class="colLast"> |
| <div class="block">A metadata object that provides mapping of a set of result columns to an |
| ObjEntity.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="ObjAttribute.html" title="class in org.apache.cayenne.map">ObjAttribute</a></th> |
| <td class="colLast"> |
| <div class="block">An ObjAttribute is a mapping descriptor of a Java class property.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</a></th> |
| <td class="colLast"> |
| <div class="block">ObjEntity is a mapping descriptor for a DataObject Java class.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="ObjRelationship.html" title="class in org.apache.cayenne.map">ObjRelationship</a></th> |
| <td class="colLast"> |
| <div class="block">Describes an association between two Java classes mapped as source and target |
| ObjEntity.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="Procedure.html" title="class in org.apache.cayenne.map">Procedure</a></th> |
| <td class="colLast"> |
| <div class="block">A mapping descriptor for a database stored procedure.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="ProcedureParameter.html" title="class in org.apache.cayenne.map">ProcedureParameter</a></th> |
| <td class="colLast"> |
| <div class="block">A descriptor for the Procedure parameter.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="ProcedureQueryDescriptor.html" title="class in org.apache.cayenne.map">ProcedureQueryDescriptor</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="QueryDescriptor.html" title="class in org.apache.cayenne.map">QueryDescriptor</a></th> |
| <td class="colLast"> |
| <div class="block">Generic descriptor of a Cayenne query.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="QueryDescriptorLoader.html" title="class in org.apache.cayenne.map">QueryDescriptorLoader</a></th> |
| <td class="colLast"> |
| <div class="block">A builder that constructs Cayenne queries from abstract configuration information |
| defined in cayenne-data-map*.dtd.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="Relationship.html" title="class in org.apache.cayenne.map">Relationship</a></th> |
| <td class="colLast"> |
| <div class="block">Defines a relationship between two entities.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SelectQueryDescriptor.html" title="class in org.apache.cayenne.map">SelectQueryDescriptor</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SQLResult.html" title="class in org.apache.cayenne.map">SQLResult</a></th> |
| <td class="colLast"> |
| <div class="block">A metadata object that defines how a row in a result set can be converted to |
| result objects.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SQLTemplateDescriptor.html" title="class in org.apache.cayenne.map">SQLTemplateDescriptor</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Enum</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="JoinType.html" title="enum in org.apache.cayenne.map">JoinType</a></th> |
| <td class="colLast"> |
| <div class="block">Enumerates supported JOIN types.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="LifecycleEvent.html" title="enum in org.apache.cayenne.map">LifecycleEvent</a></th> |
| <td class="colLast"> |
| <div class="block">Defines possible entity object lifecycle events.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| </div> |
| </main> |
| <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 class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.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> |
| <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> |