http://git-wip-us.apache.org/repos/asf/cayenne-website/blob/0af753b3/docs/1.2/api/cayenne/org/objectstyle/cayenne/access/DataRowStore.html ---------------------------------------------------------------------- diff --git a/docs/1.2/api/cayenne/org/objectstyle/cayenne/access/DataRowStore.html b/docs/1.2/api/cayenne/org/objectstyle/cayenne/access/DataRowStore.html new file mode 100644 index 0000000..2121ed9 --- /dev/null +++ b/docs/1.2/api/cayenne/org/objectstyle/cayenne/access/DataRowStore.html @@ -0,0 +1,1100 @@ +<!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:42:41 EDT 2006 --> +<TITLE> +DataRowStore (Cayenne API Documentation - v.1.2) +</TITLE> + +<META NAME="keywords" CONTENT="org.objectstyle.cayenne.access.DataRowStore class"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../objectstyle-javadoc.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + parent.document.title="DataRowStore (Cayenne API Documentation - v.1.2)"; +} +</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> </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="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-files/index-1.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/objectstyle/cayenne/access/DataPortDelegate.html" title="interface in org.objectstyle.cayenne.access"><B>PREV CLASS</B></A> + <A HREF="../../../../org/objectstyle/cayenne/access/DbGenerator.html" title="class in org.objectstyle.cayenne.access"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../index.html?org/objectstyle/cayenne/access/DataRowStore.html" target="_top"><B>FRAMES</B></A> + <A HREF="DataRowStore.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.objectstyle.cayenne.access</FONT> +<BR> +Class DataRowStore</H2> +<PRE> +java.lang.Object + <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.objectstyle.cayenne.access.DataRowStore</B> +</PRE> +<DL> +<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD> +</DL> +<HR> +<DL> +<DT><PRE>public class <B>DataRowStore</B><DT>extends java.lang.Object<DT>implements java.io.Serializable</DL> +</PRE> + +<P> +A fixed size cache of DataRows keyed by ObjectId. + <p> + <strong>Synchronization Note: </strong> DataRowStore synchronizes most operations on + its own instance. + </p> +<P> + +<P> +<DL> +<DT><B>Since:</B></DT> + <DD>1.1</DD> +<DT><B>Author:</B></DT> + <DD>Andrei Adamchik</DD> +<DT><B>See Also:</B><DD><A HREF="../../../../serialized-form.html#org.objectstyle.cayenne.access.DataRowStore">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>static java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DataRowStore.html#EVENT_BRIDGE_FACTORY_DEFAULT">EVENT_BRIDGE_FACTORY_DEFAULT</A></B></CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DataRowStore.html#EVENT_BRIDGE_FACTORY_PROPERTY">EVENT_BRIDGE_FACTORY_PROPERTY</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/objectstyle/cayenne/event/EventManager.html" title="class in org.objectstyle.cayenne.event">EventManager</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DataRowStore.html#eventManager">eventManager</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/objectstyle/cayenne/event/EventSubject.html" title="class in org.objectstyle.cayenne.event">EventSubject</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DataRowStore.html#eventSubject">eventSubject</A></B></CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>protected java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DataRowStore.html#name">name</A></B></CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>protected boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DataRowStore.html#notifyingRemoteListeners">notifyingRemoteListeners</A></B></CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DataRowStore.html#REMOTE_NOTIFICATION_DEFAULT">REMOTE_NOTIFICATION_DEFAULT</A></B></CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DataRowStore.html#REMOTE_NOTIFICATION_PROPERTY">REMOTE_NOTIFICATION_PROPERTY</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/objectstyle/cayenne/event/EventBridge.html" title="class in org.objectstyle.cayenne.event">EventBridge</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DataRowStore.html#remoteNotificationsHandler">remoteNotificationsHandler</A></B></CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static int</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DataRowStore.html#SNAPSHOT_CACHE_SIZE_DEFAULT">SNAPSHOT_CACHE_SIZE_DEFAULT</A></B></CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DataRowStore.html#SNAPSHOT_CACHE_SIZE_PROPERTY">SNAPSHOT_CACHE_SIZE_PROPERTY</A></B></CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static long</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DataRowStore.html#SNAPSHOT_EXPIRATION_DEFAULT">SNAPSHOT_EXPIRATION_DEFAULT</A></B></CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DataRowStore.html#SNAPSHOT_EXPIRATION_PROPERTY">SNAPSHOT_EXPIRATION_PROPERTY</A></B></CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>protected org.apache.commons.collections.map.LRUMap</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DataRowStore.html#snapshotLists">snapshotLists</A></B></CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>protected org.apache.commons.collections.map.LRUMap</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DataRowStore.html#snapshots">snapshots</A></B></CODE> + +<BR> + </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/objectstyle/cayenne/access/DataRowStore.html#DataRowStore(java.lang.String)">DataRowStore</A></B>(java.lang.String name)</CODE> + +<BR> + Creates new named DataRowStore with default configuration.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DataRowStore.html#DataRowStore(java.lang.String, java.util.Map)">DataRowStore</A></B>(java.lang.String name, + java.util.Map properties)</CODE> + +<BR> + Creates new DataRowStore with a specified name and a set of properties.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DataRowStore.html#DataRowStore(java.lang.String, java.util.Map, org.objectstyle.cayenne.event.EventManager)">DataRowStore</A></B>(java.lang.String name, + java.util.Map properties, + <A HREF="../../../../org/objectstyle/cayenne/event/EventManager.html" title="class in org.objectstyle.cayenne.event">EventManager</A> eventManager)</CODE> + +<BR> + Creates new DataRowStore with a specified name and a set of properties.</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/objectstyle/cayenne/access/DataRowStore.html#cacheSnapshots(java.lang.String, java.util.List)">cacheSnapshots</A></B>(java.lang.String key, + java.util.List snapshots)</CODE> + +<BR> + Registers a list of snapshots with internal cache, using a String key.</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/objectstyle/cayenne/access/DataRowStore.html#clear()">clear</A></B>()</CODE> + +<BR> + Expires and removes all stored snapshots without sending any notification events.</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/objectstyle/cayenne/access/DataRowStore.html#forgetSnapshot(org.objectstyle.cayenne.ObjectId)">forgetSnapshot</A></B>(<A HREF="../../../../org/objectstyle/cayenne/ObjectId.html" title="class in org.objectstyle.cayenne">ObjectId</A> id)</CODE> + +<BR> + Evicts a snapshot from cache without generating any SnapshotEvents.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../../org/objectstyle/cayenne/DataRow.html" title="class in org.objectstyle.cayenne">DataRow</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DataRowStore.html#getCachedSnapshot(org.objectstyle.cayenne.ObjectId)">getCachedSnapshot</A></B>(<A HREF="../../../../org/objectstyle/cayenne/ObjectId.html" title="class in org.objectstyle.cayenne">ObjectId</A> oid)</CODE> + +<BR> + Returns cached snapshot or null if no snapshot is currently cached for the given + ObjectId.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.util.List</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DataRowStore.html#getCachedSnapshots(java.lang.String)">getCachedSnapshots</A></B>(java.lang.String key)</CODE> + +<BR> + Returns a list of previously cached snapshots.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../../org/objectstyle/cayenne/event/EventManager.html" title="class in org.objectstyle.cayenne.event">EventManager</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DataRowStore.html#getEventManager()">getEventManager</A></B>()</CODE> + +<BR> + Returns an EventManager associated with this DataRowStore.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DataRowStore.html#getName()">getName</A></B>()</CODE> + +<BR> + Returns the name of this DataRowStore.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../../org/objectstyle/cayenne/DataRow.html" title="class in org.objectstyle.cayenne">DataRow</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DataRowStore.html#getSnapshot(org.objectstyle.cayenne.ObjectId, org.objectstyle.cayenne.access.QueryEngine)">getSnapshot</A></B>(<A HREF="../../../../org/objectstyle/cayenne/ObjectId.html" title="class in org.objectstyle.cayenne">ObjectId</A> oid, + <A HREF="../../../../org/objectstyle/cayenne/access/QueryEngine.html" title="interface in org.objectstyle.cayenne.access">QueryEngine</A> engine)</CODE> + +<BR> + <B>Deprecated.</B> <I>since 1.2 unused, as DataRowStore no longer performs queries on its + own.</I></TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../../org/objectstyle/cayenne/event/EventSubject.html" title="class in org.objectstyle.cayenne.event">EventSubject</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DataRowStore.html#getSnapshotEventSubject()">getSnapshotEventSubject</A></B>()</CODE> + +<BR> + Returns EventSubject used by this SnapshotCache to notify of snapshot changes.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>protected void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DataRowStore.html#initWithProperties(java.util.Map)">initWithProperties</A></B>(java.util.Map properties)</CODE> + +<BR> + </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/objectstyle/cayenne/access/DataRowStore.html#isNotifyingRemoteListeners()">isNotifyingRemoteListeners</A></B>()</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> int</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DataRowStore.html#maximumSize()">maximumSize</A></B>()</CODE> + +<BR> + Returns maximum allowed cache size.</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/objectstyle/cayenne/access/DataRowStore.html#processRemoteEvent(org.objectstyle.cayenne.access.event.SnapshotEvent)">processRemoteEvent</A></B>(<A HREF="../../../../org/objectstyle/cayenne/access/event/SnapshotEvent.html" title="class in org.objectstyle.cayenne.access.event">SnapshotEvent</A> event)</CODE> + +<BR> + Handles remote events received via EventBridge.</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/objectstyle/cayenne/access/DataRowStore.html#processSnapshotChanges(java.lang.Object, java.util.Map, java.util.Collection, java.util.Collection)">processSnapshotChanges</A></B>(java.lang.Object source, + java.util.Map updatedSnapshots, + java.util.Collection deletedSnapshotIds, + java.util.Collection indirectlyModifiedIds)</CODE> + +<BR> + <B>Deprecated.</B> <I></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/objectstyle/cayenne/access/DataRowStore.html#processSnapshotChanges(java.lang.Object, java.util.Map, java.util.Collection, java.util.Collection, java.util.Collection)">processSnapshotChanges</A></B>(java.lang.Object postedBy, + java.util.Map updatedSnapshots, + java.util.Collection deletedSnapshotIds, + java.util.Collection invalidatedSnapshotIds, + java.util.Collection indirectlyModifiedIds)</CODE> + +<BR> + Processes changes made to snapshots.</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/objectstyle/cayenne/access/DataRowStore.html#setEventManager(org.objectstyle.cayenne.event.EventManager)">setEventManager</A></B>(<A HREF="../../../../org/objectstyle/cayenne/event/EventManager.html" title="class in org.objectstyle.cayenne.event">EventManager</A> eventManager)</CODE> + +<BR> + Sets an EventManager associated with this DataRowStore.</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/objectstyle/cayenne/access/DataRowStore.html#setName(java.lang.String)">setName</A></B>(java.lang.String name)</CODE> + +<BR> + Sets the name of this DataRowStore.</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/objectstyle/cayenne/access/DataRowStore.html#setNotifyingRemoteListeners(boolean)">setNotifyingRemoteListeners</A></B>(boolean notifyingRemoteListeners)</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/objectstyle/cayenne/access/DataRowStore.html#shutdown()">shutdown</A></B>()</CODE> + +<BR> + Shuts down any remote notification connections, and clears internal cache.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> int</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DataRowStore.html#size()">size</A></B>()</CODE> + +<BR> + Returns current cache size.</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.Object</B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</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="SNAPSHOT_EXPIRATION_PROPERTY"><!-- --></A><H3> +SNAPSHOT_EXPIRATION_PROPERTY</H3> +<PRE> +public static final java.lang.String <B>SNAPSHOT_EXPIRATION_PROPERTY</B></PRE> +<DL> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.objectstyle.cayenne.access.DataRowStore.SNAPSHOT_EXPIRATION_PROPERTY">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="SNAPSHOT_CACHE_SIZE_PROPERTY"><!-- --></A><H3> +SNAPSHOT_CACHE_SIZE_PROPERTY</H3> +<PRE> +public static final java.lang.String <B>SNAPSHOT_CACHE_SIZE_PROPERTY</B></PRE> +<DL> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.objectstyle.cayenne.access.DataRowStore.SNAPSHOT_CACHE_SIZE_PROPERTY">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="REMOTE_NOTIFICATION_PROPERTY"><!-- --></A><H3> +REMOTE_NOTIFICATION_PROPERTY</H3> +<PRE> +public static final java.lang.String <B>REMOTE_NOTIFICATION_PROPERTY</B></PRE> +<DL> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.objectstyle.cayenne.access.DataRowStore.REMOTE_NOTIFICATION_PROPERTY">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="EVENT_BRIDGE_FACTORY_PROPERTY"><!-- --></A><H3> +EVENT_BRIDGE_FACTORY_PROPERTY</H3> +<PRE> +public static final java.lang.String <B>EVENT_BRIDGE_FACTORY_PROPERTY</B></PRE> +<DL> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.objectstyle.cayenne.access.DataRowStore.EVENT_BRIDGE_FACTORY_PROPERTY">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="SNAPSHOT_EXPIRATION_DEFAULT"><!-- --></A><H3> +SNAPSHOT_EXPIRATION_DEFAULT</H3> +<PRE> +public static final long <B>SNAPSHOT_EXPIRATION_DEFAULT</B></PRE> +<DL> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.objectstyle.cayenne.access.DataRowStore.SNAPSHOT_EXPIRATION_DEFAULT">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="SNAPSHOT_CACHE_SIZE_DEFAULT"><!-- --></A><H3> +SNAPSHOT_CACHE_SIZE_DEFAULT</H3> +<PRE> +public static final int <B>SNAPSHOT_CACHE_SIZE_DEFAULT</B></PRE> +<DL> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.objectstyle.cayenne.access.DataRowStore.SNAPSHOT_CACHE_SIZE_DEFAULT">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="REMOTE_NOTIFICATION_DEFAULT"><!-- --></A><H3> +REMOTE_NOTIFICATION_DEFAULT</H3> +<PRE> +public static final boolean <B>REMOTE_NOTIFICATION_DEFAULT</B></PRE> +<DL> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.objectstyle.cayenne.access.DataRowStore.REMOTE_NOTIFICATION_DEFAULT">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="EVENT_BRIDGE_FACTORY_DEFAULT"><!-- --></A><H3> +EVENT_BRIDGE_FACTORY_DEFAULT</H3> +<PRE> +public static final java.lang.String <B>EVENT_BRIDGE_FACTORY_DEFAULT</B></PRE> +<DL> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.objectstyle.cayenne.access.DataRowStore.EVENT_BRIDGE_FACTORY_DEFAULT">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="name"><!-- --></A><H3> +name</H3> +<PRE> +protected java.lang.String <B>name</B></PRE> +<DL> +<DL> +</DL> +</DL> +<HR> + +<A NAME="snapshots"><!-- --></A><H3> +snapshots</H3> +<PRE> +protected org.apache.commons.collections.map.LRUMap <B>snapshots</B></PRE> +<DL> +<DL> +</DL> +</DL> +<HR> + +<A NAME="snapshotLists"><!-- --></A><H3> +snapshotLists</H3> +<PRE> +protected org.apache.commons.collections.map.LRUMap <B>snapshotLists</B></PRE> +<DL> +<DL> +</DL> +</DL> +<HR> + +<A NAME="notifyingRemoteListeners"><!-- --></A><H3> +notifyingRemoteListeners</H3> +<PRE> +protected boolean <B>notifyingRemoteListeners</B></PRE> +<DL> +<DL> +</DL> +</DL> +<HR> + +<A NAME="eventManager"><!-- --></A><H3> +eventManager</H3> +<PRE> +protected transient <A HREF="../../../../org/objectstyle/cayenne/event/EventManager.html" title="class in org.objectstyle.cayenne.event">EventManager</A> <B>eventManager</B></PRE> +<DL> +<DL> +</DL> +</DL> +<HR> + +<A NAME="remoteNotificationsHandler"><!-- --></A><H3> +remoteNotificationsHandler</H3> +<PRE> +protected transient <A HREF="../../../../org/objectstyle/cayenne/event/EventBridge.html" title="class in org.objectstyle.cayenne.event">EventBridge</A> <B>remoteNotificationsHandler</B></PRE> +<DL> +<DL> +</DL> +</DL> +<HR> + +<A NAME="eventSubject"><!-- --></A><H3> +eventSubject</H3> +<PRE> +protected transient <A HREF="../../../../org/objectstyle/cayenne/event/EventSubject.html" title="class in org.objectstyle.cayenne.event">EventSubject</A> <B>eventSubject</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="DataRowStore(java.lang.String)"><!-- --></A><H3> +DataRowStore</H3> +<PRE> +public <B>DataRowStore</B>(java.lang.String name)</PRE> +<DL> +<DD>Creates new named DataRowStore with default configuration. +<P> +</DL> +<HR> + +<A NAME="DataRowStore(java.lang.String, java.util.Map)"><!-- --></A><H3> +DataRowStore</H3> +<PRE> +public <B>DataRowStore</B>(java.lang.String name, + java.util.Map properties)</PRE> +<DL> +<DD>Creates new DataRowStore with a specified name and a set of properties. If no + properties are defined, default values are used. +<P> +<DL> +<DT><B>Parameters:</B><DD><CODE>name</CODE> - DataRowStore name. Used to idenitfy this DataRowStore in events, etc. + Can't be null.<DD><CODE>properties</CODE> - Properties map used to configure DataRowStore parameters. Can be + null.</DL> +</DL> +<HR> + +<A NAME="DataRowStore(java.lang.String, java.util.Map, org.objectstyle.cayenne.event.EventManager)"><!-- --></A><H3> +DataRowStore</H3> +<PRE> +public <B>DataRowStore</B>(java.lang.String name, + java.util.Map properties, + <A HREF="../../../../org/objectstyle/cayenne/event/EventManager.html" title="class in org.objectstyle.cayenne.event">EventManager</A> eventManager)</PRE> +<DL> +<DD>Creates new DataRowStore with a specified name and a set of properties. If no + properties are defined, default values are used. +<P> +<DL> +<DT><B>Parameters:</B><DD><CODE>name</CODE> - DataRowStore name. Used to idenitfy this DataRowStore in events, etc. + Can't be null.<DD><CODE>properties</CODE> - Properties map used to configure DataRowStore parameters. Can be + null.<DD><CODE>eventManager</CODE> - EventManager that should be used for posting and receiving + events.<DT><B>Since:</B></DT> + <DD>1.2</DD> +</DL> +</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="initWithProperties(java.util.Map)"><!-- --></A><H3> +initWithProperties</H3> +<PRE> +protected void <B>initWithProperties</B>(java.util.Map properties)</PRE> +<DL> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="size()"><!-- --></A><H3> +size</H3> +<PRE> +public int <B>size</B>()</PRE> +<DL> +<DD>Returns current cache size. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="maximumSize()"><!-- --></A><H3> +maximumSize</H3> +<PRE> +public int <B>maximumSize</B>()</PRE> +<DL> +<DD>Returns maximum allowed cache size. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="shutdown()"><!-- --></A><H3> +shutdown</H3> +<PRE> +public void <B>shutdown</B>()</PRE> +<DL> +<DD>Shuts down any remote notification connections, and clears internal cache. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getName()"><!-- --></A><H3> +getName</H3> +<PRE> +public java.lang.String <B>getName</B>()</PRE> +<DL> +<DD>Returns the name of this DataRowStore. Name allows to create EventSubjects for + event notifications addressed to or sent from this DataRowStore. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="setName(java.lang.String)"><!-- --></A><H3> +setName</H3> +<PRE> +public void <B>setName</B>(java.lang.String name)</PRE> +<DL> +<DD>Sets the name of this DataRowStore. Name allows to create EventSubjects for event + notifications addressed to or sent from this DataRowStore. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getEventManager()"><!-- --></A><H3> +getEventManager</H3> +<PRE> +public <A HREF="../../../../org/objectstyle/cayenne/event/EventManager.html" title="class in org.objectstyle.cayenne.event">EventManager</A> <B>getEventManager</B>()</PRE> +<DL> +<DD>Returns an EventManager associated with this DataRowStore. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Since:</B></DT> + <DD>1.2</DD> +</DL> +</DD> +</DL> +<HR> + +<A NAME="setEventManager(org.objectstyle.cayenne.event.EventManager)"><!-- --></A><H3> +setEventManager</H3> +<PRE> +public void <B>setEventManager</B>(<A HREF="../../../../org/objectstyle/cayenne/event/EventManager.html" title="class in org.objectstyle.cayenne.event">EventManager</A> eventManager)</PRE> +<DL> +<DD>Sets an EventManager associated with this DataRowStore. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<DT><B>Since:</B></DT> + <DD>1.2</DD> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getCachedSnapshot(org.objectstyle.cayenne.ObjectId)"><!-- --></A><H3> +getCachedSnapshot</H3> +<PRE> +public <A HREF="../../../../org/objectstyle/cayenne/DataRow.html" title="class in org.objectstyle.cayenne">DataRow</A> <B>getCachedSnapshot</B>(<A HREF="../../../../org/objectstyle/cayenne/ObjectId.html" title="class in org.objectstyle.cayenne">ObjectId</A> oid)</PRE> +<DL> +<DD>Returns cached snapshot or null if no snapshot is currently cached for the given + ObjectId. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getSnapshot(org.objectstyle.cayenne.ObjectId, org.objectstyle.cayenne.access.QueryEngine)"><!-- --></A><H3> +getSnapshot</H3> +<PRE> +public <A HREF="../../../../org/objectstyle/cayenne/DataRow.html" title="class in org.objectstyle.cayenne">DataRow</A> <B>getSnapshot</B>(<A HREF="../../../../org/objectstyle/cayenne/ObjectId.html" title="class in org.objectstyle.cayenne">ObjectId</A> oid, + <A HREF="../../../../org/objectstyle/cayenne/access/QueryEngine.html" title="interface in org.objectstyle.cayenne.access">QueryEngine</A> engine)</PRE> +<DL> +<DD><B>Deprecated.</B> <I>since 1.2 unused, as DataRowStore no longer performs queries on its + own.</I> +<P> +<DD>Returns a snapshot for ObjectId. If snapshot is currently cached, it is returned. + If not, a provided QueryEngine is used to fetch it from the database. If there is + no database row for a given id, null is returned. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="cacheSnapshots(java.lang.String, java.util.List)"><!-- --></A><H3> +cacheSnapshots</H3> +<PRE> +public void <B>cacheSnapshots</B>(java.lang.String key, + java.util.List snapshots)</PRE> +<DL> +<DD>Registers a list of snapshots with internal cache, using a String key. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getCachedSnapshots(java.lang.String)"><!-- --></A><H3> +getCachedSnapshots</H3> +<PRE> +public java.util.List <B>getCachedSnapshots</B>(java.lang.String key)</PRE> +<DL> +<DD>Returns a list of previously cached snapshots. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getSnapshotEventSubject()"><!-- --></A><H3> +getSnapshotEventSubject</H3> +<PRE> +public <A HREF="../../../../org/objectstyle/cayenne/event/EventSubject.html" title="class in org.objectstyle.cayenne.event">EventSubject</A> <B>getSnapshotEventSubject</B>()</PRE> +<DL> +<DD>Returns EventSubject used by this SnapshotCache to notify of snapshot changes. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="clear()"><!-- --></A><H3> +clear</H3> +<PRE> +public void <B>clear</B>()</PRE> +<DL> +<DD>Expires and removes all stored snapshots without sending any notification events. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="forgetSnapshot(org.objectstyle.cayenne.ObjectId)"><!-- --></A><H3> +forgetSnapshot</H3> +<PRE> +public void <B>forgetSnapshot</B>(<A HREF="../../../../org/objectstyle/cayenne/ObjectId.html" title="class in org.objectstyle.cayenne">ObjectId</A> id)</PRE> +<DL> +<DD>Evicts a snapshot from cache without generating any SnapshotEvents. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="processRemoteEvent(org.objectstyle.cayenne.access.event.SnapshotEvent)"><!-- --></A><H3> +processRemoteEvent</H3> +<PRE> +public void <B>processRemoteEvent</B>(<A HREF="../../../../org/objectstyle/cayenne/access/event/SnapshotEvent.html" title="class in org.objectstyle.cayenne.access.event">SnapshotEvent</A> event)</PRE> +<DL> +<DD>Handles remote events received via EventBridge. Performs needed snapshot updates, + and then resends the event to local listeners. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="processSnapshotChanges(java.lang.Object, java.util.Map, java.util.Collection, java.util.Collection)"><!-- --></A><H3> +processSnapshotChanges</H3> +<PRE> +public void <B>processSnapshotChanges</B>(java.lang.Object source, + java.util.Map updatedSnapshots, + java.util.Collection deletedSnapshotIds, + java.util.Collection indirectlyModifiedIds)</PRE> +<DL> +<DD><B>Deprecated.</B> <I></I> +<P> +<DD>Processes changes made to snapshots. Modifies internal cache state, and then sends + the event to all listeners. Source of these changes is usually an ObjectStore. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="processSnapshotChanges(java.lang.Object, java.util.Map, java.util.Collection, java.util.Collection, java.util.Collection)"><!-- --></A><H3> +processSnapshotChanges</H3> +<PRE> +public void <B>processSnapshotChanges</B>(java.lang.Object postedBy, + java.util.Map updatedSnapshots, + java.util.Collection deletedSnapshotIds, + java.util.Collection invalidatedSnapshotIds, + java.util.Collection indirectlyModifiedIds)</PRE> +<DL> +<DD>Processes changes made to snapshots. Modifies internal cache state, and then sends + the event to all listeners. Source of these changes is usually an ObjectStore. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="isNotifyingRemoteListeners()"><!-- --></A><H3> +isNotifyingRemoteListeners</H3> +<PRE> +public boolean <B>isNotifyingRemoteListeners</B>()</PRE> +<DL> +<DD><DL> +</DL> +</DD> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="setNotifyingRemoteListeners(boolean)"><!-- --></A><H3> +setNotifyingRemoteListeners</H3> +<PRE> +public void <B>setNotifyingRemoteListeners</B>(boolean notifyingRemoteListeners)</PRE> +<DL> +<DD><DL> +</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> </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="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-files/index-1.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/objectstyle/cayenne/access/DataPortDelegate.html" title="interface in org.objectstyle.cayenne.access"><B>PREV CLASS</B></A> + <A HREF="../../../../org/objectstyle/cayenne/access/DbGenerator.html" title="class in org.objectstyle.cayenne.access"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../index.html?org/objectstyle/cayenne/access/DataRowStore.html" target="_top"><B>FRAMES</B></A> + <A HREF="DataRowStore.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> + + <!--@SFLOGO@--> <i>Copyright © 2001-2006 <a href= + "http://objectstyle.org"; target="_top">ObjectStyle.org</a> All Rights Reserved.</i> + +</BODY> +</HTML>
http://git-wip-us.apache.org/repos/asf/cayenne-website/blob/0af753b3/docs/1.2/api/cayenne/org/objectstyle/cayenne/access/DbGenerator.html ---------------------------------------------------------------------- diff --git a/docs/1.2/api/cayenne/org/objectstyle/cayenne/access/DbGenerator.html b/docs/1.2/api/cayenne/org/objectstyle/cayenne/access/DbGenerator.html new file mode 100644 index 0000000..5502236 --- /dev/null +++ b/docs/1.2/api/cayenne/org/objectstyle/cayenne/access/DbGenerator.html @@ -0,0 +1,1066 @@ +<!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:42:41 EDT 2006 --> +<TITLE> +DbGenerator (Cayenne API Documentation - v.1.2) +</TITLE> + +<META NAME="keywords" CONTENT="org.objectstyle.cayenne.access.DbGenerator class"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../objectstyle-javadoc.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + parent.document.title="DbGenerator (Cayenne API Documentation - v.1.2)"; +} +</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> </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="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-files/index-1.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/objectstyle/cayenne/access/DataRowStore.html" title="class in org.objectstyle.cayenne.access"><B>PREV CLASS</B></A> + <A HREF="../../../../org/objectstyle/cayenne/access/DbLoader.html" title="class in org.objectstyle.cayenne.access"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../index.html?org/objectstyle/cayenne/access/DbGenerator.html" target="_top"><B>FRAMES</B></A> + <A HREF="DbGenerator.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.objectstyle.cayenne.access</FONT> +<BR> +Class DbGenerator</H2> +<PRE> +java.lang.Object + <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.objectstyle.cayenne.access.DbGenerator</B> +</PRE> +<HR> +<DL> +<DT><PRE>public class <B>DbGenerator</B><DT>extends java.lang.Object</DL> +</PRE> + +<P> +Utility class that generates database schema based on Cayenne mapping. It is a logical + counterpart of DbLoader class. +<P> + +<P> +<DL> +<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 <A HREF="../../../../org/objectstyle/cayenne/dba/DbAdapter.html" title="interface in org.objectstyle.cayenne.dba">DbAdapter</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DbGenerator.html#adapter">adapter</A></B></CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>protected java.util.Map</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DbGenerator.html#createFK">createFK</A></B></CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>protected java.util.List</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DbGenerator.html#createPK">createPK</A></B></CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>protected java.util.Map</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DbGenerator.html#createTables">createTables</A></B></CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>protected java.util.List</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DbGenerator.html#dbEntitiesInInsertOrder">dbEntitiesInInsertOrder</A></B></CODE> + +<BR> + Contains all DbEntities ordered considering their interdependencies.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>protected java.util.List</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DbGenerator.html#dbEntitiesRequiringAutoPK">dbEntitiesRequiringAutoPK</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/objectstyle/cayenne/access/DataDomain.html" title="class in org.objectstyle.cayenne.access">DataDomain</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DbGenerator.html#domain">domain</A></B></CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>protected java.util.List</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DbGenerator.html#dropPK">dropPK</A></B></CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>protected java.util.Map</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DbGenerator.html#dropTables">dropTables</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/objectstyle/cayenne/validation/ValidationResult.html" title="class in org.objectstyle.cayenne.validation">ValidationResult</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DbGenerator.html#failures">failures</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/objectstyle/cayenne/map/DataMap.html" title="class in org.objectstyle.cayenne.map">DataMap</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DbGenerator.html#map">map</A></B></CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>protected boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DbGenerator.html#shouldCreateFKConstraints">shouldCreateFKConstraints</A></B></CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>protected boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DbGenerator.html#shouldCreatePKSupport">shouldCreatePKSupport</A></B></CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>protected boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DbGenerator.html#shouldCreateTables">shouldCreateTables</A></B></CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>protected boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DbGenerator.html#shouldDropPKSupport">shouldDropPKSupport</A></B></CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>protected boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DbGenerator.html#shouldDropTables">shouldDropTables</A></B></CODE> + +<BR> + </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/objectstyle/cayenne/access/DbGenerator.html#DbGenerator(org.objectstyle.cayenne.dba.DbAdapter, org.objectstyle.cayenne.map.DataMap)">DbGenerator</A></B>(<A HREF="../../../../org/objectstyle/cayenne/dba/DbAdapter.html" title="interface in org.objectstyle.cayenne.dba">DbAdapter</A> adapter, + <A HREF="../../../../org/objectstyle/cayenne/map/DataMap.html" title="class in org.objectstyle.cayenne.map">DataMap</A> map)</CODE> + +<BR> + Creates and initializes new DbGenerator.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DbGenerator.html#DbGenerator(org.objectstyle.cayenne.dba.DbAdapter, org.objectstyle.cayenne.map.DataMap, java.util.Collection)">DbGenerator</A></B>(<A HREF="../../../../org/objectstyle/cayenne/dba/DbAdapter.html" title="interface in org.objectstyle.cayenne.dba">DbAdapter</A> adapter, + <A HREF="../../../../org/objectstyle/cayenne/map/DataMap.html" title="class in org.objectstyle.cayenne.map">DataMap</A> map, + java.util.Collection excludedEntities)</CODE> + +<BR> + Creates and initializes new DbGenerator instance.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DbGenerator.html#DbGenerator(org.objectstyle.cayenne.dba.DbAdapter, org.objectstyle.cayenne.map.DataMap, java.util.Collection, org.objectstyle.cayenne.access.DataDomain)">DbGenerator</A></B>(<A HREF="../../../../org/objectstyle/cayenne/dba/DbAdapter.html" title="interface in org.objectstyle.cayenne.dba">DbAdapter</A> adapter, + <A HREF="../../../../org/objectstyle/cayenne/map/DataMap.html" title="class in org.objectstyle.cayenne.map">DataMap</A> map, + java.util.Collection excludedEntities, + <A HREF="../../../../org/objectstyle/cayenne/access/DataDomain.html" title="class in org.objectstyle.cayenne.access">DataDomain</A> domain)</CODE> + +<BR> + Creates and initializes new DbGenerator instance.</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>protected void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DbGenerator.html#buildStatements()">buildStatements</A></B>()</CODE> + +<BR> + Creates and stores internally a set of statements for database schema creation, + ignoring configured schema creation preferences.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.util.List</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DbGenerator.html#configuredStatements()">configuredStatements</A></B>()</CODE> + +<BR> + Returns a list of all schema statements that should be executed with the current + configuration.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.util.List</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DbGenerator.html#createFkConstraintsQueries(org.objectstyle.cayenne.map.DbEntity)">createFkConstraintsQueries</A></B>(<A HREF="../../../../org/objectstyle/cayenne/map/DbEntity.html" title="class in org.objectstyle.cayenne.map">DbEntity</A> dbEnt)</CODE> + +<BR> + Returns an array of queries to create foreign key constraints for a particular + DbEntity.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../../org/objectstyle/cayenne/dba/DbAdapter.html" title="interface in org.objectstyle.cayenne.dba">DbAdapter</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DbGenerator.html#getAdapter()">getAdapter</A></B>()</CODE> + +<BR> + Returns DbAdapter associated with this DbGenerator.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../../org/objectstyle/cayenne/access/DataDomain.html" title="class in org.objectstyle.cayenne.access">DataDomain</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DbGenerator.html#getDomain()">getDomain</A></B>()</CODE> + +<BR> + Returns a DataDomain used by the DbGenerator to detect cross-database + relationships.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> <A HREF="../../../../org/objectstyle/cayenne/validation/ValidationResult.html" title="class in org.objectstyle.cayenne.validation">ValidationResult</A></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DbGenerator.html#getFailures()">getFailures</A></B>()</CODE> + +<BR> + Returns an object representing a collection of failures that occurred on the last + "runGenerator" invocation, or null if there were no failures.</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/objectstyle/cayenne/access/DbGenerator.html#isEmpty(boolean)">isEmpty</A></B>(boolean respectConfiguredSettings)</CODE> + +<BR> + Returns <code>true</code> if there is nothing to be done by this generator.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>protected void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DbGenerator.html#resetToDefaults()">resetToDefaults</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/objectstyle/cayenne/access/DbGenerator.html#runGenerator(javax.sql.DataSource)">runGenerator</A></B>(javax.sql.DataSource ds)</CODE> + +<BR> + Executes a set of commands to drop/create database objects.</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/objectstyle/cayenne/access/DbGenerator.html#runGenerator(org.objectstyle.cayenne.conn.DataSourceInfo)">runGenerator</A></B>(<A HREF="../../../../org/objectstyle/cayenne/conn/DataSourceInfo.html" title="class in org.objectstyle.cayenne.conn">DataSourceInfo</A> dsi)</CODE> + +<BR> + Creates a temporary DataSource out of DataSourceInfo and invokes + <code>public void runGenerator(DataSource ds)</code>.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>protected boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/access/DbGenerator.html#safeExecute(java.sql.Connection, java.lang.String)">safeExecute</A></B>(java.sql.Connection connection, + java.lang.String sql)</CODE> + +<BR> + Builds and executes a SQL statement, catching and storing SQL exceptions resulting + from invalid SQL.</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/objectstyle/cayenne/access/DbGenerator.html#setShouldCreateFKConstraints(boolean)">setShouldCreateFKConstraints</A></B>(boolean shouldCreateFKConstraints)</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/objectstyle/cayenne/access/DbGenerator.html#setShouldCreatePKSupport(boolean)">setShouldCreatePKSupport</A></B>(boolean shouldCreatePKSupport)</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/objectstyle/cayenne/access/DbGenerator.html#setShouldCreateTables(boolean)">setShouldCreateTables</A></B>(boolean shouldCreateTables)</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/objectstyle/cayenne/access/DbGenerator.html#setShouldDropPKSupport(boolean)">setShouldDropPKSupport</A></B>(boolean shouldDropPKSupport)</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/objectstyle/cayenne/access/DbGenerator.html#setShouldDropTables(boolean)">setShouldDropTables</A></B>(boolean shouldDropTables)</CODE> + +<BR> + </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/objectstyle/cayenne/access/DbGenerator.html#shouldCreateFKConstraints()">shouldCreateFKConstraints</A></B>()</CODE> + +<BR> + </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/objectstyle/cayenne/access/DbGenerator.html#shouldCreatePKSupport()">shouldCreatePKSupport</A></B>()</CODE> + +<BR> + Returns whether DbGenerator is configured to create primary key support for DataMap + entities.</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/objectstyle/cayenne/access/DbGenerator.html#shouldCreateTables()">shouldCreateTables</A></B>()</CODE> + +<BR> + Returns whether DbGenerator is configured to create tables for DataMap entities.</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/objectstyle/cayenne/access/DbGenerator.html#shouldDropPKSupport()">shouldDropPKSupport</A></B>()</CODE> + +<BR> + </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/objectstyle/cayenne/access/DbGenerator.html#shouldDropTables()">shouldDropTables</A></B>()</CODE> + +<BR> + </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.Object</B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</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="adapter"><!-- --></A><H3> +adapter</H3> +<PRE> +protected <A HREF="../../../../org/objectstyle/cayenne/dba/DbAdapter.html" title="interface in org.objectstyle.cayenne.dba">DbAdapter</A> <B>adapter</B></PRE> +<DL> +<DL> +</DL> +</DL> +<HR> + +<A NAME="map"><!-- --></A><H3> +map</H3> +<PRE> +protected <A HREF="../../../../org/objectstyle/cayenne/map/DataMap.html" title="class in org.objectstyle.cayenne.map">DataMap</A> <B>map</B></PRE> +<DL> +<DL> +</DL> +</DL> +<HR> + +<A NAME="domain"><!-- --></A><H3> +domain</H3> +<PRE> +protected <A HREF="../../../../org/objectstyle/cayenne/access/DataDomain.html" title="class in org.objectstyle.cayenne.access">DataDomain</A> <B>domain</B></PRE> +<DL> +<DL> +</DL> +</DL> +<HR> + +<A NAME="dropTables"><!-- --></A><H3> +dropTables</H3> +<PRE> +protected java.util.Map <B>dropTables</B></PRE> +<DL> +<DL> +</DL> +</DL> +<HR> + +<A NAME="createTables"><!-- --></A><H3> +createTables</H3> +<PRE> +protected java.util.Map <B>createTables</B></PRE> +<DL> +<DL> +</DL> +</DL> +<HR> + +<A NAME="createFK"><!-- --></A><H3> +createFK</H3> +<PRE> +protected java.util.Map <B>createFK</B></PRE> +<DL> +<DL> +</DL> +</DL> +<HR> + +<A NAME="createPK"><!-- --></A><H3> +createPK</H3> +<PRE> +protected java.util.List <B>createPK</B></PRE> +<DL> +<DL> +</DL> +</DL> +<HR> + +<A NAME="dropPK"><!-- --></A><H3> +dropPK</H3> +<PRE> +protected java.util.List <B>dropPK</B></PRE> +<DL> +<DL> +</DL> +</DL> +<HR> + +<A NAME="dbEntitiesInInsertOrder"><!-- --></A><H3> +dbEntitiesInInsertOrder</H3> +<PRE> +protected java.util.List <B>dbEntitiesInInsertOrder</B></PRE> +<DL> +<DD>Contains all DbEntities ordered considering their interdependencies. + DerivedDbEntities are filtered out of this list. +<P> +<DL> +</DL> +</DL> +<HR> + +<A NAME="dbEntitiesRequiringAutoPK"><!-- --></A><H3> +dbEntitiesRequiringAutoPK</H3> +<PRE> +protected java.util.List <B>dbEntitiesRequiringAutoPK</B></PRE> +<DL> +<DL> +</DL> +</DL> +<HR> + +<A NAME="shouldDropTables"><!-- --></A><H3> +shouldDropTables</H3> +<PRE> +protected boolean <B>shouldDropTables</B></PRE> +<DL> +<DL> +</DL> +</DL> +<HR> + +<A NAME="shouldCreateTables"><!-- --></A><H3> +shouldCreateTables</H3> +<PRE> +protected boolean <B>shouldCreateTables</B></PRE> +<DL> +<DL> +</DL> +</DL> +<HR> + +<A NAME="shouldDropPKSupport"><!-- --></A><H3> +shouldDropPKSupport</H3> +<PRE> +protected boolean <B>shouldDropPKSupport</B></PRE> +<DL> +<DL> +</DL> +</DL> +<HR> + +<A NAME="shouldCreatePKSupport"><!-- --></A><H3> +shouldCreatePKSupport</H3> +<PRE> +protected boolean <B>shouldCreatePKSupport</B></PRE> +<DL> +<DL> +</DL> +</DL> +<HR> + +<A NAME="shouldCreateFKConstraints"><!-- --></A><H3> +shouldCreateFKConstraints</H3> +<PRE> +protected boolean <B>shouldCreateFKConstraints</B></PRE> +<DL> +<DL> +</DL> +</DL> +<HR> + +<A NAME="failures"><!-- --></A><H3> +failures</H3> +<PRE> +protected <A HREF="../../../../org/objectstyle/cayenne/validation/ValidationResult.html" title="class in org.objectstyle.cayenne.validation">ValidationResult</A> <B>failures</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="DbGenerator(org.objectstyle.cayenne.dba.DbAdapter, org.objectstyle.cayenne.map.DataMap)"><!-- --></A><H3> +DbGenerator</H3> +<PRE> +public <B>DbGenerator</B>(<A HREF="../../../../org/objectstyle/cayenne/dba/DbAdapter.html" title="interface in org.objectstyle.cayenne.dba">DbAdapter</A> adapter, + <A HREF="../../../../org/objectstyle/cayenne/map/DataMap.html" title="class in org.objectstyle.cayenne.map">DataMap</A> map)</PRE> +<DL> +<DD>Creates and initializes new DbGenerator. +<P> +</DL> +<HR> + +<A NAME="DbGenerator(org.objectstyle.cayenne.dba.DbAdapter, org.objectstyle.cayenne.map.DataMap, java.util.Collection)"><!-- --></A><H3> +DbGenerator</H3> +<PRE> +public <B>DbGenerator</B>(<A HREF="../../../../org/objectstyle/cayenne/dba/DbAdapter.html" title="interface in org.objectstyle.cayenne.dba">DbAdapter</A> adapter, + <A HREF="../../../../org/objectstyle/cayenne/map/DataMap.html" title="class in org.objectstyle.cayenne.map">DataMap</A> map, + java.util.Collection excludedEntities)</PRE> +<DL> +<DD>Creates and initializes new DbGenerator instance. +<P> +<DL> +<DT><B>Parameters:</B><DD><CODE>adapter</CODE> - DbAdapter corresponding to the database<DD><CODE>map</CODE> - DataMap whose entities will be used in schema generation<DD><CODE>excludedEntities</CODE> - entities that should be ignored during schema generation</DL> +</DL> +<HR> + +<A NAME="DbGenerator(org.objectstyle.cayenne.dba.DbAdapter, org.objectstyle.cayenne.map.DataMap, java.util.Collection, org.objectstyle.cayenne.access.DataDomain)"><!-- --></A><H3> +DbGenerator</H3> +<PRE> +public <B>DbGenerator</B>(<A HREF="../../../../org/objectstyle/cayenne/dba/DbAdapter.html" title="interface in org.objectstyle.cayenne.dba">DbAdapter</A> adapter, + <A HREF="../../../../org/objectstyle/cayenne/map/DataMap.html" title="class in org.objectstyle.cayenne.map">DataMap</A> map, + java.util.Collection excludedEntities, + <A HREF="../../../../org/objectstyle/cayenne/access/DataDomain.html" title="class in org.objectstyle.cayenne.access">DataDomain</A> domain)</PRE> +<DL> +<DD>Creates and initializes new DbGenerator instance. +<P> +<DL> +<DT><B>Parameters:</B><DD><CODE>adapter</CODE> - DbAdapter corresponding to the database<DD><CODE>map</CODE> - DataMap whose entities will be used in schema generation<DD><CODE>excludedEntities</CODE> - entities that should be ignored during schema generation<DD><CODE>domain</CODE> - optional DataDomain used to detect cross-database relationships.<DT><B>Since:</B></DT> + <DD>1.2</DD> +</DL> +</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="resetToDefaults()"><!-- --></A><H3> +resetToDefaults</H3> +<PRE> +protected void <B>resetToDefaults</B>()</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="buildStatements()"><!-- --></A><H3> +buildStatements</H3> +<PRE> +protected void <B>buildStatements</B>()</PRE> +<DL> +<DD>Creates and stores internally a set of statements for database schema creation, + ignoring configured schema creation preferences. Statements are NOT executed in + this method. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="isEmpty(boolean)"><!-- --></A><H3> +isEmpty</H3> +<PRE> +public boolean <B>isEmpty</B>(boolean respectConfiguredSettings)</PRE> +<DL> +<DD>Returns <code>true</code> if there is nothing to be done by this generator. If + <code>respectConfiguredSettings</code> is <code>true</code>, checks are done + applying currently configured settings, otherwise check is done, assuming that all + possible generated objects. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getAdapter()"><!-- --></A><H3> +getAdapter</H3> +<PRE> +public <A HREF="../../../../org/objectstyle/cayenne/dba/DbAdapter.html" title="interface in org.objectstyle.cayenne.dba">DbAdapter</A> <B>getAdapter</B>()</PRE> +<DL> +<DD>Returns DbAdapter associated with this DbGenerator. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="configuredStatements()"><!-- --></A><H3> +configuredStatements</H3> +<PRE> +public java.util.List <B>configuredStatements</B>()</PRE> +<DL> +<DD>Returns a list of all schema statements that should be executed with the current + configuration. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="runGenerator(org.objectstyle.cayenne.conn.DataSourceInfo)"><!-- --></A><H3> +runGenerator</H3> +<PRE> +public void <B>runGenerator</B>(<A HREF="../../../../org/objectstyle/cayenne/conn/DataSourceInfo.html" title="class in org.objectstyle.cayenne.conn">DataSourceInfo</A> dsi) + throws java.lang.Exception</PRE> +<DL> +<DD>Creates a temporary DataSource out of DataSourceInfo and invokes + <code>public void runGenerator(DataSource ds)</code>. +<P> +<DD><DL> + +<DT><B>Throws:</B> +<DD><CODE>java.lang.Exception</CODE></DL> +</DD> +</DL> +<HR> + +<A NAME="runGenerator(javax.sql.DataSource)"><!-- --></A><H3> +runGenerator</H3> +<PRE> +public void <B>runGenerator</B>(javax.sql.DataSource ds) + throws java.lang.Exception</PRE> +<DL> +<DD>Executes a set of commands to drop/create database objects. This is the main worker + method of DbGenerator. Command set is built based on pre-configured generator + settings. +<P> +<DD><DL> + +<DT><B>Throws:</B> +<DD><CODE>java.lang.Exception</CODE></DL> +</DD> +</DL> +<HR> + +<A NAME="safeExecute(java.sql.Connection, java.lang.String)"><!-- --></A><H3> +safeExecute</H3> +<PRE> +protected boolean <B>safeExecute</B>(java.sql.Connection connection, + java.lang.String sql) + throws java.sql.SQLException</PRE> +<DL> +<DD>Builds and executes a SQL statement, catching and storing SQL exceptions resulting + from invalid SQL. Only non-recoverable exceptions are rethrown. +<P> +<DD><DL> + +<DT><B>Throws:</B> +<DD><CODE>java.sql.SQLException</CODE><DT><B>Since:</B></DT> + <DD>1.1</DD> +</DL> +</DD> +</DL> +<HR> + +<A NAME="createFkConstraintsQueries(org.objectstyle.cayenne.map.DbEntity)"><!-- --></A><H3> +createFkConstraintsQueries</H3> +<PRE> +public java.util.List <B>createFkConstraintsQueries</B>(<A HREF="../../../../org/objectstyle/cayenne/map/DbEntity.html" title="class in org.objectstyle.cayenne.map">DbEntity</A> dbEnt)</PRE> +<DL> +<DD>Returns an array of queries to create foreign key constraints for a particular + DbEntity. Throws CayenneRuntimeException, if called for adapter that does not + support FK constraints. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getFailures()"><!-- --></A><H3> +getFailures</H3> +<PRE> +public <A HREF="../../../../org/objectstyle/cayenne/validation/ValidationResult.html" title="class in org.objectstyle.cayenne.validation">ValidationResult</A> <B>getFailures</B>()</PRE> +<DL> +<DD>Returns an object representing a collection of failures that occurred on the last + "runGenerator" invocation, or null if there were no failures. Failures usually + indicate problems with generated DDL (such as "create...", "drop...", etc.) and + usually happen due to the DataMap being out of sync with the database. +<P> +<DD><DL> +<DT><B>Since:</B></DT> + <DD>1.1</DD> +</DL> +</DD> +</DL> +<HR> + +<A NAME="shouldCreatePKSupport()"><!-- --></A><H3> +shouldCreatePKSupport</H3> +<PRE> +public boolean <B>shouldCreatePKSupport</B>()</PRE> +<DL> +<DD>Returns whether DbGenerator is configured to create primary key support for DataMap + entities. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="shouldCreateTables()"><!-- --></A><H3> +shouldCreateTables</H3> +<PRE> +public boolean <B>shouldCreateTables</B>()</PRE> +<DL> +<DD>Returns whether DbGenerator is configured to create tables for DataMap entities. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="shouldDropPKSupport()"><!-- --></A><H3> +shouldDropPKSupport</H3> +<PRE> +public boolean <B>shouldDropPKSupport</B>()</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="shouldDropTables()"><!-- --></A><H3> +shouldDropTables</H3> +<PRE> +public boolean <B>shouldDropTables</B>()</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="shouldCreateFKConstraints()"><!-- --></A><H3> +shouldCreateFKConstraints</H3> +<PRE> +public boolean <B>shouldCreateFKConstraints</B>()</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="setShouldCreatePKSupport(boolean)"><!-- --></A><H3> +setShouldCreatePKSupport</H3> +<PRE> +public void <B>setShouldCreatePKSupport</B>(boolean shouldCreatePKSupport)</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="setShouldCreateTables(boolean)"><!-- --></A><H3> +setShouldCreateTables</H3> +<PRE> +public void <B>setShouldCreateTables</B>(boolean shouldCreateTables)</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="setShouldDropPKSupport(boolean)"><!-- --></A><H3> +setShouldDropPKSupport</H3> +<PRE> +public void <B>setShouldDropPKSupport</B>(boolean shouldDropPKSupport)</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="setShouldDropTables(boolean)"><!-- --></A><H3> +setShouldDropTables</H3> +<PRE> +public void <B>setShouldDropTables</B>(boolean shouldDropTables)</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="setShouldCreateFKConstraints(boolean)"><!-- --></A><H3> +setShouldCreateFKConstraints</H3> +<PRE> +public void <B>setShouldCreateFKConstraints</B>(boolean shouldCreateFKConstraints)</PRE> +<DL> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getDomain()"><!-- --></A><H3> +getDomain</H3> +<PRE> +public <A HREF="../../../../org/objectstyle/cayenne/access/DataDomain.html" title="class in org.objectstyle.cayenne.access">DataDomain</A> <B>getDomain</B>()</PRE> +<DL> +<DD>Returns a DataDomain used by the DbGenerator to detect cross-database + relationships. By default DataDomain is null. +<P> +<DD><DL> +<DT><B>Since:</B></DT> + <DD>1.2</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="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-files/index-1.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/objectstyle/cayenne/access/DataRowStore.html" title="class in org.objectstyle.cayenne.access"><B>PREV CLASS</B></A> + <A HREF="../../../../org/objectstyle/cayenne/access/DbLoader.html" title="class in org.objectstyle.cayenne.access"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../index.html?org/objectstyle/cayenne/access/DbGenerator.html" target="_top"><B>FRAMES</B></A> + <A HREF="DbGenerator.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> + + <!--@SFLOGO@--> <i>Copyright © 2001-2006 <a href= + "http://objectstyle.org"; target="_top">ObjectStyle.org</a> All Rights Reserved.</i> + +</BODY> +</HTML>
