| <!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 (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 (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</h1> |
| </div> |
| <div class="contentContainer"> |
| <section role="region"><a id="package.description"> |
| <!-- --> |
| </a> |
| <div class="block"><p>Contains persistence APIs directly accessible by users.</p></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="DataChannel.html" title="interface in org.apache.cayenne">DataChannel</a></th> |
| <td class="colLast"> |
| <div class="block">DataChannel is an abstraction used by ObjectContexts to obtain mapping metadata and |
| access a persistent store.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="DataChannelFilter.html" title="interface in org.apache.cayenne">DataChannelFilter</a></th> |
| <td class="colLast">Deprecated. |
| <div class="deprecationComment">since 4.1 use <a href="DataChannelQueryFilter.html" title="interface in org.apache.cayenne"><code>DataChannelQueryFilter</code></a> and <a href="DataChannelSyncFilter.html" title="interface in org.apache.cayenne"><code>DataChannelSyncFilter</code></a></div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="DataChannelFilterChain.html" title="interface in org.apache.cayenne">DataChannelFilterChain</a></th> |
| <td class="colLast">Deprecated. |
| <div class="deprecationComment">since 4.1 in favor of <a href="DataChannelSyncFilterChain.html" title="interface in org.apache.cayenne"><code>DataChannelSyncFilterChain</code></a> and <a href="DataChannelQueryFilterChain.html" title="interface in org.apache.cayenne"><code>DataChannelQueryFilterChain</code></a></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="DataChannelListener.html" title="interface in org.apache.cayenne">DataChannelListener</a></th> |
| <td class="colLast"> |
| <div class="block">A listener of <a href="DataChannel.html" title="interface in org.apache.cayenne"><code>DataChannel</code></a> lifecycle events.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="DataChannelQueryFilter.html" title="interface in org.apache.cayenne">DataChannelQueryFilter</a></th> |
| <td class="colLast"> |
| <div class="block">An interface of a filter that allows to intercept DataChannel query operations.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="DataChannelQueryFilterChain.html" title="interface in org.apache.cayenne">DataChannelQueryFilterChain</a></th> |
| <td class="colLast"> |
| <div class="block">Interface for chain of query filters</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="DataChannelSyncFilter.html" title="interface in org.apache.cayenne">DataChannelSyncFilter</a></th> |
| <td class="colLast"> |
| <div class="block">An interface of a filter that allows to intercept DataChannel sync operations.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="DataChannelSyncFilterChain.html" title="interface in org.apache.cayenne">DataChannelSyncFilterChain</a></th> |
| <td class="colLast"> |
| <div class="block">Interface for chain of sync filters</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="DataObject.html" title="interface in org.apache.cayenne">DataObject</a></th> |
| <td class="colLast"> |
| <div class="block">Defines basic methods for a persistent object in Cayenne.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="EmbeddableObject.html" title="interface in org.apache.cayenne">EmbeddableObject</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="ExtendedEnumeration.html" title="interface in org.apache.cayenne">ExtendedEnumeration</a></th> |
| <td class="colLast"> |
| <div class="block">An interface that Enum classes may implement to map enum instances to arbitrary DB |
| values that do not match the enum names or positions.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="LifecycleListener.html" title="interface in org.apache.cayenne">LifecycleListener</a></th> |
| <td class="colLast"> |
| <div class="block">A callback interface to listen to persistent object lifecycle events.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a></th> |
| <td class="colLast"> |
| <div class="block">A Cayenne object facade to a persistent store.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="ObjectId.html" title="interface in org.apache.cayenne">ObjectId</a></th> |
| <td class="colLast"> |
| <div class="block"> |
| A portable global identifier for persistent objects.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="Persistent.html" title="interface in org.apache.cayenne">Persistent</a></th> |
| <td class="colLast"> |
| <div class="block">Defines minimal API of an object that can be persisted via Cayenne.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="QueryResponse.html" title="interface in org.apache.cayenne">QueryResponse</a></th> |
| <td class="colLast"> |
| <div class="block">Represents a result of query execution.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="QueryResult.html" title="interface in org.apache.cayenne">QueryResult</a><T></th> |
| <td class="colLast"> |
| <div class="block">Represents a collection of items which are results of a multipart query execution.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="QueryResultItem.html" title="interface in org.apache.cayenne">QueryResultItem</a><T></th> |
| <td class="colLast"> |
| <div class="block">Represents a single item in a multipart query execution.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="ResultIterator.html" title="interface in org.apache.cayenne">ResultIterator</a><T></th> |
| <td class="colLast"> |
| <div class="block">Defines API of an iterator over the records returned as a result of |
| Select queries execution.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="ResultIteratorCallback.html" title="interface in org.apache.cayenne">ResultIteratorCallback</a><T></th> |
| <td class="colLast"> |
| <div class="block">A callback interface invoked on each row when iterating over |
| <a href="ResultIterator.html" title="interface in org.apache.cayenne"><code>ResultIterator</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="Validating.html" title="interface in org.apache.cayenne">Validating</a></th> |
| <td class="colLast"> |
| <div class="block">Defines a number of callback methods that allow an object to be validated before safe.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="ValueHolder.html" title="interface in org.apache.cayenne">ValueHolder</a><E></th> |
| <td class="colLast"> |
| <div class="block">Provides a level of indirection for property value access, most often used for deferred |
| faulting of to-one relationships.</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="BaseContext.html" title="class in org.apache.cayenne">BaseContext</a></th> |
| <td class="colLast"> |
| <div class="block">A common base superclass for Cayenne ObjectContext implementors.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="BaseDataObject.html" title="class in org.apache.cayenne">BaseDataObject</a></th> |
| <td class="colLast"> |
| <div class="block">Base implementation of <a href="DataObject.html" title="interface in org.apache.cayenne"><code>DataObject</code></a>, |
| have no assumption about how data is actually stored.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="Cayenne.html" title="class in org.apache.cayenne">Cayenne</a></th> |
| <td class="colLast"> |
| <div class="block">Various utils for processing persistent objects and their properties</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="CayenneDataObject.html" title="class in org.apache.cayenne">CayenneDataObject</a></th> |
| <td class="colLast"> |
| <div class="block">Implementation of <a href="DataObject.html" title="interface in org.apache.cayenne"><code>DataObject</code></a> that uses <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"><code>Map</code></a> to store object fields.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="DataChannelSyncCallbackAction.html" title="class in org.apache.cayenne">DataChannelSyncCallbackAction</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="DataRow.html" title="class in org.apache.cayenne">DataRow</a></th> |
| <td class="colLast"> |
| <div class="block">DataRow a map that holds values retrieved from the database for a given query row.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="Fault.html" title="class in org.apache.cayenne">Fault</a></th> |
| <td class="colLast"> |
| <div class="block">Represents a placeholder for an unresolved relationship from a source object.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="HybridDataObject.html" title="class in org.apache.cayenne">HybridDataObject</a></th> |
| <td class="colLast"> |
| <div class="block">This data object like <a href="CayenneDataObject.html" title="class in org.apache.cayenne"><code>CayenneDataObject</code></a> uses <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"><code>Map</code></a> to store generic attributes, |
| only difference is that this Map will be created lazily at first write, thus reducing memory penalty if possible.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="PersistenceState.html" title="class in org.apache.cayenne">PersistenceState</a></th> |
| <td class="colLast"> |
| <div class="block">Defines a set of object states from the point of view of persistence.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="PersistentObject.html" title="class in org.apache.cayenne">PersistentObject</a></th> |
| <td class="colLast"> |
| <div class="block">A convenience base superclass for concrete Persistent objects.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="ProcedureResult.html" title="class in org.apache.cayenne">ProcedureResult</a><T></th> |
| <td class="colLast"> |
| <div class="block">Result of procedure call.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="ResultBatchIterator.html" title="class in org.apache.cayenne">ResultBatchIterator</a><T></th> |
| <td class="colLast"> |
| <div class="block">Defines API of a batch iterator over the ResultIterator returned as a result of |
| Select queries execution.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Exception Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Exception</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="CayenneException.html" title="class in org.apache.cayenne">CayenneException</a></th> |
| <td class="colLast">Deprecated. |
| <div class="deprecationComment">since 4.1 use <a href="CayenneRuntimeException.html" title="class in org.apache.cayenne"><code>CayenneRuntimeException</code></a> instead</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="CayenneRuntimeException.html" title="class in org.apache.cayenne">CayenneRuntimeException</a></th> |
| <td class="colLast"> |
| <div class="block">A generic unchecked exception that may be thrown by Cayenne framework.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="ConfigurationException.html" title="class in org.apache.cayenne">ConfigurationException</a></th> |
| <td class="colLast"> |
| <div class="block">A runtime exception thrown on failures in Cayenne configuration.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="DeleteDenyException.html" title="class in org.apache.cayenne">DeleteDenyException</a></th> |
| <td class="colLast"> |
| <div class="block">An exception thrown during an attempt to delete an object that has a relationship to a |
| non-null related object, that has a DENY delete rule.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="FaultFailureException.html" title="class in org.apache.cayenne">FaultFailureException</a></th> |
| <td class="colLast"> |
| <div class="block">A runtime exception thrown when during lazy object initialization Cayenne finds that no |
| matching row exists in the database for a given ObjectId.</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> |
