| <!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_41) on Fri Apr 12 14:46:32 CDT 2013 --> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <TITLE> |
| ForeignKey (OpenJPA Parent POM 1.2.3 API) |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.apache.openjpa.jdbc.schema.ForeignKey class"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="ForeignKey (OpenJPA Parent POM 1.2.3 API)"; |
| } |
| </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="class-use/ForeignKey.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../org/apache/openjpa/jdbc/schema/FileSchemaFactory.html" title="class in org.apache.openjpa.jdbc.schema"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../org/apache/openjpa/jdbc/schema/Index.html" title="class in org.apache.openjpa.jdbc.schema"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../index.html?org/apache/openjpa/jdbc/schema/ForeignKey.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="ForeignKey.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.apache.openjpa.jdbc.schema</FONT> |
| <BR> |
| Class ForeignKey</H2> |
| <PRE> |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">java.lang.Object</A> |
| <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../org/apache/openjpa/jdbc/schema/ReferenceCounter.html" title="class in org.apache.openjpa.jdbc.schema">org.apache.openjpa.jdbc.schema.ReferenceCounter</A> |
| <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../org/apache/openjpa/jdbc/schema/Constraint.html" title="class in org.apache.openjpa.jdbc.schema">org.apache.openjpa.jdbc.schema.Constraint</A> |
| <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.openjpa.jdbc.schema.ForeignKey</B> |
| </PRE> |
| <DL> |
| <DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/Serializable.html" title="class or interface in java.io">Serializable</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public class <B>ForeignKey</B><DT>extends <A HREF="../../../../../org/apache/openjpa/jdbc/schema/Constraint.html" title="class in org.apache.openjpa.jdbc.schema">Constraint</A></DL> |
| </PRE> |
| |
| <P> |
| Represents a database foreign key; may be a logical key with no |
| database representation. This class can also represent a partial key, |
| aligning with <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/sql/DatabaseMetaData.html" title="class or interface in java.sql"><CODE>DatabaseMetaData</CODE></A>. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Author:</B></DT> |
| <DD>Abe White</DD> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../serialized-form.html#org.apache.openjpa.jdbc.schema.ForeignKey">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 int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#ACTION_CASCADE">ACTION_CASCADE</A></B></CODE> |
| |
| <BR> |
| Cascade any modification of the joined primary key columns to |
| this table.</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/apache/openjpa/jdbc/schema/ForeignKey.html#ACTION_DEFAULT">ACTION_DEFAULT</A></B></CODE> |
| |
| <BR> |
| Set the local columns to their default values if the primary key |
| columns are modified.</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/apache/openjpa/jdbc/schema/ForeignKey.html#ACTION_NONE">ACTION_NONE</A></B></CODE> |
| |
| <BR> |
| Logical foreign key; links columns, but does not perform any action |
| when the joined primary key columns are modified.</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/apache/openjpa/jdbc/schema/ForeignKey.html#ACTION_NULL">ACTION_NULL</A></B></CODE> |
| |
| <BR> |
| Null the local columns if the joined primary key columns are modified.</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/apache/openjpa/jdbc/schema/ForeignKey.html#ACTION_RESTRICT">ACTION_RESTRICT</A></B></CODE> |
| |
| <BR> |
| Throw an exception if joined primary key columns are modified.</TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| |
| <A NAME="constructor_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Constructor Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#ForeignKey()">ForeignKey</A></B>()</CODE> |
| |
| <BR> |
| Default constructor.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#ForeignKey(java.lang.String, org.apache.openjpa.jdbc.schema.Table)">ForeignKey</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> name, |
| <A HREF="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</A> table)</CODE> |
| |
| <BR> |
| Constructor.</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> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#columnsMatch(org.apache.openjpa.jdbc.schema.Column[], org.apache.openjpa.jdbc.schema.Column[])">columnsMatch</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A>[] fkCols, |
| <A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A>[] fkPKCols)</CODE> |
| |
| <BR> |
| Return true if the given local and foreign columns match those |
| on this key.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#containsColumn(org.apache.openjpa.jdbc.schema.Column)">containsColumn</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A> col)</CODE> |
| |
| <BR> |
| Return true if the fk includes the given local column.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#containsConstantColumn(org.apache.openjpa.jdbc.schema.Column)">containsConstantColumn</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A> col)</CODE> |
| |
| <BR> |
| Return true if the fk includes the given local column.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#containsConstantPrimaryKeyColumn(org.apache.openjpa.jdbc.schema.Column)">containsConstantPrimaryKeyColumn</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A> col)</CODE> |
| |
| <BR> |
| Return true if the fk includes the given primary key column.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#containsPrimaryKeyColumn(org.apache.openjpa.jdbc.schema.Column)">containsPrimaryKeyColumn</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A> col)</CODE> |
| |
| <BR> |
| Return true if the fk includes the given primary key column.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#derefColumns()">derefColumns</A></B>()</CODE> |
| |
| <BR> |
| Deref all columns in this key.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#equalsForeignKey(org.apache.openjpa.jdbc.schema.ForeignKey)">equalsForeignKey</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html" title="class in org.apache.openjpa.jdbc.schema">ForeignKey</A> fk)</CODE> |
| |
| <BR> |
| Foreign keys are equal if the satisfy the equality constraints of |
| <A HREF="../../../../../org/apache/openjpa/jdbc/schema/Constraint.html" title="class in org.apache.openjpa.jdbc.schema"><CODE>Constraint</CODE></A> and they have the same local and primary key |
| columns and action.</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/apache/openjpa/jdbc/schema/ForeignKey.html#getAction(java.lang.String)">getAction</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> name)</CODE> |
| |
| <BR> |
| Return the foreign key action constant for the given action name.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#getActionName(int)">getActionName</A></B>(int action)</CODE> |
| |
| <BR> |
| Return the foreign key action name for the given action constant.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#getColumn(org.apache.openjpa.jdbc.schema.Column)">getColumn</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A> pk)</CODE> |
| |
| <BR> |
| Return the local column joined to the given primary key column.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A>[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#getColumns()">getColumns</A></B>()</CODE> |
| |
| <BR> |
| Return the local columns in the foreign key local table order.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#getConstant(org.apache.openjpa.jdbc.schema.Column)">getConstant</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A> local)</CODE> |
| |
| <BR> |
| Return the constant value assigned to the given local column.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A>[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#getConstantColumns()">getConstantColumns</A></B>()</CODE> |
| |
| <BR> |
| Return the local columns that we link to using constant values.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A>[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#getConstantPrimaryKeyColumns()">getConstantPrimaryKeyColumns</A></B>()</CODE> |
| |
| <BR> |
| Return the primary key columns that we link to using constant values.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#getConstants()">getConstants</A></B>()</CODE> |
| |
| <BR> |
| Return the constant values assigned to the local columns |
| returned by <A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#getConstantColumns()"><CODE>getConstantColumns()</CODE></A>.</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/apache/openjpa/jdbc/schema/ForeignKey.html#getDeleteAction()">getDeleteAction</A></B>()</CODE> |
| |
| <BR> |
| Return the delete action for the key.</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/apache/openjpa/jdbc/schema/ForeignKey.html#getIndex()">getIndex</A></B>()</CODE> |
| |
| <BR> |
| Return the foreign key's 0-based index in the owning table.</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/apache/openjpa/jdbc/schema/ForeignKey.html#getKeySequence()">getKeySequence</A></B>()</CODE> |
| |
| <BR> |
| The sequence of this join in the foreign key.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#getPrimaryKeyColumn(org.apache.openjpa.jdbc.schema.Column)">getPrimaryKeyColumn</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A> local)</CODE> |
| |
| <BR> |
| Return the primary key column joined to the given local column.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#getPrimaryKeyColumnName()">getPrimaryKeyColumnName</A></B>()</CODE> |
| |
| <BR> |
| The name of the primary key column.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A>[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#getPrimaryKeyColumns()">getPrimaryKeyColumns</A></B>()</CODE> |
| |
| <BR> |
| Return the foreign columns in the foreign key, in join-order with |
| the result of <A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#getColumns()"><CODE>getColumns()</CODE></A>.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#getPrimaryKeyConstant(org.apache.openjpa.jdbc.schema.Column)">getPrimaryKeyConstant</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A> pk)</CODE> |
| |
| <BR> |
| Return the constant value assigned to the given primary key column.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#getPrimaryKeyConstants()">getPrimaryKeyConstants</A></B>()</CODE> |
| |
| <BR> |
| Return the constant values assigned to the primary key columns |
| returned by <A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#getConstantPrimaryKeyColumns()"><CODE>getConstantPrimaryKeyColumns()</CODE></A>.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#getPrimaryKeySchemaName()">getPrimaryKeySchemaName</A></B>()</CODE> |
| |
| <BR> |
| The name of the primary key table's schema.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#getPrimaryKeyTable()">getPrimaryKeyTable</A></B>()</CODE> |
| |
| <BR> |
| Returns the table this foreign key is linking to, if it is known yet.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#getPrimaryKeyTableName()">getPrimaryKeyTableName</A></B>()</CODE> |
| |
| <BR> |
| The name of the primary key table.</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/apache/openjpa/jdbc/schema/ForeignKey.html#getUpdateAction()">getUpdateAction</A></B>()</CODE> |
| |
| <BR> |
| Return the update action for the key.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#hasNotNullColumns()">hasNotNullColumns</A></B>()</CODE> |
| |
| <BR> |
| Checks for non-nullable local columns.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#isLogical()">isLogical</A></B>()</CODE> |
| |
| <BR> |
| Return whether this constraint is a logical constraint only; i.e.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#isPrimaryKeyAutoAssigned()">isPrimaryKeyAutoAssigned</A></B>()</CODE> |
| |
| <BR> |
| Whether the primary key columns of this key are auto-incrementing, or |
| whether they themselves are members of a foreign key who's primary key |
| is auto-incrementing (recursing to arbitrary depth).</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#join(org.apache.openjpa.jdbc.schema.Column, org.apache.openjpa.jdbc.schema.Column)">join</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A> local, |
| <A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A> toPK)</CODE> |
| |
| <BR> |
| Join a local column to a primary key column of another table.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#joinConstant(org.apache.openjpa.jdbc.schema.Column, java.lang.Object)">joinConstant</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A> col, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> val)</CODE> |
| |
| <BR> |
| Join a constant value to a local column of this table.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#joinConstant(java.lang.Object, org.apache.openjpa.jdbc.schema.Column)">joinConstant</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> val, |
| <A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A> toPK)</CODE> |
| |
| <BR> |
| Join a constant value to a primary key column of another table.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#refColumns()">refColumns</A></B>()</CODE> |
| |
| <BR> |
| Ref all columns in this key.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#removeJoin(org.apache.openjpa.jdbc.schema.Column)">removeJoin</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A> col)</CODE> |
| |
| <BR> |
| Remove any joins inolving the given column.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#setConstantJoins(org.apache.openjpa.jdbc.schema.Column[], java.lang.Object[])">setConstantJoins</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A>[] cols, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>[] consts)</CODE> |
| |
| <BR> |
| Set the foreign key's constant joins.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#setConstantJoins(java.lang.Object[], org.apache.openjpa.jdbc.schema.Column[])">setConstantJoins</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>[] consts, |
| <A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A>[] pkCols)</CODE> |
| |
| <BR> |
| Set the foreign key's constant joins.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#setDeleteAction(int)">setDeleteAction</A></B>(int action)</CODE> |
| |
| <BR> |
| Set the delete action for the key.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>(package private) void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#setIndex(int)">setIndex</A></B>(int index)</CODE> |
| |
| <BR> |
| Set the foreign key's 0-based index in the owning table.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#setJoins(org.apache.openjpa.jdbc.schema.Column[], org.apache.openjpa.jdbc.schema.Column[])">setJoins</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A>[] cols, |
| <A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A>[] pkCols)</CODE> |
| |
| <BR> |
| Set the foreign key's joins.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#setKeySequence(int)">setKeySequence</A></B>(int seq)</CODE> |
| |
| <BR> |
| The sequence of this join in the foreign 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/apache/openjpa/jdbc/schema/ForeignKey.html#setPrimaryKeyColumnName(java.lang.String)">setPrimaryKeyColumnName</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> pkColumnName)</CODE> |
| |
| <BR> |
| The name of the primary key column.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#setPrimaryKeySchemaName(java.lang.String)">setPrimaryKeySchemaName</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> pkSchemaName)</CODE> |
| |
| <BR> |
| The name of the primary key table's schema.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#setPrimaryKeyTableName(java.lang.String)">setPrimaryKeyTableName</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> pkTableName)</CODE> |
| |
| <BR> |
| The name of the primary key table.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#setUpdateAction(int)">setUpdateAction</A></B>(int action)</CODE> |
| |
| <BR> |
| Set the update action for the key.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.apache.openjpa.jdbc.schema.Constraint"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class org.apache.openjpa.jdbc.schema.<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Constraint.html" title="class in org.apache.openjpa.jdbc.schema">Constraint</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../../org/apache/openjpa/jdbc/schema/Constraint.html#getColumnName()">getColumnName</A>, <A HREF="../../../../../org/apache/openjpa/jdbc/schema/Constraint.html#getFullName()">getFullName</A>, <A HREF="../../../../../org/apache/openjpa/jdbc/schema/Constraint.html#getName()">getName</A>, <A HREF="../../../../../org/apache/openjpa/jdbc/schema/Constraint.html#getSchemaName()">getSchemaName</A>, <A HREF="../../../../../org/apache/openjpa/jdbc/schema/Constraint.html#getTable()">getTable</A>, <A HREF="../../../../../org/apache/openjpa/jdbc/schema/Constraint.html#getTableName()">getTableName</A>, <A HREF="../../../../../org/apache/openjpa/jdbc/schema/Constraint.html#isDeferred()">isDeferred</A>, <A HREF="../../../../../org/apache/openjpa/jdbc/schema/Constraint.html#remove()">remove</A>, <A HREF="../../../../../org/apache/openjpa/jdbc/schema/Constraint.html#setColumnName(java.lang.String)">setColumnName</A>, <A HREF="../../../../../org/apache/openjpa/jdbc/schema/Constraint.html#setDeferred(boolean)">setDeferred</A>, <A HREF="../../../../../org/apache/openjpa/jdbc/schema/Constraint.html#setName(java.lang.String)">setName</A>, <A HREF="../../../../../org/apache/openjpa/jdbc/schema/Constraint.html#setSchemaName(java.lang.String)">setSchemaName</A>, <A HREF="../../../../../org/apache/openjpa/jdbc/schema/Constraint.html#setTableName(java.lang.String)">setTableName</A>, <A HREF="../../../../../org/apache/openjpa/jdbc/schema/Constraint.html#toString()">toString</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.apache.openjpa.jdbc.schema.ReferenceCounter"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class org.apache.openjpa.jdbc.schema.<A HREF="../../../../../org/apache/openjpa/jdbc/schema/ReferenceCounter.html" title="class in org.apache.openjpa.jdbc.schema">ReferenceCounter</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../../org/apache/openjpa/jdbc/schema/ReferenceCounter.html#deref()">deref</A>, <A HREF="../../../../../org/apache/openjpa/jdbc/schema/ReferenceCounter.html#getRefCount()">getRefCount</A>, <A HREF="../../../../../org/apache/openjpa/jdbc/schema/ReferenceCounter.html#ref()">ref</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ FIELD DETAIL =========== --> |
| |
| <A NAME="field_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Field Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="ACTION_NONE"><!-- --></A><H3> |
| ACTION_NONE</H3> |
| <PRE> |
| public static final int <B>ACTION_NONE</B></PRE> |
| <DL> |
| <DD>Logical foreign key; links columns, but does not perform any action |
| when the joined primary key columns are modified. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.openjpa.jdbc.schema.ForeignKey.ACTION_NONE">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="ACTION_RESTRICT"><!-- --></A><H3> |
| ACTION_RESTRICT</H3> |
| <PRE> |
| public static final int <B>ACTION_RESTRICT</B></PRE> |
| <DL> |
| <DD>Throw an exception if joined primary key columns are modified. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.openjpa.jdbc.schema.ForeignKey.ACTION_RESTRICT">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="ACTION_CASCADE"><!-- --></A><H3> |
| ACTION_CASCADE</H3> |
| <PRE> |
| public static final int <B>ACTION_CASCADE</B></PRE> |
| <DL> |
| <DD>Cascade any modification of the joined primary key columns to |
| this table. If the joined primary key row is deleted, the row in this |
| table will also be deleted. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.openjpa.jdbc.schema.ForeignKey.ACTION_CASCADE">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="ACTION_NULL"><!-- --></A><H3> |
| ACTION_NULL</H3> |
| <PRE> |
| public static final int <B>ACTION_NULL</B></PRE> |
| <DL> |
| <DD>Null the local columns if the joined primary key columns are modified. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.openjpa.jdbc.schema.ForeignKey.ACTION_NULL">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="ACTION_DEFAULT"><!-- --></A><H3> |
| ACTION_DEFAULT</H3> |
| <PRE> |
| public static final int <B>ACTION_DEFAULT</B></PRE> |
| <DL> |
| <DD>Set the local columns to their default values if the primary key |
| columns are modified. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.openjpa.jdbc.schema.ForeignKey.ACTION_DEFAULT">Constant Field Values</A></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="ForeignKey()"><!-- --></A><H3> |
| ForeignKey</H3> |
| <PRE> |
| public <B>ForeignKey</B>()</PRE> |
| <DL> |
| <DD>Default constructor. |
| <P> |
| </DL> |
| <HR> |
| |
| <A NAME="ForeignKey(java.lang.String, org.apache.openjpa.jdbc.schema.Table)"><!-- --></A><H3> |
| ForeignKey</H3> |
| <PRE> |
| public <B>ForeignKey</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> name, |
| <A HREF="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</A> table)</PRE> |
| <DL> |
| <DD>Constructor. |
| <P> |
| <DL> |
| <DT><B>Parameters:</B><DD><CODE>name</CODE> - the foreign key name, if any<DD><CODE>table</CODE> - the local table of the foreign key</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="getAction(java.lang.String)"><!-- --></A><H3> |
| getAction</H3> |
| <PRE> |
| public static int <B>getAction</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> name)</PRE> |
| <DL> |
| <DD>Return the foreign key action constant for the given action name. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getActionName(int)"><!-- --></A><H3> |
| getActionName</H3> |
| <PRE> |
| public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getActionName</B>(int action)</PRE> |
| <DL> |
| <DD>Return the foreign key action name for the given action constant. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isLogical()"><!-- --></A><H3> |
| isLogical</H3> |
| <PRE> |
| public boolean <B>isLogical</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from class: <CODE><A HREF="../../../../../org/apache/openjpa/jdbc/schema/Constraint.html#isLogical()">Constraint</A></CODE></B></DD> |
| <DD>Return whether this constraint is a logical constraint only; i.e. |
| if it does not exist in the database. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/openjpa/jdbc/schema/Constraint.html#isLogical()">isLogical</A></CODE> in class <CODE><A HREF="../../../../../org/apache/openjpa/jdbc/schema/Constraint.html" title="class in org.apache.openjpa.jdbc.schema">Constraint</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isPrimaryKeyAutoAssigned()"><!-- --></A><H3> |
| isPrimaryKeyAutoAssigned</H3> |
| <PRE> |
| public boolean <B>isPrimaryKeyAutoAssigned</B>()</PRE> |
| <DL> |
| <DD>Whether the primary key columns of this key are auto-incrementing, or |
| whether they themselves are members of a foreign key who's primary key |
| is auto-incrementing (recursing to arbitrary depth). |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getPrimaryKeyTableName()"><!-- --></A><H3> |
| getPrimaryKeyTableName</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getPrimaryKeyTableName</B>()</PRE> |
| <DL> |
| <DD>The name of the primary key table. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setPrimaryKeyTableName(java.lang.String)"><!-- --></A><H3> |
| setPrimaryKeyTableName</H3> |
| <PRE> |
| public void <B>setPrimaryKeyTableName</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> pkTableName)</PRE> |
| <DL> |
| <DD>The name of the primary key table. You can only set the primary |
| key table name on foreign keys that have not already been joined. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getPrimaryKeySchemaName()"><!-- --></A><H3> |
| getPrimaryKeySchemaName</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getPrimaryKeySchemaName</B>()</PRE> |
| <DL> |
| <DD>The name of the primary key table's schema. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setPrimaryKeySchemaName(java.lang.String)"><!-- --></A><H3> |
| setPrimaryKeySchemaName</H3> |
| <PRE> |
| public void <B>setPrimaryKeySchemaName</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> pkSchemaName)</PRE> |
| <DL> |
| <DD>The name of the primary key table's schema. You can only set the |
| primary key schema name on foreign keys that have not already been |
| joined. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getPrimaryKeyColumnName()"><!-- --></A><H3> |
| getPrimaryKeyColumnName</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getPrimaryKeyColumnName</B>()</PRE> |
| <DL> |
| <DD>The name of the primary key column. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setPrimaryKeyColumnName(java.lang.String)"><!-- --></A><H3> |
| setPrimaryKeyColumnName</H3> |
| <PRE> |
| public void <B>setPrimaryKeyColumnName</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> pkColumnName)</PRE> |
| <DL> |
| <DD>The name of the primary key column. You can only set the |
| primary key column name on foreign keys that have not already been |
| joined. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getKeySequence()"><!-- --></A><H3> |
| getKeySequence</H3> |
| <PRE> |
| public int <B>getKeySequence</B>()</PRE> |
| <DL> |
| <DD>The sequence of this join in the foreign key. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setKeySequence(int)"><!-- --></A><H3> |
| setKeySequence</H3> |
| <PRE> |
| public void <B>setKeySequence</B>(int seq)</PRE> |
| <DL> |
| <DD>The sequence of this join in the foreign key. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDeleteAction()"><!-- --></A><H3> |
| getDeleteAction</H3> |
| <PRE> |
| public int <B>getDeleteAction</B>()</PRE> |
| <DL> |
| <DD>Return the delete action for the key. Will be one of: |
| <A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#ACTION_NONE"><CODE>ACTION_NONE</CODE></A>, <A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#ACTION_RESTRICT"><CODE>ACTION_RESTRICT</CODE></A>, |
| <A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#ACTION_CASCADE"><CODE>ACTION_CASCADE</CODE></A>, <A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#ACTION_NULL"><CODE>ACTION_NULL</CODE></A>, <A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#ACTION_DEFAULT"><CODE>ACTION_DEFAULT</CODE></A>. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setDeleteAction(int)"><!-- --></A><H3> |
| setDeleteAction</H3> |
| <PRE> |
| public void <B>setDeleteAction</B>(int action)</PRE> |
| <DL> |
| <DD>Set the delete action for the key. Must be one of: |
| <A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#ACTION_NONE"><CODE>ACTION_NONE</CODE></A>, <A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#ACTION_RESTRICT"><CODE>ACTION_RESTRICT</CODE></A>, |
| <A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#ACTION_CASCADE"><CODE>ACTION_CASCADE</CODE></A>, <A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#ACTION_NULL"><CODE>ACTION_NULL</CODE></A>, <A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#ACTION_DEFAULT"><CODE>ACTION_DEFAULT</CODE></A>. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getUpdateAction()"><!-- --></A><H3> |
| getUpdateAction</H3> |
| <PRE> |
| public int <B>getUpdateAction</B>()</PRE> |
| <DL> |
| <DD>Return the update action for the key. Will be one of: |
| <A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#ACTION_NONE"><CODE>ACTION_NONE</CODE></A>, <A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#ACTION_RESTRICT"><CODE>ACTION_RESTRICT</CODE></A>, |
| <A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#ACTION_CASCADE"><CODE>ACTION_CASCADE</CODE></A>, <A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#ACTION_NULL"><CODE>ACTION_NULL</CODE></A>, <A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#ACTION_DEFAULT"><CODE>ACTION_DEFAULT</CODE></A>. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setUpdateAction(int)"><!-- --></A><H3> |
| setUpdateAction</H3> |
| <PRE> |
| public void <B>setUpdateAction</B>(int action)</PRE> |
| <DL> |
| <DD>Set the update action for the key. Must be one of: |
| <A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#ACTION_NONE"><CODE>ACTION_NONE</CODE></A>, <A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#ACTION_RESTRICT"><CODE>ACTION_RESTRICT</CODE></A>, |
| <A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#ACTION_CASCADE"><CODE>ACTION_CASCADE</CODE></A>, <A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#ACTION_NULL"><CODE>ACTION_NULL</CODE></A>, <A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#ACTION_DEFAULT"><CODE>ACTION_DEFAULT</CODE></A>. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getIndex()"><!-- --></A><H3> |
| getIndex</H3> |
| <PRE> |
| public int <B>getIndex</B>()</PRE> |
| <DL> |
| <DD>Return the foreign key's 0-based index in the owning table. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setIndex(int)"><!-- --></A><H3> |
| setIndex</H3> |
| <PRE> |
| void <B>setIndex</B>(int index)</PRE> |
| <DL> |
| <DD>Set the foreign key's 0-based index in the owning table. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getPrimaryKeyColumn(org.apache.openjpa.jdbc.schema.Column)"><!-- --></A><H3> |
| getPrimaryKeyColumn</H3> |
| <PRE> |
| public <A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A> <B>getPrimaryKeyColumn</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A> local)</PRE> |
| <DL> |
| <DD>Return the primary key column joined to the given local column. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getColumn(org.apache.openjpa.jdbc.schema.Column)"><!-- --></A><H3> |
| getColumn</H3> |
| <PRE> |
| public <A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A> <B>getColumn</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A> pk)</PRE> |
| <DL> |
| <DD>Return the local column joined to the given primary key column. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getConstant(org.apache.openjpa.jdbc.schema.Column)"><!-- --></A><H3> |
| getConstant</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> <B>getConstant</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A> local)</PRE> |
| <DL> |
| <DD>Return the constant value assigned to the given local column. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getPrimaryKeyConstant(org.apache.openjpa.jdbc.schema.Column)"><!-- --></A><H3> |
| getPrimaryKeyConstant</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> <B>getPrimaryKeyConstant</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A> pk)</PRE> |
| <DL> |
| <DD>Return the constant value assigned to the given primary key column. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getColumns()"><!-- --></A><H3> |
| getColumns</H3> |
| <PRE> |
| public <A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A>[] <B>getColumns</B>()</PRE> |
| <DL> |
| <DD>Return the local columns in the foreign key local table order. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getConstants()"><!-- --></A><H3> |
| getConstants</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>[] <B>getConstants</B>()</PRE> |
| <DL> |
| <DD>Return the constant values assigned to the local columns |
| returned by <A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#getConstantColumns()"><CODE>getConstantColumns()</CODE></A>. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getPrimaryKeyConstants()"><!-- --></A><H3> |
| getPrimaryKeyConstants</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>[] <B>getPrimaryKeyConstants</B>()</PRE> |
| <DL> |
| <DD>Return the constant values assigned to the primary key columns |
| returned by <A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#getConstantPrimaryKeyColumns()"><CODE>getConstantPrimaryKeyColumns()</CODE></A>. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="containsColumn(org.apache.openjpa.jdbc.schema.Column)"><!-- --></A><H3> |
| containsColumn</H3> |
| <PRE> |
| public boolean <B>containsColumn</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A> col)</PRE> |
| <DL> |
| <DD>Return true if the fk includes the given local column. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="containsPrimaryKeyColumn(org.apache.openjpa.jdbc.schema.Column)"><!-- --></A><H3> |
| containsPrimaryKeyColumn</H3> |
| <PRE> |
| public boolean <B>containsPrimaryKeyColumn</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A> col)</PRE> |
| <DL> |
| <DD>Return true if the fk includes the given primary key column. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="containsConstantColumn(org.apache.openjpa.jdbc.schema.Column)"><!-- --></A><H3> |
| containsConstantColumn</H3> |
| <PRE> |
| public boolean <B>containsConstantColumn</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A> col)</PRE> |
| <DL> |
| <DD>Return true if the fk includes the given local column. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="containsConstantPrimaryKeyColumn(org.apache.openjpa.jdbc.schema.Column)"><!-- --></A><H3> |
| containsConstantPrimaryKeyColumn</H3> |
| <PRE> |
| public boolean <B>containsConstantPrimaryKeyColumn</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A> col)</PRE> |
| <DL> |
| <DD>Return true if the fk includes the given primary key column. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getPrimaryKeyColumns()"><!-- --></A><H3> |
| getPrimaryKeyColumns</H3> |
| <PRE> |
| public <A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A>[] <B>getPrimaryKeyColumns</B>()</PRE> |
| <DL> |
| <DD>Return the foreign columns in the foreign key, in join-order with |
| the result of <A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#getColumns()"><CODE>getColumns()</CODE></A>. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getConstantColumns()"><!-- --></A><H3> |
| getConstantColumns</H3> |
| <PRE> |
| public <A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A>[] <B>getConstantColumns</B>()</PRE> |
| <DL> |
| <DD>Return the local columns that we link to using constant values. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getConstantPrimaryKeyColumns()"><!-- --></A><H3> |
| getConstantPrimaryKeyColumns</H3> |
| <PRE> |
| public <A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A>[] <B>getConstantPrimaryKeyColumns</B>()</PRE> |
| <DL> |
| <DD>Return the primary key columns that we link to using constant values. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setJoins(org.apache.openjpa.jdbc.schema.Column[], org.apache.openjpa.jdbc.schema.Column[])"><!-- --></A><H3> |
| setJoins</H3> |
| <PRE> |
| public void <B>setJoins</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A>[] cols, |
| <A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A>[] pkCols)</PRE> |
| <DL> |
| <DD>Set the foreign key's joins. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setConstantJoins(java.lang.Object[], org.apache.openjpa.jdbc.schema.Column[])"><!-- --></A><H3> |
| setConstantJoins</H3> |
| <PRE> |
| public void <B>setConstantJoins</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>[] consts, |
| <A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A>[] pkCols)</PRE> |
| <DL> |
| <DD>Set the foreign key's constant joins. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setConstantJoins(org.apache.openjpa.jdbc.schema.Column[], java.lang.Object[])"><!-- --></A><H3> |
| setConstantJoins</H3> |
| <PRE> |
| public void <B>setConstantJoins</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A>[] cols, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>[] consts)</PRE> |
| <DL> |
| <DD>Set the foreign key's constant joins. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="join(org.apache.openjpa.jdbc.schema.Column, org.apache.openjpa.jdbc.schema.Column)"><!-- --></A><H3> |
| join</H3> |
| <PRE> |
| public void <B>join</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A> local, |
| <A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A> toPK)</PRE> |
| <DL> |
| <DD>Join a local column to a primary key column of another table. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="joinConstant(java.lang.Object, org.apache.openjpa.jdbc.schema.Column)"><!-- --></A><H3> |
| joinConstant</H3> |
| <PRE> |
| public void <B>joinConstant</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> val, |
| <A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A> toPK)</PRE> |
| <DL> |
| <DD>Join a constant value to a primary key column of another table. The |
| constant must be either a string or a number. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="joinConstant(org.apache.openjpa.jdbc.schema.Column, java.lang.Object)"><!-- --></A><H3> |
| joinConstant</H3> |
| <PRE> |
| public void <B>joinConstant</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A> col, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> val)</PRE> |
| <DL> |
| <DD>Join a constant value to a local column of this table. The |
| constant must be either a string or a number. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="removeJoin(org.apache.openjpa.jdbc.schema.Column)"><!-- --></A><H3> |
| removeJoin</H3> |
| <PRE> |
| public boolean <B>removeJoin</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A> col)</PRE> |
| <DL> |
| <DD>Remove any joins inolving the given column. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>true if the join was removed, false if not part of the key</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getPrimaryKeyTable()"><!-- --></A><H3> |
| getPrimaryKeyTable</H3> |
| <PRE> |
| public <A HREF="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</A> <B>getPrimaryKeyTable</B>()</PRE> |
| <DL> |
| <DD>Returns the table this foreign key is linking to, if it is known yet. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="refColumns()"><!-- --></A><H3> |
| refColumns</H3> |
| <PRE> |
| public void <B>refColumns</B>()</PRE> |
| <DL> |
| <DD>Ref all columns in this key. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="derefColumns()"><!-- --></A><H3> |
| derefColumns</H3> |
| <PRE> |
| public void <B>derefColumns</B>()</PRE> |
| <DL> |
| <DD>Deref all columns in this key. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="equalsForeignKey(org.apache.openjpa.jdbc.schema.ForeignKey)"><!-- --></A><H3> |
| equalsForeignKey</H3> |
| <PRE> |
| public boolean <B>equalsForeignKey</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html" title="class in org.apache.openjpa.jdbc.schema">ForeignKey</A> fk)</PRE> |
| <DL> |
| <DD>Foreign keys are equal if the satisfy the equality constraints of |
| <A HREF="../../../../../org/apache/openjpa/jdbc/schema/Constraint.html" title="class in org.apache.openjpa.jdbc.schema"><CODE>Constraint</CODE></A> and they have the same local and primary key |
| columns and action. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="columnsMatch(org.apache.openjpa.jdbc.schema.Column[], org.apache.openjpa.jdbc.schema.Column[])"><!-- --></A><H3> |
| columnsMatch</H3> |
| <PRE> |
| public boolean <B>columnsMatch</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A>[] fkCols, |
| <A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A>[] fkPKCols)</PRE> |
| <DL> |
| <DD>Return true if the given local and foreign columns match those |
| on this key. This can be used to find foreign keys given only |
| column linking information. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="hasNotNullColumns()"><!-- --></A><H3> |
| hasNotNullColumns</H3> |
| <PRE> |
| public boolean <B>hasNotNullColumns</B>()</PRE> |
| <DL> |
| <DD>Checks for non-nullable local columns. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ForeignKey.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../org/apache/openjpa/jdbc/schema/FileSchemaFactory.html" title="class in org.apache.openjpa.jdbc.schema"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../org/apache/openjpa/jdbc/schema/Index.html" title="class in org.apache.openjpa.jdbc.schema"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../index.html?org/apache/openjpa/jdbc/schema/ForeignKey.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="ForeignKey.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| Copyright © 2006-2013 <a href="http://www.apache.org">Apache Software Foundation</a>. All Rights Reserved. |
| </BODY> |
| </HTML> |
