blob: bce3cd327d5c16e8d543349fe1c235033803e80e [file] [log] [blame]
<!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.access (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.access (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&nbsp;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">&nbsp;</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&nbsp;org.apache.cayenne.access</h1>
</div>
<div class="contentContainer">
<section role="region"><a id="package.description">
<!-- -->
</a>
<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>
</section>
<ul class="blockList">
<li class="blockList">
<table class="typeSummary">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</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="DataContextDelegate.html" title="interface in org.apache.cayenne.access">DataContextDelegate</a></th>
<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">
<th class="colFirst" scope="row"><a href="DataRowStoreFactory.html" title="interface in org.apache.cayenne.access">DataRowStoreFactory</a></th>
<td class="colLast">
<div class="block">A factory for creating <a href="DataRowStore.html" title="class in org.apache.cayenne.access"><code>DataRowStore</code></a></div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ObjectMapRetainStrategy.html" title="interface in org.apache.cayenne.access">ObjectMapRetainStrategy</a></th>
<td class="colLast">
<div class="block">A strategy for retaining objects in <a href="ObjectStore.html" title="class in org.apache.cayenne.access"><code>ObjectStore</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="OperationHints.html" title="interface in org.apache.cayenne.access">OperationHints</a></th>
<td class="colLast">
<div class="block">Defines API that allows QueryEngine to obtain information about query execution
strategy.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="OperationObserver.html" title="interface in org.apache.cayenne.access">OperationObserver</a></th>
<td class="colLast">
<div class="block">Defines a set of callback methods that allow <a href="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="rowColor">
<th class="colFirst" scope="row"><a href="QueryEngine.html" title="interface in org.apache.cayenne.access">QueryEngine</a></th>
<td class="colLast">
<div class="block">Defines methods used to run Cayenne queries.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</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="AttributeFault.html" title="class in org.apache.cayenne.access">AttributeFault</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ClientServerChannel.html" title="class in org.apache.cayenne.access">ClientServerChannel</a></th>
<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="altColor">
<th class="colFirst" scope="row"><a href="DataContext.html" title="class in org.apache.cayenne.access">DataContext</a></th>
<td class="colLast">
<div class="block">The most common implementation of <a href="../ObjectContext.html" title="interface in org.apache.cayenne"><code>ObjectContext</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="DataDomain.html" title="class in org.apache.cayenne.access">DataDomain</a></th>
<td class="colLast">
<div class="block">DataDomain performs query routing functions in Cayenne.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="DataNode.html" title="class in org.apache.cayenne.access">DataNode</a></th>
<td class="colLast">
<div class="block">An abstraction of a single physical data storage.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="DataRowStore.html" title="class in org.apache.cayenne.access">DataRowStore</a></th>
<td class="colLast">
<div class="block">A fixed size cache of DataRows keyed by ObjectId.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="DbGenerator.html" title="class in org.apache.cayenne.access">DbGenerator</a></th>
<td class="colLast">
<div class="block">Utility class that generates database schema based on Cayenne mapping.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="DefaultDataRowStoreFactory.html" title="class in org.apache.cayenne.access">DefaultDataRowStoreFactory</a></th>
<td class="colLast">
<div class="block">A default implementation of <a href="DataRowStoreFactory.html" title="interface in org.apache.cayenne.access"><code>DataRowStoreFactory</code></a></div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="DefaultObjectMapRetainStrategy.html" title="class in org.apache.cayenne.access">DefaultObjectMapRetainStrategy</a></th>
<td class="colLast">
<div class="block">Default implementation of <a href="ObjectMapRetainStrategy.html" title="interface in org.apache.cayenne.access"><code>ObjectMapRetainStrategy</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="IncrementalFaultList.html" title="class in org.apache.cayenne.access">IncrementalFaultList</a>&lt;E&gt;</th>
<td class="colLast">
<div class="block">A synchronized list that serves as a container of DataObjects.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="LegacyDataDomainFlushAction.html" title="class in org.apache.cayenne.access">LegacyDataDomainFlushAction</a></th>
<td class="colLast">Deprecated.
<div class="deprecationComment">this implementation is deprecated since 4.2, <a href="flush/DefaultDataDomainFlushAction.html" title="class in org.apache.cayenne.access.flush"><code>DefaultDataDomainFlushAction</code></a> is used</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="LegacyDataDomainFlushActionFactory.html" title="class in org.apache.cayenne.access">LegacyDataDomainFlushActionFactory</a></th>
<td class="colLast">Deprecated.</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="NoSyncObjectStore.html" title="class in org.apache.cayenne.access">NoSyncObjectStore</a></th>
<td class="colLast">
<div class="block">An <a href="ObjectStore.html" title="class in org.apache.cayenne.access"><code>ObjectStore</code></a> which doesn't receive notifications
on parent's <a href="DataRowStore.html" title="class in org.apache.cayenne.access"><code>DataRowStore</code></a> events.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ObjectDiff.html" title="class in org.apache.cayenne.access">ObjectDiff</a></th>
<td class="colLast">
<div class="block">A dynamic GraphDiff that represents a delta between object simple properties
at diff creation time and its current state.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ObjectStore.html" title="class in org.apache.cayenne.access">ObjectStore</a></th>
<td class="colLast">
<div class="block">ObjectStore stores objects using their ObjectId as a key.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ObjectStoreGraphDiff.html" title="class in org.apache.cayenne.access">ObjectStoreGraphDiff</a></th>
<td class="colLast">
<div class="block">A GraphDiff facade for the ObjectStore changes.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ToManyList.html" title="class in org.apache.cayenne.access">ToManyList</a>&lt;E&gt;</th>
<td class="colLast">
<div class="block">A list that holds objects for to-many relationships.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ToManyListFault.html" title="class in org.apache.cayenne.access">ToManyListFault</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ToManyMapFault.html" title="class in org.apache.cayenne.access">ToManyMapFault</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ToManySet.html" title="class in org.apache.cayenne.access">ToManySet</a>&lt;E&gt;</th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ToManySetFault.html" title="class in org.apache.cayenne.access">ToManySetFault</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ToOneFault.html" title="class in org.apache.cayenne.access">ToOneFault</a></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary">
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</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="DomainStoppedException.html" title="class in org.apache.cayenne.access">DomainStoppedException</a></th>
<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">
<th class="colFirst" scope="row"><a href="OptimisticLockException.html" title="class in org.apache.cayenne.access">OptimisticLockException</a></th>
<td class="colLast">
<div class="block">An exception thrown on optimistic lock failure.</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&nbsp;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 &#169; 2001&#x2013;2022 <a href="https://cayenne.apache.org/">Apache Cayenne</a>. All rights reserved.</small></p>
</footer>
</body>
</html>