| <!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:56 FET 2014 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>ClassDescriptor (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="ClassDescriptor (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/ClassDescriptor.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/reflect/BeanAccessor.html" title="class in org.apache.cayenne.reflect"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/cayenne/reflect/ClassDescriptorFactory.html" title="interface in org.apache.cayenne.reflect"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/cayenne/reflect/ClassDescriptor.html" target="_top">Frames</a></li> |
| <li><a href="ClassDescriptor.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>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.reflect</div> |
| <h2 title="Interface ClassDescriptor" class="title">Interface ClassDescriptor</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/cayenne/reflect/LazyClassDescriptorDecorator.html" title="class in org.apache.cayenne.reflect">LazyClassDescriptorDecorator</a>, <a href="../../../../org/apache/cayenne/reflect/PersistentDescriptor.html" title="class in org.apache.cayenne.reflect">PersistentDescriptor</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">ClassDescriptor</span></pre> |
| <div class="block">A runtime descriptor of an persistent class.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.2</dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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><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></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/reflect/ClassDescriptor.html#createObject()">createObject</a></strong>()</code> |
| <div class="block">Creates a new instance of a class described by this object.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/reflect/Property.html" title="interface in org.apache.cayenne.reflect">Property</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/reflect/ClassDescriptor.html#getDeclaredProperty(java.lang.String)">getDeclaredProperty</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> propertyName)</code> |
| <div class="block">Returns a Java Bean property descriptor matching property name or null if no such |
| property is found.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <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/reflect/ClassDescriptor.html#getDiscriminatorColumns()">getDiscriminatorColumns</a></strong>()</code> |
| <div class="block">Returns a collection of ObjAttribute for the described class, its superclasses and |
| subclasses, that participate in inheritance qualifier.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <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><strong><a href="../../../../org/apache/cayenne/reflect/ClassDescriptor.html#getEntity()">getEntity</a></strong>()</code> |
| <div class="block">Returns an ObjEntity associated with this descriptor.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/map/EntityInheritanceTree.html" title="class in org.apache.cayenne.map">EntityInheritanceTree</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/reflect/ClassDescriptor.html#getEntityInheritanceTree()">getEntityInheritanceTree</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/reflect/ClassDescriptor.html#getEntityQualifier()">getEntityQualifier</a></strong>()</code> |
| <div class="block">Returns entity qualifier as a Cayenne expression that includes qualifiers for this |
| entity and all subentities.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <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/reflect/AttributeProperty.html" title="interface in org.apache.cayenne.reflect">AttributeProperty</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/reflect/ClassDescriptor.html#getIdProperties()">getIdProperties</a></strong>()</code> |
| <div class="block">Returns a collection of the properties mapped to id columns.</div> |
| </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/reflect/ArcProperty.html" title="interface in org.apache.cayenne.reflect">ArcProperty</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/reflect/ClassDescriptor.html#getMapArcProperties()">getMapArcProperties</a></strong>()</code> |
| <div class="block">Returns a collection over the arc properties whose reverse arcs are to-many maps.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <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/reflect/ClassDescriptor.html#getObjectClass()">getObjectClass</a></strong>()</code> |
| <div class="block">Returns a class mapped by this descriptor.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/reflect/Property.html" title="interface in org.apache.cayenne.reflect">Property</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/reflect/ClassDescriptor.html#getProperty(java.lang.String)">getProperty</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> propertyName)</code> |
| <div class="block">Returns a property descriptor matching property name, or null if no such property |
| is found.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <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/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/reflect/ClassDescriptor.html#getRootDbEntities()">getRootDbEntities</a></strong>()</code> |
| <div class="block">Returns a collection of DbEntities that are the root tables for this descriptor's |
| ObjEntity.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/reflect/ClassDescriptor.html" title="interface in org.apache.cayenne.reflect">ClassDescriptor</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/reflect/ClassDescriptor.html#getSubclassDescriptor(java.lang.Class)">getSubclassDescriptor</a></strong>(<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><?> objectClass)</code> |
| <div class="block">Returns the most "specialized" descriptor for a given class.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/cayenne/reflect/ClassDescriptor.html" title="interface in org.apache.cayenne.reflect">ClassDescriptor</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/reflect/ClassDescriptor.html#getSuperclassDescriptor()">getSuperclassDescriptor</a></strong>()</code> |
| <div class="block">Returns a descriptor of the mapped superclass or null if the descriptor's entity |
| sits at the top of inheritance hierarchy or no inheritance is mapped.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/reflect/ClassDescriptor.html#hasSubclasses()">hasSubclasses</a></strong>()</code> |
| <div class="block">Returns whether this class has persistent subclasses.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/reflect/ClassDescriptor.html#injectValueHolders(java.lang.Object)">injectValueHolders</a></strong>(<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> object)</code> |
| <div class="block">Prepares object properties for access.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/reflect/ClassDescriptor.html#isFault(java.lang.Object)">isFault</a></strong>(<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> object)</code> |
| <div class="block">Returns true if an object is not fully resolved.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/reflect/ClassDescriptor.html#shallowMerge(java.lang.Object,%20java.lang.Object)">shallowMerge</a></strong>(<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> from, |
| <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> to)</code> |
| <div class="block">Merges object properties from one object to another, avoiding traversal of the |
| ArcProperties.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/reflect/ClassDescriptor.html#visitAllProperties(org.apache.cayenne.reflect.PropertyVisitor)">visitAllProperties</a></strong>(<a href="../../../../org/apache/cayenne/reflect/PropertyVisitor.html" title="interface in org.apache.cayenne.reflect">PropertyVisitor</a> visitor)</code> |
| <div class="block">Passes the visitor to the properties "visit" method for a combination of all |
| properties, including properties declared in this descriptor, its super |
| descriptors, and all subdescriptors.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/reflect/ClassDescriptor.html#visitDeclaredProperties(org.apache.cayenne.reflect.PropertyVisitor)">visitDeclaredProperties</a></strong>(<a href="../../../../org/apache/cayenne/reflect/PropertyVisitor.html" title="interface in org.apache.cayenne.reflect">PropertyVisitor</a> visitor)</code> |
| <div class="block">Passes the visitor to the properties "visit" method for all properties declared in |
| this descriptor.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/cayenne/reflect/ClassDescriptor.html#visitProperties(org.apache.cayenne.reflect.PropertyVisitor)">visitProperties</a></strong>(<a href="../../../../org/apache/cayenne/reflect/PropertyVisitor.html" title="interface in org.apache.cayenne.reflect">PropertyVisitor</a> visitor)</code> |
| <div class="block">Passes the visitor to the properties "visit" method for all properties declared in |
| this descriptor and all its super-decsriptors.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ 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><a href="../../../../org/apache/cayenne/map/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</a> getEntity()</pre> |
| <div class="block">Returns an ObjEntity associated with this descriptor.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.0</dd></dl> |
| </li> |
| </ul> |
| <a name="getRootDbEntities()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRootDbEntities</h4> |
| <pre><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/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a>> getRootDbEntities()</pre> |
| <div class="block">Returns a collection of DbEntities that are the root tables for this descriptor's |
| ObjEntity. Usually such collection would contain only one entity, however in cases |
| involving subclass horizontal inheritance, it will be more than one, and in cases |
| of abstract entities with no subclasses, the collection will be empty.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.0</dd></dl> |
| </li> |
| </ul> |
| <a name="getEntityInheritanceTree()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEntityInheritanceTree</h4> |
| <pre><a href="../../../../org/apache/cayenne/map/EntityInheritanceTree.html" title="class in org.apache.cayenne.map">EntityInheritanceTree</a> getEntityInheritanceTree()</pre> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.0</dd></dl> |
| </li> |
| </ul> |
| <a name="hasSubclasses()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasSubclasses</h4> |
| <pre>boolean hasSubclasses()</pre> |
| <div class="block">Returns whether this class has persistent subclasses.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.1</dd></dl> |
| </li> |
| </ul> |
| <a name="getObjectClass()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getObjectClass</h4> |
| <pre><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><?> getObjectClass()</pre> |
| <div class="block">Returns a class mapped by this descriptor.</div> |
| </li> |
| </ul> |
| <a name="getSuperclassDescriptor()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSuperclassDescriptor</h4> |
| <pre><a href="../../../../org/apache/cayenne/reflect/ClassDescriptor.html" title="interface in org.apache.cayenne.reflect">ClassDescriptor</a> getSuperclassDescriptor()</pre> |
| <div class="block">Returns a descriptor of the mapped superclass or null if the descriptor's entity |
| sits at the top of inheritance hierarchy or no inheritance is mapped.</div> |
| </li> |
| </ul> |
| <a name="getSubclassDescriptor(java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSubclassDescriptor</h4> |
| <pre><a href="../../../../org/apache/cayenne/reflect/ClassDescriptor.html" title="interface in org.apache.cayenne.reflect">ClassDescriptor</a> getSubclassDescriptor(<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><?> objectClass)</pre> |
| <div class="block">Returns the most "specialized" descriptor for a given class. This method assumes |
| that the following is true: |
| |
| <pre> |
| this.getObjectClass().isAssignableFrom(objectClass) |
| </pre></div> |
| </li> |
| </ul> |
| <a name="createObject()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createObject</h4> |
| <pre><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> createObject()</pre> |
| <div class="block">Creates a new instance of a class described by this object.</div> |
| </li> |
| </ul> |
| <a name="injectValueHolders(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>injectValueHolders</h4> |
| <pre>void injectValueHolders(<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> object) |
| throws <a href="../../../../org/apache/cayenne/reflect/PropertyException.html" title="class in org.apache.cayenne.reflect">PropertyException</a></pre> |
| <div class="block">Prepares object properties for access. This may include injection of value holders |
| into the object and such.</div> |
| <dl><dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/cayenne/reflect/PropertyException.html" title="class in org.apache.cayenne.reflect">PropertyException</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="shallowMerge(java.lang.Object, java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shallowMerge</h4> |
| <pre>void shallowMerge(<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> from, |
| <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> to) |
| throws <a href="../../../../org/apache/cayenne/reflect/PropertyException.html" title="class in org.apache.cayenne.reflect">PropertyException</a></pre> |
| <div class="block">Merges object properties from one object to another, avoiding traversal of the |
| ArcProperties.</div> |
| <dl><dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/cayenne/reflect/PropertyException.html" title="class in org.apache.cayenne.reflect">PropertyException</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="getProperty(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProperty</h4> |
| <pre><a href="../../../../org/apache/cayenne/reflect/Property.html" title="interface in org.apache.cayenne.reflect">Property</a> getProperty(<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> propertyName)</pre> |
| <div class="block">Returns a property descriptor matching property name, or null if no such property |
| is found. Lookup includes properties from this descriptor and all its superclass |
| descriptors. Returned property can be any one of <a href="../../../../org/apache/cayenne/reflect/AttributeProperty.html" title="interface in org.apache.cayenne.reflect"><code>AttributeProperty</code></a>, |
| <a href="../../../../org/apache/cayenne/reflect/ToManyProperty.html" title="interface in org.apache.cayenne.reflect"><code>ToManyProperty</code></a>, <a href="../../../../org/apache/cayenne/reflect/ToOneProperty.html" title="interface in org.apache.cayenne.reflect"><code>ToOneProperty</code></a>.</div> |
| </li> |
| </ul> |
| <a name="getDeclaredProperty(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDeclaredProperty</h4> |
| <pre><a href="../../../../org/apache/cayenne/reflect/Property.html" title="interface in org.apache.cayenne.reflect">Property</a> getDeclaredProperty(<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> propertyName)</pre> |
| <div class="block">Returns a Java Bean property descriptor matching property name or null if no such |
| property is found. Lookup DOES NOT including properties from the superclass |
| descriptors. Returned property can be any one of <a href="../../../../org/apache/cayenne/reflect/AttributeProperty.html" title="interface in org.apache.cayenne.reflect"><code>AttributeProperty</code></a>, |
| <a href="../../../../org/apache/cayenne/reflect/ToManyProperty.html" title="interface in org.apache.cayenne.reflect"><code>ToManyProperty</code></a>, <a href="../../../../org/apache/cayenne/reflect/ToOneProperty.html" title="interface in org.apache.cayenne.reflect"><code>ToOneProperty</code></a>.</div> |
| </li> |
| </ul> |
| <a name="getIdProperties()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIdProperties</h4> |
| <pre><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/reflect/AttributeProperty.html" title="interface in org.apache.cayenne.reflect">AttributeProperty</a>> getIdProperties()</pre> |
| <div class="block">Returns a collection of the properties mapped to id columns.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.1</dd></dl> |
| </li> |
| </ul> |
| <a name="getDiscriminatorColumns()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDiscriminatorColumns</h4> |
| <pre><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>> getDiscriminatorColumns()</pre> |
| <div class="block">Returns a collection of ObjAttribute for the described class, its superclasses and |
| subclasses, that participate in inheritance qualifier. If a discriminator |
| expression specifies a DbAttribute instead of an ObjAttribute, a synthetic |
| ObjAttribute is created and returned.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.1</dd></dl> |
| </li> |
| </ul> |
| <a name="getEntityQualifier()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEntityQualifier</h4> |
| <pre><a href="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</a> getEntityQualifier()</pre> |
| <div class="block">Returns entity qualifier as a Cayenne expression that includes qualifiers for this |
| entity and all subentities.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.0</dd></dl> |
| </li> |
| </ul> |
| <a name="getMapArcProperties()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMapArcProperties</h4> |
| <pre><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/reflect/ArcProperty.html" title="interface in org.apache.cayenne.reflect">ArcProperty</a>> getMapArcProperties()</pre> |
| <div class="block">Returns a collection over the arc properties whose reverse arcs are to-many maps. |
| I.e. for each ArcProperty in returned collection, the following is true: |
| |
| <pre> |
| arc.getComplimentaryReverseArc() instanceof ToManyMapProperty |
| </pre></div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.1</dd></dl> |
| </li> |
| </ul> |
| <a name="visitProperties(org.apache.cayenne.reflect.PropertyVisitor)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>visitProperties</h4> |
| <pre>boolean visitProperties(<a href="../../../../org/apache/cayenne/reflect/PropertyVisitor.html" title="interface in org.apache.cayenne.reflect">PropertyVisitor</a> visitor)</pre> |
| <div class="block">Passes the visitor to the properties "visit" method for all properties declared in |
| this descriptor and all its super-decsriptors. Properties that are overridden in |
| subdescriptors will include overridden information. Walkthrough is terminated in |
| case one of the properties returns false. Returns true if all visited properties |
| returned true, false - if one property returned false.</div> |
| </li> |
| </ul> |
| <a name="visitDeclaredProperties(org.apache.cayenne.reflect.PropertyVisitor)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>visitDeclaredProperties</h4> |
| <pre>boolean visitDeclaredProperties(<a href="../../../../org/apache/cayenne/reflect/PropertyVisitor.html" title="interface in org.apache.cayenne.reflect">PropertyVisitor</a> visitor)</pre> |
| <div class="block">Passes the visitor to the properties "visit" method for all properties declared in |
| this descriptor. This property set excludes inherited properties, even those that |
| got overridden in this subclass. Walkthrough is terminated in case one of the |
| properties returns false. Returns true if all visited properties returned true, |
| false - if one property returned false.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.0</dd></dl> |
| </li> |
| </ul> |
| <a name="visitAllProperties(org.apache.cayenne.reflect.PropertyVisitor)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>visitAllProperties</h4> |
| <pre>boolean visitAllProperties(<a href="../../../../org/apache/cayenne/reflect/PropertyVisitor.html" title="interface in org.apache.cayenne.reflect">PropertyVisitor</a> visitor)</pre> |
| <div class="block">Passes the visitor to the properties "visit" method for a combination of all |
| properties, including properties declared in this descriptor, its super |
| descriptors, and all subdescriptors. Walkthrough is terminated in case one of the |
| properties returns false. Returns true if all visited properties returned true, |
| false - if one property returned false.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.0</dd></dl> |
| </li> |
| </ul> |
| <a name="isFault(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>isFault</h4> |
| <pre>boolean isFault(<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> object)</pre> |
| <div class="block">Returns true if an object is not fully resolved.</div> |
| </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/ClassDescriptor.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/reflect/BeanAccessor.html" title="class in org.apache.cayenne.reflect"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/cayenne/reflect/ClassDescriptorFactory.html" title="interface in org.apache.cayenne.reflect"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/cayenne/reflect/ClassDescriptor.html" target="_top">Frames</a></li> |
| <li><a href="ClassDescriptor.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>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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> |