| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_112) on Mon Oct 14 11:36:19 MSK 2019 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>org.apache.cayenne (cayenne-doc: Cayenne Documentation 4.0.2 API)</title> |
| <meta name="date" content="2019-10-14"> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../script.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.0.2 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../overview-summary.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> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Package</li> |
| <li><a href="../../../org/apache/cayenne/access/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/apache/cayenne/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../allclasses-noframe.html">All Classes</a></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> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="header"> |
| <h1 title="Package" class="title">Package org.apache.cayenne</h1> |
| <div class="docSummary"> |
| <div class="block">Contains persistence APIs directly accessible by users.</div> |
| </div> |
| <p>See: <a href="#package.description">Description</a></p> |
| </div> |
| <div class="contentContainer"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> |
| <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"> |
| <td class="colFirst"><a href="../../../org/apache/cayenne/DataChannel.html" title="interface in org.apache.cayenne">DataChannel</a></td> |
| <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"> |
| <td class="colFirst"><a href="../../../org/apache/cayenne/DataChannelFilter.html" title="interface in org.apache.cayenne">DataChannelFilter</a></td> |
| <td class="colLast"> |
| <div class="block">An interface of a filter that allows to intercept DataChannel operations.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../org/apache/cayenne/DataChannelFilterChain.html" title="interface in org.apache.cayenne">DataChannelFilterChain</a></td> |
| <td class="colLast"> |
| <div class="block">Provides DataChannelFilters with API to pass control to the next filter in the chain or |
| the underlying DataChannel for the last chain filter.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../org/apache/cayenne/DataChannelListener.html" title="interface in org.apache.cayenne">DataChannelListener</a></td> |
| <td class="colLast"> |
| <div class="block">A listener of <a href="../../../org/apache/cayenne/DataChannel.html" title="interface in org.apache.cayenne"><code>DataChannel</code></a> lifecycle events.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../org/apache/cayenne/DataChannelSyncFilterChain.html" title="interface in org.apache.cayenne">DataChannelSyncFilterChain</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../org/apache/cayenne/DataObject.html" title="interface in org.apache.cayenne">DataObject</a></td> |
| <td class="colLast"> |
| <div class="block">Defines basic methods for a persistent object in Cayenne.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../org/apache/cayenne/ExtendedEnumeration.html" title="interface in org.apache.cayenne">ExtendedEnumeration</a></td> |
| <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"> |
| <td class="colFirst"><a href="../../../org/apache/cayenne/LifecycleListener.html" title="interface in org.apache.cayenne">LifecycleListener</a></td> |
| <td class="colLast"> |
| <div class="block">A callback interface to listen to persistent object lifecycle events.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../org/apache/cayenne/ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a></td> |
| <td class="colLast"> |
| <div class="block">A Cayenne object facade to a persistent store.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../org/apache/cayenne/Persistent.html" title="interface in org.apache.cayenne">Persistent</a></td> |
| <td class="colLast"> |
| <div class="block">Defines minimal API of an object that can be persisted via Cayenne.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../org/apache/cayenne/QueryResponse.html" title="interface in org.apache.cayenne">QueryResponse</a></td> |
| <td class="colLast"> |
| <div class="block">Represents a result of query execution.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../org/apache/cayenne/QueryResult.html" title="interface in org.apache.cayenne">QueryResult</a><T></td> |
| <td class="colLast"> |
| <div class="block">Represents a collection of items which are results of a multipart query execution.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../org/apache/cayenne/QueryResultItem.html" title="interface in org.apache.cayenne">QueryResultItem</a><T></td> |
| <td class="colLast"> |
| <div class="block">Represents a single item in a multipart query execution.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../org/apache/cayenne/ResultIterator.html" title="interface in org.apache.cayenne">ResultIterator</a><T></td> |
| <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="altColor"> |
| <td class="colFirst"><a href="../../../org/apache/cayenne/ResultIteratorCallback.html" title="interface in org.apache.cayenne">ResultIteratorCallback</a><T></td> |
| <td class="colLast"> |
| <div class="block">A callback interface invoked on each row when iterating over |
| <a href="../../../org/apache/cayenne/ResultIterator.html" title="interface in org.apache.cayenne"><code>ResultIterator</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../org/apache/cayenne/Validating.html" title="interface in org.apache.cayenne">Validating</a></td> |
| <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="altColor"> |
| <td class="colFirst"><a href="../../../org/apache/cayenne/ValueHolder.html" title="interface in org.apache.cayenne">ValueHolder</a></td> |
| <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" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> |
| <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"> |
| <td class="colFirst"><a href="../../../org/apache/cayenne/BaseContext.html" title="class in org.apache.cayenne">BaseContext</a></td> |
| <td class="colLast"> |
| <div class="block">A common base superclass for Cayenne ObjectContext implementors.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../org/apache/cayenne/Cayenne.html" title="class in org.apache.cayenne">Cayenne</a></td> |
| <td class="colLast"> |
| <div class="block">Various utils for processing persistent objects and their properties</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../org/apache/cayenne/CayenneContext.html" title="class in org.apache.cayenne">CayenneContext</a></td> |
| <td class="colLast"> |
| <div class="block">A default generic implementation of ObjectContext suitable for accessing |
| Cayenne from either an ORM or a client tiers.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../org/apache/cayenne/CayenneDataObject.html" title="class in org.apache.cayenne">CayenneDataObject</a></td> |
| <td class="colLast"> |
| <div class="block">A default implementation of DataObject interface.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../org/apache/cayenne/DataChannelSyncCallbackAction.html" title="class in org.apache.cayenne">DataChannelSyncCallbackAction</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../org/apache/cayenne/DataRow.html" title="class in org.apache.cayenne">DataRow</a></td> |
| <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"> |
| <td class="colFirst"><a href="../../../org/apache/cayenne/Fault.html" title="class in org.apache.cayenne">Fault</a></td> |
| <td class="colLast"> |
| <div class="block">Represents a placeholder for an unresolved relationship from a source object.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../org/apache/cayenne/ObjectId.html" title="class in org.apache.cayenne">ObjectId</a></td> |
| <td class="colLast"> |
| <div class="block">A portable global identifier for persistent objects.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../org/apache/cayenne/PersistenceState.html" title="class in org.apache.cayenne">PersistenceState</a></td> |
| <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"> |
| <td class="colFirst"><a href="../../../org/apache/cayenne/PersistentObject.html" title="class in org.apache.cayenne">PersistentObject</a></td> |
| <td class="colLast"> |
| <div class="block">A convenience base superclass for concrete Persistent objects.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../org/apache/cayenne/ProcedureResult.html" title="class in org.apache.cayenne">ProcedureResult</a><T></td> |
| <td class="colLast"> |
| <div class="block">Result of procedure call.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../org/apache/cayenne/ResultBatchIterator.html" title="class in org.apache.cayenne">ResultBatchIterator</a><T></td> |
| <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" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation"> |
| <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"> |
| <td class="colFirst"><a href="../../../org/apache/cayenne/CayenneException.html" title="class in org.apache.cayenne">CayenneException</a></td> |
| <td class="colLast"> |
| <div class="block">A generic checked exception that may be thrown by Cayenne framework.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../org/apache/cayenne/CayenneRuntimeException.html" title="class in org.apache.cayenne">CayenneRuntimeException</a></td> |
| <td class="colLast"> |
| <div class="block">A generic unchecked exception that may be thrown by Cayenne framework.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../org/apache/cayenne/ConfigurationException.html" title="class in org.apache.cayenne">ConfigurationException</a></td> |
| <td class="colLast"> |
| <div class="block">A runtime exception thrown on failures in Cayenne configuration.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../org/apache/cayenne/DeleteDenyException.html" title="class in org.apache.cayenne">DeleteDenyException</a></td> |
| <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"> |
| <td class="colFirst"><a href="../../../org/apache/cayenne/FaultFailureException.html" title="class in org.apache.cayenne">FaultFailureException</a></td> |
| <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> |
| <a name="package.description"> |
| <!-- --> |
| </a> |
| <h2 title="Package org.apache.cayenne Description">Package org.apache.cayenne Description</h2> |
| <div class="block"><p>Contains persistence APIs directly accessible by users.</p></div> |
| </div> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../overview-summary.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> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Package</li> |
| <li><a href="../../../org/apache/cayenne/access/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/apache/cayenne/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../allclasses-noframe.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> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2001–2019 <a href="http://cayenne.apache.org/">Apache Cayenne</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
