| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc (build 1.6.0_24) on Sat Jun 11 11:32:50 EEST 2011 --> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <TITLE> |
| ClassDescriptor (Cayenne Documentation 3.0.2 API) |
| </TITLE> |
| |
| <META NAME="date" CONTENT="2011-06-11"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="ClassDescriptor (Cayenne Documentation 3.0.2 API)"; |
| } |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| <HR> |
| |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <A NAME="navbar_top"><!-- --></A> |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ClassDescriptor.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/apache/cayenne/reflect/BeanAccessor.html" title="class in org.apache.cayenne.reflect"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/cayenne/reflect/ClassDescriptorFactory.html" title="interface in org.apache.cayenne.reflect"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/cayenne/reflect/ClassDescriptor.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="ClassDescriptor.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.apache.cayenne.reflect</FONT> |
| <BR> |
| Interface ClassDescriptor</H2> |
| <DL> |
| <DT><B>All Known Implementing Classes:</B> <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> |
| <DL> |
| <DT><PRE>public interface <B>ClassDescriptor</B></DL> |
| </PRE> |
| |
| <P> |
| A runtime descriptor of an persistent class. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| </DL> |
| <HR> |
| |
| <P> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/reflect/ClassDescriptor.html#createObject()">createObject</A></B>()</CODE> |
| |
| <BR> |
| Creates a new instance of a class described by this object.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/cayenne/reflect/Property.html" title="interface in org.apache.cayenne.reflect">Property</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/reflect/ClassDescriptor.html#getDeclaredProperty(java.lang.String)">getDeclaredProperty</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> propertyName)</CODE> |
| |
| <BR> |
| Returns a Java Bean property descriptor matching property name or null if no such |
| property is found.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A><<A HREF="../../../../org/apache/cayenne/map/ObjAttribute.html" title="class in org.apache.cayenne.map">ObjAttribute</A>></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/reflect/ClassDescriptor.html#getDiscriminatorColumns()">getDiscriminatorColumns</A></B>()</CODE> |
| |
| <BR> |
| Returns a collection of ObjAttribute for the described class, its superclasses and |
| subclasses, that participate in inheritance qualifier.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/cayenne/map/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/reflect/ClassDescriptor.html#getEntity()">getEntity</A></B>()</CODE> |
| |
| <BR> |
| Returns an ObjEntity associated with this descriptor.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/cayenne/map/EntityInheritanceTree.html" title="class in org.apache.cayenne.map">EntityInheritanceTree</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/reflect/ClassDescriptor.html#getEntityInheritanceTree()">getEntityInheritanceTree</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/reflect/ClassDescriptor.html#getEntityQualifier()">getEntityQualifier</A></B>()</CODE> |
| |
| <BR> |
| Returns entity qualifier as a Cayenne expression that includes qualifiers for this |
| entity and all subentities.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A><<A HREF="../../../../org/apache/cayenne/reflect/Property.html" title="interface in org.apache.cayenne.reflect">Property</A>></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/reflect/ClassDescriptor.html#getIdProperties()">getIdProperties</A></B>()</CODE> |
| |
| <BR> |
| Returns an iterator over the properties mapped to id columns.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A><<A HREF="../../../../org/apache/cayenne/reflect/ArcProperty.html" title="interface in org.apache.cayenne.reflect">ArcProperty</A>></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/reflect/ClassDescriptor.html#getMapArcProperties()">getMapArcProperties</A></B>()</CODE> |
| |
| <BR> |
| Returns an iterator over the arc properties whose reverse arcs are to-many maps.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A><?></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/reflect/ClassDescriptor.html#getObjectClass()">getObjectClass</A></B>()</CODE> |
| |
| <BR> |
| Returns a class mapped by this descriptor.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A><<A HREF="../../../../org/apache/cayenne/reflect/Property.html" title="interface in org.apache.cayenne.reflect">Property</A>></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/reflect/ClassDescriptor.html#getProperties()">getProperties</A></B>()</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>since 3.0. Use <A HREF="../../../../org/apache/cayenne/reflect/ClassDescriptor.html#visitProperties(org.apache.cayenne.reflect.PropertyVisitor)"><CODE>visitProperties(PropertyVisitor)</CODE></A> method |
| instead.</I></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/cayenne/reflect/Property.html" title="interface in org.apache.cayenne.reflect">Property</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/reflect/ClassDescriptor.html#getProperty(java.lang.String)">getProperty</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> propertyName)</CODE> |
| |
| <BR> |
| Returns a property descriptor matching property name, or null if no such property |
| is found.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/javase/6/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></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/reflect/ClassDescriptor.html#getRootDbEntities()">getRootDbEntities</A></B>()</CODE> |
| |
| <BR> |
| Returns a collection of DbEntities that are the root tables for this descriptor's |
| ObjEntity.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/cayenne/reflect/ClassDescriptor.html" title="interface in org.apache.cayenne.reflect">ClassDescriptor</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/reflect/ClassDescriptor.html#getSubclassDescriptor(java.lang.Class)">getSubclassDescriptor</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A><?> objectClass)</CODE> |
| |
| <BR> |
| Returns the most "specialized" descriptor for a given class.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/cayenne/reflect/ClassDescriptor.html" title="interface in org.apache.cayenne.reflect">ClassDescriptor</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/reflect/ClassDescriptor.html#getSuperclassDescriptor()">getSuperclassDescriptor</A></B>()</CODE> |
| |
| <BR> |
| 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.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/reflect/ClassDescriptor.html#injectValueHolders(java.lang.Object)">injectValueHolders</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> object)</CODE> |
| |
| <BR> |
| Prepares object properties for access.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/reflect/ClassDescriptor.html#isFault(java.lang.Object)">isFault</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> object)</CODE> |
| |
| <BR> |
| Returns true if an object is not fully resolved.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/reflect/ClassDescriptor.html#shallowMerge(java.lang.Object, java.lang.Object)">shallowMerge</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> from, |
| <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> to)</CODE> |
| |
| <BR> |
| Merges object properties from one object to another, avoiding traversal of the |
| ArcProperties.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/reflect/ClassDescriptor.html#visitAllProperties(org.apache.cayenne.reflect.PropertyVisitor)">visitAllProperties</A></B>(<A HREF="../../../../org/apache/cayenne/reflect/PropertyVisitor.html" title="interface in org.apache.cayenne.reflect">PropertyVisitor</A> visitor)</CODE> |
| |
| <BR> |
| 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.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/reflect/ClassDescriptor.html#visitDeclaredProperties(org.apache.cayenne.reflect.PropertyVisitor)">visitDeclaredProperties</A></B>(<A HREF="../../../../org/apache/cayenne/reflect/PropertyVisitor.html" title="interface in org.apache.cayenne.reflect">PropertyVisitor</A> visitor)</CODE> |
| |
| <BR> |
| Passes the visitor to the properties "visit" method for all properties declared in |
| this descriptor.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/reflect/ClassDescriptor.html#visitProperties(org.apache.cayenne.reflect.PropertyVisitor)">visitProperties</A></B>(<A HREF="../../../../org/apache/cayenne/reflect/PropertyVisitor.html" title="interface in org.apache.cayenne.reflect">PropertyVisitor</A> visitor)</CODE> |
| |
| <BR> |
| Passes the visitor to the properties "visit" method for all properties declared in |
| this descriptor and all its super-decsriptors.</TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="getEntity()"><!-- --></A><H3> |
| getEntity</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/cayenne/map/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</A> <B>getEntity</B>()</PRE> |
| <DL> |
| <DD>Returns an ObjEntity associated with this descriptor. |
| <P> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>3.0</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getRootDbEntities()"><!-- --></A><H3> |
| getRootDbEntities</H3> |
| <PRE> |
| <A HREF="http://java.sun.com/javase/6/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>> <B>getRootDbEntities</B>()</PRE> |
| <DL> |
| <DD>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. |
| <P> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>3.0</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getEntityInheritanceTree()"><!-- --></A><H3> |
| getEntityInheritanceTree</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/cayenne/map/EntityInheritanceTree.html" title="class in org.apache.cayenne.map">EntityInheritanceTree</A> <B>getEntityInheritanceTree</B>()</PRE> |
| <DL> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>3.0</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getObjectClass()"><!-- --></A><H3> |
| getObjectClass</H3> |
| <PRE> |
| <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A><?> <B>getObjectClass</B>()</PRE> |
| <DL> |
| <DD>Returns a class mapped by this descriptor. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getSuperclassDescriptor()"><!-- --></A><H3> |
| getSuperclassDescriptor</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/cayenne/reflect/ClassDescriptor.html" title="interface in org.apache.cayenne.reflect">ClassDescriptor</A> <B>getSuperclassDescriptor</B>()</PRE> |
| <DL> |
| <DD>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. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getSubclassDescriptor(java.lang.Class)"><!-- --></A><H3> |
| getSubclassDescriptor</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/cayenne/reflect/ClassDescriptor.html" title="interface in org.apache.cayenne.reflect">ClassDescriptor</A> <B>getSubclassDescriptor</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A><?> objectClass)</PRE> |
| <DL> |
| <DD>Returns the most "specialized" descriptor for a given class. This method assumes |
| that the following is true: |
| |
| <pre> |
| this.getObjectClass().isAssignableFrom(objectClass) |
| </pre> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="createObject()"><!-- --></A><H3> |
| createObject</H3> |
| <PRE> |
| <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> <B>createObject</B>()</PRE> |
| <DL> |
| <DD>Creates a new instance of a class described by this object. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="injectValueHolders(java.lang.Object)"><!-- --></A><H3> |
| injectValueHolders</H3> |
| <PRE> |
| void <B>injectValueHolders</B>(<A HREF="http://java.sun.com/javase/6/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> |
| <DL> |
| <DD>Prepares object properties for access. This may include injection of value holders |
| into the object and such. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../org/apache/cayenne/reflect/PropertyException.html" title="class in org.apache.cayenne.reflect">PropertyException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="shallowMerge(java.lang.Object, java.lang.Object)"><!-- --></A><H3> |
| shallowMerge</H3> |
| <PRE> |
| void <B>shallowMerge</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> from, |
| <A HREF="http://java.sun.com/javase/6/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> |
| <DL> |
| <DD>Merges object properties from one object to another, avoiding traversal of the |
| ArcProperties. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../org/apache/cayenne/reflect/PropertyException.html" title="class in org.apache.cayenne.reflect">PropertyException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getProperty(java.lang.String)"><!-- --></A><H3> |
| getProperty</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/cayenne/reflect/Property.html" title="interface in org.apache.cayenne.reflect">Property</A> <B>getProperty</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> propertyName)</PRE> |
| <DL> |
| <DD>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>. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDeclaredProperty(java.lang.String)"><!-- --></A><H3> |
| getDeclaredProperty</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/cayenne/reflect/Property.html" title="interface in org.apache.cayenne.reflect">Property</A> <B>getDeclaredProperty</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> propertyName)</PRE> |
| <DL> |
| <DD>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>. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getProperties()"><!-- --></A><H3> |
| getProperties</H3> |
| <PRE> |
| <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A><<A HREF="../../../../org/apache/cayenne/reflect/Property.html" title="interface in org.apache.cayenne.reflect">Property</A>> <B>getProperties</B>()</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>since 3.0. Use <A HREF="../../../../org/apache/cayenne/reflect/ClassDescriptor.html#visitProperties(org.apache.cayenne.reflect.PropertyVisitor)"><CODE>visitProperties(PropertyVisitor)</CODE></A> method |
| instead.</I> |
| <P> |
| <DD>Returns an Iterator over descriptor properties. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getIdProperties()"><!-- --></A><H3> |
| getIdProperties</H3> |
| <PRE> |
| <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A><<A HREF="../../../../org/apache/cayenne/reflect/Property.html" title="interface in org.apache.cayenne.reflect">Property</A>> <B>getIdProperties</B>()</PRE> |
| <DL> |
| <DD>Returns an iterator over the properties mapped to id columns. |
| <P> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>3.0</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDiscriminatorColumns()"><!-- --></A><H3> |
| getDiscriminatorColumns</H3> |
| <PRE> |
| <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A><<A HREF="../../../../org/apache/cayenne/map/ObjAttribute.html" title="class in org.apache.cayenne.map">ObjAttribute</A>> <B>getDiscriminatorColumns</B>()</PRE> |
| <DL> |
| <DD>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. |
| <P> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>3.0</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getEntityQualifier()"><!-- --></A><H3> |
| getEntityQualifier</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</A> <B>getEntityQualifier</B>()</PRE> |
| <DL> |
| <DD>Returns entity qualifier as a Cayenne expression that includes qualifiers for this |
| entity and all subentities. |
| <P> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>3.0</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getMapArcProperties()"><!-- --></A><H3> |
| getMapArcProperties</H3> |
| <PRE> |
| <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A><<A HREF="../../../../org/apache/cayenne/reflect/ArcProperty.html" title="interface in org.apache.cayenne.reflect">ArcProperty</A>> <B>getMapArcProperties</B>()</PRE> |
| <DL> |
| <DD>Returns an iterator over the arc properties whose reverse arcs are to-many maps. |
| I.e. for each ArcProperty in the iterator, the following is true: |
| |
| <pre> |
| arc.getComplimentaryReverseArc() instanceof ToManyMapProperty |
| </pre> |
| <P> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>3.0</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="visitProperties(org.apache.cayenne.reflect.PropertyVisitor)"><!-- --></A><H3> |
| visitProperties</H3> |
| <PRE> |
| boolean <B>visitProperties</B>(<A HREF="../../../../org/apache/cayenne/reflect/PropertyVisitor.html" title="interface in org.apache.cayenne.reflect">PropertyVisitor</A> visitor)</PRE> |
| <DL> |
| <DD>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. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="visitDeclaredProperties(org.apache.cayenne.reflect.PropertyVisitor)"><!-- --></A><H3> |
| visitDeclaredProperties</H3> |
| <PRE> |
| boolean <B>visitDeclaredProperties</B>(<A HREF="../../../../org/apache/cayenne/reflect/PropertyVisitor.html" title="interface in org.apache.cayenne.reflect">PropertyVisitor</A> visitor)</PRE> |
| <DL> |
| <DD>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. |
| <P> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>3.0</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="visitAllProperties(org.apache.cayenne.reflect.PropertyVisitor)"><!-- --></A><H3> |
| visitAllProperties</H3> |
| <PRE> |
| boolean <B>visitAllProperties</B>(<A HREF="../../../../org/apache/cayenne/reflect/PropertyVisitor.html" title="interface in org.apache.cayenne.reflect">PropertyVisitor</A> visitor)</PRE> |
| <DL> |
| <DD>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. |
| <P> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>3.0</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isFault(java.lang.Object)"><!-- --></A><H3> |
| isFault</H3> |
| <PRE> |
| boolean <B>isFault</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> object)</PRE> |
| <DL> |
| <DD>Returns true if an object is not fully resolved. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ClassDescriptor.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/apache/cayenne/reflect/BeanAccessor.html" title="class in org.apache.cayenne.reflect"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/cayenne/reflect/ClassDescriptorFactory.html" title="interface in org.apache.cayenne.reflect"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/cayenne/reflect/ClassDescriptor.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="ClassDescriptor.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| Copyright © 2001-2011 <a href="http://cayenne.apache.org/">Apache Cayenne</a>. All Rights Reserved. |
| </BODY> |
| </HTML> |
