| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc (build 1.5.0_06) on Sat Oct 14 18:42:06 PDT 2006 --> |
| <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> |
| <TITLE> |
| SchemaParser (OpenJPA 0.9.0-incubating API) |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.apache.openjpa.jdbc.schema.SchemaParser interface"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="SchemaParser (OpenJPA 0.9.0-incubating API)"; |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <A NAME="navbar_top"><!-- --></A> |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SchemaParser.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaGroup.html" title="class in org.apache.openjpa.jdbc.schema"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../org/apache/openjpa/jdbc/schema/Schemas.html" title="class in org.apache.openjpa.jdbc.schema"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../index.html?org/apache/openjpa/jdbc/schema/SchemaParser.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="SchemaParser.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"> |
| org.apache.openjpa.jdbc.schema</FONT> |
| <BR> |
| Interface SchemaParser</H2> |
| <DL> |
| <DT><B>All Superinterfaces:</B> <DD><A HREF="../../../../../org/apache/openjpa/lib/meta/MetaDataParser.html" title="interface in org.apache.openjpa.lib.meta">MetaDataParser</A></DD> |
| </DL> |
| <DL> |
| <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../org/apache/openjpa/jdbc/schema/XMLSchemaParser.html" title="class in org.apache.openjpa.jdbc.schema">XMLSchemaParser</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public interface <B>SchemaParser</B><DT>extends <A HREF="../../../../../org/apache/openjpa/lib/meta/MetaDataParser.html" title="interface in org.apache.openjpa.lib.meta">MetaDataParser</A></DL> |
| </PRE> |
| |
| <P> |
| Interface class for parers that read schema information. Parsers |
| will place all parsed schemas into the current <A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaGroup.html" title="class in org.apache.openjpa.jdbc.schema"><CODE>SchemaGroup</CODE></A>, set |
| via the <A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaParser.html#setSchemaGroup(org.apache.openjpa.jdbc.schema.SchemaGroup)"><CODE>setSchemaGroup(org.apache.openjpa.jdbc.schema.SchemaGroup)</CODE></A> method. This allows parsing of |
| multiple files into a single schema group. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Author:</B></DT> |
| <DD>Abe White</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> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaParser.html#getDelayConstraintResolve()">getDelayConstraintResolve</A></B>()</CODE> |
| |
| <BR> |
| Delay resolution of foreign key constraints until |
| <A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaParser.html#resolveConstraints()"><CODE>resolveConstraints()</CODE></A> is called.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaGroup.html" title="class in org.apache.openjpa.jdbc.schema">SchemaGroup</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaParser.html#getSchemaGroup()">getSchemaGroup</A></B>()</CODE> |
| |
| <BR> |
| Return the current schema group.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaParser.html#resolveConstraints()">resolveConstraints</A></B>()</CODE> |
| |
| <BR> |
| If this parser is in delayed resolve mode, resolve all constraints.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaParser.html#setDelayConstraintResolve(boolean)">setDelayConstraintResolve</A></B>(boolean delay)</CODE> |
| |
| <BR> |
| Delay resolution of foreign key constraints until |
| <A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaParser.html#resolveConstraints()"><CODE>resolveConstraints()</CODE></A> is called.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaParser.html#setSchemaGroup(org.apache.openjpa.jdbc.schema.SchemaGroup)">setSchemaGroup</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaGroup.html" title="class in org.apache.openjpa.jdbc.schema">SchemaGroup</A> group)</CODE> |
| |
| <BR> |
| Set the current schema group; this clears all state from the last group.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.apache.openjpa.lib.meta.MetaDataParser"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from interface org.apache.openjpa.lib.meta.<A HREF="../../../../../org/apache/openjpa/lib/meta/MetaDataParser.html" title="interface in org.apache.openjpa.lib.meta">MetaDataParser</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../../org/apache/openjpa/lib/meta/MetaDataParser.html#clear()">clear</A>, <A HREF="../../../../../org/apache/openjpa/lib/meta/MetaDataParser.html#getResults()">getResults</A>, <A HREF="../../../../../org/apache/openjpa/lib/meta/MetaDataParser.html#parse(java.lang.Class, boolean)">parse</A>, <A HREF="../../../../../org/apache/openjpa/lib/meta/MetaDataParser.html#parse(java.io.File)">parse</A>, <A HREF="../../../../../org/apache/openjpa/lib/meta/MetaDataParser.html#parse(org.apache.openjpa.lib.meta.MetaDataIterator)">parse</A>, <A HREF="../../../../../org/apache/openjpa/lib/meta/MetaDataParser.html#parse(java.io.Reader, java.lang.String)">parse</A>, <A HREF="../../../../../org/apache/openjpa/lib/meta/MetaDataParser.html#parse(java.lang.String)">parse</A>, <A HREF="../../../../../org/apache/openjpa/lib/meta/MetaDataParser.html#parse(java.net.URL)">parse</A>, <A HREF="../../../../../org/apache/openjpa/lib/meta/MetaDataParser.html#setClassLoader(java.lang.ClassLoader)">setClassLoader</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="getDelayConstraintResolve()"><!-- --></A><H3> |
| getDelayConstraintResolve</H3> |
| <PRE> |
| boolean <B>getDelayConstraintResolve</B>()</PRE> |
| <DL> |
| <DD>Delay resolution of foreign key constraints until |
| <A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaParser.html#resolveConstraints()"><CODE>resolveConstraints()</CODE></A> is called. This allows you to parse |
| multiple resources where a foreign key in one resource might refer |
| to a table in another. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setDelayConstraintResolve(boolean)"><!-- --></A><H3> |
| setDelayConstraintResolve</H3> |
| <PRE> |
| void <B>setDelayConstraintResolve</B>(boolean delay)</PRE> |
| <DL> |
| <DD>Delay resolution of foreign key constraints until |
| <A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaParser.html#resolveConstraints()"><CODE>resolveConstraints()</CODE></A> is called. This allows you to parse |
| multiple resources where a foreign key in one resource might refer |
| to a table in another. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getSchemaGroup()"><!-- --></A><H3> |
| getSchemaGroup</H3> |
| <PRE> |
| <A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaGroup.html" title="class in org.apache.openjpa.jdbc.schema">SchemaGroup</A> <B>getSchemaGroup</B>()</PRE> |
| <DL> |
| <DD>Return the current schema group. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setSchemaGroup(org.apache.openjpa.jdbc.schema.SchemaGroup)"><!-- --></A><H3> |
| setSchemaGroup</H3> |
| <PRE> |
| void <B>setSchemaGroup</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaGroup.html" title="class in org.apache.openjpa.jdbc.schema">SchemaGroup</A> group)</PRE> |
| <DL> |
| <DD>Set the current schema group; this clears all state from the last group. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="resolveConstraints()"><!-- --></A><H3> |
| resolveConstraints</H3> |
| <PRE> |
| void <B>resolveConstraints</B>()</PRE> |
| <DL> |
| <DD>If this parser is in delayed resolve mode, resolve all constraints. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SchemaParser.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaGroup.html" title="class in org.apache.openjpa.jdbc.schema"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../org/apache/openjpa/jdbc/schema/Schemas.html" title="class in org.apache.openjpa.jdbc.schema"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../index.html?org/apache/openjpa/jdbc/schema/SchemaParser.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="SchemaParser.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 © 2006 Apache Software Foundation. All Rights Reserved. |
| </BODY> |
| </HTML> |