| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_112) on Mon Oct 14 11:36:19 MSK 2019 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>CayenneDataObject (cayenne-doc: Cayenne Documentation 4.0.2 API)</title> |
| <meta name="date" content="2019-10-14"> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="CayenneDataObject (cayenne-doc: Cayenne Documentation 4.0.2 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":9,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/CayenneDataObject.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../index-all.html">Index</a></li> |
| <li><a href="../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../org/apache/cayenne/CayenneContext.html" title="class in org.apache.cayenne"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../org/apache/cayenne/CayenneException.html" title="class in org.apache.cayenne"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/apache/cayenne/CayenneDataObject.html" target="_top">Frames</a></li> |
| <li><a href="CayenneDataObject.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <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 name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.cayenne</div> |
| <h2 title="Class CayenneDataObject" class="title">Class CayenneDataObject</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../org/apache/cayenne/PersistentObject.html" title="class in org.apache.cayenne">org.apache.cayenne.PersistentObject</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.cayenne.CayenneDataObject</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="https://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="../../../org/apache/cayenne/DataObject.html" title="interface in org.apache.cayenne">DataObject</a>, <a href="../../../org/apache/cayenne/Persistent.html" title="interface in org.apache.cayenne">Persistent</a>, <a href="../../../org/apache/cayenne/Validating.html" title="interface in org.apache.cayenne">Validating</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">CayenneDataObject</span> |
| extends <a href="../../../org/apache/cayenne/PersistentObject.html" title="class in org.apache.cayenne">PersistentObject</a> |
| implements <a href="../../../org/apache/cayenne/DataObject.html" title="interface in org.apache.cayenne">DataObject</a>, <a href="../../../org/apache/cayenne/Validating.html" title="interface in org.apache.cayenne">Validating</a></pre> |
| <div class="block">A default implementation of DataObject interface. It is normally used as a |
| superclass of Cayenne persistent objects.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../serialized-form.html#org.apache.cayenne.CayenneDataObject">Serialized Form</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/cayenne/CayenneDataObject.html#snapshotVersion">snapshotVersion</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/cayenne/CayenneDataObject.html#values">values</a></span></code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.cayenne.PersistentObject"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.cayenne.<a href="../../../org/apache/cayenne/PersistentObject.html" title="class in org.apache.cayenne">PersistentObject</a></h3> |
| <code><a href="../../../org/apache/cayenne/PersistentObject.html#objectContext">objectContext</a>, <a href="../../../org/apache/cayenne/PersistentObject.html#objectId">objectId</a>, <a href="../../../org/apache/cayenne/PersistentObject.html#persistenceState">persistenceState</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.cayenne.DataObject"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.cayenne.<a href="../../../org/apache/cayenne/DataObject.html" title="interface in org.apache.cayenne">DataObject</a></h3> |
| <code><a href="../../../org/apache/cayenne/DataObject.html#DEFAULT_VERSION">DEFAULT_VERSION</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/cayenne/CayenneDataObject.html#CayenneDataObject--">CayenneDataObject</a></span>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <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="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="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/cayenne/CayenneDataObject.html#addToManyTarget-java.lang.String-org.apache.cayenne.DataObject-boolean-">addToManyTarget</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> relName, |
| <a href="../../../org/apache/cayenne/DataObject.html" title="interface in org.apache.cayenne">DataObject</a> value, |
| boolean setReverse)</code> |
| <div class="block">Adds an object to a to-many relationship.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/cayenne/CayenneDataObject.html#appendProperties-java.lang.StringBuffer-">appendProperties</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/StringBuffer.html?is-external=true" title="class or interface in java.lang">StringBuffer</a> buffer)</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/cayenne/CayenneDataObject.html#getSnapshotVersion--">getSnapshotVersion</a></span>()</code> |
| <div class="block">Returns a version of a DataRow snapshot that was used to create this |
| object.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/cayenne/CayenneDataObject.html#makePath-java.lang.String...-">makePath</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... pathParts)</code> |
| <div class="block">Convenience method to invoke <a href="../../../org/apache/cayenne/Cayenne.html#makePath-java.lang.String...-"><code>Cayenne.makePath(String...)</code></a> from |
| within a DataObject subclass to create a dotted path using the generated |
| string constants for attributes and relationships.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/cayenne/CayenneDataObject.html#readNestedProperty-java.lang.String-">readNestedProperty</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> path)</code> |
| <div class="block">Returns a value of the property identified by a property path.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/cayenne/CayenneDataObject.html#readProperty-java.lang.String-">readProperty</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> propertyName)</code> |
| <div class="block">Returns a value of the property identified by propName.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/cayenne/CayenneDataObject.html#readPropertyDirectly-java.lang.String-">readPropertyDirectly</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> propName)</code> |
| <div class="block">Returns mapped property value as curently stored in the DataObject.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/cayenne/CayenneDataObject.html#removeToManyTarget-java.lang.String-org.apache.cayenne.DataObject-boolean-">removeToManyTarget</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> relName, |
| <a href="../../../org/apache/cayenne/DataObject.html" title="interface in org.apache.cayenne">DataObject</a> value, |
| boolean setReverse)</code> |
| <div class="block">Removes an object from a to-many relationship.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/cayenne/CayenneDataObject.html#setObjectContext-org.apache.cayenne.ObjectContext-">setObjectContext</a></span>(<a href="../../../org/apache/cayenne/ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a> objectContext)</code> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/cayenne/CayenneDataObject.html#setPersistenceState-int-">setPersistenceState</a></span>(int persistenceState)</code> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/cayenne/CayenneDataObject.html#setReverseRelationship-java.lang.String-org.apache.cayenne.DataObject-">setReverseRelationship</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> relName, |
| <a href="../../../org/apache/cayenne/DataObject.html" title="interface in org.apache.cayenne">DataObject</a> val)</code> |
| <div class="block">Initializes reverse relationship from object <code>val</code> to this |
| object.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/cayenne/CayenneDataObject.html#setSnapshotVersion-long-">setSnapshotVersion</a></span>(long snapshotVersion)</code> </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><? extends <a href="../../../org/apache/cayenne/DataObject.html" title="interface in org.apache.cayenne">DataObject</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/cayenne/CayenneDataObject.html#setToManyTarget-java.lang.String-java.util.Collection-boolean-">setToManyTarget</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> relName, |
| <a href="https://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><? extends <a href="../../../org/apache/cayenne/DataObject.html" title="interface in org.apache.cayenne">DataObject</a>> values, |
| boolean setReverse)</code> |
| <div class="block">Sets the relationships to the specified <code>DataObject</code> objects.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/cayenne/CayenneDataObject.html#setToOneTarget-java.lang.String-org.apache.cayenne.DataObject-boolean-">setToOneTarget</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> relationshipName, |
| <a href="../../../org/apache/cayenne/DataObject.html" title="interface in org.apache.cayenne">DataObject</a> value, |
| boolean setReverse)</code> |
| <div class="block">Sets to-one relationship to a new value.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/cayenne/CayenneDataObject.html#toString--">toString</a></span>()</code> </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/StringBuffer.html?is-external=true" title="class or interface in java.lang">StringBuffer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/cayenne/CayenneDataObject.html#toStringBuffer-java.lang.StringBuffer-boolean-">toStringBuffer</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/StringBuffer.html?is-external=true" title="class or interface in java.lang">StringBuffer</a> buffer, |
| boolean fullDesc)</code> |
| <div class="block">A variation of "toString" method, that may be more efficient in some |
| cases.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/cayenne/CayenneDataObject.html#unsetReverseRelationship-java.lang.String-org.apache.cayenne.DataObject-">unsetReverseRelationship</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> relName, |
| <a href="../../../org/apache/cayenne/DataObject.html" title="interface in org.apache.cayenne">DataObject</a> val)</code> |
| <div class="block">Removes current object from reverse relationship of object |
| <code>val</code> to this object.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/cayenne/CayenneDataObject.html#validateForDelete-org.apache.cayenne.validation.ValidationResult-">validateForDelete</a></span>(<a href="../../../org/apache/cayenne/validation/ValidationResult.html" title="class in org.apache.cayenne.validation">ValidationResult</a> validationResult)</code> |
| <div class="block">This implementation does nothing.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/cayenne/CayenneDataObject.html#validateForInsert-org.apache.cayenne.validation.ValidationResult-">validateForInsert</a></span>(<a href="../../../org/apache/cayenne/validation/ValidationResult.html" title="class in org.apache.cayenne.validation">ValidationResult</a> validationResult)</code> |
| <div class="block">Calls <a href="../../../org/apache/cayenne/CayenneDataObject.html#validateForSave-org.apache.cayenne.validation.ValidationResult-"><code>validateForSave(ValidationResult)</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/cayenne/CayenneDataObject.html#validateForSave-org.apache.cayenne.validation.ValidationResult-">validateForSave</a></span>(<a href="../../../org/apache/cayenne/validation/ValidationResult.html" title="class in org.apache.cayenne.validation">ValidationResult</a> validationResult)</code> |
| <div class="block">Performs property validation of the object, appending any validation |
| failures to the provided validationResult object.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/cayenne/CayenneDataObject.html#validateForUpdate-org.apache.cayenne.validation.ValidationResult-">validateForUpdate</a></span>(<a href="../../../org/apache/cayenne/validation/ValidationResult.html" title="class in org.apache.cayenne.validation">ValidationResult</a> validationResult)</code> |
| <div class="block">Calls <a href="../../../org/apache/cayenne/CayenneDataObject.html#validateForSave-org.apache.cayenne.validation.ValidationResult-"><code>validateForSave(ValidationResult)</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/cayenne/CayenneDataObject.html#willConnect-java.lang.String-org.apache.cayenne.Persistent-">willConnect</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> relationshipName, |
| <a href="../../../org/apache/cayenne/Persistent.html" title="interface in org.apache.cayenne">Persistent</a> object)</code> |
| <div class="block">Called before establishing a relationship with another object.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/cayenne/CayenneDataObject.html#writeProperty-java.lang.String-java.lang.Object-">writeProperty</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> propName, |
| <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> val)</code> |
| <div class="block">Sets the property to the new value.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/cayenne/CayenneDataObject.html#writePropertyDirectly-java.lang.String-java.lang.Object-">writePropertyDirectly</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> propName, |
| <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> val)</code> |
| <div class="block">Modifies a value of a named property without altering the object state in any way, |
| and without triggering any database operations.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.cayenne.PersistentObject"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.cayenne.<a href="../../../org/apache/cayenne/PersistentObject.html" title="class in org.apache.cayenne">PersistentObject</a></h3> |
| <code><a href="../../../org/apache/cayenne/PersistentObject.html#getMapKey-java.lang.String-java.lang.Object-">getMapKey</a>, <a href="../../../org/apache/cayenne/PersistentObject.html#getObjectContext--">getObjectContext</a>, <a href="../../../org/apache/cayenne/PersistentObject.html#getObjectId--">getObjectId</a>, <a href="../../../org/apache/cayenne/PersistentObject.html#getPersistenceState--">getPersistenceState</a>, <a href="../../../org/apache/cayenne/PersistentObject.html#setObjectId-org.apache.cayenne.ObjectId-">setObjectId</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.cayenne.Persistent"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.cayenne.<a href="../../../org/apache/cayenne/Persistent.html" title="interface in org.apache.cayenne">Persistent</a></h3> |
| <code><a href="../../../org/apache/cayenne/Persistent.html#getObjectContext--">getObjectContext</a>, <a href="../../../org/apache/cayenne/Persistent.html#getObjectId--">getObjectId</a>, <a href="../../../org/apache/cayenne/Persistent.html#getPersistenceState--">getPersistenceState</a>, <a href="../../../org/apache/cayenne/Persistent.html#setObjectId-org.apache.cayenne.ObjectId-">setObjectId</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="snapshotVersion"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>snapshotVersion</h4> |
| <pre>protected long snapshotVersion</pre> |
| </li> |
| </ul> |
| <a name="values"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>values</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> values</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="CayenneDataObject--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>CayenneDataObject</h4> |
| <pre>public CayenneDataObject()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="setPersistenceState-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPersistenceState</h4> |
| <pre>public void setPersistenceState(int persistenceState)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../org/apache/cayenne/Persistent.html#setPersistenceState-int-">setPersistenceState</a></code> in interface <code><a href="../../../org/apache/cayenne/Persistent.html" title="interface in org.apache.cayenne">Persistent</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../org/apache/cayenne/PersistentObject.html#setPersistenceState-int-">setPersistenceState</a></code> in class <code><a href="../../../org/apache/cayenne/PersistentObject.html" title="class in org.apache.cayenne">PersistentObject</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="readNestedProperty-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readNestedProperty</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> readNestedProperty(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> path)</pre> |
| <div class="block">Returns a value of the property identified by a property path. Supports |
| reading both mapped and unmapped properties. Unmapped properties are |
| accessed in a manner consistent with JavaBeans specification. |
| <p> |
| Property path (or nested property) is a dot-separated path used to |
| traverse object relationships until the final object is found. If a null |
| object found while traversing path, null is returned. If a list is |
| encountered in the middle of the path, CayenneRuntimeException is thrown. |
| Unlike <a href="../../../org/apache/cayenne/CayenneDataObject.html#readPropertyDirectly-java.lang.String-"><code>readPropertyDirectly(String)</code></a>, this method will resolve an |
| object if it is HOLLOW. |
| <p> |
| Examples: |
| </p> |
| <ul> |
| <li>Read this object property:<br> |
| <code>String name = (String)artist.readNestedProperty("name");</code><br> |
| <br> |
| </li> |
| <li>Read an object related to this object:<br> |
| <code>Gallery g = (Gallery)paintingInfo.readNestedProperty("toPainting.toGallery");</code> |
| <br> |
| <br> |
| </li> |
| <li>Read a property of an object related to this object: <br> |
| <code>String name = (String)painting.readNestedProperty("toArtist.artistName");</code> |
| <br> |
| <br> |
| </li> |
| <li>Read to-many relationship list:<br> |
| <code>List exhibits = (List)painting.readNestedProperty("toGallery.exhibitArray");</code> |
| <br> |
| <br> |
| </li> |
| <li>Read to-many relationship in the middle of the path:<br> |
| <code>List<String> names = (List<String>)artist.readNestedProperty("paintingArray.paintingName");</code> |
| <br> |
| <br> |
| </li> |
| </ul></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../org/apache/cayenne/DataObject.html#readNestedProperty-java.lang.String-">readNestedProperty</a></code> in interface <code><a href="../../../org/apache/cayenne/DataObject.html" title="interface in org.apache.cayenne">DataObject</a></code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0.5</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="readProperty-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readProperty</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> readProperty(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> propertyName)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../org/apache/cayenne/DataObject.html#readProperty-java.lang.String-">DataObject</a></code></span></div> |
| <div class="block">Returns a value of the property identified by propName. Resolves faults if needed. |
| This method can safely be used instead of or in addition to the auto-generated |
| property accessors in subclasses of CayenneDataObject.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../org/apache/cayenne/DataObject.html#readProperty-java.lang.String-">readProperty</a></code> in interface <code><a href="../../../org/apache/cayenne/DataObject.html" title="interface in org.apache.cayenne">DataObject</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="readPropertyDirectly-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readPropertyDirectly</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> readPropertyDirectly(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> propName)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../org/apache/cayenne/DataObject.html#readPropertyDirectly-java.lang.String-">DataObject</a></code></span></div> |
| <div class="block">Returns mapped property value as curently stored in the DataObject. Returned value |
| maybe a fault or a real value. This method will not attempt to resolve faults, or |
| to read unmapped properties.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../org/apache/cayenne/DataObject.html#readPropertyDirectly-java.lang.String-">readPropertyDirectly</a></code> in interface <code><a href="../../../org/apache/cayenne/DataObject.html" title="interface in org.apache.cayenne">DataObject</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="writeProperty-java.lang.String-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeProperty</h4> |
| <pre>public void writeProperty(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> propName, |
| <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> val)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../org/apache/cayenne/DataObject.html#writeProperty-java.lang.String-java.lang.Object-">DataObject</a></code></span></div> |
| <div class="block">Sets the property to the new value. Resolves faults if needed. This method can be |
| safely used instead of or in addition to the auto-generated property modifiers to |
| set simple properties. Note that to set to-one relationships use |
| <a href="../../../org/apache/cayenne/DataObject.html#setToOneTarget-java.lang.String-org.apache.cayenne.DataObject-boolean-"><code>DataObject.setToOneTarget(String, DataObject, boolean)</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../org/apache/cayenne/DataObject.html#writeProperty-java.lang.String-java.lang.Object-">writeProperty</a></code> in interface <code><a href="../../../org/apache/cayenne/DataObject.html" title="interface in org.apache.cayenne">DataObject</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>propName</code> - a name of the bean property being modified.</dd> |
| <dd><code>val</code> - a new value of the property.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="writePropertyDirectly-java.lang.String-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writePropertyDirectly</h4> |
| <pre>public void writePropertyDirectly(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> propName, |
| <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> val)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../org/apache/cayenne/DataObject.html#writePropertyDirectly-java.lang.String-java.lang.Object-">DataObject</a></code></span></div> |
| <div class="block">Modifies a value of a named property without altering the object state in any way, |
| and without triggering any database operations. This method is intended mostly for |
| internal use by Cayenne framework, and shouldn't be called from the application |
| code.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../org/apache/cayenne/DataObject.html#writePropertyDirectly-java.lang.String-java.lang.Object-">writePropertyDirectly</a></code> in interface <code><a href="../../../org/apache/cayenne/DataObject.html" title="interface in org.apache.cayenne">DataObject</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeToManyTarget-java.lang.String-org.apache.cayenne.DataObject-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeToManyTarget</h4> |
| <pre>public void removeToManyTarget(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> relName, |
| <a href="../../../org/apache/cayenne/DataObject.html" title="interface in org.apache.cayenne">DataObject</a> value, |
| boolean setReverse)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../org/apache/cayenne/DataObject.html#removeToManyTarget-java.lang.String-org.apache.cayenne.DataObject-boolean-">DataObject</a></code></span></div> |
| <div class="block">Removes an object from a to-many relationship.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../org/apache/cayenne/DataObject.html#removeToManyTarget-java.lang.String-org.apache.cayenne.DataObject-boolean-">removeToManyTarget</a></code> in interface <code><a href="../../../org/apache/cayenne/DataObject.html" title="interface in org.apache.cayenne">DataObject</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addToManyTarget-java.lang.String-org.apache.cayenne.DataObject-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addToManyTarget</h4> |
| <pre>public void addToManyTarget(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> relName, |
| <a href="../../../org/apache/cayenne/DataObject.html" title="interface in org.apache.cayenne">DataObject</a> value, |
| boolean setReverse)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../org/apache/cayenne/DataObject.html#addToManyTarget-java.lang.String-org.apache.cayenne.DataObject-boolean-">DataObject</a></code></span></div> |
| <div class="block">Adds an object to a to-many relationship.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../org/apache/cayenne/DataObject.html#addToManyTarget-java.lang.String-org.apache.cayenne.DataObject-boolean-">addToManyTarget</a></code> in interface <code><a href="../../../org/apache/cayenne/DataObject.html" title="interface in org.apache.cayenne">DataObject</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setToManyTarget-java.lang.String-java.util.Collection-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setToManyTarget</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><? extends <a href="../../../org/apache/cayenne/DataObject.html" title="interface in org.apache.cayenne">DataObject</a>> setToManyTarget(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> relName, |
| <a href="https://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><? extends <a href="../../../org/apache/cayenne/DataObject.html" title="interface in org.apache.cayenne">DataObject</a>> values, |
| boolean setReverse)</pre> |
| <div class="block">Sets the relationships to the specified <code>DataObject</code> objects. |
| |
| <p> |
| New relationships will be created with |
| <a href="../../../org/apache/cayenne/CayenneDataObject.html#addToManyTarget-java.lang.String-org.apache.cayenne.DataObject-boolean-"><code>addToManyTarget(String, org.apache.cayenne.DataObject, boolean)</code></a>, |
| already established relationships stay untouched. Missing relationships |
| will be removed with |
| <a href="../../../org/apache/cayenne/CayenneDataObject.html#removeToManyTarget-java.lang.String-org.apache.cayenne.DataObject-boolean-"><code>removeToManyTarget(String, org.apache.cayenne.DataObject, boolean)</code></a> |
| and returnd as List. You may delete them manually. |
| </p> |
| |
| <p> |
| Notice: Moving an object relationship to another object, is still needing |
| an manually "unregister" from the first object by |
| <a href="../../../org/apache/cayenne/CayenneDataObject.html#removeToManyTarget-java.lang.String-org.apache.cayenne.DataObject-boolean-"><code>removeToManyTarget(String, org.apache.cayenne.DataObject, boolean)</code></a> |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>relName</code> - name of the relation</dd> |
| <dd><code>values</code> - <code>DataObject</code> objects of this |
| <code>Collection</code> are set to the object. No changes will |
| be made to the the <code>Collection</code>, a copy is used. It |
| is safe to pass a persisted <code>Collection</code> of another |
| object.</dd> |
| <dd><code>setReverse</code> - update reverse relationships</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>List<? extends DataObject></code> of unrelated |
| DataObjects. If no relationship was removed an empty List is |
| returned.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if no relationship could be read by relName, or if the passed |
| <code>Collection</code> is null. To clear all relationships |
| use an empty <code>Collection</code></dd> |
| <dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - if the relation Collection Type is neither |
| <code>java.util.Collection</code> nor |
| <code>java.util.Map</code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setToOneTarget-java.lang.String-org.apache.cayenne.DataObject-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setToOneTarget</h4> |
| <pre>public void setToOneTarget(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> relationshipName, |
| <a href="../../../org/apache/cayenne/DataObject.html" title="interface in org.apache.cayenne">DataObject</a> value, |
| boolean setReverse)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../org/apache/cayenne/DataObject.html#setToOneTarget-java.lang.String-org.apache.cayenne.DataObject-boolean-">DataObject</a></code></span></div> |
| <div class="block">Sets to-one relationship to a new value. Resolves faults if needed. This method can |
| safely be used instead of or in addition to the auto-generated property modifiers |
| to set properties that are to-one relationships.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../org/apache/cayenne/DataObject.html#setToOneTarget-java.lang.String-org.apache.cayenne.DataObject-boolean-">setToOneTarget</a></code> in interface <code><a href="../../../org/apache/cayenne/DataObject.html" title="interface in org.apache.cayenne">DataObject</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>relationshipName</code> - a name of the bean property being modified - same as the |
| name of ObjRelationship.</dd> |
| <dd><code>value</code> - a new value of the property.</dd> |
| <dd><code>setReverse</code> - whether to update the reverse relationship pointing from the old |
| and new values of the property to this object.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="willConnect-java.lang.String-org.apache.cayenne.Persistent-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>willConnect</h4> |
| <pre>protected void willConnect(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> relationshipName, |
| <a href="../../../org/apache/cayenne/Persistent.html" title="interface in org.apache.cayenne">Persistent</a> object)</pre> |
| <div class="block">Called before establishing a relationship with another object. Applies |
| "persistence by reachability" logic, pulling one of the two objects to a |
| DataConext of another object in case one of the objects is transient. If |
| both objects are persistent, and they don't have the same DataContext, |
| CayenneRuntimeException is thrown.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setReverseRelationship-java.lang.String-org.apache.cayenne.DataObject-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setReverseRelationship</h4> |
| <pre>protected void setReverseRelationship(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> relName, |
| <a href="../../../org/apache/cayenne/DataObject.html" title="interface in org.apache.cayenne">DataObject</a> val)</pre> |
| <div class="block">Initializes reverse relationship from object <code>val</code> to this |
| object.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>relName</code> - name of relationship from this object to <code>val</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="unsetReverseRelationship-java.lang.String-org.apache.cayenne.DataObject-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unsetReverseRelationship</h4> |
| <pre>protected void unsetReverseRelationship(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> relName, |
| <a href="../../../org/apache/cayenne/DataObject.html" title="interface in org.apache.cayenne">DataObject</a> val)</pre> |
| <div class="block">Removes current object from reverse relationship of object |
| <code>val</code> to this object.</div> |
| </li> |
| </ul> |
| <a name="toStringBuffer-java.lang.StringBuffer-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toStringBuffer</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/StringBuffer.html?is-external=true" title="class or interface in java.lang">StringBuffer</a> toStringBuffer(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/StringBuffer.html?is-external=true" title="class or interface in java.lang">StringBuffer</a> buffer, |
| boolean fullDesc)</pre> |
| <div class="block">A variation of "toString" method, that may be more efficient in some |
| cases. For example when printing a list of objects into the same String.</div> |
| </li> |
| </ul> |
| <a name="appendProperties-java.lang.StringBuffer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>appendProperties</h4> |
| <pre>protected void appendProperties(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/StringBuffer.html?is-external=true" title="class or interface in java.lang">StringBuffer</a> buffer)</pre> |
| </li> |
| </ul> |
| <a name="toString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> toString()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../org/apache/cayenne/PersistentObject.html#toString--">toString</a></code> in class <code><a href="../../../org/apache/cayenne/PersistentObject.html" title="class in org.apache.cayenne">PersistentObject</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSnapshotVersion--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSnapshotVersion</h4> |
| <pre>public long getSnapshotVersion()</pre> |
| <div class="block">Returns a version of a DataRow snapshot that was used to create this |
| object.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../org/apache/cayenne/DataObject.html#getSnapshotVersion--">getSnapshotVersion</a></code> in interface <code><a href="../../../org/apache/cayenne/DataObject.html" title="interface in org.apache.cayenne">DataObject</a></code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSnapshotVersion-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSnapshotVersion</h4> |
| <pre>public void setSnapshotVersion(long snapshotVersion)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../org/apache/cayenne/DataObject.html#setSnapshotVersion-long-">setSnapshotVersion</a></code> in interface <code><a href="../../../org/apache/cayenne/DataObject.html" title="interface in org.apache.cayenne">DataObject</a></code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="makePath-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>makePath</h4> |
| <pre>public static <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> makePath(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... pathParts)</pre> |
| <div class="block">Convenience method to invoke <a href="../../../org/apache/cayenne/Cayenne.html#makePath-java.lang.String...-"><code>Cayenne.makePath(String...)</code></a> from |
| within a DataObject subclass to create a dotted path using the generated |
| string constants for attributes and relationships.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.1</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../org/apache/cayenne/Cayenne.html#makePath-java.lang.String...-"><code>Cayenne.makePath(String...)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="validateForSave-org.apache.cayenne.validation.ValidationResult-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validateForSave</h4> |
| <pre>protected void validateForSave(<a href="../../../org/apache/cayenne/validation/ValidationResult.html" title="class in org.apache.cayenne.validation">ValidationResult</a> validationResult)</pre> |
| <div class="block">Performs property validation of the object, appending any validation |
| failures to the provided validationResult object. This method is invoked |
| from "validateFor.." before committing a NEW or MODIFIED object to the |
| database. Validation includes checking for null values and value sizes. |
| CayenneDataObject subclasses may override this method, calling super.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="validateForInsert-org.apache.cayenne.validation.ValidationResult-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validateForInsert</h4> |
| <pre>public void validateForInsert(<a href="../../../org/apache/cayenne/validation/ValidationResult.html" title="class in org.apache.cayenne.validation">ValidationResult</a> validationResult)</pre> |
| <div class="block">Calls <a href="../../../org/apache/cayenne/CayenneDataObject.html#validateForSave-org.apache.cayenne.validation.ValidationResult-"><code>validateForSave(ValidationResult)</code></a>. CayenneDataObject |
| subclasses may override it providing validation logic that should be |
| executed for the newly created objects before saving them.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../org/apache/cayenne/Validating.html#validateForInsert-org.apache.cayenne.validation.ValidationResult-">validateForInsert</a></code> in interface <code><a href="../../../org/apache/cayenne/Validating.html" title="interface in org.apache.cayenne">Validating</a></code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="validateForUpdate-org.apache.cayenne.validation.ValidationResult-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validateForUpdate</h4> |
| <pre>public void validateForUpdate(<a href="../../../org/apache/cayenne/validation/ValidationResult.html" title="class in org.apache.cayenne.validation">ValidationResult</a> validationResult)</pre> |
| <div class="block">Calls <a href="../../../org/apache/cayenne/CayenneDataObject.html#validateForSave-org.apache.cayenne.validation.ValidationResult-"><code>validateForSave(ValidationResult)</code></a>. CayenneDataObject |
| subclasses may override it providing validation logic that should be |
| executed for the modified objects before saving them.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../org/apache/cayenne/Validating.html#validateForUpdate-org.apache.cayenne.validation.ValidationResult-">validateForUpdate</a></code> in interface <code><a href="../../../org/apache/cayenne/Validating.html" title="interface in org.apache.cayenne">Validating</a></code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="validateForDelete-org.apache.cayenne.validation.ValidationResult-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validateForDelete</h4> |
| <pre>public void validateForDelete(<a href="../../../org/apache/cayenne/validation/ValidationResult.html" title="class in org.apache.cayenne.validation">ValidationResult</a> validationResult)</pre> |
| <div class="block">This implementation does nothing. CayenneDataObject subclasses may |
| override it providing validation logic that should be executed for the |
| deleted objects before committing them.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../org/apache/cayenne/Validating.html#validateForDelete-org.apache.cayenne.validation.ValidationResult-">validateForDelete</a></code> in interface <code><a href="../../../org/apache/cayenne/Validating.html" title="interface in org.apache.cayenne">Validating</a></code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setObjectContext-org.apache.cayenne.ObjectContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setObjectContext</h4> |
| <pre>public void setObjectContext(<a href="../../../org/apache/cayenne/ObjectContext.html" title="interface in org.apache.cayenne">ObjectContext</a> objectContext)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../org/apache/cayenne/Persistent.html#setObjectContext-org.apache.cayenne.ObjectContext-">setObjectContext</a></code> in interface <code><a href="../../../org/apache/cayenne/Persistent.html" title="interface in org.apache.cayenne">Persistent</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../org/apache/cayenne/PersistentObject.html#setObjectContext-org.apache.cayenne.ObjectContext-">setObjectContext</a></code> in class <code><a href="../../../org/apache/cayenne/PersistentObject.html" title="class in org.apache.cayenne">PersistentObject</a></code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.2</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/CayenneDataObject.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../index-all.html">Index</a></li> |
| <li><a href="../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../org/apache/cayenne/CayenneContext.html" title="class in org.apache.cayenne"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../org/apache/cayenne/CayenneException.html" title="class in org.apache.cayenne"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/apache/cayenne/CayenneDataObject.html" target="_top">Frames</a></li> |
| <li><a href="CayenneDataObject.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <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 name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2001–2019 <a href="http://cayenne.apache.org/">Apache Cayenne</a>. All rights reserved.</small></p> |
| </body> |
| </html> |