| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_79) on Mon Mar 21 21:59:44 CET 2016 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>ForeignKey (OpenJPA Parent POM 2.4.1 API)</title> |
| <meta name="date" content="2016-03-21"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="ForeignKey (OpenJPA Parent POM 2.4.1 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ForeignKey.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/openjpa/jdbc/schema/FileSchemaFactory.html" title="class in org.apache.openjpa.jdbc.schema"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.FKMapKey.html" title="class in org.apache.openjpa.jdbc.schema"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/openjpa/jdbc/schema/ForeignKey.html" target="_top">Frames</a></li> |
| <li><a href="ForeignKey.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested_class_summary">Nested</a> | </li> |
| <li><a href="#field_summary">Field</a> | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.openjpa.jdbc.schema</div> |
| <h2 title="Class ForeignKey" class="title">Class ForeignKey</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../org/apache/openjpa/jdbc/schema/Constraint.html" title="class in org.apache.openjpa.jdbc.schema">org.apache.openjpa.jdbc.schema.Constraint</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.openjpa.jdbc.schema.ForeignKey</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="http://download.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="strong">ForeignKey</span> |
| extends <a href="../../../../../org/apache/openjpa/jdbc/schema/Constraint.html" title="class in org.apache.openjpa.jdbc.schema">Constraint</a></pre> |
| <div class="block">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://download.oracle.com/javase/6/docs/api/java/sql/DatabaseMetaData.html?is-external=true" title="class or interface in java.sql"><code>DatabaseMetaData</code></a>.</div> |
| <dl><dt><span class="strong">Author:</span></dt> |
| <dd>Abe White</dd> |
| <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../serialized-form.html#org.apache.openjpa.jdbc.schema.ForeignKey">Serialized Form</a></dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested_class_summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.FKMapKey.html" title="class in org.apache.openjpa.jdbc.schema">ForeignKey.FKMapKey</a></strong></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#ACTION_CASCADE">ACTION_CASCADE</a></strong></code> |
| <div class="block">Cascade any modification of the joined primary key columns to |
| this table.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#ACTION_DEFAULT">ACTION_DEFAULT</a></strong></code> |
| <div class="block">Set the local columns to their default values if the primary key |
| columns are modified.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#ACTION_NONE">ACTION_NONE</a></strong></code> |
| <div class="block">Logical foreign key; links columns, but does not perform any action |
| when the joined primary key columns are modified.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#ACTION_NULL">ACTION_NULL</a></strong></code> |
| <div class="block">Null the local columns if the joined primary key columns are modified.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#ACTION_RESTRICT">ACTION_RESTRICT</a></strong></code> |
| <div class="block">Throw an exception if joined primary key columns are modified.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#ForeignKey()">ForeignKey</a></strong>()</code> |
| <div class="block">Default constructor.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#ForeignKey(org.apache.openjpa.jdbc.identifier.DBIdentifier,%20org.apache.openjpa.jdbc.schema.Table)">ForeignKey</a></strong>(<a href="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</a> name, |
| <a href="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</a> table)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#ForeignKey(java.lang.String,%20org.apache.openjpa.jdbc.schema.Table)">ForeignKey</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" 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> |
| <div class="block"><strong>Deprecated.</strong> </div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#addColumn(org.apache.openjpa.jdbc.schema.ForeignKey)">addColumn</a></strong>(<a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html" title="class in org.apache.openjpa.jdbc.schema">ForeignKey</a> fk)</code> |
| <div class="block">Joins the column of a single column FK to this FK.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#columnsMatch(org.apache.openjpa.jdbc.schema.Column[],%20org.apache.openjpa.jdbc.schema.Column[])">columnsMatch</a></strong>(<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> |
| <div class="block">Return true if the given local and foreign columns match those |
| on this key.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#containsColumn(org.apache.openjpa.jdbc.schema.Column)">containsColumn</a></strong>(<a href="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</a> col)</code> |
| <div class="block">Return true if the fk includes the given local column.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#containsConstantColumn(org.apache.openjpa.jdbc.schema.Column)">containsConstantColumn</a></strong>(<a href="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</a> col)</code> |
| <div class="block">Return true if the fk includes the given local column.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#containsConstantPrimaryKeyColumn(org.apache.openjpa.jdbc.schema.Column)">containsConstantPrimaryKeyColumn</a></strong>(<a href="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</a> col)</code> |
| <div class="block">Return true if the fk includes the given primary key column.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#containsPrimaryKeyColumn(org.apache.openjpa.jdbc.schema.Column)">containsPrimaryKeyColumn</a></strong>(<a href="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</a> col)</code> |
| <div class="block">Return true if the fk includes the given primary key column.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#deref()">deref</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#derefColumns()">derefColumns</a></strong>()</code> |
| <div class="block">Deref all columns in this key.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#equalsForeignKey(org.apache.openjpa.jdbc.schema.ForeignKey)">equalsForeignKey</a></strong>(<a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html" title="class in org.apache.openjpa.jdbc.schema">ForeignKey</a> fk)</code> |
| <div class="block">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.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#getAction(java.lang.String)">getAction</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> |
| <div class="block">Return the foreign key action constant for the given action name.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#getActionName(int)">getActionName</a></strong>(int action)</code> |
| <div class="block">Return the foreign key action name for the given action constant.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#getColumn(org.apache.openjpa.jdbc.schema.Column)">getColumn</a></strong>(<a href="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</a> pk)</code> |
| <div class="block">Return the local column joined to the given primary key column.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</a>[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#getColumns()">getColumns</a></strong>()</code> |
| <div class="block">Return the local columns in the foreign key local table order.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#getConstant(org.apache.openjpa.jdbc.schema.Column)">getConstant</a></strong>(<a href="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</a> local)</code> |
| <div class="block">Return the constant value assigned to the given local column.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</a>[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#getConstantColumns()">getConstantColumns</a></strong>()</code> |
| <div class="block">Return the local columns that we link to using constant values.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</a>[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#getConstantPrimaryKeyColumns()">getConstantPrimaryKeyColumns</a></strong>()</code> |
| <div class="block">Return the primary key columns that we link to using constant values.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#getConstants()">getConstants</a></strong>()</code> |
| <div class="block">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>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#getDeleteAction()">getDeleteAction</a></strong>()</code> |
| <div class="block">Return the delete action for the key.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#getIndex()">getIndex</a></strong>()</code> |
| <div class="block">Return the foreign key's 0-based index in the owning table.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#getKeySequence()">getKeySequence</a></strong>()</code> |
| <div class="block">The sequence of this join in the foreign key.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#getPrimaryKeyColumn(org.apache.openjpa.jdbc.schema.Column)">getPrimaryKeyColumn</a></strong>(<a href="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</a> local)</code> |
| <div class="block">Return the primary key column joined to the given local column.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#getPrimaryKeyColumnIdentifier()">getPrimaryKeyColumnIdentifier</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#getPrimaryKeyColumnName()">getPrimaryKeyColumnName</a></strong>()</code> |
| <div class="block"><strong>Deprecated.</strong> </div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</a>[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#getPrimaryKeyColumns()">getPrimaryKeyColumns</a></strong>()</code> |
| <div class="block">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>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#getPrimaryKeyConstant(org.apache.openjpa.jdbc.schema.Column)">getPrimaryKeyConstant</a></strong>(<a href="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</a> pk)</code> |
| <div class="block">Return the constant value assigned to the given primary key column.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#getPrimaryKeyConstants()">getPrimaryKeyConstants</a></strong>()</code> |
| <div class="block">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>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#getPrimaryKeySchemaIdentifier()">getPrimaryKeySchemaIdentifier</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#getPrimaryKeySchemaName()">getPrimaryKeySchemaName</a></strong>()</code> |
| <div class="block"><strong>Deprecated.</strong> </div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#getPrimaryKeyTable()">getPrimaryKeyTable</a></strong>()</code> |
| <div class="block">Returns the table this foreign key is linking to, if it is known yet.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#getPrimaryKeyTableIdentifier()">getPrimaryKeyTableIdentifier</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#getPrimaryKeyTableName()">getPrimaryKeyTableName</a></strong>()</code> |
| <div class="block"><strong>Deprecated.</strong> </div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#getRefCount()">getRefCount</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#getUpdateAction()">getUpdateAction</a></strong>()</code> |
| <div class="block">Return the update action for the key.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#hasNotNullColumns()">hasNotNullColumns</a></strong>()</code> |
| <div class="block">Checks for non-nullable local columns.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#isLogical()">isLogical</a></strong>()</code> |
| <div class="block">Return whether this constraint is a logical constraint only; i.e.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#isPrimaryKeyAutoAssigned()">isPrimaryKeyAutoAssigned</a></strong>()</code> |
| <div class="block">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).</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#join(org.apache.openjpa.jdbc.schema.Column,%20org.apache.openjpa.jdbc.schema.Column)">join</a></strong>(<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> |
| <div class="block">Join a local column to a primary key column of another table.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#joinConstant(org.apache.openjpa.jdbc.schema.Column,%20java.lang.Object)">joinConstant</a></strong>(<a href="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</a> col, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> val)</code> |
| <div class="block">Join a constant value to a local column of this table.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#joinConstant(java.lang.Object,%20org.apache.openjpa.jdbc.schema.Column)">joinConstant</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" 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> |
| <div class="block">Join a constant value to a primary key column of another table.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#loadIdentifierFromDB(org.apache.openjpa.jdbc.sql.DBDictionary,%20java.sql.Connection)">loadIdentifierFromDB</a></strong>(<a href="../../../../../org/apache/openjpa/jdbc/sql/DBDictionary.html" title="class in org.apache.openjpa.jdbc.sql">DBDictionary</a> dbdict, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/sql/Connection.html?is-external=true" title="class or interface in java.sql">Connection</a> conn)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#loadNameFromDB(org.apache.openjpa.jdbc.sql.DBDictionary,%20java.sql.Connection)">loadNameFromDB</a></strong>(<a href="../../../../../org/apache/openjpa/jdbc/sql/DBDictionary.html" title="class in org.apache.openjpa.jdbc.sql">DBDictionary</a> dbdict, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/sql/Connection.html?is-external=true" title="class or interface in java.sql">Connection</a> conn)</code> |
| <div class="block"><strong>Deprecated.</strong> </div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#ref()">ref</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#refColumns()">refColumns</a></strong>()</code> |
| <div class="block">Ref all columns in this key.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#removeJoin(org.apache.openjpa.jdbc.schema.Column)">removeJoin</a></strong>(<a href="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</a> col)</code> |
| <div class="block">Remove any joins inolving the given column.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#setConstantJoins(org.apache.openjpa.jdbc.schema.Column[],%20java.lang.Object[])">setConstantJoins</a></strong>(<a href="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</a>[] cols, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>[] consts)</code> |
| <div class="block">Set the foreign key's constant joins.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#setConstantJoins(java.lang.Object[],%20org.apache.openjpa.jdbc.schema.Column[])">setConstantJoins</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" 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> |
| <div class="block">Set the foreign key's constant joins.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#setDeleteAction(int)">setDeleteAction</a></strong>(int action)</code> |
| <div class="block">Set the delete action for the key.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#setJoins(org.apache.openjpa.jdbc.schema.Column[],%20org.apache.openjpa.jdbc.schema.Column[])">setJoins</a></strong>(<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> |
| <div class="block">Set the foreign key's joins.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#setKeySequence(int)">setKeySequence</a></strong>(int seq)</code> |
| <div class="block">The sequence of this join in the foreign key.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#setPrimaryKeyColumnIdentifier(org.apache.openjpa.jdbc.identifier.DBIdentifier)">setPrimaryKeyColumnIdentifier</a></strong>(<a href="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</a> pkColumnName)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#setPrimaryKeyColumnName(java.lang.String)">setPrimaryKeyColumnName</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> pkColumnName)</code> |
| <div class="block"><strong>Deprecated.</strong> </div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#setPrimaryKeySchemaIdentifier(org.apache.openjpa.jdbc.identifier.DBIdentifier)">setPrimaryKeySchemaIdentifier</a></strong>(<a href="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</a> pkSchemaName)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#setPrimaryKeySchemaName(java.lang.String)">setPrimaryKeySchemaName</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> pkSchemaName)</code> |
| <div class="block"><strong>Deprecated.</strong> </div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#setPrimaryKeyTableIdentifier(org.apache.openjpa.jdbc.identifier.DBIdentifier)">setPrimaryKeyTableIdentifier</a></strong>(<a href="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</a> pkTableName)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#setPrimaryKeyTableName(java.lang.String)">setPrimaryKeyTableName</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> pkTableName)</code> |
| <div class="block"><strong>Deprecated.</strong> </div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html#setUpdateAction(int)">setUpdateAction</a></strong>(int action)</code> |
| <div class="block">Set the update action for the key.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.openjpa.jdbc.schema.Constraint"> |
| <!-- --> |
| </a> |
| <h3>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></h3> |
| <code><a href="../../../../../org/apache/openjpa/jdbc/schema/Constraint.html#getColumnIdentifier()">getColumnIdentifier</a>, <a href="../../../../../org/apache/openjpa/jdbc/schema/Constraint.html#getColumnName()">getColumnName</a>, <a href="../../../../../org/apache/openjpa/jdbc/schema/Constraint.html#getFullIdentifier()">getFullIdentifier</a>, <a href="../../../../../org/apache/openjpa/jdbc/schema/Constraint.html#getFullName()">getFullName</a>, <a href="../../../../../org/apache/openjpa/jdbc/schema/Constraint.html#getIdentifier()">getIdentifier</a>, <a href="../../../../../org/apache/openjpa/jdbc/schema/Constraint.html#getName()">getName</a>, <a href="../../../../../org/apache/openjpa/jdbc/schema/Constraint.html#getQualifiedPath()">getQualifiedPath</a>, <a href="../../../../../org/apache/openjpa/jdbc/schema/Constraint.html#getSchemaIdentifier()">getSchemaIdentifier</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#getTableIdentifier()">getTableIdentifier</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#setColumnIdentifier(org.apache.openjpa.jdbc.identifier.DBIdentifier)">setColumnIdentifier</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#setIdentifier(org.apache.openjpa.jdbc.identifier.DBIdentifier)">setIdentifier</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#setSchemaIdentifier(org.apache.openjpa.jdbc.identifier.DBIdentifier)">setSchemaIdentifier</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#setTableIdentifier(org.apache.openjpa.jdbc.identifier.DBIdentifier)">setTableIdentifier</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></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="ACTION_NONE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ACTION_NONE</h4> |
| <pre>public static final int ACTION_NONE</pre> |
| <div class="block">Logical foreign key; links columns, but does not perform any action |
| when the joined primary key columns are modified.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.openjpa.jdbc.schema.ForeignKey.ACTION_NONE">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="ACTION_RESTRICT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ACTION_RESTRICT</h4> |
| <pre>public static final int ACTION_RESTRICT</pre> |
| <div class="block">Throw an exception if joined primary key columns are modified.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.openjpa.jdbc.schema.ForeignKey.ACTION_RESTRICT">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="ACTION_CASCADE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ACTION_CASCADE</h4> |
| <pre>public static final int ACTION_CASCADE</pre> |
| <div class="block">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.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.openjpa.jdbc.schema.ForeignKey.ACTION_CASCADE">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="ACTION_NULL"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ACTION_NULL</h4> |
| <pre>public static final int ACTION_NULL</pre> |
| <div class="block">Null the local columns if the joined primary key columns are modified.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.openjpa.jdbc.schema.ForeignKey.ACTION_NULL">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="ACTION_DEFAULT"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ACTION_DEFAULT</h4> |
| <pre>public static final int ACTION_DEFAULT</pre> |
| <div class="block">Set the local columns to their default values if the primary key |
| columns are modified.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.openjpa.jdbc.schema.ForeignKey.ACTION_DEFAULT">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="ForeignKey()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ForeignKey</h4> |
| <pre>public ForeignKey()</pre> |
| <div class="block">Default constructor.</div> |
| </li> |
| </ul> |
| <a name="ForeignKey(java.lang.String, org.apache.openjpa.jdbc.schema.Table)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ForeignKey</h4> |
| <pre>public ForeignKey(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" 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> |
| <div class="block"><span class="strong">Deprecated.</span> <i></i></div> |
| <div class="block">Constructor.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the foreign key name, if any</dd><dd><code>table</code> - the local table of the foreign key</dd></dl> |
| </li> |
| </ul> |
| <a name="ForeignKey(org.apache.openjpa.jdbc.identifier.DBIdentifier, org.apache.openjpa.jdbc.schema.Table)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ForeignKey</h4> |
| <pre>public ForeignKey(<a href="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</a> name, |
| <a href="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</a> table)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getAction(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAction</h4> |
| <pre>public static int getAction(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| <div class="block">Return the foreign key action constant for the given action name.</div> |
| </li> |
| </ul> |
| <a name="getActionName(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getActionName</h4> |
| <pre>public static <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getActionName(int action)</pre> |
| <div class="block">Return the foreign key action name for the given action constant.</div> |
| </li> |
| </ul> |
| <a name="isLogical()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isLogical</h4> |
| <pre>public boolean isLogical()</pre> |
| <div class="block"><strong>Description copied from class: <code><a href="../../../../../org/apache/openjpa/jdbc/schema/Constraint.html#isLogical()">Constraint</a></code></strong></div> |
| <div class="block">Return whether this constraint is a logical constraint only; i.e. |
| if it does not exist in the database.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <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></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isPrimaryKeyAutoAssigned()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isPrimaryKeyAutoAssigned</h4> |
| <pre>public boolean isPrimaryKeyAutoAssigned()</pre> |
| <div class="block">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).</div> |
| </li> |
| </ul> |
| <a name="getPrimaryKeyTableName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPrimaryKeyTableName</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getPrimaryKeyTableName()</pre> |
| <div class="block"><span class="strong">Deprecated.</span> <i></i></div> |
| <div class="block">The name of the primary key table.</div> |
| </li> |
| </ul> |
| <a name="getPrimaryKeyTableIdentifier()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPrimaryKeyTableIdentifier</h4> |
| <pre>public <a href="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</a> getPrimaryKeyTableIdentifier()</pre> |
| </li> |
| </ul> |
| <a name="setPrimaryKeyTableName(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPrimaryKeyTableName</h4> |
| <pre>public void setPrimaryKeyTableName(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> pkTableName)</pre> |
| <div class="block"><span class="strong">Deprecated.</span> <i></i></div> |
| <div class="block">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.</div> |
| </li> |
| </ul> |
| <a name="setPrimaryKeyTableIdentifier(org.apache.openjpa.jdbc.identifier.DBIdentifier)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPrimaryKeyTableIdentifier</h4> |
| <pre>public void setPrimaryKeyTableIdentifier(<a href="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</a> pkTableName)</pre> |
| </li> |
| </ul> |
| <a name="getPrimaryKeySchemaName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPrimaryKeySchemaName</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getPrimaryKeySchemaName()</pre> |
| <div class="block"><span class="strong">Deprecated.</span> <i></i></div> |
| <div class="block">The name of the primary key table's schema.</div> |
| </li> |
| </ul> |
| <a name="getPrimaryKeySchemaIdentifier()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPrimaryKeySchemaIdentifier</h4> |
| <pre>public <a href="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</a> getPrimaryKeySchemaIdentifier()</pre> |
| </li> |
| </ul> |
| <a name="setPrimaryKeySchemaName(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPrimaryKeySchemaName</h4> |
| <pre>public void setPrimaryKeySchemaName(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> pkSchemaName)</pre> |
| <div class="block"><span class="strong">Deprecated.</span> <i></i></div> |
| <div class="block">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.</div> |
| </li> |
| </ul> |
| <a name="setPrimaryKeySchemaIdentifier(org.apache.openjpa.jdbc.identifier.DBIdentifier)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPrimaryKeySchemaIdentifier</h4> |
| <pre>public void setPrimaryKeySchemaIdentifier(<a href="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</a> pkSchemaName)</pre> |
| </li> |
| </ul> |
| <a name="getPrimaryKeyColumnName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPrimaryKeyColumnName</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getPrimaryKeyColumnName()</pre> |
| <div class="block"><span class="strong">Deprecated.</span> <i></i></div> |
| <div class="block">The name of the primary key column.</div> |
| </li> |
| </ul> |
| <a name="getPrimaryKeyColumnIdentifier()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPrimaryKeyColumnIdentifier</h4> |
| <pre>public <a href="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</a> getPrimaryKeyColumnIdentifier()</pre> |
| </li> |
| </ul> |
| <a name="setPrimaryKeyColumnName(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPrimaryKeyColumnName</h4> |
| <pre>public void setPrimaryKeyColumnName(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> pkColumnName)</pre> |
| <div class="block"><span class="strong">Deprecated.</span> <i></i></div> |
| <div class="block">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.</div> |
| </li> |
| </ul> |
| <a name="setPrimaryKeyColumnIdentifier(org.apache.openjpa.jdbc.identifier.DBIdentifier)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPrimaryKeyColumnIdentifier</h4> |
| <pre>public void setPrimaryKeyColumnIdentifier(<a href="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</a> pkColumnName)</pre> |
| </li> |
| </ul> |
| <a name="getKeySequence()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getKeySequence</h4> |
| <pre>public int getKeySequence()</pre> |
| <div class="block">The sequence of this join in the foreign key.</div> |
| </li> |
| </ul> |
| <a name="setKeySequence(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setKeySequence</h4> |
| <pre>public void setKeySequence(int seq)</pre> |
| <div class="block">The sequence of this join in the foreign key.</div> |
| </li> |
| </ul> |
| <a name="getDeleteAction()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDeleteAction</h4> |
| <pre>public int getDeleteAction()</pre> |
| <div class="block">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>.</div> |
| </li> |
| </ul> |
| <a name="setDeleteAction(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDeleteAction</h4> |
| <pre>public void setDeleteAction(int action)</pre> |
| <div class="block">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>.</div> |
| </li> |
| </ul> |
| <a name="getUpdateAction()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUpdateAction</h4> |
| <pre>public int getUpdateAction()</pre> |
| <div class="block">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>.</div> |
| </li> |
| </ul> |
| <a name="setUpdateAction(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setUpdateAction</h4> |
| <pre>public void setUpdateAction(int action)</pre> |
| <div class="block">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>.</div> |
| </li> |
| </ul> |
| <a name="getIndex()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIndex</h4> |
| <pre>public int getIndex()</pre> |
| <div class="block">Return the foreign key's 0-based index in the owning table.</div> |
| </li> |
| </ul> |
| <a name="getPrimaryKeyColumn(org.apache.openjpa.jdbc.schema.Column)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPrimaryKeyColumn</h4> |
| <pre>public <a href="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</a> getPrimaryKeyColumn(<a href="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</a> local)</pre> |
| <div class="block">Return the primary key column joined to the given local column.</div> |
| </li> |
| </ul> |
| <a name="getColumn(org.apache.openjpa.jdbc.schema.Column)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getColumn</h4> |
| <pre>public <a href="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</a> getColumn(<a href="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</a> pk)</pre> |
| <div class="block">Return the local column joined to the given primary key column.</div> |
| </li> |
| </ul> |
| <a name="getConstant(org.apache.openjpa.jdbc.schema.Column)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConstant</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> getConstant(<a href="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</a> local)</pre> |
| <div class="block">Return the constant value assigned to the given local column.</div> |
| </li> |
| </ul> |
| <a name="getPrimaryKeyConstant(org.apache.openjpa.jdbc.schema.Column)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPrimaryKeyConstant</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> getPrimaryKeyConstant(<a href="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</a> pk)</pre> |
| <div class="block">Return the constant value assigned to the given primary key column.</div> |
| </li> |
| </ul> |
| <a name="getColumns()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getColumns</h4> |
| <pre>public <a href="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</a>[] getColumns()</pre> |
| <div class="block">Return the local columns in the foreign key local table order.</div> |
| </li> |
| </ul> |
| <a name="getConstants()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConstants</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>[] getConstants()</pre> |
| <div class="block">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>.</div> |
| </li> |
| </ul> |
| <a name="getPrimaryKeyConstants()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPrimaryKeyConstants</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>[] getPrimaryKeyConstants()</pre> |
| <div class="block">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>.</div> |
| </li> |
| </ul> |
| <a name="containsColumn(org.apache.openjpa.jdbc.schema.Column)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>containsColumn</h4> |
| <pre>public boolean containsColumn(<a href="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</a> col)</pre> |
| <div class="block">Return true if the fk includes the given local column.</div> |
| </li> |
| </ul> |
| <a name="containsPrimaryKeyColumn(org.apache.openjpa.jdbc.schema.Column)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>containsPrimaryKeyColumn</h4> |
| <pre>public boolean containsPrimaryKeyColumn(<a href="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</a> col)</pre> |
| <div class="block">Return true if the fk includes the given primary key column.</div> |
| </li> |
| </ul> |
| <a name="containsConstantColumn(org.apache.openjpa.jdbc.schema.Column)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>containsConstantColumn</h4> |
| <pre>public boolean containsConstantColumn(<a href="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</a> col)</pre> |
| <div class="block">Return true if the fk includes the given local column.</div> |
| </li> |
| </ul> |
| <a name="containsConstantPrimaryKeyColumn(org.apache.openjpa.jdbc.schema.Column)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>containsConstantPrimaryKeyColumn</h4> |
| <pre>public boolean containsConstantPrimaryKeyColumn(<a href="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</a> col)</pre> |
| <div class="block">Return true if the fk includes the given primary key column.</div> |
| </li> |
| </ul> |
| <a name="getPrimaryKeyColumns()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPrimaryKeyColumns</h4> |
| <pre>public <a href="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</a>[] getPrimaryKeyColumns()</pre> |
| <div class="block">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>.</div> |
| </li> |
| </ul> |
| <a name="getConstantColumns()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConstantColumns</h4> |
| <pre>public <a href="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</a>[] getConstantColumns()</pre> |
| <div class="block">Return the local columns that we link to using constant values.</div> |
| </li> |
| </ul> |
| <a name="getConstantPrimaryKeyColumns()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConstantPrimaryKeyColumns</h4> |
| <pre>public <a href="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</a>[] getConstantPrimaryKeyColumns()</pre> |
| <div class="block">Return the primary key columns that we link to using constant values.</div> |
| </li> |
| </ul> |
| <a name="setJoins(org.apache.openjpa.jdbc.schema.Column[], org.apache.openjpa.jdbc.schema.Column[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setJoins</h4> |
| <pre>public void setJoins(<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> |
| <div class="block">Set the foreign key's joins.</div> |
| </li> |
| </ul> |
| <a name="setConstantJoins(java.lang.Object[], org.apache.openjpa.jdbc.schema.Column[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setConstantJoins</h4> |
| <pre>public void setConstantJoins(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" 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> |
| <div class="block">Set the foreign key's constant joins.</div> |
| </li> |
| </ul> |
| <a name="setConstantJoins(org.apache.openjpa.jdbc.schema.Column[], java.lang.Object[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setConstantJoins</h4> |
| <pre>public void setConstantJoins(<a href="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</a>[] cols, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>[] consts)</pre> |
| <div class="block">Set the foreign key's constant joins.</div> |
| </li> |
| </ul> |
| <a name="join(org.apache.openjpa.jdbc.schema.Column, org.apache.openjpa.jdbc.schema.Column)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>join</h4> |
| <pre>public void join(<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> |
| <div class="block">Join a local column to a primary key column of another table.</div> |
| </li> |
| </ul> |
| <a name="joinConstant(java.lang.Object, org.apache.openjpa.jdbc.schema.Column)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>joinConstant</h4> |
| <pre>public void joinConstant(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" 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> |
| <div class="block">Join a constant value to a primary key column of another table. The |
| constant must be either a string or a number.</div> |
| </li> |
| </ul> |
| <a name="joinConstant(org.apache.openjpa.jdbc.schema.Column, java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>joinConstant</h4> |
| <pre>public void joinConstant(<a href="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</a> col, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> val)</pre> |
| <div class="block">Join a constant value to a local column of this table. The |
| constant must be either a string or a number.</div> |
| </li> |
| </ul> |
| <a name="removeJoin(org.apache.openjpa.jdbc.schema.Column)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeJoin</h4> |
| <pre>public boolean removeJoin(<a href="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</a> col)</pre> |
| <div class="block">Remove any joins inolving the given column.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>true if the join was removed, false if not part of the key</dd></dl> |
| </li> |
| </ul> |
| <a name="getPrimaryKeyTable()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPrimaryKeyTable</h4> |
| <pre>public <a href="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</a> getPrimaryKeyTable()</pre> |
| <div class="block">Returns the table this foreign key is linking to, if it is known yet.</div> |
| </li> |
| </ul> |
| <a name="refColumns()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>refColumns</h4> |
| <pre>public void refColumns()</pre> |
| <div class="block">Ref all columns in this key.</div> |
| </li> |
| </ul> |
| <a name="derefColumns()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>derefColumns</h4> |
| <pre>public void derefColumns()</pre> |
| <div class="block">Deref all columns in this key.</div> |
| </li> |
| </ul> |
| <a name="equalsForeignKey(org.apache.openjpa.jdbc.schema.ForeignKey)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>equalsForeignKey</h4> |
| <pre>public boolean equalsForeignKey(<a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html" title="class in org.apache.openjpa.jdbc.schema">ForeignKey</a> fk)</pre> |
| <div class="block">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.</div> |
| </li> |
| </ul> |
| <a name="columnsMatch(org.apache.openjpa.jdbc.schema.Column[], org.apache.openjpa.jdbc.schema.Column[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>columnsMatch</h4> |
| <pre>public boolean columnsMatch(<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> |
| <div class="block">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.</div> |
| </li> |
| </ul> |
| <a name="hasNotNullColumns()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasNotNullColumns</h4> |
| <pre>public boolean hasNotNullColumns()</pre> |
| <div class="block">Checks for non-nullable local columns.</div> |
| </li> |
| </ul> |
| <a name="loadNameFromDB(org.apache.openjpa.jdbc.sql.DBDictionary, java.sql.Connection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>loadNameFromDB</h4> |
| <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> loadNameFromDB(<a href="../../../../../org/apache/openjpa/jdbc/sql/DBDictionary.html" title="class in org.apache.openjpa.jdbc.sql">DBDictionary</a> dbdict, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/sql/Connection.html?is-external=true" title="class or interface in java.sql">Connection</a> conn)</pre> |
| <div class="block"><span class="strong">Deprecated.</span> <i></i></div> |
| <div class="block">Return the name of the foreignkey constraint as defined in the database.</div> |
| </li> |
| </ul> |
| <a name="loadIdentifierFromDB(org.apache.openjpa.jdbc.sql.DBDictionary, java.sql.Connection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>loadIdentifierFromDB</h4> |
| <pre>public <a href="../../../../../org/apache/openjpa/jdbc/identifier/DBIdentifier.html" title="class in org.apache.openjpa.jdbc.identifier">DBIdentifier</a> loadIdentifierFromDB(<a href="../../../../../org/apache/openjpa/jdbc/sql/DBDictionary.html" title="class in org.apache.openjpa.jdbc.sql">DBDictionary</a> dbdict, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/sql/Connection.html?is-external=true" title="class or interface in java.sql">Connection</a> conn)</pre> |
| </li> |
| </ul> |
| <a name="addColumn(org.apache.openjpa.jdbc.schema.ForeignKey)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addColumn</h4> |
| <pre>public void addColumn(<a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html" title="class in org.apache.openjpa.jdbc.schema">ForeignKey</a> fk)</pre> |
| <div class="block">Joins the column of a single column FK to this FK.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>fk</code> - </dd></dl> |
| </li> |
| </ul> |
| <a name="getRefCount()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRefCount</h4> |
| <pre>public int getRefCount()</pre> |
| </li> |
| </ul> |
| <a name="ref()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ref</h4> |
| <pre>public void ref()</pre> |
| </li> |
| </ul> |
| <a name="deref()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>deref</h4> |
| <pre>public void deref()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ForeignKey.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/openjpa/jdbc/schema/FileSchemaFactory.html" title="class in org.apache.openjpa.jdbc.schema"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.FKMapKey.html" title="class in org.apache.openjpa.jdbc.schema"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/openjpa/jdbc/schema/ForeignKey.html" target="_top">Frames</a></li> |
| <li><a href="ForeignKey.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested_class_summary">Nested</a> | </li> |
| <li><a href="#field_summary">Field</a> | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2006–2016 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |