| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (21) on Fri Jun 14 12:28:32 GET 2024 --> |
| <title>org.apache.cayenne (cayenne-doc: Cayenne Documentation 4.2.1 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2024-06-14"> |
| <meta name="description" content="declaration: package: org.apache.cayenne"> |
| <meta name="generator" content="javadoc/PackageWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../script-dir/jquery-ui.min.css" title="Style"> |
| <script type="text/javascript" src="../../../script.js"></script> |
| <script type="text/javascript" src="../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="package-declaration-page"> |
| <script type="text/javascript">var pathtoroot = "../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span></button> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <div class="about-language"><a href="https://cayenne.apache.org" target="top">Apache Cayenne</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../index.html">Overview</a></li> |
| <li class="nav-bar-cell1-rev">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#package">Help</a></li> |
| </ul> |
| <ul class="sub-nav-list-small"> |
| <li> |
| <p>Package:</p> |
| <ul> |
| <li><a href="#package-description">Description</a></li> |
| <li>Related Packages</li> |
| <li><a href="#class-summary">Classes and Interfaces</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div id="navbar-sub-list"> |
| <ul class="sub-nav-list"> |
| <li>Package: </li> |
| <li><a href="#package-description">Description</a> | </li> |
| <li>Related Packages | </li> |
| <li><a href="#class-summary">Classes and Interfaces</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><a href="../../../search.html">SEARCH</a> |
| <input type="text" id="search-input" disabled placeholder="Search"> |
| <input type="reset" id="reset-button" disabled value="reset"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <div class="header"> |
| <h1 title="Package org.apache.cayenne" class="title">Package org.apache.cayenne</h1> |
| </div> |
| <hr> |
| <div class="package-signature">package <span class="element-name">org.apache.cayenne</span></div> |
| <section class="package-description" id="package-description"> |
| <div class="block"><p>Contains persistence APIs directly accessible by users.</p></div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <li> |
| <div id="class-summary"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab1" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab1', 2)" class="table-tab">Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button><button id="class-summary-tab5" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab5', 2)" class="table-tab">Exception Classes</button></div> |
| <div id="class-summary.tabpanel" role="tabpanel"> |
| <div class="summary-table two-column-summary" aria-labelledby="class-summary-tab0"> |
| <div class="table-header col-first">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="BaseContext.html" title="class in org.apache.cayenne">BaseContext</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">A common base superclass for Cayenne ObjectContext implementors.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="BaseDataObject.html" title="class in org.apache.cayenne">BaseDataObject</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <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> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="Cayenne.html" title="class in org.apache.cayenne">Cayenne</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Various utils for processing persistent objects and their properties</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="CayenneDataObject.html" title="class in org.apache.cayenne">CayenneDataObject</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <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" title="class or interface in java.util" class="external-link"><code>Map</code></a> to store object fields.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab5"><a href="CayenneException.html" title="class in org.apache.cayenne">CayenneException</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab5">Deprecated. |
| <div class="deprecation-comment">since 4.1 use <a href="CayenneRuntimeException.html" title="class in org.apache.cayenne"><code>CayenneRuntimeException</code></a> instead</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab5"><a href="CayenneRuntimeException.html" title="class in org.apache.cayenne">CayenneRuntimeException</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab5"> |
| <div class="block">A generic unchecked exception that may be thrown by Cayenne framework.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab5"><a href="ConfigurationException.html" title="class in org.apache.cayenne">ConfigurationException</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab5"> |
| <div class="block">A runtime exception thrown on failures in Cayenne configuration.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="DataChannel.html" title="interface in org.apache.cayenne">DataChannel</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">DataChannel is an abstraction used by ObjectContexts to obtain mapping metadata and |
| access a persistent store.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="DataChannelFilter.html" title="interface in org.apache.cayenne">DataChannelFilter</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1">Deprecated. |
| <div class="deprecation-comment">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> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="DataChannelFilterChain.html" title="interface in org.apache.cayenne">DataChannelFilterChain</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1">Deprecated. |
| <div class="deprecation-comment">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> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="DataChannelListener.html" title="interface in org.apache.cayenne">DataChannelListener</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">A listener of <a href="DataChannel.html" title="interface in org.apache.cayenne"><code>DataChannel</code></a> lifecycle events.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="DataChannelQueryFilter.html" title="interface in org.apache.cayenne">DataChannelQueryFilter</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">An interface of a filter that allows to intercept DataChannel query operations.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="DataChannelQueryFilterChain.html" title="interface in org.apache.cayenne">DataChannelQueryFilterChain</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Interface for chain of query filters</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DataChannelSyncCallbackAction.html" title="class in org.apache.cayenne">DataChannelSyncCallbackAction</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="DataChannelSyncFilter.html" title="interface in org.apache.cayenne">DataChannelSyncFilter</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">An interface of a filter that allows to intercept DataChannel sync operations.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="DataChannelSyncFilterChain.html" title="interface in org.apache.cayenne">DataChannelSyncFilterChain</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Interface for chain of sync filters</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="DataObject.html" title="interface in org.apache.cayenne">DataObject</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Defines basic methods for a persistent object in Cayenne.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DataRow.html" title="class in org.apache.cayenne">DataRow</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">DataRow a map that holds values retrieved from the database for a given query row.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab5"><a href="DeleteDenyException.html" title="class in org.apache.cayenne">DeleteDenyException</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab5"> |
| <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> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="EmbeddableObject.html" title="interface in org.apache.cayenne">EmbeddableObject</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="ExtendedEnumeration.html" title="interface in org.apache.cayenne">ExtendedEnumeration</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <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> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Fault.html" title="class in org.apache.cayenne">Fault</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Represents a placeholder for an unresolved relationship from a source object.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab5"><a href="FaultFailureException.html" title="class in org.apache.cayenne">FaultFailureException</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab5"> |
| <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> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="HybridDataObject.html" title="class in org.apache.cayenne">HybridDataObject</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <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" title="class or interface in java.util" class="external-link"><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> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="LifecycleListener.html" title="interface in org.apache.cayenne">LifecycleListener</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">A callback interface to listen to persistent object lifecycle events.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">A Cayenne object facade to a persistent store.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="ObjectId.html" title="interface in org.apache.cayenne">ObjectId</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block"> |
| A portable global identifier for persistent objects.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="PersistenceState.html" title="class in org.apache.cayenne">PersistenceState</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Defines a set of object states from the point of view of persistence.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="Persistent.html" title="interface in org.apache.cayenne">Persistent</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Defines minimal API of an object that can be persisted via Cayenne.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="PersistentObject.html" title="class in org.apache.cayenne">PersistentObject</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">A convenience base superclass for concrete Persistent objects.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="ProcedureResult.html" title="class in org.apache.cayenne">ProcedureResult</a><T></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Result of procedure call.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="QueryResponse.html" title="interface in org.apache.cayenne">QueryResponse</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Represents a result of query execution.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="QueryResult.html" title="interface in org.apache.cayenne">QueryResult</a><T></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Represents a collection of items which are results of a multipart query execution.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="QueryResultItem.html" title="interface in org.apache.cayenne">QueryResultItem</a><T></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Represents a single item in a multipart query execution.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="ResultBatchIterator.html" title="class in org.apache.cayenne">ResultBatchIterator</a><T></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Defines API of a batch iterator over the ResultIterator returned as a result of |
| Select queries execution.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="ResultIterator.html" title="interface in org.apache.cayenne">ResultIterator</a><T></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Defines API of an iterator over the records returned as a result of |
| Select queries execution.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="ResultIteratorCallback.html" title="interface in org.apache.cayenne">ResultIteratorCallback</a><T></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <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> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="Validating.html" title="interface in org.apache.cayenne">Validating</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Defines a number of callback methods that allow an object to be validated before safe.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="ValueHolder.html" title="interface in org.apache.cayenne">ValueHolder</a><E></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Provides a level of indirection for property value access, most often used for deferred |
| faulting of to-one relationships.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </section> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2001–2024 <a href="https://cayenne.apache.org/">Apache Cayenne</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
