Google Git
Sign in
apache / openjpa-site / f4f8b894b02554a0a851bbf380ef41d45c445062 / . / content / builds / 2.4.2 / apidocs / org / apache / openjpa / jdbc / schema / SchemaSerializer.html
blob: 7b976d235db1fe9f1a2e9e57c5951a57e2b0ad5e [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>SchemaSerializer (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="SchemaSerializer (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/SchemaSerializer.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/Schemas.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/SchemaTool.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/SchemaSerializer.html" target="_top">Frames</a></li>
<li><a href="SchemaSerializer.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 SchemaSerializer" class="title">Interface SchemaSerializer</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/MetaDataSerializer.html" title="interface in org.apache.openjpa.lib.meta">MetaDataSerializer</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/openjpa/jdbc/schema/XMLSchemaSerializer.html" title="class in org.apache.openjpa.jdbc.schema">XMLSchemaSerializer</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">SchemaSerializer</span>
extends <a href="../../../../../org/apache/openjpa/lib/meta/MetaDataSerializer.html" title="interface in org.apache.openjpa.lib.meta">MetaDataSerializer</a></pre>
<div class="block">Interface for schema serializers. Serializers work at the fine-grained
fine-grained table level to allow you to split schemas among multiple files.</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">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.openjpa.lib.meta.MetaDataSerializer">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.apache.openjpa.lib.meta.<a href="../../../../../org/apache/openjpa/lib/meta/MetaDataSerializer.html" title="interface in org.apache.openjpa.lib.meta">MetaDataSerializer</a></h3>
<code><a href="../../../../../org/apache/openjpa/lib/meta/MetaDataSerializer.html#APPEND">APPEND</a>, <a href="../../../../../org/apache/openjpa/lib/meta/MetaDataSerializer.html#COMPACT">COMPACT</a>, <a href="../../../../../org/apache/openjpa/lib/meta/MetaDataSerializer.html#PRETTY">PRETTY</a>, <a href="../../../../../org/apache/openjpa/lib/meta/MetaDataSerializer.html#VERBOSE">VERBOSE</a></code></li>
</ul>
</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">&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>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/schema/SchemaSerializer.html#addAll(org.apache.openjpa.jdbc.schema.Schema)">addAll</a></strong>(<a href="../../../../../org/apache/openjpa/jdbc/schema/Schema.html" title="class in org.apache.openjpa.jdbc.schema">Schema</a>&nbsp;schema)</code>
<div class="block">Add the given schema's objects to the set of objects that will be
serialized.</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/SchemaSerializer.html#addAll(org.apache.openjpa.jdbc.schema.SchemaGroup)">addAll</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">Add all the objects in the given group to the set of objects that
will be serialized.</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/SchemaSerializer.html#addTable(org.apache.openjpa.jdbc.schema.Table)">addTable</a></strong>(<a href="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</a>&nbsp;table)</code>
<div class="block">Add the given table to the set of tables that will be serialized.</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/SchemaSerializer.html#clear()">clear</a></strong>()</code>
<div class="block">Clear the set of objects to be serialized.</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/SchemaSerializer.html#getTables()">getTables</a></strong>()</code>
<div class="block">Return the set of tables that will be serialized.</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/SchemaSerializer.html#removeAll(org.apache.openjpa.jdbc.schema.Schema)">removeAll</a></strong>(<a href="../../../../../org/apache/openjpa/jdbc/schema/Schema.html" title="class in org.apache.openjpa.jdbc.schema">Schema</a>&nbsp;schema)</code>
<div class="block">Remove the given schema's objects from the set to be serialized.</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/SchemaSerializer.html#removeAll(org.apache.openjpa.jdbc.schema.SchemaGroup)">removeAll</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">Remove all schemas in the given group from the set to be serialized.</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/SchemaSerializer.html#removeTable(org.apache.openjpa.jdbc.schema.Table)">removeTable</a></strong>(<a href="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</a>&nbsp;table)</code>
<div class="block">Remove the given table from the set to be serialized.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.openjpa.lib.meta.MetaDataSerializer">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.openjpa.lib.meta.<a href="../../../../../org/apache/openjpa/lib/meta/MetaDataSerializer.html" title="interface in org.apache.openjpa.lib.meta">MetaDataSerializer</a></h3>
<code><a href="../../../../../org/apache/openjpa/lib/meta/MetaDataSerializer.html#serialize(java.io.File,%20int)">serialize</a>, <a href="../../../../../org/apache/openjpa/lib/meta/MetaDataSerializer.html#serialize(int)">serialize</a>, <a href="../../../../../org/apache/openjpa/lib/meta/MetaDataSerializer.html#serialize(java.util.Map,%20int)">serialize</a>, <a href="../../../../../org/apache/openjpa/lib/meta/MetaDataSerializer.html#serialize(java.io.Writer,%20int)">serialize</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="getTables()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTables</h4>
<pre><a href="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</a>[]&nbsp;getTables()</pre>
<div class="block">Return the set of tables that will be serialized.</div>
</li>
</ul>
<a name="addTable(org.apache.openjpa.jdbc.schema.Table)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addTable</h4>
<pre>void&nbsp;addTable(<a href="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</a>&nbsp;table)</pre>
<div class="block">Add the given table to the set of tables that will be serialized.</div>
</li>
</ul>
<a name="removeTable(org.apache.openjpa.jdbc.schema.Table)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeTable</h4>
<pre>boolean&nbsp;removeTable(<a href="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</a>&nbsp;table)</pre>
<div class="block">Remove the given table from the set to be serialized.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if table was removed, false if not in set</dd></dl>
</li>
</ul>
<a name="addAll(org.apache.openjpa.jdbc.schema.Schema)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addAll</h4>
<pre>void&nbsp;addAll(<a href="../../../../../org/apache/openjpa/jdbc/schema/Schema.html" title="class in org.apache.openjpa.jdbc.schema">Schema</a>&nbsp;schema)</pre>
<div class="block">Add the given schema's objects to the set of objects that will be
serialized.</div>
</li>
</ul>
<a name="addAll(org.apache.openjpa.jdbc.schema.SchemaGroup)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addAll</h4>
<pre>void&nbsp;addAll(<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">Add all the objects in the given group to the set of objects that
will be serialized.</div>
</li>
</ul>
<a name="removeAll(org.apache.openjpa.jdbc.schema.Schema)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeAll</h4>
<pre>boolean&nbsp;removeAll(<a href="../../../../../org/apache/openjpa/jdbc/schema/Schema.html" title="class in org.apache.openjpa.jdbc.schema">Schema</a>&nbsp;schema)</pre>
<div class="block">Remove the given schema's objects from the set to be serialized.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if any objects in schema removed, false if none in set</dd></dl>
</li>
</ul>
<a name="removeAll(org.apache.openjpa.jdbc.schema.SchemaGroup)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeAll</h4>
<pre>boolean&nbsp;removeAll(<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">Remove all schemas in the given group from the set to be serialized.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if any objects in the group were removed, false if
none in set</dd></dl>
</li>
</ul>
<a name="clear()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>clear</h4>
<pre>void&nbsp;clear()</pre>
<div class="block">Clear the set of objects to be serialized.</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/SchemaSerializer.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/Schemas.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/SchemaTool.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/SchemaSerializer.html" target="_top">Frames</a></li>
<li><a href="SchemaSerializer.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>