| <!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 (version 1.7.0_67) on Sat Sep 20 17:22:59 FET 2014 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>EmbeddedAttribute (Cayenne Documentation 3.1 API)</title> |
| <meta name="date" content="2014-09-20"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="EmbeddedAttribute (Cayenne Documentation 3.1 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/EmbeddedAttribute.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/EmbeddableAttribute.html" title="class in org.apache.cayenne.map"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/cayenne/map/Entity.html" title="class in org.apache.cayenne.map"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/cayenne/map/EmbeddedAttribute.html" target="_top">Frames</a></li> |
| <li><a href="EmbeddedAttribute.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 EmbeddedAttribute" class="title">Class EmbeddedAttribute</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/1.5.0/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><a href="../../../../org/apache/cayenne/map/ObjAttribute.html" title="class in org.apache.cayenne.map">org.apache.cayenne.map.ObjAttribute</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.cayenne.map.EmbeddedAttribute</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="http://docs.oracle.com/javase/1.5.0/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> |
| <hr> |
| <br> |
| <pre>public class <span class="strong">EmbeddedAttribute</span> |
| extends <a href="../../../../org/apache/cayenne/map/ObjAttribute.html" title="class in org.apache.cayenne.map">ObjAttribute</a></pre> |
| <div class="block">An attribute of the ObjEntity that maps to an embeddable class.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.0</dd> |
| <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../serialized-form.html#org.apache.cayenne.map.EmbeddedAttribute">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="overviewSummary" 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="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util">SortedMap</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/map/EmbeddedAttribute.html#attributeOverrides">attributeOverrides</a></strong></code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields_inherited_from_class_org.apache.cayenne.map.ObjAttribute"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.cayenne.map.<a href="../../../../org/apache/cayenne/map/ObjAttribute.html" title="class in org.apache.cayenne.map">ObjAttribute</a></h3> |
| <code><a href="../../../../org/apache/cayenne/map/ObjAttribute.html#dbAttributePath">dbAttributePath</a>, <a href="../../../../org/apache/cayenne/map/ObjAttribute.html#type">type</a>, <a href="../../../../org/apache/cayenne/map/ObjAttribute.html#usedForLocking">usedForLocking</a></code></li> |
| </ul> |
| <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="overviewSummary" 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><strong><a href="../../../../org/apache/cayenne/map/EmbeddedAttribute.html#EmbeddedAttribute()">EmbeddedAttribute</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/apache/cayenne/map/EmbeddedAttribute.html#EmbeddedAttribute(java.lang.String)">EmbeddedAttribute</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/apache/cayenne/map/EmbeddedAttribute.html#EmbeddedAttribute(java.lang.String,%20java.lang.String,%20org.apache.cayenne.map.ObjEntity)">EmbeddedAttribute</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="http://docs.oracle.com/javase/1.5.0/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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/map/EmbeddedAttribute.html#addAttributeOverride(java.lang.String,%20java.lang.String)">addAttributeOverride</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> dbAttributeName)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/map/EmbeddedAttribute.html#encodeAsXML(org.apache.cayenne.util.XMLEncoder)">encodeAsXML</a></strong>(<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 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><strong><a href="../../../../org/apache/cayenne/map/EmbeddedAttribute.html#getAttribute(java.lang.String)">getAttribute</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> |
| <div class="block">Returns an ObjAttribute for a given name, taking into account column name |
| overrides.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <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><strong><a href="../../../../org/apache/cayenne/map/EmbeddedAttribute.html#getAttributeForDbPath(java.lang.String)">getAttributeForDbPath</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> dbPath)</code> |
| <div class="block">Returns an ObjAttribute that maps to a given <a href="../../../../org/apache/cayenne/map/DbAttribute.html" title="class in org.apache.cayenne.map"><code>DbAttribute</code></a>, or returns null |
| if no such attribute exists.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/map/EmbeddedAttribute.html#getAttributeOverrides()">getAttributeOverrides</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/cayenne/map/ObjAttribute.html" title="class in org.apache.cayenne.map">ObjAttribute</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/map/EmbeddedAttribute.html#getAttributes()">getAttributes</a></strong>()</code> |
| <div class="block">Returns a Collection of ObjAttributes of an embedded object taking into account |
| column name overrides.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/map/Embeddable.html" title="class in org.apache.cayenne.map">Embeddable</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/map/EmbeddedAttribute.html#getEmbeddable()">getEmbeddable</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/map/EmbeddedAttribute.html#getJavaClass()">getJavaClass</a></strong>()</code> |
| <div class="block">Returns Java class of an object property described by this attribute.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/map/EmbeddedAttribute.html#getType()">getType</a></strong>()</code> |
| <div class="block">Returns a type of this attribute that must be an <a href="../../../../org/apache/cayenne/map/Embeddable.html" title="class in org.apache.cayenne.map"><code>Embeddable</code></a> object.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/map/EmbeddedAttribute.html#removeAttributeOverride(java.lang.String)">removeAttributeOverride</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/map/EmbeddedAttribute.html#setType(java.lang.String)">setType</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> type)</code> |
| <div class="block">Sets a type of this attribute that must be an <a href="../../../../org/apache/cayenne/map/Embeddable.html" title="class in org.apache.cayenne.map"><code>Embeddable</code></a> object.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.cayenne.map.ObjAttribute"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.cayenne.map.<a href="../../../../org/apache/cayenne/map/ObjAttribute.html" title="class in org.apache.cayenne.map">ObjAttribute</a></h3> |
| <code><a href="../../../../org/apache/cayenne/map/ObjAttribute.html#acceptVisitor(org.apache.cayenne.configuration.ConfigurationNodeVisitor)">acceptVisitor</a>, <a href="../../../../org/apache/cayenne/map/ObjAttribute.html#getClientAttribute()">getClientAttribute</a>, <a href="../../../../org/apache/cayenne/map/ObjAttribute.html#getDbAttribute()">getDbAttribute</a>, <a href="../../../../org/apache/cayenne/map/ObjAttribute.html#getDbAttributeName()">getDbAttributeName</a>, <a href="../../../../org/apache/cayenne/map/ObjAttribute.html#getDbAttributePath()">getDbAttributePath</a>, <a href="../../../../org/apache/cayenne/map/ObjAttribute.html#getDbPathIterator()">getDbPathIterator</a>, <a href="../../../../org/apache/cayenne/map/ObjAttribute.html#getDbPathIterator(org.apache.cayenne.map.ObjEntity)">getDbPathIterator</a>, <a href="../../../../org/apache/cayenne/map/ObjAttribute.html#getMaxLength()">getMaxLength</a>, <a href="../../../../org/apache/cayenne/map/ObjAttribute.html#isFlattened()">isFlattened</a>, <a href="../../../../org/apache/cayenne/map/ObjAttribute.html#isInherited()">isInherited</a>, <a href="../../../../org/apache/cayenne/map/ObjAttribute.html#isMandatory()">isMandatory</a>, <a href="../../../../org/apache/cayenne/map/ObjAttribute.html#isPrimaryKey()">isPrimaryKey</a>, <a href="../../../../org/apache/cayenne/map/ObjAttribute.html#isUsedForLocking()">isUsedForLocking</a>, <a href="../../../../org/apache/cayenne/map/ObjAttribute.html#setDbAttributePath(java.lang.String)">setDbAttributePath</a>, <a href="../../../../org/apache/cayenne/map/ObjAttribute.html#setUsedForLocking(boolean)">setUsedForLocking</a>, <a href="../../../../org/apache/cayenne/map/ObjAttribute.html#updateDbAttributePath()">updateDbAttributePath</a></code></li> |
| </ul> |
| <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#getEntity()">getEntity</a>, <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>, <a href="../../../../org/apache/cayenne/map/Attribute.html#toString()">toString</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="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" 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="attributeOverrides"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>attributeOverrides</h4> |
| <pre>protected <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util">SortedMap</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> attributeOverrides</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="EmbeddedAttribute()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>EmbeddedAttribute</h4> |
| <pre>public EmbeddedAttribute()</pre> |
| </li> |
| </ul> |
| <a name="EmbeddedAttribute(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>EmbeddedAttribute</h4> |
| <pre>public EmbeddedAttribute(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| </li> |
| </ul> |
| <a name="EmbeddedAttribute(java.lang.String, java.lang.String, org.apache.cayenne.map.ObjEntity)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>EmbeddedAttribute</h4> |
| <pre>public EmbeddedAttribute(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="http://docs.oracle.com/javase/1.5.0/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> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <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"><strong>Description copied from class: <code><a href="../../../../org/apache/cayenne/map/ObjAttribute.html#encodeAsXML(org.apache.cayenne.util.XMLEncoder)">ObjAttribute</a></code></strong></div> |
| <div class="block">Prints itself as XML to the provided XMLEncoder.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></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><strong>Overrides:</strong></dt> |
| <dd><code><a href="../../../../org/apache/cayenne/map/ObjAttribute.html#encodeAsXML(org.apache.cayenne.util.XMLEncoder)">encodeAsXML</a></code> in class <code><a href="../../../../org/apache/cayenne/map/ObjAttribute.html" title="class in org.apache.cayenne.map">ObjAttribute</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAttributeOverrides()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAttributeOverrides</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> getAttributeOverrides()</pre> |
| </li> |
| </ul> |
| <a name="getEmbeddable()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEmbeddable</h4> |
| <pre>public <a href="../../../../org/apache/cayenne/map/Embeddable.html" title="class in org.apache.cayenne.map">Embeddable</a> getEmbeddable()</pre> |
| </li> |
| </ul> |
| <a name="getAttributeForDbPath(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAttributeForDbPath</h4> |
| <pre>public <a href="../../../../org/apache/cayenne/map/ObjAttribute.html" title="class in org.apache.cayenne.map">ObjAttribute</a> getAttributeForDbPath(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> dbPath)</pre> |
| <div class="block">Returns an ObjAttribute that maps to a given <a href="../../../../org/apache/cayenne/map/DbAttribute.html" title="class in org.apache.cayenne.map"><code>DbAttribute</code></a>, or returns null |
| if no such attribute exists.</div> |
| </li> |
| </ul> |
| <a name="getAttribute(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAttribute</h4> |
| <pre>public <a href="../../../../org/apache/cayenne/map/ObjAttribute.html" title="class in org.apache.cayenne.map">ObjAttribute</a> getAttribute(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| <div class="block">Returns an ObjAttribute for a given name, taking into account column name |
| overrides.</div> |
| </li> |
| </ul> |
| <a name="getAttributes()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAttributes</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/cayenne/map/ObjAttribute.html" title="class in org.apache.cayenne.map">ObjAttribute</a>> getAttributes()</pre> |
| <div class="block">Returns a Collection of ObjAttributes of an embedded object taking into account |
| column name overrides.</div> |
| </li> |
| </ul> |
| <a name="addAttributeOverride(java.lang.String, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addAttributeOverride</h4> |
| <pre>public void addAttributeOverride(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> dbAttributeName)</pre> |
| </li> |
| </ul> |
| <a name="removeAttributeOverride(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeAttributeOverride</h4> |
| <pre>public void removeAttributeOverride(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| </li> |
| </ul> |
| <a name="getType()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getType</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getType()</pre> |
| <div class="block">Returns a type of this attribute that must be an <a href="../../../../org/apache/cayenne/map/Embeddable.html" title="class in org.apache.cayenne.map"><code>Embeddable</code></a> object.</div> |
| <dl> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code><a href="../../../../org/apache/cayenne/map/ObjAttribute.html#getType()">getType</a></code> in class <code><a href="../../../../org/apache/cayenne/map/ObjAttribute.html" title="class in org.apache.cayenne.map">ObjAttribute</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getJavaClass()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getJavaClass</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/1.5.0/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> |
| <dl> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code><a href="../../../../org/apache/cayenne/map/ObjAttribute.html#getJavaClass()">getJavaClass</a></code> in class <code><a href="../../../../org/apache/cayenne/map/ObjAttribute.html" title="class in org.apache.cayenne.map">ObjAttribute</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setType(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setType</h4> |
| <pre>public void setType(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> type)</pre> |
| <div class="block">Sets a type of this attribute that must be an <a href="../../../../org/apache/cayenne/map/Embeddable.html" title="class in org.apache.cayenne.map"><code>Embeddable</code></a> object.</div> |
| <dl> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code><a href="../../../../org/apache/cayenne/map/ObjAttribute.html#setType(java.lang.String)">setType</a></code> in class <code><a href="../../../../org/apache/cayenne/map/ObjAttribute.html" title="class in org.apache.cayenne.map">ObjAttribute</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/EmbeddedAttribute.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/EmbeddableAttribute.html" title="class in org.apache.cayenne.map"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/cayenne/map/Entity.html" title="class in org.apache.cayenne.map"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/cayenne/map/EmbeddedAttribute.html" target="_top">Frames</a></li> |
| <li><a href="EmbeddedAttribute.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–2014 <a href="http://cayenne.apache.org/">Apache Cayenne</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
