blob: ccfb361a6781af8873cbb8a6af5fb41b51c4e6e9 [file] [log] [blame]
<!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.5.0_06) on Wed Jul 19 14:45:51 EDT 2006 -->
<TITLE>
EntityDescriptor (Apache Cayenne API Documentation - v.2.0-incubating-SNAPSHOT)
</TITLE>
<META NAME="keywords" CONTENT="org.apache.cayenne.map.EntityDescriptor class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../apache-javadoc.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="EntityDescriptor (Apache Cayenne API Documentation - v.2.0-incubating-SNAPSHOT)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= 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>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../org/apache/cayenne/map/Entity.html" title="class in org.apache.cayenne.map"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/apache/cayenne/map/EntityDescriptorFactory.html" title="class in org.apache.cayenne.map"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/apache/cayenne/map/EntityDescriptor.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="EntityDescriptor.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<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.map</FONT>
<BR>
Class EntityDescriptor</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../org/apache/cayenne/property/BaseClassDescriptor.html" title="class in org.apache.cayenne.property">org.apache.cayenne.property.BaseClassDescriptor</A>
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.cayenne.map.EntityDescriptor</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../org/apache/cayenne/property/ClassDescriptor.html" title="interface in org.apache.cayenne.property">ClassDescriptor</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public class <B>EntityDescriptor</B><DT>extends <A HREF="../../../../org/apache/cayenne/property/BaseClassDescriptor.html" title="class in org.apache.cayenne.property">BaseClassDescriptor</A></DL>
</PRE>
<P>
A ClassDescriptor describing a persistent bean based on ObjEntity.
<P>
<P>
<DL>
<DT><B>Since:</B></DT>
<DD>1.2</DD>
<DT><B>Author:</B></DT>
<DD>Andrus Adamchik</DD>
</DL>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_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>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/cayenne/map/EntityDescriptor.html#dataObject">dataObject</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;<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/map/EntityDescriptor.html#entity">entity</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;<A NAME="fields_inherited_from_class_org.apache.cayenne.property.BaseClassDescriptor"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Fields inherited from class org.apache.cayenne.property.<A HREF="../../../../org/apache/cayenne/property/BaseClassDescriptor.html" title="class in org.apache.cayenne.property">BaseClassDescriptor</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../org/apache/cayenne/property/BaseClassDescriptor.html#declaredProperties">declaredProperties</A>, <A HREF="../../../../org/apache/cayenne/property/BaseClassDescriptor.html#objectClass">objectClass</A>, <A HREF="../../../../org/apache/cayenne/property/BaseClassDescriptor.html#persistenceStateProperty">persistenceStateProperty</A>, <A HREF="../../../../org/apache/cayenne/property/BaseClassDescriptor.html#subclassDescriptors">subclassDescriptors</A>, <A HREF="../../../../org/apache/cayenne/property/BaseClassDescriptor.html#superclassDescriptor">superclassDescriptor</A>, <A HREF="../../../../org/apache/cayenne/property/BaseClassDescriptor.html#valueHolderProperties">valueHolderProperties</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_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>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../org/apache/cayenne/map/EntityDescriptor.html#EntityDescriptor(org.apache.cayenne.map.ObjEntity, org.apache.cayenne.property.ClassDescriptor)">EntityDescriptor</A></B>(<A HREF="../../../../org/apache/cayenne/map/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</A>&nbsp;entity,
<A HREF="../../../../org/apache/cayenne/property/ClassDescriptor.html" title="interface in org.apache.cayenne.property">ClassDescriptor</A>&nbsp;superclassDescriptor)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates and compiles a class descriptor for a given entity.</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== 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>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/cayenne/map/EntityDescriptor.html#compile(org.apache.cayenne.map.EntityResolver)">compile</A></B>(<A HREF="../../../../org/apache/cayenne/map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</A>&nbsp;resolver)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Prepares the descriptor.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/cayenne/map/EntityDescriptor.html#compileAttributes(java.util.Map)">compileAttributes</A></B>(java.util.Map&nbsp;allDescriptors)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Implements an attributes compilation step.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/cayenne/map/EntityDescriptor.html#compileRelationships(org.apache.cayenne.map.EntityResolver, java.util.Map)">compileRelationships</A></B>(<A HREF="../../../../org/apache/cayenne/map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</A>&nbsp;resolver,
java.util.Map&nbsp;allDescriptors)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Implements a relationships compilation step.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/cayenne/map/EntityDescriptor.html#compileSpecialProperties()">compileSpecialProperties</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Implements an attributes compilation step.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/cayenne/map/EntityDescriptor.html#compileSubclassMapping(org.apache.cayenne.map.EntityResolver, java.util.Map, org.apache.cayenne.map.EntityInheritanceTree)">compileSubclassMapping</A></B>(<A HREF="../../../../org/apache/cayenne/map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</A>&nbsp;resolver,
java.util.Map&nbsp;subclassDescriptors,
<A HREF="../../../../org/apache/cayenne/map/EntityInheritanceTree.html" title="class in org.apache.cayenne.map">EntityInheritanceTree</A>&nbsp;treeNode)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<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/map/EntityDescriptor.html#getEntity()">getEntity</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns ObjEntity described by this object.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/cayenne/map/EntityDescriptor.html#removeDeclaredProperty(java.lang.String)">removeDeclaredProperty</A></B>(java.lang.String&nbsp;propertyName)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes declared property.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/cayenne/map/EntityDescriptor.html#setDeclaredProperty(org.apache.cayenne.property.Property)">setDeclaredProperty</A></B>(<A HREF="../../../../org/apache/cayenne/property/Property.html" title="interface in org.apache.cayenne.property">Property</A>&nbsp;property)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Registers a property.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/cayenne/map/EntityDescriptor.html#shallowMerge(java.lang.Object, java.lang.Object)">shallowMerge</A></B>(java.lang.Object&nbsp;from,
java.lang.Object&nbsp;to)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Copies object properties from one object to another.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/cayenne/map/EntityDescriptor.html#toString()">toString</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Overrides toString method of Object to provide a meaningful description.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_org.apache.cayenne.property.BaseClassDescriptor"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class org.apache.cayenne.property.<A HREF="../../../../org/apache/cayenne/property/BaseClassDescriptor.html" title="class in org.apache.cayenne.property">BaseClassDescriptor</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../org/apache/cayenne/property/BaseClassDescriptor.html#createObject()">createObject</A>, <A HREF="../../../../org/apache/cayenne/property/BaseClassDescriptor.html#getDeclaredProperty(java.lang.String)">getDeclaredProperty</A>, <A HREF="../../../../org/apache/cayenne/property/BaseClassDescriptor.html#getObjectClass()">getObjectClass</A>, <A HREF="../../../../org/apache/cayenne/property/BaseClassDescriptor.html#getProperties()">getProperties</A>, <A HREF="../../../../org/apache/cayenne/property/BaseClassDescriptor.html#getProperty(java.lang.String)">getProperty</A>, <A HREF="../../../../org/apache/cayenne/property/BaseClassDescriptor.html#getSubclassDescriptor(java.lang.Class)">getSubclassDescriptor</A>, <A HREF="../../../../org/apache/cayenne/property/BaseClassDescriptor.html#getSuperclassDescriptor()">getSuperclassDescriptor</A>, <A HREF="../../../../org/apache/cayenne/property/BaseClassDescriptor.html#injectValueHolders(java.lang.Object)">injectValueHolders</A>, <A HREF="../../../../org/apache/cayenne/property/BaseClassDescriptor.html#isFault(java.lang.Object)">isFault</A>, <A HREF="../../../../org/apache/cayenne/property/BaseClassDescriptor.html#isValid()">isValid</A>, <A HREF="../../../../org/apache/cayenne/property/BaseClassDescriptor.html#visitProperties(org.apache.cayenne.property.PropertyVisitor)">visitProperties</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_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>Field Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="entity"><!-- --></A><H3>
entity</H3>
<PRE>
protected <A HREF="../../../../org/apache/cayenne/map/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</A> <B>entity</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="dataObject"><!-- --></A><H3>
dataObject</H3>
<PRE>
protected boolean <B>dataObject</B></PRE>
<DL>
<DL>
</DL>
</DL>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_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>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="EntityDescriptor(org.apache.cayenne.map.ObjEntity, org.apache.cayenne.property.ClassDescriptor)"><!-- --></A><H3>
EntityDescriptor</H3>
<PRE>
public <B>EntityDescriptor</B>(<A HREF="../../../../org/apache/cayenne/map/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</A>&nbsp;entity,
<A HREF="../../../../org/apache/cayenne/property/ClassDescriptor.html" title="interface in org.apache.cayenne.property">ClassDescriptor</A>&nbsp;superclassDescriptor)</PRE>
<DL>
<DD>Creates and compiles a class descriptor for a given entity. A second optional
'superclassDescriptor' parameter should be used if an entity has a super-entity.
<P>
</DL>
<!-- ============ 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="shallowMerge(java.lang.Object, java.lang.Object)"><!-- --></A><H3>
shallowMerge</H3>
<PRE>
public void <B>shallowMerge</B>(java.lang.Object&nbsp;from,
java.lang.Object&nbsp;to)
throws <A HREF="../../../../org/apache/cayenne/property/PropertyAccessException.html" title="class in org.apache.cayenne.property">PropertyAccessException</A></PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/cayenne/property/BaseClassDescriptor.html#shallowMerge(java.lang.Object, java.lang.Object)">BaseClassDescriptor</A></CODE></B></DD>
<DD>Copies object properties from one object to another. Invokes 'shallowCopy' of a
super descriptor and then invokes 'shallowCopy' of each declared property.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/cayenne/property/ClassDescriptor.html#shallowMerge(java.lang.Object, java.lang.Object)">shallowMerge</A></CODE> in interface <CODE><A HREF="../../../../org/apache/cayenne/property/ClassDescriptor.html" title="interface in org.apache.cayenne.property">ClassDescriptor</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/cayenne/property/BaseClassDescriptor.html#shallowMerge(java.lang.Object, java.lang.Object)">shallowMerge</A></CODE> in class <CODE><A HREF="../../../../org/apache/cayenne/property/BaseClassDescriptor.html" title="class in org.apache.cayenne.property">BaseClassDescriptor</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/apache/cayenne/property/PropertyAccessException.html" title="class in org.apache.cayenne.property">PropertyAccessException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="getEntity()"><!-- --></A><H3>
getEntity</H3>
<PRE>
public <A HREF="../../../../org/apache/cayenne/map/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</A> <B>getEntity</B>()</PRE>
<DL>
<DD>Returns ObjEntity described by this object.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setDeclaredProperty(org.apache.cayenne.property.Property)"><!-- --></A><H3>
setDeclaredProperty</H3>
<PRE>
public void <B>setDeclaredProperty</B>(<A HREF="../../../../org/apache/cayenne/property/Property.html" title="interface in org.apache.cayenne.property">Property</A>&nbsp;property)</PRE>
<DL>
<DD>Registers a property. This method is useful to customize default ClassDescriptor
generated from ObjEntity by adding new properties or overriding the standard ones.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="removeDeclaredProperty(java.lang.String)"><!-- --></A><H3>
removeDeclaredProperty</H3>
<PRE>
public void <B>removeDeclaredProperty</B>(java.lang.String&nbsp;propertyName)</PRE>
<DL>
<DD>Removes declared property. This method can be used to customize default
ClassDescriptor generated from ObjEntity.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="compile(org.apache.cayenne.map.EntityResolver)"><!-- --></A><H3>
compile</H3>
<PRE>
public void <B>compile</B>(<A HREF="../../../../org/apache/cayenne/map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</A>&nbsp;resolver)</PRE>
<DL>
<DD>Prepares the descriptor. A descriptor must be explicitly compiled before it can
operate.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="compileSubclassMapping(org.apache.cayenne.map.EntityResolver, java.util.Map, org.apache.cayenne.map.EntityInheritanceTree)"><!-- --></A><H3>
compileSubclassMapping</H3>
<PRE>
protected void <B>compileSubclassMapping</B>(<A HREF="../../../../org/apache/cayenne/map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</A>&nbsp;resolver,
java.util.Map&nbsp;subclassDescriptors,
<A HREF="../../../../org/apache/cayenne/map/EntityInheritanceTree.html" title="class in org.apache.cayenne.map">EntityInheritanceTree</A>&nbsp;treeNode)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="compileSpecialProperties()"><!-- --></A><H3>
compileSpecialProperties</H3>
<PRE>
protected void <B>compileSpecialProperties</B>()</PRE>
<DL>
<DD>Implements an attributes compilation step. Called internally from "compile".
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="compileAttributes(java.util.Map)"><!-- --></A><H3>
compileAttributes</H3>
<PRE>
protected void <B>compileAttributes</B>(java.util.Map&nbsp;allDescriptors)</PRE>
<DL>
<DD>Implements an attributes compilation step. Called internally from "compile".
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="compileRelationships(org.apache.cayenne.map.EntityResolver, java.util.Map)"><!-- --></A><H3>
compileRelationships</H3>
<PRE>
protected void <B>compileRelationships</B>(<A HREF="../../../../org/apache/cayenne/map/EntityResolver.html" title="class in org.apache.cayenne.map">EntityResolver</A>&nbsp;resolver,
java.util.Map&nbsp;allDescriptors)</PRE>
<DL>
<DD>Implements a relationships compilation step. Maps each to-one relationship to a
ValueHolderProperty and to-many - to CollectionProperty. Called internally from
"compile" method.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="toString()"><!-- --></A><H3>
toString</H3>
<PRE>
public java.lang.String <B>toString</B>()</PRE>
<DL>
<DD>Overrides toString method of Object to provide a meaningful description.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL>
</DD>
<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>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../org/apache/cayenne/map/Entity.html" title="class in org.apache.cayenne.map"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/apache/cayenne/map/EntityDescriptorFactory.html" title="class in org.apache.cayenne.map"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/apache/cayenne/map/EntityDescriptor.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="EntityDescriptor.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<i>Copyright &#169; 2001-2006 <a href=
"http://apache.org" target="_top">Apache.org</a> All Rights Reserved.</i>
</BODY>
</HTML>