| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.10) on Mon Dec 05 10:27:04 MSK 2022 --> |
| <title>BaseContext (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="BaseContext (cayenne-doc: Cayenne Documentation 4.2.RC2 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":9,"i5":6,"i6":6,"i7":6,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":6,"i18":10,"i19":9,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":6,"i28":10,"i29":6,"i30":6,"i31":6,"i32":6,"i33":10,"i34":6,"i35":6,"i36":10,"i37":10,"i38":6,"i39":6,"i40":6,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10,"i47":10,"i48":10,"i49":6}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| 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><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/BaseContext.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> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </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> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.cayenne</a></div> |
| <h2 title="Class BaseContext" class="title">Class BaseContext</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.cayenne.BaseContext</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a></code>, <code><a href="DataChannel.html" title="interface in org.apache.cayenne">DataChannel</a></code>, <code><a href="ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a></code></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="access/DataContext.html" title="class in org.apache.cayenne.access">DataContext</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public abstract class <span class="typeNameLabel">BaseContext</span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> |
| implements <a href="ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a></pre> |
| <div class="block">A common base superclass for Cayenne ObjectContext implementors.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../serialized-form.html#org.apache.cayenne.BaseContext">Serialized Form</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="DataChannel.html" title="interface in org.apache.cayenne">DataChannel</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#channel">channel</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#entityResolver">entityResolver</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="util/ObjectContextGraphAction.html" title="class in org.apache.cayenne.util">ObjectContextGraphAction</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#graphAction">graphAction</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Graph action that handles property changes</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="cache/QueryCache.html" title="interface in org.apache.cayenne.cache">QueryCache</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#queryCache">queryCache</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ThreadLocal.html?is-external=true" title="class or interface in java.lang" class="externalLink">ThreadLocal</a><<a href="ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#threadObjectContext">threadObjectContext</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">A holder of a ObjectContext bound to the current thread.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <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">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#userProperties">userProperties</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Stores user defined properties associated with this DataContext.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#validatingObjectsOnCommit">validatingObjectsOnCommit</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.org.apache.cayenne.DataChannel"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.cayenne.<a href="DataChannel.html" title="interface in org.apache.cayenne">DataChannel</a></h3> |
| <code><a href="DataChannel.html#FLUSH_CASCADE_SYNC">FLUSH_CASCADE_SYNC</a>, <a href="DataChannel.html#FLUSH_NOCASCADE_SYNC">FLUSH_NOCASCADE_SYNC</a>, <a href="DataChannel.html#GRAPH_CHANGED_SUBJECT">GRAPH_CHANGED_SUBJECT</a>, <a href="DataChannel.html#GRAPH_FLUSHED_SUBJECT">GRAPH_FLUSHED_SUBJECT</a>, <a href="DataChannel.html#GRAPH_ROLLEDBACK_SUBJECT">GRAPH_ROLLEDBACK_SUBJECT</a>, <a href="DataChannel.html#ROLLBACK_CASCADE_SYNC">ROLLBACK_CASCADE_SYNC</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier</th> |
| <th class="colSecond" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">BaseContext</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#attachToChannel(org.apache.cayenne.DataChannel)">attachToChannel</a></span>​(<a href="DataChannel.html" title="interface in org.apache.cayenne">DataChannel</a> channel)</code></th> |
| <td class="colLast"> |
| <div class="block">Attaches to a provided DataChannel.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#attachToRuntime(org.apache.cayenne.di.Injector)">attachToRuntime</a></span>​(<a href="di/Injector.html" title="interface in org.apache.cayenne.di">Injector</a> injector)</code></th> |
| <td class="colLast"> |
| <div class="block">Attaches this context to the CayenneRuntime whose Injector is passed as |
| an argument to this method.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#attachToRuntimeIfNeeded()">attachToRuntimeIfNeeded</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Checks whether this context is attached to Cayenne runtime stack and if |
| not, attempts to attach itself to the runtime using Injector returned |
| from the call to <a href="configuration/CayenneRuntime.html#getThreadInjector()"><code>CayenneRuntime.getThreadInjector()</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><T> <a href="ResultBatchIterator.html" title="class in org.apache.cayenne">ResultBatchIterator</a><T></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#batchIterator(org.apache.cayenne.query.Select,int)">batchIterator</a></span>​(<a href="query/Select.html" title="interface in org.apache.cayenne.query">Select</a><T> query, |
| int size)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a ResultBatchIterator based on the provided query and batch size.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#bindThreadObjectContext(org.apache.cayenne.ObjectContext)">bindThreadObjectContext</a></span>​(<a href="ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a> context)</code></th> |
| <td class="colLast"> |
| <div class="block">Binds a ObjectContext to the current thread.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#commitChanges()">commitChanges</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Flushes all changes to objects in this context to the parent DataChannel, |
| cascading flush operation all the way through the stack, ultimately |
| saving data in the database.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#commitChangesToParent()">commitChangesToParent</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Flushes all changes to objects in this context to the parent DataChannel.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><?></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deletedObjects()">deletedObjects</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a collection of objects that are registered with this |
| ObjectContext and have a state PersistenceState.DELETED</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deleteObject(java.lang.Object)">deleteObject</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> object)</code></th> |
| <td class="colLast"> |
| <div class="block">Schedules deletion of a persistent object.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deleteObjects(java.util.Collection)">deleteObjects</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><?> objects)</code></th> |
| <td class="colLast"> |
| <div class="block">Schedules deletion of a collection of persistent objects.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><T> void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deleteObjects(T...)">deleteObjects</a></span>​(T... objects)</code></th> |
| <td class="colLast"> |
| <div class="block">Schedules deletion of one or more persistent objects.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fireDataChannelChanged(java.lang.Object,org.apache.cayenne.graph.GraphDiff)">fireDataChannelChanged</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> postedBy, |
| <a href="graph/GraphDiff.html" title="interface in org.apache.cayenne.graph">GraphDiff</a> changes)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fireDataChannelCommitted(java.lang.Object,org.apache.cayenne.graph.GraphDiff)">fireDataChannelCommitted</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> postedBy, |
| <a href="graph/GraphDiff.html" title="interface in org.apache.cayenne.graph">GraphDiff</a> changes)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fireDataChannelRolledback(java.lang.Object,org.apache.cayenne.graph.GraphDiff)">fireDataChannelRolledback</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> postedBy, |
| <a href="graph/GraphDiff.html" title="interface in org.apache.cayenne.graph">GraphDiff</a> changes)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="DataChannel.html" title="interface in org.apache.cayenne">DataChannel</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getChannel()">getChannel</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns an DataChannel used by this context.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEntityResolver()">getEntityResolver</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns EntityResolver that stores all mapping information accessible by |
| this ObjectContext.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="event/EventManager.html" title="interface in org.apache.cayenne.event">EventManager</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEventManager()">getEventManager</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns EventManager associated with the ObjectStore.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="graph/GraphManager.html" title="interface in org.apache.cayenne.graph">GraphManager</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getGraphManager()">getGraphManager</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns GraphManager that manages object graph associated with this |
| context.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="cache/QueryCache.html" title="interface in org.apache.cayenne.cache">QueryCache</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getQueryCache()">getQueryCache</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>static <a href="ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getThreadObjectContext()">getThreadObjectContext</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the ObjectContext bound to the current thread.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>protected <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">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getUserProperties()">getUserProperties</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a map of user-defined properties associated with this |
| DataContext.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getUserProperty(java.lang.String)">getUserProperty</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a user-defined property previously set via 'setUserProperty'.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#injectInitialValue(java.lang.Object)">injectInitialValue</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> obj)</code></th> |
| <td class="colLast"> |
| <div class="block">If ObjEntity qualifier is set, asks it to inject initial value to an |
| object.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#invalidateObjects(java.util.Collection)">invalidateObjects</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><?> objects)</code></th> |
| <td class="colLast"> |
| <div class="block">Invalidates a Collection of persistent objects.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code><T> void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#invalidateObjects(T...)">invalidateObjects</a></span>​(T... objects)</code></th> |
| <td class="colLast"> |
| <div class="block">Invalidates one or more persistent objects.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isValidatingObjectsOnCommit()">isValidatingObjectsOnCommit</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns whether this ObjectContext performs object validation before |
| commit is executed.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code><T> void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#iterate(org.apache.cayenne.query.Select,org.apache.cayenne.ResultIteratorCallback)">iterate</a></span>​(<a href="query/Select.html" title="interface in org.apache.cayenne.query">Select</a><T> query, |
| <a href="ResultIteratorCallback.html" title="interface in org.apache.cayenne">ResultIteratorCallback</a><T> callback)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a ResultIterator based on the provided query and passes it to a |
| callback for processing.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>abstract <T> <a href="ResultIterator.html" title="interface in org.apache.cayenne">ResultIterator</a><T></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#iterator(org.apache.cayenne.query.Select)">iterator</a></span>​(<a href="query/Select.html" title="interface in org.apache.cayenne.query">Select</a><T> query)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a ResultIterator based on the provided query.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code><T extends <a href="Persistent.html" title="interface in org.apache.cayenne">Persistent</a>><br>T</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#localObject(T)">localObject</a></span>​(T objectFromAnotherContext)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a local copy of 'objectFromAnotherContext' object.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><?></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#modifiedObjects()">modifiedObjects</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a collection of objects that are registered with this |
| ObjectContext and have a state PersistenceState.MODIFIED</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code>abstract <T> T</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newObject(java.lang.Class)">newObject</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><T> persistentClass)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a new persistent object of a given class scheduled to be inserted |
| to the database on next commit.</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><?></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newObjects()">newObjects</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a collection of objects that are registered with this |
| ObjectContext and have a state PersistenceState.NEW</div> |
| </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code>protected abstract <a href="graph/GraphDiff.html" title="interface in org.apache.cayenne.graph">GraphDiff</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onContextFlush(org.apache.cayenne.ObjectContext,org.apache.cayenne.graph.GraphDiff,boolean)">onContextFlush</a></span>​(<a href="ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a> originatingContext, |
| <a href="graph/GraphDiff.html" title="interface in org.apache.cayenne.graph">GraphDiff</a> changes, |
| boolean cascade)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code><a href="graph/GraphDiff.html" title="interface in org.apache.cayenne.graph">GraphDiff</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onSync(org.apache.cayenne.ObjectContext,org.apache.cayenne.graph.GraphDiff,int)">onSync</a></span>​(<a href="ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a> originatingContext, |
| <a href="graph/GraphDiff.html" title="interface in org.apache.cayenne.graph">GraphDiff</a> changes, |
| int syncType)</code></th> |
| <td class="colLast"> |
| <div class="block">Processes synchronization request from a child ObjectContext, returning a GraphDiff |
| that describes changes to objects made on the receiving end as a result of |
| synchronization.</div> |
| </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="QueryResponse.html" title="interface in org.apache.cayenne">QueryResponse</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#performGenericQuery(org.apache.cayenne.query.Query)">performGenericQuery</a></span>​(<a href="query/Query.html" title="interface in org.apache.cayenne.query">Query</a> query)</code></th> |
| <td class="colLast"> |
| <div class="block">Executes any kind of query providing the result in a form of |
| QueryResponse.</div> |
| </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#performQuery(org.apache.cayenne.query.Query)">performQuery</a></span>​(<a href="query/Query.html" title="interface in org.apache.cayenne.query">Query</a> query)</code></th> |
| <td class="colLast"> |
| <div class="block">Executes a selecting query, returning a list of persistent objects or |
| data rows.</div> |
| </td> |
| </tr> |
| <tr id="i36" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#prepareForAccess(org.apache.cayenne.Persistent,java.lang.String,boolean)">prepareForAccess</a></span>​(<a href="Persistent.html" title="interface in org.apache.cayenne">Persistent</a> object, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> property, |
| boolean lazyFaulting)</code></th> |
| <td class="colLast"> |
| <div class="block">A callback method that child Persistent objects are expected to call |
| before accessing property values.</div> |
| </td> |
| </tr> |
| <tr id="i37" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#propertyChanged(org.apache.cayenne.Persistent,java.lang.String,java.lang.Object,java.lang.Object)">propertyChanged</a></span>​(<a href="Persistent.html" title="interface in org.apache.cayenne">Persistent</a> object, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> property, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> oldValue, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> newValue)</code></th> |
| <td class="colLast"> |
| <div class="block">A callback method that child Persistent objects are expected to call from |
| inside the setter after modifying a value of a persistent property, |
| including "simple" and "arc" properties.</div> |
| </td> |
| </tr> |
| <tr id="i38" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#registerNewObject(java.lang.Object)">registerNewObject</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> object)</code></th> |
| <td class="colLast"> |
| <div class="block">Registers a transient object with the context.</div> |
| </td> |
| </tr> |
| <tr id="i39" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#rollbackChanges()">rollbackChanges</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Resets all uncommitted changes made to the objects in this ObjectContext, |
| cascading rollback operation all the way through the stack.</div> |
| </td> |
| </tr> |
| <tr id="i40" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#rollbackChangesLocally()">rollbackChangesLocally</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Resets all uncommitted changes made to the objects in this ObjectContext.</div> |
| </td> |
| </tr> |
| <tr id="i41" class="rowColor"> |
| <td class="colFirst"><code><T> <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><T></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#select(org.apache.cayenne.query.Select)">select</a></span>​(<a href="query/Select.html" title="interface in org.apache.cayenne.query">Select</a><T> query)</code></th> |
| <td class="colLast"> |
| <div class="block">Executes a selecting query, returning a list of persistent objects or |
| data rows.</div> |
| </td> |
| </tr> |
| <tr id="i42" class="altColor"> |
| <td class="colFirst"><code><T> T</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#selectFirst(org.apache.cayenne.query.Select)">selectFirst</a></span>​(<a href="query/Select.html" title="interface in org.apache.cayenne.query">Select</a><T> query)</code></th> |
| <td class="colLast"> |
| <div class="block">Selects a single object using provided query.</div> |
| </td> |
| </tr> |
| <tr id="i43" class="rowColor"> |
| <td class="colFirst"><code><T> T</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#selectOne(org.apache.cayenne.query.Select)">selectOne</a></span>​(<a href="query/Select.html" title="interface in org.apache.cayenne.query">Select</a><T> query)</code></th> |
| <td class="colLast"> |
| <div class="block">Executes a selecting query, returning either NULL if query matched no |
| objects, or a single object.</div> |
| </td> |
| </tr> |
| <tr id="i44" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setChannel(org.apache.cayenne.DataChannel)">setChannel</a></span>​(<a href="DataChannel.html" title="interface in org.apache.cayenne">DataChannel</a> channel)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets a new DataChannel for this context.</div> |
| </td> |
| </tr> |
| <tr id="i45" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setEntityResolver(org.apache.cayenne.map.EntityResolver)">setEntityResolver</a></span>​(<a href="map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</a> entityResolver)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i46" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setQueryCache(org.apache.cayenne.cache.QueryCache)">setQueryCache</a></span>​(<a href="cache/QueryCache.html" title="interface in org.apache.cayenne.cache">QueryCache</a> queryCache)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets a QueryCache to be used for storing cached query results.</div> |
| </td> |
| </tr> |
| <tr id="i47" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setUserProperty(java.lang.String,java.lang.Object)">setUserProperty</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> value)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets a user-defined property.</div> |
| </td> |
| </tr> |
| <tr id="i48" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setValidatingObjectsOnCommit(boolean)">setValidatingObjectsOnCommit</a></span>​(boolean flag)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the property defining whether this ObjectContext should perform |
| object validation before commit is executed.</div> |
| </td> |
| </tr> |
| <tr id="i49" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><?></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#uncommittedObjects()">uncommittedObjects</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a collection of MODIFIED, DELETED or NEW objects.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.cayenne.DataChannel"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.cayenne.<a href="DataChannel.html" title="interface in org.apache.cayenne">DataChannel</a></h3> |
| <code><a href="DataChannel.html#onQuery(org.apache.cayenne.ObjectContext,org.apache.cayenne.query.Query)">onQuery</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.cayenne.ObjectContext"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.cayenne.<a href="ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a></h3> |
| <code><a href="ObjectContext.html#hasChanges()">hasChanges</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a id="threadObjectContext"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>threadObjectContext</h4> |
| <pre>protected static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ThreadLocal.html?is-external=true" title="class or interface in java.lang" class="externalLink">ThreadLocal</a><<a href="ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a>> threadObjectContext</pre> |
| <div class="block">A holder of a ObjectContext bound to the current thread.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="channel"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>channel</h4> |
| <pre>protected transient <a href="DataChannel.html" title="interface in org.apache.cayenne">DataChannel</a> channel</pre> |
| </li> |
| </ul> |
| <a id="queryCache"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>queryCache</h4> |
| <pre>protected transient <a href="cache/QueryCache.html" title="interface in org.apache.cayenne.cache">QueryCache</a> queryCache</pre> |
| </li> |
| </ul> |
| <a id="entityResolver"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>entityResolver</h4> |
| <pre>protected transient <a href="map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</a> entityResolver</pre> |
| </li> |
| </ul> |
| <a id="validatingObjectsOnCommit"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validatingObjectsOnCommit</h4> |
| <pre>protected boolean validatingObjectsOnCommit</pre> |
| </li> |
| </ul> |
| <a id="graphAction"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>graphAction</h4> |
| <pre>protected <a href="util/ObjectContextGraphAction.html" title="class in org.apache.cayenne.util">ObjectContextGraphAction</a> graphAction</pre> |
| <div class="block">Graph action that handles property changes</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="userProperties"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>userProperties</h4> |
| <pre>protected volatile <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">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>> userProperties</pre> |
| <div class="block">Stores user defined properties associated with this DataContext.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>BaseContext</h4> |
| <pre>protected BaseContext()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="getThreadObjectContext()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getThreadObjectContext</h4> |
| <pre class="methodSignature">public static <a href="ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a> getThreadObjectContext() |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></pre> |
| <div class="block">Returns the ObjectContext bound to the current thread.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the ObjectContext associated with caller thread.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></code> - if there is no ObjectContext bound to the current thread.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="bindThreadObjectContext(org.apache.cayenne.ObjectContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>bindThreadObjectContext</h4> |
| <pre class="methodSignature">public static void bindThreadObjectContext​(<a href="ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a> context)</pre> |
| <div class="block">Binds a ObjectContext to the current thread. ObjectContext can later be |
| retrieved by users in the same thread by calling |
| <a href="#getThreadObjectContext()"><code>getThreadObjectContext()</code></a>. Using null parameter will |
| unbind currently bound ObjectContext.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="attachToRuntimeIfNeeded()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>attachToRuntimeIfNeeded</h4> |
| <pre class="methodSignature">protected boolean attachToRuntimeIfNeeded()</pre> |
| <div class="block">Checks whether this context is attached to Cayenne runtime stack and if |
| not, attempts to attach itself to the runtime using Injector returned |
| from the call to <a href="configuration/CayenneRuntime.html#getThreadInjector()"><code>CayenneRuntime.getThreadInjector()</code></a>. If thread |
| Injector is not available and the context is not attached, throws |
| CayenneRuntimeException. |
| <p> |
| This method is called internally by the context before access to |
| transient variables to allow the context to attach to the stack lazily |
| following deserialization.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the context successfully attached to the thread runtime, |
| false - if it was already attached.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="attachToRuntime(org.apache.cayenne.di.Injector)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>attachToRuntime</h4> |
| <pre class="methodSignature">protected void attachToRuntime​(<a href="di/Injector.html" title="interface in org.apache.cayenne.di">Injector</a> injector)</pre> |
| <div class="block">Attaches this context to the CayenneRuntime whose Injector is passed as |
| an argument to this method.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="attachToChannel(org.apache.cayenne.DataChannel)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>attachToChannel</h4> |
| <pre class="methodSignature">protected void attachToChannel​(<a href="DataChannel.html" title="interface in org.apache.cayenne">DataChannel</a> channel)</pre> |
| <div class="block">Attaches to a provided DataChannel.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="commitChanges()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>commitChanges</h4> |
| <pre class="methodSignature">public abstract void commitChanges()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ObjectContext.html#commitChanges()">ObjectContext</a></code></span></div> |
| <div class="block">Flushes all changes to objects in this context to the parent DataChannel, |
| cascading flush operation all the way through the stack, ultimately |
| saving data in the database.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ObjectContext.html#commitChanges()">commitChanges</a></code> in interface <code><a href="ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="commitChangesToParent()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>commitChangesToParent</h4> |
| <pre class="methodSignature">public abstract void commitChangesToParent()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ObjectContext.html#commitChangesToParent()">ObjectContext</a></code></span></div> |
| <div class="block">Flushes all changes to objects in this context to the parent DataChannel. |
| Same as <a href="ObjectContext.html#commitChanges()"><code>ObjectContext.commitChanges()</code></a>, but no cascading flush occurs.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ObjectContext.html#commitChangesToParent()">commitChangesToParent</a></code> in interface <code><a href="ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="deleteObject(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteObject</h4> |
| <pre class="methodSignature">public void deleteObject​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> object) |
| throws <a href="DeleteDenyException.html" title="class in org.apache.cayenne">DeleteDenyException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ObjectContext.html#deleteObject(java.lang.Object)">ObjectContext</a></code></span></div> |
| <div class="block">Schedules deletion of a persistent object.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ObjectContext.html#deleteObject(java.lang.Object)">deleteObject</a></code> in interface <code><a href="ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="DeleteDenyException.html" title="class in org.apache.cayenne">DeleteDenyException</a></code> - if a <a href="map/DeleteRule.html#DENY"><code>DeleteRule.DENY</code></a> delete |
| rule is applicable for object deletion.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="deletedObjects()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deletedObjects</h4> |
| <pre class="methodSignature">public abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><?> deletedObjects()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ObjectContext.html#deletedObjects()">ObjectContext</a></code></span></div> |
| <div class="block">Returns a collection of objects that are registered with this |
| ObjectContext and have a state PersistenceState.DELETED</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ObjectContext.html#deletedObjects()">deletedObjects</a></code> in interface <code><a href="ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getChannel()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getChannel</h4> |
| <pre class="methodSignature">public <a href="DataChannel.html" title="interface in org.apache.cayenne">DataChannel</a> getChannel()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ObjectContext.html#getChannel()">ObjectContext</a></code></span></div> |
| <div class="block">Returns an DataChannel used by this context.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ObjectContext.html#getChannel()">getChannel</a></code> in interface <code><a href="ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setChannel(org.apache.cayenne.DataChannel)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setChannel</h4> |
| <pre class="methodSignature">public void setChannel​(<a href="DataChannel.html" title="interface in org.apache.cayenne">DataChannel</a> channel)</pre> |
| <div class="block">Sets a new DataChannel for this context.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getEntityResolver()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEntityResolver</h4> |
| <pre class="methodSignature">public <a href="map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</a> getEntityResolver()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ObjectContext.html#getEntityResolver()">ObjectContext</a></code></span></div> |
| <div class="block">Returns EntityResolver that stores all mapping information accessible by |
| this ObjectContext.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="DataChannel.html#getEntityResolver()">getEntityResolver</a></code> in interface <code><a href="DataChannel.html" title="interface in org.apache.cayenne">DataChannel</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ObjectContext.html#getEntityResolver()">getEntityResolver</a></code> in interface <code><a href="ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setEntityResolver(org.apache.cayenne.map.EntityResolver)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEntityResolver</h4> |
| <pre class="methodSignature">public void setEntityResolver​(<a href="map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</a> entityResolver)</pre> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isValidatingObjectsOnCommit()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isValidatingObjectsOnCommit</h4> |
| <pre class="methodSignature">public boolean isValidatingObjectsOnCommit()</pre> |
| <div class="block">Returns whether this ObjectContext performs object validation before |
| commit is executed.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setValidatingObjectsOnCommit(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setValidatingObjectsOnCommit</h4> |
| <pre class="methodSignature">public void setValidatingObjectsOnCommit​(boolean flag)</pre> |
| <div class="block">Sets the property defining whether this ObjectContext should perform |
| object validation before commit is executed.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="localObject(org.apache.cayenne.Persistent)"> |
| <!-- --> |
| </a><a id="localObject(T)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>localObject</h4> |
| <pre class="methodSignature">public <T extends <a href="Persistent.html" title="interface in org.apache.cayenne">Persistent</a>> T localObject​(T objectFromAnotherContext)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ObjectContext.html#localObject(T)">ObjectContext</a></code></span></div> |
| <div class="block">Returns a local copy of 'objectFromAnotherContext' object. "Local" means |
| that the returned object is registered in this context. If the local |
| object hasn't been previously cached in this context, a hollow object is |
| created and returned to the caller. No DB query is performed to resolve |
| an object. |
| <p> |
| Note that passing an object with a non-existing id, may later result in |
| FaultFailureException on attempt to read returned object properties.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ObjectContext.html#localObject(T)">localObject</a></code> in interface <code><a href="ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a></code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getGraphManager()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getGraphManager</h4> |
| <pre class="methodSignature">public abstract <a href="graph/GraphManager.html" title="interface in org.apache.cayenne.graph">GraphManager</a> getGraphManager()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ObjectContext.html#getGraphManager()">ObjectContext</a></code></span></div> |
| <div class="block">Returns GraphManager that manages object graph associated with this |
| context.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ObjectContext.html#getGraphManager()">getGraphManager</a></code> in interface <code><a href="ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="modifiedObjects()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>modifiedObjects</h4> |
| <pre class="methodSignature">public abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><?> modifiedObjects()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ObjectContext.html#modifiedObjects()">ObjectContext</a></code></span></div> |
| <div class="block">Returns a collection of objects that are registered with this |
| ObjectContext and have a state PersistenceState.MODIFIED</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ObjectContext.html#modifiedObjects()">modifiedObjects</a></code> in interface <code><a href="ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="newObject(java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newObject</h4> |
| <pre class="methodSignature">public abstract <T> T newObject​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><T> persistentClass)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ObjectContext.html#newObject(java.lang.Class)">ObjectContext</a></code></span></div> |
| <div class="block">Creates a new persistent object of a given class scheduled to be inserted |
| to the database on next commit.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ObjectContext.html#newObject(java.lang.Class)">newObject</a></code> in interface <code><a href="ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="registerNewObject(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>registerNewObject</h4> |
| <pre class="methodSignature">public abstract void registerNewObject​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> object)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ObjectContext.html#registerNewObject(java.lang.Object)">ObjectContext</a></code></span></div> |
| <div class="block">Registers a transient object with the context. The difference with |
| <a href="ObjectContext.html#newObject(java.lang.Class)"><code>ObjectContext.newObject(Class)</code></a> is that a user creates an object herself, |
| before attaching it to the context, instead of relying on Cayenne to do |
| that.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ObjectContext.html#registerNewObject(java.lang.Object)">registerNewObject</a></code> in interface <code><a href="ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>object</code> - new object that needs to be made persistent.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="newObjects()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newObjects</h4> |
| <pre class="methodSignature">public abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><?> newObjects()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ObjectContext.html#newObjects()">ObjectContext</a></code></span></div> |
| <div class="block">Returns a collection of objects that are registered with this |
| ObjectContext and have a state PersistenceState.NEW</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ObjectContext.html#newObjects()">newObjects</a></code> in interface <code><a href="ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="performGenericQuery(org.apache.cayenne.query.Query)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>performGenericQuery</h4> |
| <pre class="methodSignature">public abstract <a href="QueryResponse.html" title="interface in org.apache.cayenne">QueryResponse</a> performGenericQuery​(<a href="query/Query.html" title="interface in org.apache.cayenne.query">Query</a> query)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ObjectContext.html#performGenericQuery(org.apache.cayenne.query.Query)">ObjectContext</a></code></span></div> |
| <div class="block">Executes any kind of query providing the result in a form of |
| QueryResponse.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ObjectContext.html#performGenericQuery(org.apache.cayenne.query.Query)">performGenericQuery</a></code> in interface <code><a href="ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="performQuery(org.apache.cayenne.query.Query)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>performQuery</h4> |
| <pre class="methodSignature">public abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a> performQuery​(<a href="query/Query.html" title="interface in org.apache.cayenne.query">Query</a> query)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ObjectContext.html#performQuery(org.apache.cayenne.query.Query)">ObjectContext</a></code></span></div> |
| <div class="block">Executes a selecting query, returning a list of persistent objects or |
| data rows.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ObjectContext.html#performQuery(org.apache.cayenne.query.Query)">performQuery</a></code> in interface <code><a href="ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="select(org.apache.cayenne.query.Select)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>select</h4> |
| <pre class="methodSignature">public <T> <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><T> select​(<a href="query/Select.html" title="interface in org.apache.cayenne.query">Select</a><T> query)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ObjectContext.html#select(org.apache.cayenne.query.Select)">ObjectContext</a></code></span></div> |
| <div class="block">Executes a selecting query, returning a list of persistent objects or |
| data rows.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ObjectContext.html#select(org.apache.cayenne.query.Select)">select</a></code> in interface <code><a href="ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a></code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="selectOne(org.apache.cayenne.query.Select)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>selectOne</h4> |
| <pre class="methodSignature">public <T> T selectOne​(<a href="query/Select.html" title="interface in org.apache.cayenne.query">Select</a><T> query)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ObjectContext.html#selectOne(org.apache.cayenne.query.Select)">ObjectContext</a></code></span></div> |
| <div class="block">Executes a selecting query, returning either NULL if query matched no |
| objects, or a single object. If query matches more than one object, |
| <a href="CayenneRuntimeException.html" title="class in org.apache.cayenne"><code>CayenneRuntimeException</code></a> is thrown.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ObjectContext.html#selectOne(org.apache.cayenne.query.Select)">selectOne</a></code> in interface <code><a href="ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a></code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="selectFirst(org.apache.cayenne.query.Select)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>selectFirst</h4> |
| <pre class="methodSignature">public <T> T selectFirst​(<a href="query/Select.html" title="interface in org.apache.cayenne.query">Select</a><T> query)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ObjectContext.html#selectFirst(org.apache.cayenne.query.Select)">ObjectContext</a></code></span></div> |
| <div class="block">Selects a single object using provided query. The query itself can |
| match any number of objects, but will return only the first one. It |
| returns null if no objects were matched. |
| <p> |
| If it matched more than one object, the first object from the list is |
| returned. This makes 'selectFirst' different from |
| <a href="ObjectContext.html#selectOne(org.apache.cayenne.query.Select)"><code>ObjectContext.selectOne(Select)</code></a>, which would throw in this situation. |
| 'selectFirst' is useful e.g. when the query is ordered and we only want |
| to see the first object (e.g. "most recent news article"), etc. |
| <p> |
| Selecting the first object via "Select.selectFirst(ObjectContext)" |
| is more comprehensible than selecting via "ObjectContext.selectFirst(Select)", |
| because implementations of "Select" set fetch size limit to one.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ObjectContext.html#selectFirst(org.apache.cayenne.query.Select)">selectFirst</a></code> in interface <code><a href="ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a></code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="iterate(org.apache.cayenne.query.Select,org.apache.cayenne.ResultIteratorCallback)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>iterate</h4> |
| <pre class="methodSignature">public <T> void iterate​(<a href="query/Select.html" title="interface in org.apache.cayenne.query">Select</a><T> query, |
| <a href="ResultIteratorCallback.html" title="interface in org.apache.cayenne">ResultIteratorCallback</a><T> callback)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ObjectContext.html#iterate(org.apache.cayenne.query.Select,org.apache.cayenne.ResultIteratorCallback)">ObjectContext</a></code></span></div> |
| <div class="block">Creates a ResultIterator based on the provided query and passes it to a |
| callback for processing. The caller does not need to worry about closing |
| the iterator. This method takes care of it.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ObjectContext.html#iterate(org.apache.cayenne.query.Select,org.apache.cayenne.ResultIteratorCallback)">iterate</a></code> in interface <code><a href="ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a></code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="iterator(org.apache.cayenne.query.Select)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>iterator</h4> |
| <pre class="methodSignature">public abstract <T> <a href="ResultIterator.html" title="interface in org.apache.cayenne">ResultIterator</a><T> iterator​(<a href="query/Select.html" title="interface in org.apache.cayenne.query">Select</a><T> query)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ObjectContext.html#iterator(org.apache.cayenne.query.Select)">ObjectContext</a></code></span></div> |
| <div class="block">Creates a ResultIterator based on the provided query. It is usually |
| backed by an open result set and is useful for processing of large data |
| sets, preserving a constant memory footprint. The caller must wrap |
| iteration in try/finally (or try-with-resources for Java 1.7 and higher) and |
| close the ResultIterator explicitly. |
| Or use <a href="ObjectContext.html#iterate(org.apache.cayenne.query.Select,org.apache.cayenne.ResultIteratorCallback)"><code>ObjectContext.iterate(Select, ResultIteratorCallback)</code></a> as an alternative.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ObjectContext.html#iterator(org.apache.cayenne.query.Select)">iterator</a></code> in interface <code><a href="ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="batchIterator(org.apache.cayenne.query.Select,int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>batchIterator</h4> |
| <pre class="methodSignature">public <T> <a href="ResultBatchIterator.html" title="class in org.apache.cayenne">ResultBatchIterator</a><T> batchIterator​(<a href="query/Select.html" title="interface in org.apache.cayenne.query">Select</a><T> query, |
| int size)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ObjectContext.html#batchIterator(org.apache.cayenne.query.Select,int)">ObjectContext</a></code></span></div> |
| <div class="block">Creates a ResultBatchIterator based on the provided query and batch size. It is usually |
| backed by an open result set and is useful for processing of large data |
| sets, preserving a constant memory footprint. The caller must wrap |
| iteration in try/finally (or try-with-resources for Java 1.7 and higher) and |
| close the ResultBatchIterator explicitly.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ObjectContext.html#batchIterator(org.apache.cayenne.query.Select,int)">batchIterator</a></code> in interface <code><a href="ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="prepareForAccess(org.apache.cayenne.Persistent,java.lang.String,boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>prepareForAccess</h4> |
| <pre class="methodSignature">public void prepareForAccess​(<a href="Persistent.html" title="interface in org.apache.cayenne">Persistent</a> object, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> property, |
| boolean lazyFaulting)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ObjectContext.html#prepareForAccess(org.apache.cayenne.Persistent,java.lang.String,boolean)">ObjectContext</a></code></span></div> |
| <div class="block">A callback method that child Persistent objects are expected to call |
| before accessing property values. This callback allows ObjectContext to |
| "inflate" unresolved objects on demand and also resolve properties that |
| rely on lazy faulting.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ObjectContext.html#prepareForAccess(org.apache.cayenne.Persistent,java.lang.String,boolean)">prepareForAccess</a></code> in interface <code><a href="ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="propertyChanged(org.apache.cayenne.Persistent,java.lang.String,java.lang.Object,java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>propertyChanged</h4> |
| <pre class="methodSignature">public void propertyChanged​(<a href="Persistent.html" title="interface in org.apache.cayenne">Persistent</a> object, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> property, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> oldValue, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> newValue)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ObjectContext.html#propertyChanged(org.apache.cayenne.Persistent,java.lang.String,java.lang.Object,java.lang.Object)">ObjectContext</a></code></span></div> |
| <div class="block">A callback method that child Persistent objects are expected to call from |
| inside the setter after modifying a value of a persistent property, |
| including "simple" and "arc" properties.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ObjectContext.html#propertyChanged(org.apache.cayenne.Persistent,java.lang.String,java.lang.Object,java.lang.Object)">propertyChanged</a></code> in interface <code><a href="ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="rollbackChanges()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>rollbackChanges</h4> |
| <pre class="methodSignature">public abstract void rollbackChanges()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ObjectContext.html#rollbackChanges()">ObjectContext</a></code></span></div> |
| <div class="block">Resets all uncommitted changes made to the objects in this ObjectContext, |
| cascading rollback operation all the way through the stack.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ObjectContext.html#rollbackChanges()">rollbackChanges</a></code> in interface <code><a href="ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="rollbackChangesLocally()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>rollbackChangesLocally</h4> |
| <pre class="methodSignature">public abstract void rollbackChangesLocally()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ObjectContext.html#rollbackChangesLocally()">ObjectContext</a></code></span></div> |
| <div class="block">Resets all uncommitted changes made to the objects in this ObjectContext. |
| Same as <a href="ObjectContext.html#rollbackChanges()"><code>ObjectContext.rollbackChanges()</code></a>, but rollback is local to this |
| context and no cascading changes undoing occurs.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ObjectContext.html#rollbackChangesLocally()">rollbackChangesLocally</a></code> in interface <code><a href="ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="uncommittedObjects()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>uncommittedObjects</h4> |
| <pre class="methodSignature">public abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><?> uncommittedObjects()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ObjectContext.html#uncommittedObjects()">ObjectContext</a></code></span></div> |
| <div class="block">Returns a collection of MODIFIED, DELETED or NEW objects.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ObjectContext.html#uncommittedObjects()">uncommittedObjects</a></code> in interface <code><a href="ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getQueryCache()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQueryCache</h4> |
| <pre class="methodSignature">public <a href="cache/QueryCache.html" title="interface in org.apache.cayenne.cache">QueryCache</a> getQueryCache()</pre> |
| </li> |
| </ul> |
| <a id="setQueryCache(org.apache.cayenne.cache.QueryCache)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setQueryCache</h4> |
| <pre class="methodSignature">public void setQueryCache​(<a href="cache/QueryCache.html" title="interface in org.apache.cayenne.cache">QueryCache</a> queryCache)</pre> |
| <div class="block">Sets a QueryCache to be used for storing cached query results.</div> |
| </li> |
| </ul> |
| <a id="getEventManager()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEventManager</h4> |
| <pre class="methodSignature">public <a href="event/EventManager.html" title="interface in org.apache.cayenne.event">EventManager</a> getEventManager()</pre> |
| <div class="block">Returns EventManager associated with the ObjectStore.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="DataChannel.html#getEventManager()">getEventManager</a></code> in interface <code><a href="DataChannel.html" title="interface in org.apache.cayenne">DataChannel</a></code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="onSync(org.apache.cayenne.ObjectContext,org.apache.cayenne.graph.GraphDiff,int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onSync</h4> |
| <pre class="methodSignature">public <a href="graph/GraphDiff.html" title="interface in org.apache.cayenne.graph">GraphDiff</a> onSync​(<a href="ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a> originatingContext, |
| <a href="graph/GraphDiff.html" title="interface in org.apache.cayenne.graph">GraphDiff</a> changes, |
| int syncType)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="DataChannel.html#onSync(org.apache.cayenne.ObjectContext,org.apache.cayenne.graph.GraphDiff,int)">DataChannel</a></code></span></div> |
| <div class="block">Processes synchronization request from a child ObjectContext, returning a GraphDiff |
| that describes changes to objects made on the receiving end as a result of |
| synchronization.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="DataChannel.html#onSync(org.apache.cayenne.ObjectContext,org.apache.cayenne.graph.GraphDiff,int)">onSync</a></code> in interface <code><a href="DataChannel.html" title="interface in org.apache.cayenne">DataChannel</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>originatingContext</code> - an ObjectContext that initiated the sync. Can be null.</dd> |
| <dd><code>changes</code> - diff from the context that initiated the sync.</dd> |
| <dd><code>syncType</code> - One of <a href="DataChannel.html#FLUSH_NOCASCADE_SYNC"><code>DataChannel.FLUSH_NOCASCADE_SYNC</code></a>, <a href="DataChannel.html#FLUSH_CASCADE_SYNC"><code>DataChannel.FLUSH_CASCADE_SYNC</code></a>, |
| <a href="DataChannel.html#ROLLBACK_CASCADE_SYNC"><code>DataChannel.ROLLBACK_CASCADE_SYNC</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="onContextFlush(org.apache.cayenne.ObjectContext,org.apache.cayenne.graph.GraphDiff,boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onContextFlush</h4> |
| <pre class="methodSignature">protected abstract <a href="graph/GraphDiff.html" title="interface in org.apache.cayenne.graph">GraphDiff</a> onContextFlush​(<a href="ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a> originatingContext, |
| <a href="graph/GraphDiff.html" title="interface in org.apache.cayenne.graph">GraphDiff</a> changes, |
| boolean cascade)</pre> |
| </li> |
| </ul> |
| <a id="fireDataChannelCommitted(java.lang.Object,org.apache.cayenne.graph.GraphDiff)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fireDataChannelCommitted</h4> |
| <pre class="methodSignature">protected void fireDataChannelCommitted​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> postedBy, |
| <a href="graph/GraphDiff.html" title="interface in org.apache.cayenne.graph">GraphDiff</a> changes)</pre> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="fireDataChannelRolledback(java.lang.Object,org.apache.cayenne.graph.GraphDiff)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fireDataChannelRolledback</h4> |
| <pre class="methodSignature">protected void fireDataChannelRolledback​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> postedBy, |
| <a href="graph/GraphDiff.html" title="interface in org.apache.cayenne.graph">GraphDiff</a> changes)</pre> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="fireDataChannelChanged(java.lang.Object,org.apache.cayenne.graph.GraphDiff)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fireDataChannelChanged</h4> |
| <pre class="methodSignature">protected void fireDataChannelChanged​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> postedBy, |
| <a href="graph/GraphDiff.html" title="interface in org.apache.cayenne.graph">GraphDiff</a> changes)</pre> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="invalidateObjects(java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>invalidateObjects</h4> |
| <pre class="methodSignature">public void invalidateObjects​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><?> objects)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ObjectContext.html#invalidateObjects(java.util.Collection)">ObjectContext</a></code></span></div> |
| <div class="block">Invalidates a Collection of persistent objects. This operation only |
| applies to the objects already committed to the database and does nothing |
| to the NEW objects. It would remove each object's snapshot from caches |
| and change object's state to HOLLOW. On the next access to this object, |
| the object will be refetched.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ObjectContext.html#invalidateObjects(java.util.Collection)">invalidateObjects</a></code> in interface <code><a href="ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="invalidateObjects(java.lang.Object[])"> |
| <!-- --> |
| </a><a id="invalidateObjects(T...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>invalidateObjects</h4> |
| <pre class="methodSignature">public <T> void invalidateObjects​(T... objects)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ObjectContext.html#invalidateObjects(T...)">ObjectContext</a></code></span></div> |
| <div class="block">Invalidates one or more persistent objects. Same as |
| <a href="ObjectContext.html#invalidateObjects(java.util.Collection)"><code>ObjectContext.invalidateObjects(Collection)</code></a> only with a vararg argument list |
| for easier invalidation of individual objects. If no arguments are passed |
| to this method, it does nothing.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ObjectContext.html#invalidateObjects(T...)">invalidateObjects</a></code> in interface <code><a href="ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a></code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getUserProperties()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUserProperties</h4> |
| <pre class="methodSignature">protected <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">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>> getUserProperties()</pre> |
| <div class="block">Returns a map of user-defined properties associated with this |
| DataContext.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getUserProperty(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUserProperty</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> getUserProperty​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key)</pre> |
| <div class="block">Returns a user-defined property previously set via 'setUserProperty'. |
| Note that it is a caller responsibility to synchronize access to |
| properties.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ObjectContext.html#getUserProperty(java.lang.String)">getUserProperty</a></code> in interface <code><a href="ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a></code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setUserProperty(java.lang.String,java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setUserProperty</h4> |
| <pre class="methodSignature">public void setUserProperty​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> key, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> value)</pre> |
| <div class="block">Sets a user-defined property. Note that it is a caller responsibility to |
| synchronize access to properties.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ObjectContext.html#setUserProperty(java.lang.String,java.lang.Object)">setUserProperty</a></code> in interface <code><a href="ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a></code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="injectInitialValue(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>injectInitialValue</h4> |
| <pre class="methodSignature">protected void injectInitialValue​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> obj)</pre> |
| <div class="block">If ObjEntity qualifier is set, asks it to inject initial value to an |
| object. Also performs all Persistent initialization operations</div> |
| </li> |
| </ul> |
| <a id="deleteObjects(java.lang.Object[])"> |
| <!-- --> |
| </a><a id="deleteObjects(T...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteObjects</h4> |
| <pre class="methodSignature">public <T> void deleteObjects​(T... objects) |
| throws <a href="DeleteDenyException.html" title="class in org.apache.cayenne">DeleteDenyException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ObjectContext.html#deleteObjects(T...)">ObjectContext</a></code></span></div> |
| <div class="block">Schedules deletion of one or more persistent objects. Same as |
| <a href="ObjectContext.html#deleteObjects(java.util.Collection)"><code>ObjectContext.deleteObjects(Collection)</code></a> only with a vararg argument list for |
| easier deletion of individual objects.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ObjectContext.html#deleteObjects(T...)">deleteObjects</a></code> in interface <code><a href="ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="DeleteDenyException.html" title="class in org.apache.cayenne">DeleteDenyException</a></code> - if a <a href="map/DeleteRule.html#DENY"><code>DeleteRule.DENY</code></a> delete |
| rule is applicable for object deletion.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="deleteObjects(java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>deleteObjects</h4> |
| <pre class="methodSignature">public void deleteObjects​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><?> objects) |
| throws <a href="DeleteDenyException.html" title="class in org.apache.cayenne">DeleteDenyException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ObjectContext.html#deleteObjects(java.util.Collection)">ObjectContext</a></code></span></div> |
| <div class="block">Schedules deletion of a collection of persistent objects.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ObjectContext.html#deleteObjects(java.util.Collection)">deleteObjects</a></code> in interface <code><a href="ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="DeleteDenyException.html" title="class in org.apache.cayenne">DeleteDenyException</a></code> - if a <a href="map/DeleteRule.html#DENY"><code>DeleteRule.DENY</code></a> delete |
| rule is applicable for object deletion.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <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><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/BaseContext.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> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </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> |