Google Git
Sign in
apache / openjpa-site / f4f8b894b02554a0a851bbf380ef41d45c445062 / . / content / builds / 2.4.2 / apidocs / org / apache / openjpa / jdbc / schema / SchemaParser.html
blob: 27e31a4918cdb074471897d31f33f4642f78ce26 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_121) on Fri Jan 06 19:36:33 UTC 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>SchemaParser (OpenJPA Parent POM 2.4.2 API)</title>
<meta name="date" content="2017-01-06">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SchemaParser (OpenJPA Parent POM 2.4.2 API)";
}
}
catch(err) {
}
//-->
</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/SchemaParser.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/SchemaGroup.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/Schemas.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/SchemaParser.html" target="_top">Frames</a></li>
<li><a href="SchemaParser.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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="Interface SchemaParser" class="title">Interface SchemaParser</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../../org/apache/openjpa/lib/meta/MetaDataParser.html" title="interface in org.apache.openjpa.lib.meta">MetaDataParser</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/openjpa/jdbc/schema/XMLSchemaParser.html" title="class in org.apache.openjpa.jdbc.schema">XMLSchemaParser</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">SchemaParser</span>
extends <a href="../../../../../org/apache/openjpa/lib/meta/MetaDataParser.html" title="interface in org.apache.openjpa.lib.meta">MetaDataParser</a></pre>
<div class="block">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.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Abe White</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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">&nbsp;</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>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/SchemaParser.html#getDelayConstraintResolve()">getDelayConstraintResolve</a></strong>()</code>
<div class="block">Delay resolution of foreign key constraints until
<a href="../../../../../org/apache/openjpa/jdbc/schema/SchemaParser.html#resolveConstraints()"><code>resolveConstraints()</code></a> is called.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/openjpa/jdbc/schema/SchemaGroup.html" title="class in org.apache.openjpa.jdbc.schema">SchemaGroup</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/SchemaParser.html#getSchemaGroup()">getSchemaGroup</a></strong>()</code>
<div class="block">Return the current schema group.</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/SchemaParser.html#resolveConstraints()">resolveConstraints</a></strong>()</code>
<div class="block">If this parser is in delayed resolve mode, resolve all constraints.</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/SchemaParser.html#setDelayConstraintResolve(boolean)">setDelayConstraintResolve</a></strong>(boolean&nbsp;delay)</code>
<div class="block">Delay resolution of foreign key constraints until
<a href="../../../../../org/apache/openjpa/jdbc/schema/SchemaParser.html#resolveConstraints()"><code>resolveConstraints()</code></a> is called.</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/SchemaParser.html#setSchemaGroup(org.apache.openjpa.jdbc.schema.SchemaGroup)">setSchemaGroup</a></strong>(<a href="../../../../../org/apache/openjpa/jdbc/schema/SchemaGroup.html" title="class in org.apache.openjpa.jdbc.schema">SchemaGroup</a>&nbsp;group)</code>
<div class="block">Set the current schema group; this clears all state from the last group.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.openjpa.lib.meta.MetaDataParser">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.openjpa.lib.meta.<a href="../../../../../org/apache/openjpa/lib/meta/MetaDataParser.html" title="interface in org.apache.openjpa.lib.meta">MetaDataParser</a></h3>
<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,%20boolean)">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,%20java.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></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getDelayConstraintResolve()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDelayConstraintResolve</h4>
<pre>boolean&nbsp;getDelayConstraintResolve()</pre>
<div class="block">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.</div>
</li>
</ul>
<a name="setDelayConstraintResolve(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDelayConstraintResolve</h4>
<pre>void&nbsp;setDelayConstraintResolve(boolean&nbsp;delay)</pre>
<div class="block">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.</div>
</li>
</ul>
<a name="getSchemaGroup()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSchemaGroup</h4>
<pre><a href="../../../../../org/apache/openjpa/jdbc/schema/SchemaGroup.html" title="class in org.apache.openjpa.jdbc.schema">SchemaGroup</a>&nbsp;getSchemaGroup()</pre>
<div class="block">Return the current schema group.</div>
</li>
</ul>
<a name="setSchemaGroup(org.apache.openjpa.jdbc.schema.SchemaGroup)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSchemaGroup</h4>
<pre>void&nbsp;setSchemaGroup(<a href="../../../../../org/apache/openjpa/jdbc/schema/SchemaGroup.html" title="class in org.apache.openjpa.jdbc.schema">SchemaGroup</a>&nbsp;group)</pre>
<div class="block">Set the current schema group; this clears all state from the last group.</div>
</li>
</ul>
<a name="resolveConstraints()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>resolveConstraints</h4>
<pre>void&nbsp;resolveConstraints()</pre>
<div class="block">If this parser is in delayed resolve mode, resolve all constraints.</div>
</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/SchemaParser.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/SchemaGroup.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/Schemas.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/SchemaParser.html" target="_top">Frames</a></li>
<li><a href="SchemaParser.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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 &#169; 2006&#x2013;2017 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>