| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc (build 1.6.0_18) on Fri May 21 07:02:02 BST 2010 --> |
| <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> |
| <TITLE> |
| JoinMetadata (JDO API 3.0) |
| </TITLE> |
| |
| <META NAME="date" CONTENT="2010-05-21"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="JoinMetadata (JDO API 3.0)"; |
| } |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| <HR> |
| |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <A NAME="navbar_top"><!-- --></A> |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/JoinMetadata.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="../../../javax/jdo/metadata/JDOMetadata.html" title="interface in javax.jdo.metadata"><B>PREV CLASS</B></A> |
| <A HREF="../../../javax/jdo/metadata/KeyMetadata.html" title="interface in javax.jdo.metadata"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../index.html?javax/jdo/metadata/JoinMetadata.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="JoinMetadata.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 | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <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"> |
| javax.jdo.metadata</FONT> |
| <BR> |
| Interface JoinMetadata</H2> |
| <DL> |
| <DT><B>All Superinterfaces:</B> <DD><A HREF="../../../javax/jdo/metadata/Metadata.html" title="interface in javax.jdo.metadata">Metadata</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public interface <B>JoinMetadata</B><DT>extends <A HREF="../../../javax/jdo/metadata/Metadata.html" title="interface in javax.jdo.metadata">Metadata</A></DL> |
| </PRE> |
| |
| <P> |
| Represents join information. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>3.0</DD> |
| </DL> |
| <HR> |
| |
| <P> |
| |
| <!-- ========== 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> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/jdo/metadata/JoinMetadata.html#getColumn()">getColumn</A></B>()</CODE> |
| |
| <BR> |
| Accessor for the join column name</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../javax/jdo/metadata/ColumnMetadata.html" title="interface in javax.jdo.metadata">ColumnMetadata</A>[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/jdo/metadata/JoinMetadata.html#getColumns()">getColumns</A></B>()</CODE> |
| |
| <BR> |
| Accessor for all column(s) defined on the join.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../javax/jdo/annotations/ForeignKeyAction.html" title="enum in javax.jdo.annotations">ForeignKeyAction</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/jdo/metadata/JoinMetadata.html#getDeleteAction()">getDeleteAction</A></B>()</CODE> |
| |
| <BR> |
| Accessor for the delete action of the FK</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../javax/jdo/metadata/ForeignKeyMetadata.html" title="interface in javax.jdo.metadata">ForeignKeyMetadata</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/jdo/metadata/JoinMetadata.html#getForeignKeyMetadata()">getForeignKeyMetadata</A></B>()</CODE> |
| |
| <BR> |
| Accessor for any foreign key metadata on this join.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../javax/jdo/metadata/Indexed.html" title="enum in javax.jdo.metadata">Indexed</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/jdo/metadata/JoinMetadata.html#getIndexed()">getIndexed</A></B>()</CODE> |
| |
| <BR> |
| Accessor for whether indexed (true|false|unique)</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../javax/jdo/metadata/IndexMetadata.html" title="interface in javax.jdo.metadata">IndexMetadata</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/jdo/metadata/JoinMetadata.html#getIndexMetadata()">getIndexMetadata</A></B>()</CODE> |
| |
| <BR> |
| Accessor for any index metadata on this join</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="../../../javax/jdo/metadata/JoinMetadata.html#getNumberOfColumns()">getNumberOfColumns</A></B>()</CODE> |
| |
| <BR> |
| Accessor for the number of columns defined for this join.</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="../../../javax/jdo/metadata/JoinMetadata.html#getOuter()">getOuter</A></B>()</CODE> |
| |
| <BR> |
| Accessor for whether to use an outer join.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../javax/jdo/metadata/PrimaryKeyMetadata.html" title="interface in javax.jdo.metadata">PrimaryKeyMetadata</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/jdo/metadata/JoinMetadata.html#getPrimaryKeyMetadata()">getPrimaryKeyMetadata</A></B>()</CODE> |
| |
| <BR> |
| Accessor for any primary key metadata on this join.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/jdo/metadata/JoinMetadata.html#getTable()">getTable</A></B>()</CODE> |
| |
| <BR> |
| Accessor for the name of the table.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.Boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/jdo/metadata/JoinMetadata.html#getUnique()">getUnique</A></B>()</CODE> |
| |
| <BR> |
| Accessor for whether unique.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../javax/jdo/metadata/UniqueMetadata.html" title="interface in javax.jdo.metadata">UniqueMetadata</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/jdo/metadata/JoinMetadata.html#getUniqueMetadata()">getUniqueMetadata</A></B>()</CODE> |
| |
| <BR> |
| Accessor for any unique constraint metadata on this join.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../javax/jdo/metadata/ColumnMetadata.html" title="interface in javax.jdo.metadata">ColumnMetadata</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/jdo/metadata/JoinMetadata.html#newColumnMetadata()">newColumnMetadata</A></B>()</CODE> |
| |
| <BR> |
| Add a new column for this join.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../javax/jdo/metadata/ForeignKeyMetadata.html" title="interface in javax.jdo.metadata">ForeignKeyMetadata</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/jdo/metadata/JoinMetadata.html#newForeignKeyMetadata()">newForeignKeyMetadata</A></B>()</CODE> |
| |
| <BR> |
| Method to set new foreign key metadata for the join</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../javax/jdo/metadata/IndexMetadata.html" title="interface in javax.jdo.metadata">IndexMetadata</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/jdo/metadata/JoinMetadata.html#newIndexMetadata()">newIndexMetadata</A></B>()</CODE> |
| |
| <BR> |
| Method to set new index metadata for the join.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../javax/jdo/metadata/PrimaryKeyMetadata.html" title="interface in javax.jdo.metadata">PrimaryKeyMetadata</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/jdo/metadata/JoinMetadata.html#newPrimaryKeyMetadata()">newPrimaryKeyMetadata</A></B>()</CODE> |
| |
| <BR> |
| Method to set new primary key metadata for the join</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../javax/jdo/metadata/UniqueMetadata.html" title="interface in javax.jdo.metadata">UniqueMetadata</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/jdo/metadata/JoinMetadata.html#newUniqueMetadata()">newUniqueMetadata</A></B>()</CODE> |
| |
| <BR> |
| Method to set new unique constraint metadata for the join</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../javax/jdo/metadata/JoinMetadata.html" title="interface in javax.jdo.metadata">JoinMetadata</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/jdo/metadata/JoinMetadata.html#setColumn(java.lang.String)">setColumn</A></B>(java.lang.String column)</CODE> |
| |
| <BR> |
| Method to set the join column.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../javax/jdo/metadata/JoinMetadata.html" title="interface in javax.jdo.metadata">JoinMetadata</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/jdo/metadata/JoinMetadata.html#setDeleteAction(javax.jdo.annotations.ForeignKeyAction)">setDeleteAction</A></B>(<A HREF="../../../javax/jdo/annotations/ForeignKeyAction.html" title="enum in javax.jdo.annotations">ForeignKeyAction</A> action)</CODE> |
| |
| <BR> |
| Method to set the delete action of the FK</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../javax/jdo/metadata/JoinMetadata.html" title="interface in javax.jdo.metadata">JoinMetadata</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/jdo/metadata/JoinMetadata.html#setIndexed(javax.jdo.metadata.Indexed)">setIndexed</A></B>(<A HREF="../../../javax/jdo/metadata/Indexed.html" title="enum in javax.jdo.metadata">Indexed</A> indexed)</CODE> |
| |
| <BR> |
| Method to set whether indexed.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../javax/jdo/metadata/JoinMetadata.html" title="interface in javax.jdo.metadata">JoinMetadata</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/jdo/metadata/JoinMetadata.html#setOuter(boolean)">setOuter</A></B>(boolean outer)</CODE> |
| |
| <BR> |
| Method to set whether to use an outer join</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../javax/jdo/metadata/JoinMetadata.html" title="interface in javax.jdo.metadata">JoinMetadata</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/jdo/metadata/JoinMetadata.html#setTable(java.lang.String)">setTable</A></B>(java.lang.String table)</CODE> |
| |
| <BR> |
| Method to set the table name.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../javax/jdo/metadata/JoinMetadata.html" title="interface in javax.jdo.metadata">JoinMetadata</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/jdo/metadata/JoinMetadata.html#setUnique(boolean)">setUnique</A></B>(boolean unique)</CODE> |
| |
| <BR> |
| Method to set whether it is unique.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_javax.jdo.metadata.Metadata"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from interface javax.jdo.metadata.<A HREF="../../../javax/jdo/metadata/Metadata.html" title="interface in javax.jdo.metadata">Metadata</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../javax/jdo/metadata/Metadata.html#getExtensions()">getExtensions</A>, <A HREF="../../../javax/jdo/metadata/Metadata.html#getNumberOfExtensions()">getNumberOfExtensions</A>, <A HREF="../../../javax/jdo/metadata/Metadata.html#getParent()">getParent</A>, <A HREF="../../../javax/jdo/metadata/Metadata.html#newExtensionMetadata(java.lang.String, java.lang.String, java.lang.String)">newExtensionMetadata</A></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ 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="setColumn(java.lang.String)"><!-- --></A><H3> |
| setColumn</H3> |
| <PRE> |
| <A HREF="../../../javax/jdo/metadata/JoinMetadata.html" title="interface in javax.jdo.metadata">JoinMetadata</A> <B>setColumn</B>(java.lang.String column)</PRE> |
| <DL> |
| <DD>Method to set the join column. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>column</CODE> - Name of the join column</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getColumn()"><!-- --></A><H3> |
| getColumn</H3> |
| <PRE> |
| java.lang.String <B>getColumn</B>()</PRE> |
| <DL> |
| <DD>Accessor for the join column name |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>The column name</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setTable(java.lang.String)"><!-- --></A><H3> |
| setTable</H3> |
| <PRE> |
| <A HREF="../../../javax/jdo/metadata/JoinMetadata.html" title="interface in javax.jdo.metadata">JoinMetadata</A> <B>setTable</B>(java.lang.String table)</PRE> |
| <DL> |
| <DD>Method to set the table name. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>table</CODE> - Table name</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getTable()"><!-- --></A><H3> |
| getTable</H3> |
| <PRE> |
| java.lang.String <B>getTable</B>()</PRE> |
| <DL> |
| <DD>Accessor for the name of the table. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>The name</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setOuter(boolean)"><!-- --></A><H3> |
| setOuter</H3> |
| <PRE> |
| <A HREF="../../../javax/jdo/metadata/JoinMetadata.html" title="interface in javax.jdo.metadata">JoinMetadata</A> <B>setOuter</B>(boolean outer)</PRE> |
| <DL> |
| <DD>Method to set whether to use an outer join |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>outer</CODE> - Outer join?</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getOuter()"><!-- --></A><H3> |
| getOuter</H3> |
| <PRE> |
| boolean <B>getOuter</B>()</PRE> |
| <DL> |
| <DD>Accessor for whether to use an outer join. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>Outer join?</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setDeleteAction(javax.jdo.annotations.ForeignKeyAction)"><!-- --></A><H3> |
| setDeleteAction</H3> |
| <PRE> |
| <A HREF="../../../javax/jdo/metadata/JoinMetadata.html" title="interface in javax.jdo.metadata">JoinMetadata</A> <B>setDeleteAction</B>(<A HREF="../../../javax/jdo/annotations/ForeignKeyAction.html" title="enum in javax.jdo.annotations">ForeignKeyAction</A> action)</PRE> |
| <DL> |
| <DD>Method to set the delete action of the FK |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>action</CODE> - Delete action of the FK</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDeleteAction()"><!-- --></A><H3> |
| getDeleteAction</H3> |
| <PRE> |
| <A HREF="../../../javax/jdo/annotations/ForeignKeyAction.html" title="enum in javax.jdo.annotations">ForeignKeyAction</A> <B>getDeleteAction</B>()</PRE> |
| <DL> |
| <DD>Accessor for the delete action of the FK |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>The FK delete-action</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setIndexed(javax.jdo.metadata.Indexed)"><!-- --></A><H3> |
| setIndexed</H3> |
| <PRE> |
| <A HREF="../../../javax/jdo/metadata/JoinMetadata.html" title="interface in javax.jdo.metadata">JoinMetadata</A> <B>setIndexed</B>(<A HREF="../../../javax/jdo/metadata/Indexed.html" title="enum in javax.jdo.metadata">Indexed</A> indexed)</PRE> |
| <DL> |
| <DD>Method to set whether indexed. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>indexed</CODE> - Whether indexed (true | false | unique)</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getIndexed()"><!-- --></A><H3> |
| getIndexed</H3> |
| <PRE> |
| <A HREF="../../../javax/jdo/metadata/Indexed.html" title="enum in javax.jdo.metadata">Indexed</A> <B>getIndexed</B>()</PRE> |
| <DL> |
| <DD>Accessor for whether indexed (true|false|unique) |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>Indexed?</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setUnique(boolean)"><!-- --></A><H3> |
| setUnique</H3> |
| <PRE> |
| <A HREF="../../../javax/jdo/metadata/JoinMetadata.html" title="interface in javax.jdo.metadata">JoinMetadata</A> <B>setUnique</B>(boolean unique)</PRE> |
| <DL> |
| <DD>Method to set whether it is unique. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>unique</CODE> - Unique?</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getUnique()"><!-- --></A><H3> |
| getUnique</H3> |
| <PRE> |
| java.lang.Boolean <B>getUnique</B>()</PRE> |
| <DL> |
| <DD>Accessor for whether unique. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>Unique?</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="newIndexMetadata()"><!-- --></A><H3> |
| newIndexMetadata</H3> |
| <PRE> |
| <A HREF="../../../javax/jdo/metadata/IndexMetadata.html" title="interface in javax.jdo.metadata">IndexMetadata</A> <B>newIndexMetadata</B>()</PRE> |
| <DL> |
| <DD>Method to set new index metadata for the join. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>The IndexMetadata</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getIndexMetadata()"><!-- --></A><H3> |
| getIndexMetadata</H3> |
| <PRE> |
| <A HREF="../../../javax/jdo/metadata/IndexMetadata.html" title="interface in javax.jdo.metadata">IndexMetadata</A> <B>getIndexMetadata</B>()</PRE> |
| <DL> |
| <DD>Accessor for any index metadata on this join |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>Index metadata</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="newUniqueMetadata()"><!-- --></A><H3> |
| newUniqueMetadata</H3> |
| <PRE> |
| <A HREF="../../../javax/jdo/metadata/UniqueMetadata.html" title="interface in javax.jdo.metadata">UniqueMetadata</A> <B>newUniqueMetadata</B>()</PRE> |
| <DL> |
| <DD>Method to set new unique constraint metadata for the join |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>The UniqueMetadata</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getUniqueMetadata()"><!-- --></A><H3> |
| getUniqueMetadata</H3> |
| <PRE> |
| <A HREF="../../../javax/jdo/metadata/UniqueMetadata.html" title="interface in javax.jdo.metadata">UniqueMetadata</A> <B>getUniqueMetadata</B>()</PRE> |
| <DL> |
| <DD>Accessor for any unique constraint metadata on this join. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>The UniqueMetadata</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="newForeignKeyMetadata()"><!-- --></A><H3> |
| newForeignKeyMetadata</H3> |
| <PRE> |
| <A HREF="../../../javax/jdo/metadata/ForeignKeyMetadata.html" title="interface in javax.jdo.metadata">ForeignKeyMetadata</A> <B>newForeignKeyMetadata</B>()</PRE> |
| <DL> |
| <DD>Method to set new foreign key metadata for the join |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>The ForeignKeyMetadata</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getForeignKeyMetadata()"><!-- --></A><H3> |
| getForeignKeyMetadata</H3> |
| <PRE> |
| <A HREF="../../../javax/jdo/metadata/ForeignKeyMetadata.html" title="interface in javax.jdo.metadata">ForeignKeyMetadata</A> <B>getForeignKeyMetadata</B>()</PRE> |
| <DL> |
| <DD>Accessor for any foreign key metadata on this join. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>The ForeignKeyMetadata</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="newPrimaryKeyMetadata()"><!-- --></A><H3> |
| newPrimaryKeyMetadata</H3> |
| <PRE> |
| <A HREF="../../../javax/jdo/metadata/PrimaryKeyMetadata.html" title="interface in javax.jdo.metadata">PrimaryKeyMetadata</A> <B>newPrimaryKeyMetadata</B>()</PRE> |
| <DL> |
| <DD>Method to set new primary key metadata for the join |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>The PrimaryKeyMetadata</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getPrimaryKeyMetadata()"><!-- --></A><H3> |
| getPrimaryKeyMetadata</H3> |
| <PRE> |
| <A HREF="../../../javax/jdo/metadata/PrimaryKeyMetadata.html" title="interface in javax.jdo.metadata">PrimaryKeyMetadata</A> <B>getPrimaryKeyMetadata</B>()</PRE> |
| <DL> |
| <DD>Accessor for any primary key metadata on this join. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>The PrimaryKeyMetadata</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getColumns()"><!-- --></A><H3> |
| getColumns</H3> |
| <PRE> |
| <A HREF="../../../javax/jdo/metadata/ColumnMetadata.html" title="interface in javax.jdo.metadata">ColumnMetadata</A>[] <B>getColumns</B>()</PRE> |
| <DL> |
| <DD>Accessor for all column(s) defined on the join. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>The column(s)</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="newColumnMetadata()"><!-- --></A><H3> |
| newColumnMetadata</H3> |
| <PRE> |
| <A HREF="../../../javax/jdo/metadata/ColumnMetadata.html" title="interface in javax.jdo.metadata">ColumnMetadata</A> <B>newColumnMetadata</B>()</PRE> |
| <DL> |
| <DD>Add a new column for this join. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>The ColumnMetadata</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getNumberOfColumns()"><!-- --></A><H3> |
| getNumberOfColumns</H3> |
| <PRE> |
| int <B>getNumberOfColumns</B>()</PRE> |
| <DL> |
| <DD>Accessor for the number of columns defined for this join. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>The number of columns</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/JoinMetadata.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="../../../javax/jdo/metadata/JDOMetadata.html" title="interface in javax.jdo.metadata"><B>PREV CLASS</B></A> |
| <A HREF="../../../javax/jdo/metadata/KeyMetadata.html" title="interface in javax.jdo.metadata"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../index.html?javax/jdo/metadata/JoinMetadata.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="JoinMetadata.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 | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| Copyright © 2005-2010 Apache Software Foundation. All Rights Reserved. |
| </BODY> |
| </HTML> |
