blob: 96eebbd7c2a16261b12a89a5c9220eb42f1f3dee [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_06) on Wed Jul 19 14:42:46 EDT 2006 -->
<TITLE>
FrontBasePkGenerator (Cayenne API Documentation - v.1.2)
</TITLE>
<META NAME="keywords" CONTENT="org.objectstyle.cayenne.dba.frontbase.FrontBasePkGenerator class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../objectstyle-javadoc.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="FrontBasePkGenerator (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>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../org/objectstyle/cayenne/dba/frontbase/FrontBaseAdapter.html" title="class in org.objectstyle.cayenne.dba.frontbase"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../org/objectstyle/cayenne/dba/frontbase/FrontBaseSniffer.html" title="class in org.objectstyle.cayenne.dba.frontbase"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?org/objectstyle/cayenne/dba/frontbase/FrontBasePkGenerator.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="FrontBasePkGenerator.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_org.objectstyle.cayenne.dba.JdbcPkGenerator">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.objectstyle.cayenne.dba.frontbase</FONT>
<BR>
Class FrontBasePkGenerator</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../org/objectstyle/cayenne/dba/JdbcPkGenerator.html" title="class in org.objectstyle.cayenne.dba">org.objectstyle.cayenne.dba.JdbcPkGenerator</A>
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.objectstyle.cayenne.dba.frontbase.FrontBasePkGenerator</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../org/objectstyle/cayenne/dba/PkGenerator.html" title="interface in org.objectstyle.cayenne.dba">PkGenerator</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public class <B>FrontBasePkGenerator</B><DT>extends <A HREF="../../../../../org/objectstyle/cayenne/dba/JdbcPkGenerator.html" title="class in org.objectstyle.cayenne.dba">JdbcPkGenerator</A></DL>
</PRE>
<P>
<DL>
<DT><B>Since:</B></DT>
<DD>1.2</DD>
<DT><B>Author:</B></DT>
<DD>Andrus Adamchik</DD>
</DL>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Field Summary</B></FONT></TH>
</TR>
</TABLE>
&nbsp;<A NAME="fields_inherited_from_class_org.objectstyle.cayenne.dba.JdbcPkGenerator"><!-- --></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.objectstyle.cayenne.dba.<A HREF="../../../../../org/objectstyle/cayenne/dba/JdbcPkGenerator.html" title="class in org.objectstyle.cayenne.dba">JdbcPkGenerator</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../org/objectstyle/cayenne/dba/JdbcPkGenerator.html#DEFAULT_PK_CACHE_SIZE">DEFAULT_PK_CACHE_SIZE</A>, <A HREF="../../../../../org/objectstyle/cayenne/dba/JdbcPkGenerator.html#NEXT_ID">NEXT_ID</A>, <A HREF="../../../../../org/objectstyle/cayenne/dba/JdbcPkGenerator.html#objDesc">objDesc</A>, <A HREF="../../../../../org/objectstyle/cayenne/dba/JdbcPkGenerator.html#pkCache">pkCache</A>, <A HREF="../../../../../org/objectstyle/cayenne/dba/JdbcPkGenerator.html#pkCacheSize">pkCacheSize</A>, <A HREF="../../../../../org/objectstyle/cayenne/dba/JdbcPkGenerator.html#resultDesc">resultDesc</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../../org/objectstyle/cayenne/dba/frontbase/FrontBasePkGenerator.html#FrontBasePkGenerator()">FrontBasePkGenerator</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/objectstyle/cayenne/dba/frontbase/FrontBasePkGenerator.html#createAutoPk(org.objectstyle.cayenne.access.DataNode, java.util.List)">createAutoPk</A></B>(<A HREF="../../../../../org/objectstyle/cayenne/access/DataNode.html" title="class in org.objectstyle.cayenne.access">DataNode</A>&nbsp;node,
java.util.List&nbsp;dbEntities)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Generates necessary database objects to provide automatic primary key support.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.util.List</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/objectstyle/cayenne/dba/frontbase/FrontBasePkGenerator.html#createAutoPkStatements(java.util.List)">createAutoPkStatements</A></B>(java.util.List&nbsp;dbEntities)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a list of SQL strings needed to generates database objects to provide
automatic primary support for the list of entities.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/objectstyle/cayenne/dba/frontbase/FrontBasePkGenerator.html#dropAutoPk(org.objectstyle.cayenne.access.DataNode, java.util.List)">dropAutoPk</A></B>(<A HREF="../../../../../org/objectstyle/cayenne/access/DataNode.html" title="class in org.objectstyle.cayenne.access">DataNode</A>&nbsp;node,
java.util.List&nbsp;dbEntities)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Drops table named "AUTO_PK_SUPPORT" if it exists in the database.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/objectstyle/cayenne/dba/frontbase/FrontBasePkGenerator.html#dropAutoPkString()">dropAutoPkString</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/objectstyle/cayenne/dba/frontbase/FrontBasePkGenerator.html#getPkCacheSize()">getPkCacheSize</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Retruns zero as PK caching is not supported by FrontBaseAdapter.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/objectstyle/cayenne/dba/frontbase/FrontBasePkGenerator.html#pkCreateString(java.lang.String)">pkCreateString</A></B>(java.lang.String&nbsp;entName)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/objectstyle/cayenne/dba/frontbase/FrontBasePkGenerator.html#pkDeleteString(java.util.List)">pkDeleteString</A></B>(java.util.List&nbsp;dbEntities)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/objectstyle/cayenne/dba/frontbase/FrontBasePkGenerator.html#pkFromDatabase(org.objectstyle.cayenne.access.DataNode, org.objectstyle.cayenne.map.DbEntity)">pkFromDatabase</A></B>(<A HREF="../../../../../org/objectstyle/cayenne/access/DataNode.html" title="class in org.objectstyle.cayenne.access">DataNode</A>&nbsp;node,
<A HREF="../../../../../org/objectstyle/cayenne/map/DbEntity.html" title="class in org.objectstyle.cayenne.map">DbEntity</A>&nbsp;entity)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Performs primary key generation ignoring cache.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/objectstyle/cayenne/dba/frontbase/FrontBasePkGenerator.html#pkSelectString(java.lang.String)">pkSelectString</A></B>(java.lang.String&nbsp;entName)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/objectstyle/cayenne/dba/frontbase/FrontBasePkGenerator.html#pkTableCreateString()">pkTableCreateString</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/objectstyle/cayenne/dba/frontbase/FrontBasePkGenerator.html#pkUpdateString(java.lang.String)">pkUpdateString</A></B>(java.lang.String&nbsp;entName)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_org.objectstyle.cayenne.dba.JdbcPkGenerator"><!-- --></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.objectstyle.cayenne.dba.<A HREF="../../../../../org/objectstyle/cayenne/dba/JdbcPkGenerator.html" title="class in org.objectstyle.cayenne.dba">JdbcPkGenerator</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../org/objectstyle/cayenne/dba/JdbcPkGenerator.html#autoPkTableExists(org.objectstyle.cayenne.access.DataNode)">autoPkTableExists</A>, <A HREF="../../../../../org/objectstyle/cayenne/dba/JdbcPkGenerator.html#binaryPK(org.objectstyle.cayenne.map.DbEntity)">binaryPK</A>, <A HREF="../../../../../org/objectstyle/cayenne/dba/JdbcPkGenerator.html#dropAutoPkStatements(java.util.List)">dropAutoPkStatements</A>, <A HREF="../../../../../org/objectstyle/cayenne/dba/JdbcPkGenerator.html#generatePkForDbEntity(org.objectstyle.cayenne.access.DataNode, org.objectstyle.cayenne.map.DbEntity)">generatePkForDbEntity</A>, <A HREF="../../../../../org/objectstyle/cayenne/dba/JdbcPkGenerator.html#generatePkForDbEntityString(org.objectstyle.cayenne.map.DbEntity)">generatePkForDbEntityString</A>, <A HREF="../../../../../org/objectstyle/cayenne/dba/JdbcPkGenerator.html#reset()">reset</A>, <A HREF="../../../../../org/objectstyle/cayenne/dba/JdbcPkGenerator.html#runUpdate(org.objectstyle.cayenne.access.DataNode, java.lang.String)">runUpdate</A>, <A HREF="../../../../../org/objectstyle/cayenne/dba/JdbcPkGenerator.html#setPkCacheSize(int)">setPkCacheSize</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ========= 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="FrontBasePkGenerator()"><!-- --></A><H3>
FrontBasePkGenerator</H3>
<PRE>
public <B>FrontBasePkGenerator</B>()</PRE>
<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="getPkCacheSize()"><!-- --></A><H3>
getPkCacheSize</H3>
<PRE>
public int <B>getPkCacheSize</B>()</PRE>
<DL>
<DD>Retruns zero as PK caching is not supported by FrontBaseAdapter.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/objectstyle/cayenne/dba/JdbcPkGenerator.html#getPkCacheSize()">getPkCacheSize</A></CODE> in class <CODE><A HREF="../../../../../org/objectstyle/cayenne/dba/JdbcPkGenerator.html" title="class in org.objectstyle.cayenne.dba">JdbcPkGenerator</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="createAutoPk(org.objectstyle.cayenne.access.DataNode, java.util.List)"><!-- --></A><H3>
createAutoPk</H3>
<PRE>
public void <B>createAutoPk</B>(<A HREF="../../../../../org/objectstyle/cayenne/access/DataNode.html" title="class in org.objectstyle.cayenne.access">DataNode</A>&nbsp;node,
java.util.List&nbsp;dbEntities)
throws java.lang.Exception</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/objectstyle/cayenne/dba/PkGenerator.html#createAutoPk(org.objectstyle.cayenne.access.DataNode, java.util.List)">PkGenerator</A></CODE></B></DD>
<DD>Generates necessary database objects to provide automatic primary key support.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/objectstyle/cayenne/dba/PkGenerator.html#createAutoPk(org.objectstyle.cayenne.access.DataNode, java.util.List)">createAutoPk</A></CODE> in interface <CODE><A HREF="../../../../../org/objectstyle/cayenne/dba/PkGenerator.html" title="interface in org.objectstyle.cayenne.dba">PkGenerator</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/objectstyle/cayenne/dba/JdbcPkGenerator.html#createAutoPk(org.objectstyle.cayenne.access.DataNode, java.util.List)">createAutoPk</A></CODE> in class <CODE><A HREF="../../../../../org/objectstyle/cayenne/dba/JdbcPkGenerator.html" title="class in org.objectstyle.cayenne.dba">JdbcPkGenerator</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>node</CODE> - node that provides access to a DataSource.<DD><CODE>dbEntities</CODE> - a list of entities that require primary key autogeneration
support
<DT><B>Throws:</B>
<DD><CODE>java.lang.Exception</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="createAutoPkStatements(java.util.List)"><!-- --></A><H3>
createAutoPkStatements</H3>
<PRE>
public java.util.List <B>createAutoPkStatements</B>(java.util.List&nbsp;dbEntities)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/objectstyle/cayenne/dba/PkGenerator.html#createAutoPkStatements(java.util.List)">PkGenerator</A></CODE></B></DD>
<DD>Returns a list of SQL strings needed to generates database objects to provide
automatic primary support for the list of entities. No actual database operations
are performed.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/objectstyle/cayenne/dba/PkGenerator.html#createAutoPkStatements(java.util.List)">createAutoPkStatements</A></CODE> in interface <CODE><A HREF="../../../../../org/objectstyle/cayenne/dba/PkGenerator.html" title="interface in org.objectstyle.cayenne.dba">PkGenerator</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/objectstyle/cayenne/dba/JdbcPkGenerator.html#createAutoPkStatements(java.util.List)">createAutoPkStatements</A></CODE> in class <CODE><A HREF="../../../../../org/objectstyle/cayenne/dba/JdbcPkGenerator.html" title="class in org.objectstyle.cayenne.dba">JdbcPkGenerator</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="dropAutoPk(org.objectstyle.cayenne.access.DataNode, java.util.List)"><!-- --></A><H3>
dropAutoPk</H3>
<PRE>
public void <B>dropAutoPk</B>(<A HREF="../../../../../org/objectstyle/cayenne/access/DataNode.html" title="class in org.objectstyle.cayenne.access">DataNode</A>&nbsp;node,
java.util.List&nbsp;dbEntities)
throws java.lang.Exception</PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../../../org/objectstyle/cayenne/dba/JdbcPkGenerator.html#dropAutoPk(org.objectstyle.cayenne.access.DataNode, java.util.List)">JdbcPkGenerator</A></CODE></B></DD>
<DD>Drops table named "AUTO_PK_SUPPORT" if it exists in the database.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/objectstyle/cayenne/dba/PkGenerator.html#dropAutoPk(org.objectstyle.cayenne.access.DataNode, java.util.List)">dropAutoPk</A></CODE> in interface <CODE><A HREF="../../../../../org/objectstyle/cayenne/dba/PkGenerator.html" title="interface in org.objectstyle.cayenne.dba">PkGenerator</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/objectstyle/cayenne/dba/JdbcPkGenerator.html#dropAutoPk(org.objectstyle.cayenne.access.DataNode, java.util.List)">dropAutoPk</A></CODE> in class <CODE><A HREF="../../../../../org/objectstyle/cayenne/dba/JdbcPkGenerator.html" title="class in org.objectstyle.cayenne.dba">JdbcPkGenerator</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>node</CODE> - node that provides access to a DataSource.<DD><CODE>dbEntities</CODE> - a list of entities whose primary key autogeneration support
should be dropped.
<DT><B>Throws:</B>
<DD><CODE>java.lang.Exception</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="pkTableCreateString()"><!-- --></A><H3>
pkTableCreateString</H3>
<PRE>
protected java.lang.String <B>pkTableCreateString</B>()</PRE>
<DL>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/objectstyle/cayenne/dba/JdbcPkGenerator.html#pkTableCreateString()">pkTableCreateString</A></CODE> in class <CODE><A HREF="../../../../../org/objectstyle/cayenne/dba/JdbcPkGenerator.html" title="class in org.objectstyle.cayenne.dba">JdbcPkGenerator</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="pkDeleteString(java.util.List)"><!-- --></A><H3>
pkDeleteString</H3>
<PRE>
protected java.lang.String <B>pkDeleteString</B>(java.util.List&nbsp;dbEntities)</PRE>
<DL>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/objectstyle/cayenne/dba/JdbcPkGenerator.html#pkDeleteString(java.util.List)">pkDeleteString</A></CODE> in class <CODE><A HREF="../../../../../org/objectstyle/cayenne/dba/JdbcPkGenerator.html" title="class in org.objectstyle.cayenne.dba">JdbcPkGenerator</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="pkCreateString(java.lang.String)"><!-- --></A><H3>
pkCreateString</H3>
<PRE>
protected java.lang.String <B>pkCreateString</B>(java.lang.String&nbsp;entName)</PRE>
<DL>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/objectstyle/cayenne/dba/JdbcPkGenerator.html#pkCreateString(java.lang.String)">pkCreateString</A></CODE> in class <CODE><A HREF="../../../../../org/objectstyle/cayenne/dba/JdbcPkGenerator.html" title="class in org.objectstyle.cayenne.dba">JdbcPkGenerator</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="pkSelectString(java.lang.String)"><!-- --></A><H3>
pkSelectString</H3>
<PRE>
protected java.lang.String <B>pkSelectString</B>(java.lang.String&nbsp;entName)</PRE>
<DL>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/objectstyle/cayenne/dba/JdbcPkGenerator.html#pkSelectString(java.lang.String)">pkSelectString</A></CODE> in class <CODE><A HREF="../../../../../org/objectstyle/cayenne/dba/JdbcPkGenerator.html" title="class in org.objectstyle.cayenne.dba">JdbcPkGenerator</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="pkUpdateString(java.lang.String)"><!-- --></A><H3>
pkUpdateString</H3>
<PRE>
protected java.lang.String <B>pkUpdateString</B>(java.lang.String&nbsp;entName)</PRE>
<DL>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/objectstyle/cayenne/dba/JdbcPkGenerator.html#pkUpdateString(java.lang.String)">pkUpdateString</A></CODE> in class <CODE><A HREF="../../../../../org/objectstyle/cayenne/dba/JdbcPkGenerator.html" title="class in org.objectstyle.cayenne.dba">JdbcPkGenerator</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="dropAutoPkString()"><!-- --></A><H3>
dropAutoPkString</H3>
<PRE>
protected java.lang.String <B>dropAutoPkString</B>()</PRE>
<DL>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/objectstyle/cayenne/dba/JdbcPkGenerator.html#dropAutoPkString()">dropAutoPkString</A></CODE> in class <CODE><A HREF="../../../../../org/objectstyle/cayenne/dba/JdbcPkGenerator.html" title="class in org.objectstyle.cayenne.dba">JdbcPkGenerator</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="pkFromDatabase(org.objectstyle.cayenne.access.DataNode, org.objectstyle.cayenne.map.DbEntity)"><!-- --></A><H3>
pkFromDatabase</H3>
<PRE>
protected int <B>pkFromDatabase</B>(<A HREF="../../../../../org/objectstyle/cayenne/access/DataNode.html" title="class in org.objectstyle.cayenne.access">DataNode</A>&nbsp;node,
<A HREF="../../../../../org/objectstyle/cayenne/map/DbEntity.html" title="class in org.objectstyle.cayenne.map">DbEntity</A>&nbsp;entity)
throws java.lang.Exception</PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../../../org/objectstyle/cayenne/dba/JdbcPkGenerator.html#pkFromDatabase(org.objectstyle.cayenne.access.DataNode, org.objectstyle.cayenne.map.DbEntity)">JdbcPkGenerator</A></CODE></B></DD>
<DD>Performs primary key generation ignoring cache. Generates a range of primary keys
as specified by "pkCacheSize" bean property.
<p>
This method is called internally from "generatePkForDbEntity" and then generated
range of key values is saved in cache for performance. Subclasses that implement
different primary key generation solutions should override this method, not
"generatePkForDbEntity".
</p>
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/objectstyle/cayenne/dba/JdbcPkGenerator.html#pkFromDatabase(org.objectstyle.cayenne.access.DataNode, org.objectstyle.cayenne.map.DbEntity)">pkFromDatabase</A></CODE> in class <CODE><A HREF="../../../../../org/objectstyle/cayenne/dba/JdbcPkGenerator.html" title="class in org.objectstyle.cayenne.dba">JdbcPkGenerator</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE>java.lang.Exception</CODE></DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../org/objectstyle/cayenne/dba/frontbase/FrontBaseAdapter.html" title="class in org.objectstyle.cayenne.dba.frontbase"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../org/objectstyle/cayenne/dba/frontbase/FrontBaseSniffer.html" title="class in org.objectstyle.cayenne.dba.frontbase"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?org/objectstyle/cayenne/dba/frontbase/FrontBasePkGenerator.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="FrontBasePkGenerator.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_org.objectstyle.cayenne.dba.JdbcPkGenerator">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<!--@SFLOGO@--> &nbsp; <i>Copyright &#169; 2001-2006 <a href=
"http://objectstyle.org" target="_top">ObjectStyle.org</a> All Rights Reserved.</i>
</BODY>
</HTML>