| <!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 (version 1.7.0_67) on Sat Sep 20 17:22:59 FET 2014 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>org.apache.cayenne.access (Cayenne Documentation 3.1 API)</title> |
| <meta name="date" content="2014-09-20"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="org.apache.cayenne.access (Cayenne Documentation 3.1 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><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><a href="../../../../org/apache/cayenne/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../org/apache/cayenne/access/dbsync/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/cayenne/access/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.access</h1> |
| <div class="docSummary"> |
| <div class="block">Contains classes that make up Cayenne ORM stack.</div> |
| </div> |
| <p>See: <a href="#package_description">Description</a></p> |
| </div> |
| <div class="contentContainer"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="packageSummary" 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/access/DataContextDelegate.html" title="interface in org.apache.cayenne.access">DataContextDelegate</a></td> |
| <td class="colLast"> |
| <div class="block">Defines API for a DataContext "delegate" - an object that is temporarily passed control |
| by DataContext at some critical points in the normal flow of execution.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/cayenne/access/DataPortDelegate.html" title="interface in org.apache.cayenne.access">DataPortDelegate</a></td> |
| <td class="colLast"> |
| <div class="block">Interface for callback and delegate methods allowing implementing classes to control |
| various aspects of data porting via DataPort.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/cayenne/access/DbLoaderDelegate.html" title="interface in org.apache.cayenne.access">DbLoaderDelegate</a></td> |
| <td class="colLast"> |
| <div class="block">DbLoaderDelegate defines API that allows to control the behavior of DbLoader during the |
| database reverse-engineering.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/cayenne/access/ObjectMapRetainStrategy.html" title="interface in org.apache.cayenne.access">ObjectMapRetainStrategy</a></td> |
| <td class="colLast"> |
| <div class="block">A strategy for retaining objects in <a href="../../../../org/apache/cayenne/access/ObjectStore.html" title="class in org.apache.cayenne.access"><code>ObjectStore</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/cayenne/access/OperationHints.html" title="interface in org.apache.cayenne.access">OperationHints</a></td> |
| <td class="colLast"> |
| <div class="block">Defines API that allows QueryEngine to obtain information about query execution |
| strategy.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/cayenne/access/OperationObserver.html" title="interface in org.apache.cayenne.access">OperationObserver</a></td> |
| <td class="colLast"> |
| <div class="block">Defines a set of callback methods that allow <a href="../../../../org/apache/cayenne/access/QueryEngine.html" title="interface in org.apache.cayenne.access"><code>QueryEngine</code></a> to pass back query |
| results and notify caller about exceptions.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/cayenne/access/QueryEngine.html" title="interface in org.apache.cayenne.access">QueryEngine</a></td> |
| <td class="colLast"> |
| <div class="block">Defines methods used to run Cayenne queries.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/cayenne/access/ResultIterator.html" title="interface in org.apache.cayenne.access">ResultIterator</a></td> |
| <td class="colLast"> |
| <div class="block">Defines API of an iterator over the records returned as a result of SelectQuery |
| execution.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/cayenne/access/TransactionDelegate.html" title="interface in org.apache.cayenne.access">TransactionDelegate</a></td> |
| <td class="colLast"> |
| <div class="block">Defines callback methods for tracking and customizing Transactions execution.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="packageSummary" 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/access/ClientServerChannel.html" title="class in org.apache.cayenne.access">ClientServerChannel</a></td> |
| <td class="colLast"> |
| <div class="block">A DataChannel that provides a server-side end of the bridge between client and server |
| objects in a Remote Object Persistence stack.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/cayenne/access/DataContext.html" title="class in org.apache.cayenne.access">DataContext</a></td> |
| <td class="colLast"> |
| <div class="block">The most common implementation of <a href="../../../../org/apache/cayenne/ObjectContext.html" title="interface in org.apache.cayenne"><code>ObjectContext</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/cayenne/access/DataDomain.html" title="class in org.apache.cayenne.access">DataDomain</a></td> |
| <td class="colLast"> |
| <div class="block">DataDomain performs query routing functions in Cayenne.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/cayenne/access/DataNode.html" title="class in org.apache.cayenne.access">DataNode</a></td> |
| <td class="colLast"> |
| <div class="block">An abstraction of a single physical data storage.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/cayenne/access/DataPort.html" title="class in org.apache.cayenne.access">DataPort</a></td> |
| <td class="colLast"> |
| <div class="block">An engine to port data between two DataNodes.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/cayenne/access/DataRowStore.html" title="class in org.apache.cayenne.access">DataRowStore</a></td> |
| <td class="colLast"> |
| <div class="block">A fixed size cache of DataRows keyed by ObjectId.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/cayenne/access/DbGenerator.html" title="class in org.apache.cayenne.access">DbGenerator</a></td> |
| <td class="colLast"> |
| <div class="block">Utility class that generates database schema based on Cayenne mapping.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/cayenne/access/DbLoader.html" title="class in org.apache.cayenne.access">DbLoader</a></td> |
| <td class="colLast"> |
| <div class="block">Utility class that does reverse engineering of the database.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/cayenne/access/DefaultObjectMapRetainStrategy.html" title="class in org.apache.cayenne.access">DefaultObjectMapRetainStrategy</a></td> |
| <td class="colLast"> |
| <div class="block">Default implementation of <a href="../../../../org/apache/cayenne/access/ObjectMapRetainStrategy.html" title="interface in org.apache.cayenne.access"><code>ObjectMapRetainStrategy</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/cayenne/access/IncrementalFaultList.html" title="class in org.apache.cayenne.access">IncrementalFaultList</a><E></td> |
| <td class="colLast"> |
| <div class="block">A synchronized list that serves as a container of DataObjects.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/cayenne/access/NoSyncObjectStore.html" title="class in org.apache.cayenne.access">NoSyncObjectStore</a></td> |
| <td class="colLast"> |
| <div class="block">An <a href="../../../../org/apache/cayenne/access/ObjectStore.html" title="class in org.apache.cayenne.access"><code>ObjectStore</code></a> which doesn't receive notifications |
| on parent's <a href="../../../../org/apache/cayenne/access/DataRowStore.html" title="class in org.apache.cayenne.access"><code>DataRowStore</code></a> events.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/cayenne/access/ObjectStore.html" title="class in org.apache.cayenne.access">ObjectStore</a></td> |
| <td class="colLast"> |
| <div class="block">ObjectStore stores objects using their ObjectId as a key.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/cayenne/access/QueryLogger.html" title="class in org.apache.cayenne.access">QueryLogger</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><i>since 3.1 replaced by injectable <a href="../../../../org/apache/cayenne/log/JdbcEventLogger.html" title="interface in org.apache.cayenne.log"><code>JdbcEventLogger</code></a>.</i></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/cayenne/access/QueryResult.html" title="class in org.apache.cayenne.access">QueryResult</a></td> |
| <td class="colLast"> |
| <div class="block">QueryResult encapsulates a result of execution of zero or more queries using |
| QueryEngine.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/cayenne/access/ToManyList.html" title="class in org.apache.cayenne.access">ToManyList</a></td> |
| <td class="colLast"> |
| <div class="block">A list that holds objects for to-many relationships.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/cayenne/access/ToManyListFault.html" title="class in org.apache.cayenne.access">ToManyListFault</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/cayenne/access/ToManyMapFault.html" title="class in org.apache.cayenne.access">ToManyMapFault</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/cayenne/access/ToManySetFault.html" title="class in org.apache.cayenne.access">ToManySetFault</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/cayenne/access/ToOneFault.html" title="class in org.apache.cayenne.access">ToOneFault</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/cayenne/access/Transaction.html" title="class in org.apache.cayenne.access">Transaction</a></td> |
| <td class="colLast"> |
| <div class="block">A Cayenne transaction.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="packageSummary" 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/access/DomainStoppedException.html" title="class in org.apache.cayenne.access">DomainStoppedException</a></td> |
| <td class="colLast"> |
| <div class="block">An exception thrown on attempts to access a DataDomain after it was explicitly shut |
| down by the user.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/cayenne/access/OptimisticLockException.html" title="class in org.apache.cayenne.access">OptimisticLockException</a></td> |
| <td class="colLast"> |
| <div class="block">An exception thrown on optimistic lock failure.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| <a name="package_description"> |
| <!-- --> |
| </a> |
| <h2 title="Package org.apache.cayenne.access Description">Package org.apache.cayenne.access Description</h2> |
| <div class="block"><p>Contains classes that make up Cayenne ORM stack. Three main classes from top to bottom |
| are DataContext, DataDomain and DataNode.</p></div> |
| </div> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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><a href="../../../../org/apache/cayenne/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../org/apache/cayenne/access/dbsync/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/cayenne/access/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–2014 <a href="http://cayenne.apache.org/">Apache Cayenne</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
