| <!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_111) on Thu Dec 20 16:00:54 MSK 2018 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>ObjAttribute (cayenne-doc: Cayenne Documentation 4.0.1 API)</title> |
| <meta name="date" content="2018-12-20"> |
| <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="ObjAttribute (cayenne-doc: Cayenne Documentation 4.0.1 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"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}; |
| var tabs = {65535:["t0","All 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/ObjAttribute.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/map/MappingNamespace.html" title="interface in org.apache.cayenne.map"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/cayenne/map/ObjEntity.html" title="class in org.apache.cayenne.map"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/cayenne/map/ObjAttribute.html" target="_top">Frames</a></li> |
| <li><a href="ObjAttribute.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.map</div> |
| <h2 title="Class ObjAttribute" class="title">Class ObjAttribute</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/map/Attribute.html" title="class in org.apache.cayenne.map">org.apache.cayenne.map.Attribute</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.cayenne.map.ObjAttribute</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/configuration/ConfigurationNode.html" title="interface in org.apache.cayenne.configuration">ConfigurationNode</a>, <a href="../../../../org/apache/cayenne/util/CayenneMapEntry.html" title="interface in org.apache.cayenne.util">CayenneMapEntry</a>, <a href="../../../../org/apache/cayenne/util/XMLSerializable.html" title="interface in org.apache.cayenne.util">XMLSerializable</a></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../org/apache/cayenne/map/EmbeddedAttribute.html" title="class in org.apache.cayenne.map">EmbeddedAttribute</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">ObjAttribute</span> |
| extends <a href="../../../../org/apache/cayenne/map/Attribute.html" title="class in org.apache.cayenne.map">Attribute</a> |
| implements <a href="../../../../org/apache/cayenne/configuration/ConfigurationNode.html" title="interface in org.apache.cayenne.configuration">ConfigurationNode</a></pre> |
| <div class="block">An ObjAttribute is a mapping descriptor of a Java class property.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../serialized-form.html#org.apache.cayenne.map.ObjAttribute">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 <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/map/ObjAttribute.html#dbAttributePath">dbAttributePath</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <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/map/ObjAttribute.html#type">type</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/map/ObjAttribute.html#usedForLocking">usedForLocking</a></span></code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.cayenne.map.Attribute"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.cayenne.map.<a href="../../../../org/apache/cayenne/map/Attribute.html" title="class in org.apache.cayenne.map">Attribute</a></h3> |
| <code><a href="../../../../org/apache/cayenne/map/Attribute.html#entity">entity</a>, <a href="../../../../org/apache/cayenne/map/Attribute.html#name">name</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/map/ObjAttribute.html#ObjAttribute--">ObjAttribute</a></span>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/map/ObjAttribute.html#ObjAttribute-org.apache.cayenne.map.ObjAttribute-">ObjAttribute</a></span>(<a href="../../../../org/apache/cayenne/map/ObjAttribute.html" title="class in org.apache.cayenne.map">ObjAttribute</a> attribute)</code> |
| <div class="block">Creates a clone of an ObjAttribute argument.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/map/ObjAttribute.html#ObjAttribute-java.lang.String-">ObjAttribute</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> name)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/map/ObjAttribute.html#ObjAttribute-java.lang.String-java.lang.String-org.apache.cayenne.map.ObjEntity-">ObjAttribute</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> name, |
| <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> type, |
| <a href="../../../../org/apache/cayenne/map/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</a> entity)</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="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><T> T</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/map/ObjAttribute.html#acceptVisitor-org.apache.cayenne.configuration.ConfigurationNodeVisitor-">acceptVisitor</a></span>(<a href="../../../../org/apache/cayenne/configuration/ConfigurationNodeVisitor.html" title="interface in org.apache.cayenne.configuration">ConfigurationNodeVisitor</a><T> visitor)</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/map/ObjAttribute.html#encodeAsXML-org.apache.cayenne.util.XMLEncoder-">encodeAsXML</a></span>(<a href="../../../../org/apache/cayenne/util/XMLEncoder.html" title="class in org.apache.cayenne.util">XMLEncoder</a> encoder)</code> |
| <div class="block">Prints itself as XML to the provided XMLEncoder.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/map/ObjAttribute.html" title="class in org.apache.cayenne.map">ObjAttribute</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/map/ObjAttribute.html#getClientAttribute--">getClientAttribute</a></span>()</code> |
| <div class="block">Returns an ObjAttribute stripped of any server-side information, such as |
| DbAttribute mapping.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/map/DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/map/ObjAttribute.html#getDbAttribute--">getDbAttribute</a></span>()</code> |
| <div class="block">Returns a DbAttribute mapped by this ObjAttribute.</div> |
| </td> |
| </tr> |
| <tr id="i4" 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/map/ObjAttribute.html#getDbAttributeName--">getDbAttributeName</a></span>()</code> |
| <div class="block">Returns the the name of the mapped DbAttribute.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <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/map/ObjAttribute.html#getDbAttributePath--">getDbAttributePath</a></span>()</code> |
| <div class="block">Returns a dot-separated path that starts in the root DbEntity that maps |
| to this attribute's ObjEntity and spans zero or more relationships, |
| always ending in a DbAttribute name.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a><<a href="../../../../org/apache/cayenne/util/CayenneMapEntry.html" title="interface in org.apache.cayenne.util">CayenneMapEntry</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/map/ObjAttribute.html#getDbPathIterator--">getDbPathIterator</a></span>()</code> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a><<a href="../../../../org/apache/cayenne/util/CayenneMapEntry.html" title="interface in org.apache.cayenne.util">CayenneMapEntry</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/map/ObjAttribute.html#getDbPathIterator-org.apache.cayenne.map.ObjEntity-">getDbPathIterator</a></span>(<a href="../../../../org/apache/cayenne/map/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</a> entity)</code> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/map/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/map/ObjAttribute.html#getEntity--">getEntity</a></span>()</code> |
| <div class="block">Returns parent entity that holds this attribute.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/map/ObjAttribute.html#getJavaClass--">getJavaClass</a></span>()</code> |
| <div class="block">Returns Java class of an object property described by this attribute.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/map/ObjAttribute.html#getMaxLength--">getMaxLength</a></span>()</code> |
| <div class="block">Returns this attribute's maximum allowed length</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <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/map/ObjAttribute.html#getType--">getType</a></span>()</code> |
| <div class="block">Returns fully qualified Java class name of the object property |
| represented by this attribute.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/map/ObjAttribute.html#isFlattened--">isFlattened</a></span>()</code> |
| <div class="block">Returns whether this attribute is "flattened", meaning that it points to |
| a column from an entity other than the DbEntity mapped to the parent |
| ObjEntity.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/map/ObjAttribute.html#isInherited--">isInherited</a></span>()</code> |
| <div class="block">Returns <code>true</code> if attribute inherited from a super entity.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/map/ObjAttribute.html#isMandatory--">isMandatory</a></span>()</code> |
| <div class="block">Returns whether this attribute is mandatory</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/map/ObjAttribute.html#isPrimaryKey--">isPrimaryKey</a></span>()</code> </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/map/ObjAttribute.html#isUsedForLocking--">isUsedForLocking</a></span>()</code> |
| <div class="block">Returns whether this attribute should be used for locking.</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/map/ObjAttribute.html#setDbAttributePath-java.lang.String-">setDbAttributePath</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> dbAttributePath)</code> </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/map/ObjAttribute.html#setType-java.lang.String-">setType</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> type)</code> |
| <div class="block">Sets the type of the data object property.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/map/ObjAttribute.html#setUsedForLocking-boolean-">setUsedForLocking</a></span>(boolean usedForLocking)</code> |
| <div class="block">Sets whether this attribute should be used for locking.</div> |
| </td> |
| </tr> |
| <tr id="i20" 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/map/ObjAttribute.html#toString--">toString</a></span>()</code> </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/cayenne/map/ObjAttribute.html#updateDbAttributePath--">updateDbAttributePath</a></span>()</code> |
| <div class="block">Updates DbAttributePath for this ObjAttribute</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.cayenne.map.Attribute"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.cayenne.map.<a href="../../../../org/apache/cayenne/map/Attribute.html" title="class in org.apache.cayenne.map">Attribute</a></h3> |
| <code><a href="../../../../org/apache/cayenne/map/Attribute.html#getName--">getName</a>, <a href="../../../../org/apache/cayenne/map/Attribute.html#getParent--">getParent</a>, <a href="../../../../org/apache/cayenne/map/Attribute.html#setEntity-org.apache.cayenne.map.Entity-">setEntity</a>, <a href="../../../../org/apache/cayenne/map/Attribute.html#setName-java.lang.String-">setName</a>, <a href="../../../../org/apache/cayenne/map/Attribute.html#setParent-java.lang.Object-">setParent</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> |
| </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="type"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>type</h4> |
| <pre>protected <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> type</pre> |
| </li> |
| </ul> |
| <a name="usedForLocking"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>usedForLocking</h4> |
| <pre>protected boolean usedForLocking</pre> |
| </li> |
| </ul> |
| <a name="dbAttributePath"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>dbAttributePath</h4> |
| <pre>protected <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> dbAttributePath</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="ObjAttribute--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ObjAttribute</h4> |
| <pre>public ObjAttribute()</pre> |
| </li> |
| </ul> |
| <a name="ObjAttribute-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ObjAttribute</h4> |
| <pre>public ObjAttribute(<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> name)</pre> |
| </li> |
| </ul> |
| <a name="ObjAttribute-java.lang.String-java.lang.String-org.apache.cayenne.map.ObjEntity-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ObjAttribute</h4> |
| <pre>public ObjAttribute(<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> name, |
| <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> type, |
| <a href="../../../../org/apache/cayenne/map/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</a> entity)</pre> |
| </li> |
| </ul> |
| <a name="ObjAttribute-org.apache.cayenne.map.ObjAttribute-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ObjAttribute</h4> |
| <pre>public ObjAttribute(<a href="../../../../org/apache/cayenne/map/ObjAttribute.html" title="class in org.apache.cayenne.map">ObjAttribute</a> attribute)</pre> |
| <div class="block">Creates a clone of an ObjAttribute argument.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getEntity--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEntity</h4> |
| <pre>public <a href="../../../../org/apache/cayenne/map/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</a> getEntity()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/cayenne/map/Attribute.html#getEntity--">Attribute</a></code></span></div> |
| <div class="block">Returns parent entity that holds this attribute.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../org/apache/cayenne/map/Attribute.html#getEntity--">getEntity</a></code> in class <code><a href="../../../../org/apache/cayenne/map/Attribute.html" title="class in org.apache.cayenne.map">Attribute</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="acceptVisitor-org.apache.cayenne.configuration.ConfigurationNodeVisitor-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>acceptVisitor</h4> |
| <pre>public <T> T acceptVisitor(<a href="../../../../org/apache/cayenne/configuration/ConfigurationNodeVisitor.html" title="interface in org.apache.cayenne.configuration">ConfigurationNodeVisitor</a><T> visitor)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/cayenne/configuration/ConfigurationNode.html#acceptVisitor-org.apache.cayenne.configuration.ConfigurationNodeVisitor-">acceptVisitor</a></code> in interface <code><a href="../../../../org/apache/cayenne/configuration/ConfigurationNode.html" title="interface in org.apache.cayenne.configuration">ConfigurationNode</a></code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getJavaClass--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getJavaClass</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> getJavaClass()</pre> |
| <div class="block">Returns Java class of an object property described by this attribute. |
| Wraps any thrown exceptions into CayenneRuntimeException.</div> |
| </li> |
| </ul> |
| <a name="encodeAsXML-org.apache.cayenne.util.XMLEncoder-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>encodeAsXML</h4> |
| <pre>public void encodeAsXML(<a href="../../../../org/apache/cayenne/util/XMLEncoder.html" title="class in org.apache.cayenne.util">XMLEncoder</a> encoder)</pre> |
| <div class="block">Prints itself as XML to the provided XMLEncoder.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/cayenne/util/XMLSerializable.html#encodeAsXML-org.apache.cayenne.util.XMLEncoder-">encodeAsXML</a></code> in interface <code><a href="../../../../org/apache/cayenne/util/XMLSerializable.html" title="interface in org.apache.cayenne.util">XMLSerializable</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/cayenne/map/Attribute.html#encodeAsXML-org.apache.cayenne.util.XMLEncoder-">encodeAsXML</a></code> in class <code><a href="../../../../org/apache/cayenne/map/Attribute.html" title="class in org.apache.cayenne.map">Attribute</a></code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getType--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getType</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> getType()</pre> |
| <div class="block">Returns fully qualified Java class name of the object property |
| represented by this attribute.</div> |
| </li> |
| </ul> |
| <a name="setType-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setType</h4> |
| <pre>public void setType(<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> type)</pre> |
| <div class="block">Sets the type of the data object property. Type is expected to be a fully |
| qualified Java class name.</div> |
| </li> |
| </ul> |
| <a name="isPrimaryKey--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isPrimaryKey</h4> |
| <pre>public boolean isPrimaryKey()</pre> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isUsedForLocking--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isUsedForLocking</h4> |
| <pre>public boolean isUsedForLocking()</pre> |
| <div class="block">Returns whether this attribute should be used for locking.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setUsedForLocking-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setUsedForLocking</h4> |
| <pre>public void setUsedForLocking(boolean usedForLocking)</pre> |
| <div class="block">Sets whether this attribute should be used for locking.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDbAttribute--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDbAttribute</h4> |
| <pre>public <a href="../../../../org/apache/cayenne/map/DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</a> getDbAttribute()</pre> |
| <div class="block">Returns a DbAttribute mapped by this ObjAttribute.</div> |
| </li> |
| </ul> |
| <a name="isInherited--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isInherited</h4> |
| <pre>public boolean isInherited()</pre> |
| <div class="block">Returns <code>true</code> if attribute inherited from a super entity.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDbPathIterator--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDbPathIterator</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/7/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a><<a href="../../../../org/apache/cayenne/util/CayenneMapEntry.html" title="interface in org.apache.cayenne.util">CayenneMapEntry</a>> getDbPathIterator()</pre> |
| </li> |
| </ul> |
| <a name="getDbPathIterator-org.apache.cayenne.map.ObjEntity-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDbPathIterator</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/7/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a><<a href="../../../../org/apache/cayenne/util/CayenneMapEntry.html" title="interface in org.apache.cayenne.util">CayenneMapEntry</a>> getDbPathIterator(<a href="../../../../org/apache/cayenne/map/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</a> entity)</pre> |
| </li> |
| </ul> |
| <a name="getDbAttributeName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDbAttributeName</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> getDbAttributeName()</pre> |
| <div class="block">Returns the the name of the mapped DbAttribute. This value is the same as |
| "dbAttributePath" for regular attributes mapped to columns. It is equql |
| to the last path component for the flattened attributes.</div> |
| </li> |
| </ul> |
| <a name="setDbAttributePath-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDbAttributePath</h4> |
| <pre>public void setDbAttributePath(<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> dbAttributePath)</pre> |
| </li> |
| </ul> |
| <a name="getDbAttributePath--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDbAttributePath</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> getDbAttributePath()</pre> |
| <div class="block">Returns a dot-separated path that starts in the root DbEntity that maps |
| to this attribute's ObjEntity and spans zero or more relationships, |
| always ending in a DbAttribute name.</div> |
| </li> |
| </ul> |
| <a name="isFlattened--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isFlattened</h4> |
| <pre>public boolean isFlattened()</pre> |
| <div class="block">Returns whether this attribute is "flattened", meaning that it points to |
| a column from an entity other than the DbEntity mapped to the parent |
| ObjEntity.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isMandatory--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isMandatory</h4> |
| <pre>public boolean isMandatory()</pre> |
| <div class="block">Returns whether this attribute is mandatory</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/cayenne/map/DbAttribute.html#isMandatory--"><code>DbAttribute.isMandatory()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMaxLength--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxLength</h4> |
| <pre>public int getMaxLength()</pre> |
| <div class="block">Returns this attribute's maximum allowed length</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/cayenne/map/DbAttribute.html#getMaxLength--"><code>DbAttribute.getMaxLength()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getClientAttribute--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getClientAttribute</h4> |
| <pre>public <a href="../../../../org/apache/cayenne/map/ObjAttribute.html" title="class in org.apache.cayenne.map">ObjAttribute</a> getClientAttribute()</pre> |
| <div class="block">Returns an ObjAttribute stripped of any server-side information, such as |
| DbAttribute mapping.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="updateDbAttributePath--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>updateDbAttributePath</h4> |
| <pre>public void updateDbAttributePath()</pre> |
| <div class="block">Updates DbAttributePath for this ObjAttribute</div> |
| </li> |
| </ul> |
| <a name="toString--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <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/map/Attribute.html#toString--">toString</a></code> in class <code><a href="../../../../org/apache/cayenne/map/Attribute.html" title="class in org.apache.cayenne.map">Attribute</a></code></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/ObjAttribute.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/map/MappingNamespace.html" title="interface in org.apache.cayenne.map"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/cayenne/map/ObjEntity.html" title="class in org.apache.cayenne.map"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/cayenne/map/ObjAttribute.html" target="_top">Frames</a></li> |
| <li><a href="ObjAttribute.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–2018 <a href="http://cayenne.apache.org/">Apache Cayenne</a>. All rights reserved.</small></p> |
| </body> |
| </html> |