| <!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:58 EEST 2011 --> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <TITLE> |
| DbEntity (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="DbEntity (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/DbEntity.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/map/DbAttribute.html" title="class in org.apache.cayenne.map"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/cayenne/map/DbJoin.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/DbEntity.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="DbEntity.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 | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <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 DbEntity</H2> |
| <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">java.lang.Object</A> |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../org/apache/cayenne/map/Entity.html" title="class in org.apache.cayenne.map">org.apache.cayenne.map.Entity</A> |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.cayenne.map.DbEntity</B> |
| </PRE> |
| <DL> |
| <DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://java.sun.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/util/EventListener.html?is-external=true" title="class or interface in java.util">EventListener</A>, <A HREF="../../../../org/apache/cayenne/map/event/DbAttributeListener.html" title="interface in org.apache.cayenne.map.event">DbAttributeListener</A>, <A HREF="../../../../org/apache/cayenne/map/event/DbEntityListener.html" title="interface in org.apache.cayenne.map.event">DbEntityListener</A>, <A HREF="../../../../org/apache/cayenne/map/event/DbRelationshipListener.html" title="interface in org.apache.cayenne.map.event">DbRelationshipListener</A>, <A HREF="../../../../org/apache/cayenne/util/CayenneMapEntry.html" title="interface in org.apache.cayenne.util">CayenneMapEntry</A>, <A HREF="../../../../org/apache/cayenne/util/XMLSerializable.html" title="interface in org.apache.cayenne.util">XMLSerializable</A></DD> |
| </DL> |
| <DL> |
| <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/apache/cayenne/map/DetectedDbEntity.html" title="class in org.apache.cayenne.map">DetectedDbEntity</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public class <B>DbEntity</B><DT>extends <A HREF="../../../../org/apache/cayenne/map/Entity.html" title="class in org.apache.cayenne.map">Entity</A><DT>implements <A HREF="../../../../org/apache/cayenne/map/event/DbEntityListener.html" title="interface in org.apache.cayenne.map.event">DbEntityListener</A>, <A HREF="../../../../org/apache/cayenne/map/event/DbAttributeListener.html" title="interface in org.apache.cayenne.map.event">DbAttributeListener</A>, <A HREF="../../../../org/apache/cayenne/map/event/DbRelationshipListener.html" title="interface in org.apache.cayenne.map.event">DbRelationshipListener</A></DL> |
| </PRE> |
| |
| <P> |
| A DbEntity is a mapping descriptor that defines a structure of a database table. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../serialized-form.html#org.apache.cayenne.map.DbEntity">Serialized Form</A></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 <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></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/map/DbEntity.html#catalog">catalog</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected <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/DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</A>></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/map/DbEntity.html#generatedAttributes">generatedAttributes</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected <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/DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</A>></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/map/DbEntity.html#primaryKey">primaryKey</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected <A HREF="../../../../org/apache/cayenne/map/DbKeyGenerator.html" title="class in org.apache.cayenne.map">DbKeyGenerator</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/map/DbEntity.html#primaryKeyGenerator">primaryKeyGenerator</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected <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/map/DbEntity.html#qualifier">qualifier</A></B></CODE> |
| |
| <BR> |
| Qualifier, that will be applied to all select queries and joins with this DbEntity</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected <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></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/map/DbEntity.html#schema">schema</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| </TABLE> |
| <A NAME="fields_inherited_from_class_org.apache.cayenne.map.Entity"><!-- --></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.map.<A HREF="../../../../org/apache/cayenne/map/Entity.html" title="class in org.apache.cayenne.map">Entity</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../org/apache/cayenne/map/Entity.html#attributes">attributes</A>, <A HREF="../../../../org/apache/cayenne/map/Entity.html#dataMap">dataMap</A>, <A HREF="../../../../org/apache/cayenne/map/Entity.html#name">name</A>, <A HREF="../../../../org/apache/cayenne/map/Entity.html#OUTER_JOIN_INDICATOR">OUTER_JOIN_INDICATOR</A>, <A HREF="../../../../org/apache/cayenne/map/Entity.html#PATH_SEPARATOR">PATH_SEPARATOR</A>, <A HREF="../../../../org/apache/cayenne/map/Entity.html#relationships">relationships</A></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ======== 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/DbEntity.html#DbEntity()">DbEntity</A></B>()</CODE> |
| |
| <BR> |
| Creates an unnamed DbEntity.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/map/DbEntity.html#DbEntity(java.lang.String)">DbEntity</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> name)</CODE> |
| |
| <BR> |
| Creates a named DbEntity.</TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== 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> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/map/DbEntity.html#addAttribute(org.apache.cayenne.map.Attribute)">addAttribute</A></B>(<A HREF="../../../../org/apache/cayenne/map/Attribute.html" title="class in org.apache.cayenne.map">Attribute</A> attr)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>in favour of <A HREF="../../../../org/apache/cayenne/map/DbEntity.html#addAttribute(org.apache.cayenne.map.DbAttribute)"><CODE>addAttribute(DbAttribute attr)</CODE></A>. Scheduled for |
| removal in Cayenne 4.</I></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/map/DbEntity.html#addAttribute(org.apache.cayenne.map.DbAttribute)">addAttribute</A></B>(<A HREF="../../../../org/apache/cayenne/map/DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</A> attr)</CODE> |
| |
| <BR> |
| Adds a new attribute to this entity.</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/map/DbEntity.html#clearAttributes()">clearAttributes</A></B>()</CODE> |
| |
| <BR> |
| </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/map/DbEntity.html#dbAttributeAdded(org.apache.cayenne.map.event.AttributeEvent)">dbAttributeAdded</A></B>(<A HREF="../../../../org/apache/cayenne/map/event/AttributeEvent.html" title="class in org.apache.cayenne.map.event">AttributeEvent</A> e)</CODE> |
| |
| <BR> |
| New attribute has been created/added.</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/map/DbEntity.html#dbAttributeChanged(org.apache.cayenne.map.event.AttributeEvent)">dbAttributeChanged</A></B>(<A HREF="../../../../org/apache/cayenne/map/event/AttributeEvent.html" title="class in org.apache.cayenne.map.event">AttributeEvent</A> e)</CODE> |
| |
| <BR> |
| Attribute property changed.</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/map/DbEntity.html#dbAttributeRemoved(org.apache.cayenne.map.event.AttributeEvent)">dbAttributeRemoved</A></B>(<A HREF="../../../../org/apache/cayenne/map/event/AttributeEvent.html" title="class in org.apache.cayenne.map.event">AttributeEvent</A> e)</CODE> |
| |
| <BR> |
| Attribute has been removed.</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/map/DbEntity.html#dbEntityAdded(org.apache.cayenne.map.event.EntityEvent)">dbEntityAdded</A></B>(<A HREF="../../../../org/apache/cayenne/map/event/EntityEvent.html" title="class in org.apache.cayenne.map.event">EntityEvent</A> e)</CODE> |
| |
| <BR> |
| New entity has been created/added.</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/map/DbEntity.html#dbEntityChanged(org.apache.cayenne.map.event.EntityEvent)">dbEntityChanged</A></B>(<A HREF="../../../../org/apache/cayenne/map/event/EntityEvent.html" title="class in org.apache.cayenne.map.event">EntityEvent</A> e)</CODE> |
| |
| <BR> |
| DbEntity property changed event.</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/map/DbEntity.html#dbEntityRemoved(org.apache.cayenne.map.event.EntityEvent)">dbEntityRemoved</A></B>(<A HREF="../../../../org/apache/cayenne/map/event/EntityEvent.html" title="class in org.apache.cayenne.map.event">EntityEvent</A> e)</CODE> |
| |
| <BR> |
| Entity has been removed.</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/map/DbEntity.html#dbRelationshipAdded(org.apache.cayenne.map.event.RelationshipEvent)">dbRelationshipAdded</A></B>(<A HREF="../../../../org/apache/cayenne/map/event/RelationshipEvent.html" title="class in org.apache.cayenne.map.event">RelationshipEvent</A> e)</CODE> |
| |
| <BR> |
| Relationship has been created/added.</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/map/DbEntity.html#dbRelationshipChanged(org.apache.cayenne.map.event.RelationshipEvent)">dbRelationshipChanged</A></B>(<A HREF="../../../../org/apache/cayenne/map/event/RelationshipEvent.html" title="class in org.apache.cayenne.map.event">RelationshipEvent</A> e)</CODE> |
| |
| <BR> |
| Relationship property changed.</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/map/DbEntity.html#dbRelationshipRemoved(org.apache.cayenne.map.event.RelationshipEvent)">dbRelationshipRemoved</A></B>(<A HREF="../../../../org/apache/cayenne/map/event/RelationshipEvent.html" title="class in org.apache.cayenne.map.event">RelationshipEvent</A> e)</CODE> |
| |
| <BR> |
| Relationship has been removed.</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/map/DbEntity.html#encodeAsXML(org.apache.cayenne.util.XMLEncoder)">encodeAsXML</A></B>(<A HREF="../../../../org/apache/cayenne/util/XMLEncoder.html" title="class in org.apache.cayenne.util">XMLEncoder</A> encoder)</CODE> |
| |
| <BR> |
| Prints itself as XML to the provided XMLEncoder.</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/DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</A>></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/map/DbEntity.html#getAttributes()">getAttributes</A></B>()</CODE> |
| |
| <BR> |
| Returns a Collection of all attributes that either belong to this DbEntity or |
| inherited.</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/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/map/DbEntity.html#getCatalog()">getCatalog</A></B>()</CODE> |
| |
| <BR> |
| Returns the catalog name of the table described by this DbEntity.</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/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/map/DbEntity.html#getFullyQualifiedName()">getFullyQualifiedName</A></B>()</CODE> |
| |
| <BR> |
| Returns table name including schema, if present.</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/DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</A>></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/map/DbEntity.html#getGeneratedAttributes()">getGeneratedAttributes</A></B>()</CODE> |
| |
| <BR> |
| Returns an unmodifiable collection of DbAttributes that are generated by the |
| database.</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/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../../org/apache/cayenne/map/DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</A>></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/map/DbEntity.html#getPrimaryKey()">getPrimaryKey</A></B>()</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>since 3.0 use <A HREF="../../../../org/apache/cayenne/map/DbEntity.html#getPrimaryKeys()"><CODE>getPrimaryKeys()</CODE></A> that returns a collection.</I></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/cayenne/map/DbKeyGenerator.html" title="class in org.apache.cayenne.map">DbKeyGenerator</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/map/DbEntity.html#getPrimaryKeyGenerator()">getPrimaryKeyGenerator</A></B>()</CODE> |
| |
| <BR> |
| Return the primary key generator for this entity.</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/DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</A>></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/map/DbEntity.html#getPrimaryKeys()">getPrimaryKeys</A></B>()</CODE> |
| |
| <BR> |
| Returns an unmodifiable collection of DbAttributes representing the primary key of |
| the table described by this DbEntity.</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/map/DbEntity.html#getQualifier()">getQualifier</A></B>()</CODE> |
| |
| <BR> |
| </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/SortedMap.html?is-external=true" title="class or interface in java.util">SortedMap</A><<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>,<A HREF="../../../../org/apache/cayenne/map/DbRelationship.html" title="class in org.apache.cayenne.map">DbRelationship</A>></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/map/DbEntity.html#getRelationshipMap()">getRelationshipMap</A></B>()</CODE> |
| |
| <BR> |
| Returns an unmodifiable map of relationships sorted by name.</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/DbRelationship.html" title="class in org.apache.cayenne.map">DbRelationship</A>></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/map/DbEntity.html#getRelationships()">getRelationships</A></B>()</CODE> |
| |
| <BR> |
| Returns a Collection of relationships from this entity or inherited.</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/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/map/DbEntity.html#getSchema()">getSchema</A></B>()</CODE> |
| |
| <BR> |
| Returns database schema of this table.</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/map/DbEntity.html#isFullReplacementIdAttached(org.apache.cayenne.ObjectId)">isFullReplacementIdAttached</A></B>(<A HREF="../../../../org/apache/cayenne/ObjectId.html" title="class in org.apache.cayenne">ObjectId</A> id)</CODE> |
| |
| <BR> |
| Returns true if there is full replacement id is attached to an ObjectId.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/cayenne/map/PathComponent.html" title="interface in org.apache.cayenne.map">PathComponent</A><<A HREF="../../../../org/apache/cayenne/map/DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</A>,<A HREF="../../../../org/apache/cayenne/map/DbRelationship.html" title="class in org.apache.cayenne.map">DbRelationship</A>></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/map/DbEntity.html#lastPathComponent(org.apache.cayenne.exp.Expression, java.util.Map)">lastPathComponent</A></B>(<A HREF="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</A> path, |
| <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A> aliasMap)</CODE> |
| |
| <BR> |
| Convenience method returning the last component in the path iterator.</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/map/DbEntity.html#removeAttribute(java.lang.String)">removeAttribute</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> attrName)</CODE> |
| |
| <BR> |
| Removes attribute from the entity, removes any relationship joins containing this |
| attribute.</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/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</A><<A HREF="../../../../org/apache/cayenne/map/PathComponent.html" title="interface in org.apache.cayenne.map">PathComponent</A><<A HREF="../../../../org/apache/cayenne/map/DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</A>,<A HREF="../../../../org/apache/cayenne/map/DbRelationship.html" title="class in org.apache.cayenne.map">DbRelationship</A>>></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/map/DbEntity.html#resolvePath(org.apache.cayenne.exp.Expression, java.util.Map)">resolvePath</A></B>(<A HREF="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</A> pathExp, |
| <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A> aliasMap)</CODE> |
| |
| <BR> |
| Returns an Iterable instance over expression path components based on this entity.</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/util/CayenneMapEntry.html" title="interface in org.apache.cayenne.util">CayenneMapEntry</A>></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/map/DbEntity.html#resolvePathComponents(org.apache.cayenne.exp.Expression)">resolvePathComponents</A></B>(<A HREF="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</A> pathExp)</CODE> |
| |
| <BR> |
| Processes expression <code>pathExp</code> and returns an Iterator of path |
| components that contains a sequence of Attributes and Relationships.</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/map/DbEntity.html#setCatalog(java.lang.String)">setCatalog</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> catalog)</CODE> |
| |
| <BR> |
| Sets the catalog name of the table described by this DbEntity.</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/map/DbEntity.html#setPrimaryKeyGenerator(org.apache.cayenne.map.DbKeyGenerator)">setPrimaryKeyGenerator</A></B>(<A HREF="../../../../org/apache/cayenne/map/DbKeyGenerator.html" title="class in org.apache.cayenne.map">DbKeyGenerator</A> primaryKeyGenerator)</CODE> |
| |
| <BR> |
| Set the primary key generator for this entity.</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/map/DbEntity.html#setQualifier(org.apache.cayenne.exp.Expression)">setQualifier</A></B>(<A HREF="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</A> qualifier)</CODE> |
| |
| <BR> |
| Sets qualifier for this entity</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/map/DbEntity.html#setSchema(java.lang.String)">setSchema</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> schema)</CODE> |
| |
| <BR> |
| Sets the database schema name of the table described by this DbEntity.</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/map/DbEntity.html#translateToRelatedEntity(org.apache.cayenne.exp.Expression, java.lang.String)">translateToRelatedEntity</A></B>(<A HREF="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</A> expression, |
| <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> relationshipPath)</CODE> |
| |
| <BR> |
| Transforms Expression rooted in this entity to an analogous expression rooted in |
| related entity.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.apache.cayenne.map.Entity"><!-- --></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.map.<A HREF="../../../../org/apache/cayenne/map/Entity.html" title="class in org.apache.cayenne.map">Entity</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../org/apache/cayenne/map/Entity.html#addRelationship(org.apache.cayenne.map.Relationship)">addRelationship</A>, <A HREF="../../../../org/apache/cayenne/map/Entity.html#clearRelationships()">clearRelationships</A>, <A HREF="../../../../org/apache/cayenne/map/Entity.html#getAnyRelationship(org.apache.cayenne.map.Entity)">getAnyRelationship</A>, <A HREF="../../../../org/apache/cayenne/map/Entity.html#getAttribute(java.lang.String)">getAttribute</A>, <A HREF="../../../../org/apache/cayenne/map/Entity.html#getAttributeMap()">getAttributeMap</A>, <A HREF="../../../../org/apache/cayenne/map/Entity.html#getDataMap()">getDataMap</A>, <A HREF="../../../../org/apache/cayenne/map/Entity.html#getName()">getName</A>, <A HREF="../../../../org/apache/cayenne/map/Entity.html#getParent()">getParent</A>, <A HREF="../../../../org/apache/cayenne/map/Entity.html#getRelationship(java.lang.String)">getRelationship</A>, <A HREF="../../../../org/apache/cayenne/map/Entity.html#lastPathComponent(org.apache.cayenne.exp.Expression)">lastPathComponent</A>, <A HREF="../../../../org/apache/cayenne/map/Entity.html#removeRelationship(java.lang.String)">removeRelationship</A>, <A HREF="../../../../org/apache/cayenne/map/Entity.html#resolvePathComponents(java.lang.String)">resolvePathComponents</A>, <A HREF="../../../../org/apache/cayenne/map/Entity.html#setDataMap(org.apache.cayenne.map.DataMap)">setDataMap</A>, <A HREF="../../../../org/apache/cayenne/map/Entity.html#setName(java.lang.String)">setName</A>, <A HREF="../../../../org/apache/cayenne/map/Entity.html#setParent(java.lang.Object)">setParent</A>, <A HREF="../../../../org/apache/cayenne/map/Entity.html#toString()">toString</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <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.<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></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <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="catalog"><!-- --></A><H3> |
| catalog</H3> |
| <PRE> |
| protected <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> <B>catalog</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="schema"><!-- --></A><H3> |
| schema</H3> |
| <PRE> |
| protected <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> <B>schema</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="primaryKey"><!-- --></A><H3> |
| primaryKey</H3> |
| <PRE> |
| protected <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/DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</A>> <B>primaryKey</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="generatedAttributes"><!-- --></A><H3> |
| generatedAttributes</H3> |
| <PRE> |
| protected <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/DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</A>> <B>generatedAttributes</B></PRE> |
| <DL> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="primaryKeyGenerator"><!-- --></A><H3> |
| primaryKeyGenerator</H3> |
| <PRE> |
| protected <A HREF="../../../../org/apache/cayenne/map/DbKeyGenerator.html" title="class in org.apache.cayenne.map">DbKeyGenerator</A> <B>primaryKeyGenerator</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="qualifier"><!-- --></A><H3> |
| qualifier</H3> |
| <PRE> |
| protected <A HREF="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</A> <B>qualifier</B></PRE> |
| <DL> |
| <DD>Qualifier, that will be applied to all select queries and joins with this DbEntity |
| <P> |
| <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="DbEntity()"><!-- --></A><H3> |
| DbEntity</H3> |
| <PRE> |
| public <B>DbEntity</B>()</PRE> |
| <DL> |
| <DD>Creates an unnamed DbEntity. |
| <P> |
| </DL> |
| <HR> |
| |
| <A NAME="DbEntity(java.lang.String)"><!-- --></A><H3> |
| DbEntity</H3> |
| <PRE> |
| public <B>DbEntity</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> name)</PRE> |
| <DL> |
| <DD>Creates a named DbEntity. |
| <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="encodeAsXML(org.apache.cayenne.util.XMLEncoder)"><!-- --></A><H3> |
| encodeAsXML</H3> |
| <PRE> |
| public void <B>encodeAsXML</B>(<A HREF="../../../../org/apache/cayenne/util/XMLEncoder.html" title="class in org.apache.cayenne.util">XMLEncoder</A> encoder)</PRE> |
| <DL> |
| <DD>Prints itself as XML to the provided XMLEncoder. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/cayenne/util/XMLSerializable.html#encodeAsXML(org.apache.cayenne.util.XMLEncoder)">encodeAsXML</A></CODE> in interface <CODE><A HREF="../../../../org/apache/cayenne/util/XMLSerializable.html" title="interface in org.apache.cayenne.util">XMLSerializable</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.1</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getFullyQualifiedName()"><!-- --></A><H3> |
| getFullyQualifiedName</H3> |
| <PRE> |
| public <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> <B>getFullyQualifiedName</B>()</PRE> |
| <DL> |
| <DD>Returns table name including schema, if present. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getSchema()"><!-- --></A><H3> |
| getSchema</H3> |
| <PRE> |
| public <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> <B>getSchema</B>()</PRE> |
| <DL> |
| <DD>Returns database schema of this table. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>table's schema, null if not set.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setSchema(java.lang.String)"><!-- --></A><H3> |
| setSchema</H3> |
| <PRE> |
| public void <B>setSchema</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> schema)</PRE> |
| <DL> |
| <DD>Sets the database schema name of the table described by this DbEntity. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getCatalog()"><!-- --></A><H3> |
| getCatalog</H3> |
| <PRE> |
| public <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> <B>getCatalog</B>()</PRE> |
| <DL> |
| <DD>Returns the catalog name of the table described by this DbEntity. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setCatalog(java.lang.String)"><!-- --></A><H3> |
| setCatalog</H3> |
| <PRE> |
| public void <B>setCatalog</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> catalog)</PRE> |
| <DL> |
| <DD>Sets the catalog name of the table described by this DbEntity. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getPrimaryKeys()"><!-- --></A><H3> |
| getPrimaryKeys</H3> |
| <PRE> |
| public <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/DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</A>> <B>getPrimaryKeys</B>()</PRE> |
| <DL> |
| <DD>Returns an unmodifiable collection of DbAttributes representing the primary key of |
| the table described by this DbEntity. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>3.0</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getPrimaryKey()"><!-- --></A><H3> |
| getPrimaryKey</H3> |
| <PRE> |
| <FONT SIZE="-1"><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</A> |
| </FONT>public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../../org/apache/cayenne/map/DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</A>> <B>getPrimaryKey</B>()</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>since 3.0 use <A HREF="../../../../org/apache/cayenne/map/DbEntity.html#getPrimaryKeys()"><CODE>getPrimaryKeys()</CODE></A> that returns a collection.</I> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getAttributes()"><!-- --></A><H3> |
| getAttributes</H3> |
| <PRE> |
| public <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/DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</A>> <B>getAttributes</B>()</PRE> |
| <DL> |
| <DD>Returns a Collection of all attributes that either belong to this DbEntity or |
| inherited. |
| <P> |
| <DD><DL> |
| <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/cayenne/map/Entity.html#getAttributes()">getAttributes</A></CODE> in class <CODE><A HREF="../../../../org/apache/cayenne/map/Entity.html" title="class in org.apache.cayenne.map">Entity</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getGeneratedAttributes()"><!-- --></A><H3> |
| getGeneratedAttributes</H3> |
| <PRE> |
| public <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/DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</A>> <B>getGeneratedAttributes</B>()</PRE> |
| <DL> |
| <DD>Returns an unmodifiable collection of DbAttributes that are generated by the |
| database. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addAttribute(org.apache.cayenne.map.DbAttribute)"><!-- --></A><H3> |
| addAttribute</H3> |
| <PRE> |
| public void <B>addAttribute</B>(<A HREF="../../../../org/apache/cayenne/map/DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</A> attr)</PRE> |
| <DL> |
| <DD>Adds a new attribute to this entity. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if Attribute has no name or there is an existing |
| attribute with the same name |
| <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if a relationship has the same name as this |
| attribute<DT><B>Since:</B></DT> |
| <DD>3.0</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addAttribute(org.apache.cayenne.map.Attribute)"><!-- --></A><H3> |
| addAttribute</H3> |
| <PRE> |
| <FONT SIZE="-1"><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</A> |
| </FONT>public void <B>addAttribute</B>(<A HREF="../../../../org/apache/cayenne/map/Attribute.html" title="class in org.apache.cayenne.map">Attribute</A> attr)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>in favour of <A HREF="../../../../org/apache/cayenne/map/DbEntity.html#addAttribute(org.apache.cayenne.map.DbAttribute)"><CODE>addAttribute(DbAttribute attr)</CODE></A>. Scheduled for |
| removal in Cayenne 4.</I> |
| <P> |
| <DD>Overrides super to fire an AttributeEvent. |
| <P> |
| <DD><DL> |
| <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/cayenne/map/Entity.html#addAttribute(org.apache.cayenne.map.Attribute)">addAttribute</A></CODE> in class <CODE><A HREF="../../../../org/apache/cayenne/map/Entity.html" title="class in org.apache.cayenne.map">Entity</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="removeAttribute(java.lang.String)"><!-- --></A><H3> |
| removeAttribute</H3> |
| <PRE> |
| public void <B>removeAttribute</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> attrName)</PRE> |
| <DL> |
| <DD>Removes attribute from the entity, removes any relationship joins containing this |
| attribute. Does nothing if the attribute name is not found. |
| <P> |
| <DD><DL> |
| <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/cayenne/map/Entity.html#removeAttribute(java.lang.String)">removeAttribute</A></CODE> in class <CODE><A HREF="../../../../org/apache/cayenne/map/Entity.html" title="class in org.apache.cayenne.map">Entity</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../org/apache/cayenne/map/Entity.html#removeAttribute(java.lang.String)"><CODE>Entity.removeAttribute(String)</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="clearAttributes()"><!-- --></A><H3> |
| clearAttributes</H3> |
| <PRE> |
| public void <B>clearAttributes</B>()</PRE> |
| <DL> |
| <DD><DL> |
| <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/cayenne/map/Entity.html#clearAttributes()">clearAttributes</A></CODE> in class <CODE><A HREF="../../../../org/apache/cayenne/map/Entity.html" title="class in org.apache.cayenne.map">Entity</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getRelationships()"><!-- --></A><H3> |
| getRelationships</H3> |
| <PRE> |
| public <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/DbRelationship.html" title="class in org.apache.cayenne.map">DbRelationship</A>> <B>getRelationships</B>()</PRE> |
| <DL> |
| <DD>Returns a Collection of relationships from this entity or inherited. |
| <P> |
| <DD><DL> |
| <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/cayenne/map/Entity.html#getRelationships()">getRelationships</A></CODE> in class <CODE><A HREF="../../../../org/apache/cayenne/map/Entity.html" title="class in org.apache.cayenne.map">Entity</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getRelationshipMap()"><!-- --></A><H3> |
| getRelationshipMap</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util">SortedMap</A><<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>,<A HREF="../../../../org/apache/cayenne/map/DbRelationship.html" title="class in org.apache.cayenne.map">DbRelationship</A>> <B>getRelationshipMap</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/cayenne/map/Entity.html#getRelationshipMap()">Entity</A></CODE></B></DD> |
| <DD>Returns an unmodifiable map of relationships sorted by name. |
| <P> |
| <DD><DL> |
| <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/cayenne/map/Entity.html#getRelationshipMap()">getRelationshipMap</A></CODE> in class <CODE><A HREF="../../../../org/apache/cayenne/map/Entity.html" title="class in org.apache.cayenne.map">Entity</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="lastPathComponent(org.apache.cayenne.exp.Expression, java.util.Map)"><!-- --></A><H3> |
| lastPathComponent</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/cayenne/map/PathComponent.html" title="interface in org.apache.cayenne.map">PathComponent</A><<A HREF="../../../../org/apache/cayenne/map/DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</A>,<A HREF="../../../../org/apache/cayenne/map/DbRelationship.html" title="class in org.apache.cayenne.map">DbRelationship</A>> <B>lastPathComponent</B>(<A HREF="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</A> path, |
| <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A> aliasMap)</PRE> |
| <DL> |
| <DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/cayenne/map/Entity.html#lastPathComponent(org.apache.cayenne.exp.Expression, java.util.Map)">Entity</A></CODE></B></DD> |
| <DD>Convenience method returning the last component in the path iterator. If the last |
| component is an alias, it is fully resolved down to the last ObjRelationship. |
| <P> |
| <DD><DL> |
| <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/cayenne/map/Entity.html#lastPathComponent(org.apache.cayenne.exp.Expression, java.util.Map)">lastPathComponent</A></CODE> in class <CODE><A HREF="../../../../org/apache/cayenne/map/Entity.html" title="class in org.apache.cayenne.map">Entity</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>3.0</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="resolvePath(org.apache.cayenne.exp.Expression, java.util.Map)"><!-- --></A><H3> |
| resolvePath</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</A><<A HREF="../../../../org/apache/cayenne/map/PathComponent.html" title="interface in org.apache.cayenne.map">PathComponent</A><<A HREF="../../../../org/apache/cayenne/map/DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</A>,<A HREF="../../../../org/apache/cayenne/map/DbRelationship.html" title="class in org.apache.cayenne.map">DbRelationship</A>>> <B>resolvePath</B>(<A HREF="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</A> pathExp, |
| <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A> aliasMap)</PRE> |
| <DL> |
| <DD>Returns an Iterable instance over expression path components based on this entity. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/cayenne/map/Entity.html#resolvePath(org.apache.cayenne.exp.Expression, java.util.Map)">resolvePath</A></CODE> in class <CODE><A HREF="../../../../org/apache/cayenne/map/Entity.html" title="class in org.apache.cayenne.map">Entity</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>3.0</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="resolvePathComponents(org.apache.cayenne.exp.Expression)"><!-- --></A><H3> |
| resolvePathComponents</H3> |
| <PRE> |
| public <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/util/CayenneMapEntry.html" title="interface in org.apache.cayenne.util">CayenneMapEntry</A>> <B>resolvePathComponents</B>(<A HREF="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</A> pathExp) |
| throws <A HREF="../../../../org/apache/cayenne/exp/ExpressionException.html" title="class in org.apache.cayenne.exp">ExpressionException</A></PRE> |
| <DL> |
| <DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/cayenne/map/Entity.html#resolvePathComponents(org.apache.cayenne.exp.Expression)">Entity</A></CODE></B></DD> |
| <DD>Processes expression <code>pathExp</code> and returns an Iterator of path |
| components that contains a sequence of Attributes and Relationships. Note that if |
| path is invalid and can not be resolved from this entity, this method will still |
| return an Iterator, but an attempt to read the first invalid path component will |
| result in ExpressionException. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/cayenne/map/Entity.html#resolvePathComponents(org.apache.cayenne.exp.Expression)">resolvePathComponents</A></CODE> in class <CODE><A HREF="../../../../org/apache/cayenne/map/Entity.html" title="class in org.apache.cayenne.map">Entity</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../org/apache/cayenne/exp/ExpressionException.html" title="class in org.apache.cayenne.exp">ExpressionException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setPrimaryKeyGenerator(org.apache.cayenne.map.DbKeyGenerator)"><!-- --></A><H3> |
| setPrimaryKeyGenerator</H3> |
| <PRE> |
| public void <B>setPrimaryKeyGenerator</B>(<A HREF="../../../../org/apache/cayenne/map/DbKeyGenerator.html" title="class in org.apache.cayenne.map">DbKeyGenerator</A> primaryKeyGenerator)</PRE> |
| <DL> |
| <DD>Set the primary key generator for this entity. If null is passed, nothing is |
| changed. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getPrimaryKeyGenerator()"><!-- --></A><H3> |
| getPrimaryKeyGenerator</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/cayenne/map/DbKeyGenerator.html" title="class in org.apache.cayenne.map">DbKeyGenerator</A> <B>getPrimaryKeyGenerator</B>()</PRE> |
| <DL> |
| <DD>Return the primary key generator for this entity. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="dbEntityChanged(org.apache.cayenne.map.event.EntityEvent)"><!-- --></A><H3> |
| dbEntityChanged</H3> |
| <PRE> |
| public void <B>dbEntityChanged</B>(<A HREF="../../../../org/apache/cayenne/map/event/EntityEvent.html" title="class in org.apache.cayenne.map.event">EntityEvent</A> e)</PRE> |
| <DL> |
| <DD>DbEntity property changed event. May be name, attribute or relationship added or |
| removed, etc. Attribute and relationship property changes are handled in respective |
| listeners. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/cayenne/map/event/DbEntityListener.html#dbEntityChanged(org.apache.cayenne.map.event.EntityEvent)">dbEntityChanged</A></CODE> in interface <CODE><A HREF="../../../../org/apache/cayenne/map/event/DbEntityListener.html" title="interface in org.apache.cayenne.map.event">DbEntityListener</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="dbEntityAdded(org.apache.cayenne.map.event.EntityEvent)"><!-- --></A><H3> |
| dbEntityAdded</H3> |
| <PRE> |
| public void <B>dbEntityAdded</B>(<A HREF="../../../../org/apache/cayenne/map/event/EntityEvent.html" title="class in org.apache.cayenne.map.event">EntityEvent</A> e)</PRE> |
| <DL> |
| <DD>New entity has been created/added. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/cayenne/map/event/DbEntityListener.html#dbEntityAdded(org.apache.cayenne.map.event.EntityEvent)">dbEntityAdded</A></CODE> in interface <CODE><A HREF="../../../../org/apache/cayenne/map/event/DbEntityListener.html" title="interface in org.apache.cayenne.map.event">DbEntityListener</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="dbEntityRemoved(org.apache.cayenne.map.event.EntityEvent)"><!-- --></A><H3> |
| dbEntityRemoved</H3> |
| <PRE> |
| public void <B>dbEntityRemoved</B>(<A HREF="../../../../org/apache/cayenne/map/event/EntityEvent.html" title="class in org.apache.cayenne.map.event">EntityEvent</A> e)</PRE> |
| <DL> |
| <DD>Entity has been removed. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/cayenne/map/event/DbEntityListener.html#dbEntityRemoved(org.apache.cayenne.map.event.EntityEvent)">dbEntityRemoved</A></CODE> in interface <CODE><A HREF="../../../../org/apache/cayenne/map/event/DbEntityListener.html" title="interface in org.apache.cayenne.map.event">DbEntityListener</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="dbAttributeAdded(org.apache.cayenne.map.event.AttributeEvent)"><!-- --></A><H3> |
| dbAttributeAdded</H3> |
| <PRE> |
| public void <B>dbAttributeAdded</B>(<A HREF="../../../../org/apache/cayenne/map/event/AttributeEvent.html" title="class in org.apache.cayenne.map.event">AttributeEvent</A> e)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/cayenne/map/event/DbAttributeListener.html#dbAttributeAdded(org.apache.cayenne.map.event.AttributeEvent)">DbAttributeListener</A></CODE></B></DD> |
| <DD>New attribute has been created/added. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/cayenne/map/event/DbAttributeListener.html#dbAttributeAdded(org.apache.cayenne.map.event.AttributeEvent)">dbAttributeAdded</A></CODE> in interface <CODE><A HREF="../../../../org/apache/cayenne/map/event/DbAttributeListener.html" title="interface in org.apache.cayenne.map.event">DbAttributeListener</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="dbAttributeChanged(org.apache.cayenne.map.event.AttributeEvent)"><!-- --></A><H3> |
| dbAttributeChanged</H3> |
| <PRE> |
| public void <B>dbAttributeChanged</B>(<A HREF="../../../../org/apache/cayenne/map/event/AttributeEvent.html" title="class in org.apache.cayenne.map.event">AttributeEvent</A> e)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/cayenne/map/event/DbAttributeListener.html#dbAttributeChanged(org.apache.cayenne.map.event.AttributeEvent)">DbAttributeListener</A></CODE></B></DD> |
| <DD>Attribute property changed. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/cayenne/map/event/DbAttributeListener.html#dbAttributeChanged(org.apache.cayenne.map.event.AttributeEvent)">dbAttributeChanged</A></CODE> in interface <CODE><A HREF="../../../../org/apache/cayenne/map/event/DbAttributeListener.html" title="interface in org.apache.cayenne.map.event">DbAttributeListener</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="dbAttributeRemoved(org.apache.cayenne.map.event.AttributeEvent)"><!-- --></A><H3> |
| dbAttributeRemoved</H3> |
| <PRE> |
| public void <B>dbAttributeRemoved</B>(<A HREF="../../../../org/apache/cayenne/map/event/AttributeEvent.html" title="class in org.apache.cayenne.map.event">AttributeEvent</A> e)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/cayenne/map/event/DbAttributeListener.html#dbAttributeRemoved(org.apache.cayenne.map.event.AttributeEvent)">DbAttributeListener</A></CODE></B></DD> |
| <DD>Attribute has been removed. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/cayenne/map/event/DbAttributeListener.html#dbAttributeRemoved(org.apache.cayenne.map.event.AttributeEvent)">dbAttributeRemoved</A></CODE> in interface <CODE><A HREF="../../../../org/apache/cayenne/map/event/DbAttributeListener.html" title="interface in org.apache.cayenne.map.event">DbAttributeListener</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="dbRelationshipChanged(org.apache.cayenne.map.event.RelationshipEvent)"><!-- --></A><H3> |
| dbRelationshipChanged</H3> |
| <PRE> |
| public void <B>dbRelationshipChanged</B>(<A HREF="../../../../org/apache/cayenne/map/event/RelationshipEvent.html" title="class in org.apache.cayenne.map.event">RelationshipEvent</A> e)</PRE> |
| <DL> |
| <DD>Relationship property changed. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/cayenne/map/event/DbRelationshipListener.html#dbRelationshipChanged(org.apache.cayenne.map.event.RelationshipEvent)">dbRelationshipChanged</A></CODE> in interface <CODE><A HREF="../../../../org/apache/cayenne/map/event/DbRelationshipListener.html" title="interface in org.apache.cayenne.map.event">DbRelationshipListener</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="dbRelationshipAdded(org.apache.cayenne.map.event.RelationshipEvent)"><!-- --></A><H3> |
| dbRelationshipAdded</H3> |
| <PRE> |
| public void <B>dbRelationshipAdded</B>(<A HREF="../../../../org/apache/cayenne/map/event/RelationshipEvent.html" title="class in org.apache.cayenne.map.event">RelationshipEvent</A> e)</PRE> |
| <DL> |
| <DD>Relationship has been created/added. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/cayenne/map/event/DbRelationshipListener.html#dbRelationshipAdded(org.apache.cayenne.map.event.RelationshipEvent)">dbRelationshipAdded</A></CODE> in interface <CODE><A HREF="../../../../org/apache/cayenne/map/event/DbRelationshipListener.html" title="interface in org.apache.cayenne.map.event">DbRelationshipListener</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="dbRelationshipRemoved(org.apache.cayenne.map.event.RelationshipEvent)"><!-- --></A><H3> |
| dbRelationshipRemoved</H3> |
| <PRE> |
| public void <B>dbRelationshipRemoved</B>(<A HREF="../../../../org/apache/cayenne/map/event/RelationshipEvent.html" title="class in org.apache.cayenne.map.event">RelationshipEvent</A> e)</PRE> |
| <DL> |
| <DD>Relationship has been removed. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/cayenne/map/event/DbRelationshipListener.html#dbRelationshipRemoved(org.apache.cayenne.map.event.RelationshipEvent)">dbRelationshipRemoved</A></CODE> in interface <CODE><A HREF="../../../../org/apache/cayenne/map/event/DbRelationshipListener.html" title="interface in org.apache.cayenne.map.event">DbRelationshipListener</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getQualifier()"><!-- --></A><H3> |
| getQualifier</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</A> <B>getQualifier</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>qualifier that will be ANDed to all select queries with this entity</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setQualifier(org.apache.cayenne.exp.Expression)"><!-- --></A><H3> |
| setQualifier</H3> |
| <PRE> |
| public void <B>setQualifier</B>(<A HREF="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</A> qualifier)</PRE> |
| <DL> |
| <DD>Sets qualifier for this entity |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isFullReplacementIdAttached(org.apache.cayenne.ObjectId)"><!-- --></A><H3> |
| isFullReplacementIdAttached</H3> |
| <PRE> |
| public boolean <B>isFullReplacementIdAttached</B>(<A HREF="../../../../org/apache/cayenne/ObjectId.html" title="class in org.apache.cayenne">ObjectId</A> id)</PRE> |
| <DL> |
| <DD>Returns true if there is full replacement id is attached to an ObjectId. "Full" |
| means that all PK columns are present and only PK columns are present. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="translateToRelatedEntity(org.apache.cayenne.exp.Expression, java.lang.String)"><!-- --></A><H3> |
| translateToRelatedEntity</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</A> <B>translateToRelatedEntity</B>(<A HREF="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</A> expression, |
| <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> relationshipPath)</PRE> |
| <DL> |
| <DD>Transforms Expression rooted in this entity to an analogous expression rooted in |
| related entity. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/cayenne/map/Entity.html#translateToRelatedEntity(org.apache.cayenne.exp.Expression, java.lang.String)">translateToRelatedEntity</A></CODE> in class <CODE><A HREF="../../../../org/apache/cayenne/map/Entity.html" title="class in org.apache.cayenne.map">Entity</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.1</DD> |
| </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/DbEntity.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/map/DbAttribute.html" title="class in org.apache.cayenne.map"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/cayenne/map/DbJoin.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/DbEntity.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="DbEntity.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 | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <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> |
