blob: 8403a940ae6a57d71b6cfe7d97081ccc5bd4a03a [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="it">
<head>
<!-- Generated by javadoc (version 1.7.0_80) on Thu Jun 14 10:04:13 CEST 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.apache.openjpa.jdbc.schema (OpenJPA Parent POM 2.4.3 API)</title>
<meta name="date" content="2018-06-14">
<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="org.apache.openjpa.jdbc.schema (OpenJPA Parent POM 2.4.3 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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/meta/strats/package-summary.html">Prev Package</a></li>
<li><a href="../../../../../org/apache/openjpa/jdbc/sql/package-summary.html">Next Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/openjpa/jdbc/schema/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.openjpa.jdbc.schema</h1>
<div class="docSummary">
<div class="block"><strong>OpenJPA-JDBC Schema Management</strong>
This package provides utilities for managing the schema of
persistent objects stored in a relational database.</div>
</div>
<p>See:&nbsp;<a href="#package_description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/schema/DriverDataSource.html" title="interface in org.apache.openjpa.jdbc.schema">DriverDataSource</a></td>
<td class="colLast">
<div class="block">A DataSource that allows additional configuration options to be set
into it, so that it can wrap a JDBC driver or other DataSource.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/schema/SchemaFactory.html" title="interface in org.apache.openjpa.jdbc.schema">SchemaFactory</a></td>
<td class="colLast">
<div class="block">Factory for <a href="../../../../../org/apache/openjpa/jdbc/schema/SchemaGroup.html" title="class in org.apache.openjpa.jdbc.schema"><code>SchemaGroup</code></a>s.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/schema/SchemaGenerator.Listener.html" title="interface in org.apache.openjpa.jdbc.schema">SchemaGenerator.Listener</a></td>
<td class="colLast">
<div class="block">A listener for a potentially lengthy schema generation process.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/schema/SchemaParser.html" title="interface in org.apache.openjpa.jdbc.schema">SchemaParser</a></td>
<td class="colLast">
<div class="block">Interface class for parers that read schema information.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/schema/SchemaSerializer.html" title="interface in org.apache.openjpa.jdbc.schema">SchemaSerializer</a></td>
<td class="colLast">
<div class="block">Interface for schema serializers.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/schema/AutoDriverDataSource.html" title="class in org.apache.openjpa.jdbc.schema">AutoDriverDataSource</a></td>
<td class="colLast">
<div class="block">Automatic Commons DBCP pooling or Simple non-pooling driver data source.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</a></td>
<td class="colLast">
<div class="block">Represents a database column.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/schema/ColumnIO.html" title="class in org.apache.openjpa.jdbc.schema">ColumnIO</a></td>
<td class="colLast">
<div class="block">Metadata about column I/O in a specific context.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/schema/Constraint.html" title="class in org.apache.openjpa.jdbc.schema">Constraint</a></td>
<td class="colLast">
<div class="block">A table constraint.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/schema/DataSourceFactory.html" title="class in org.apache.openjpa.jdbc.schema">DataSourceFactory</a></td>
<td class="colLast">
<div class="block">Factory for <a href="http://docs.oracle.com/javase/6/docs/api/javax/sql/DataSource.html?is-external=true" title="class or interface in javax.sql"><code>DataSource</code></a> objects.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/schema/DBCPDriverDataSource.html" title="class in org.apache.openjpa.jdbc.schema">DBCPDriverDataSource</a></td>
<td class="colLast">
<div class="block">Commons DBCP basic pooling driver data source.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/schema/DynamicSchemaFactory.html" title="class in org.apache.openjpa.jdbc.schema">DynamicSchemaFactory</a></td>
<td class="colLast">
<div class="block">Factory whose schema group dynamically fills itself with information
as mappings validate themselves in their <code>map</code> method.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/schema/FileSchemaFactory.html" title="class in org.apache.openjpa.jdbc.schema">FileSchemaFactory</a></td>
<td class="colLast">
<div class="block">Factory that uses an XML schema file to construct the system schema.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html" title="class in org.apache.openjpa.jdbc.schema">ForeignKey</a></td>
<td class="colLast">
<div class="block">Represents a database foreign key; may be a logical key with no
database representation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.FKMapKey.html" title="class in org.apache.openjpa.jdbc.schema">ForeignKey.FKMapKey</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/schema/Index.html" title="class in org.apache.openjpa.jdbc.schema">Index</a></td>
<td class="colLast">
<div class="block">Represents a database index.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/schema/LazySchemaFactory.html" title="class in org.apache.openjpa.jdbc.schema">LazySchemaFactory</a></td>
<td class="colLast">
<div class="block">Factory that uses database metadata to construct the system schema.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/schema/LocalConstraint.html" title="class in org.apache.openjpa.jdbc.schema">LocalConstraint</a></td>
<td class="colLast">
<div class="block">Constraint over local table columns, as opposed to a foreign key which
spans tables.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/schema/NameSet.html" title="class in org.apache.openjpa.jdbc.schema">NameSet</a></td>
<td class="colLast">
<div class="block">Name sets track what names have been taken, ignoring case.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/schema/PrimaryKey.html" title="class in org.apache.openjpa.jdbc.schema">PrimaryKey</a></td>
<td class="colLast">
<div class="block">Represents a table primary key.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/schema/Schema.html" title="class in org.apache.openjpa.jdbc.schema">Schema</a></td>
<td class="colLast">
<div class="block">Represents a database schema.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/schema/SchemaGenerator.html" title="class in org.apache.openjpa.jdbc.schema">SchemaGenerator</a></td>
<td class="colLast">
<div class="block">The SchemaGenerator creates <a href="../../../../../org/apache/openjpa/jdbc/schema/Schema.html" title="class in org.apache.openjpa.jdbc.schema"><code>Schema</code></a>s matching the current
database.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/schema/SchemaGenerator.Event.html" title="class in org.apache.openjpa.jdbc.schema">SchemaGenerator.Event</a></td>
<td class="colLast">
<div class="block">An event corresponding to the generation of a schema object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/schema/SchemaGroup.html" title="class in org.apache.openjpa.jdbc.schema">SchemaGroup</a></td>
<td class="colLast">
<div class="block">Represents a grouping of schemas used in a database.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/schema/Schemas.html" title="class in org.apache.openjpa.jdbc.schema">Schemas</a></td>
<td class="colLast">
<div class="block">Helper class to deal with schemas.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.html" title="class in org.apache.openjpa.jdbc.schema">SchemaTool</a></td>
<td class="colLast">
<div class="block">The SchemaTool is used to manage the database schema.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/schema/SchemaTool.Flags.html" title="class in org.apache.openjpa.jdbc.schema">SchemaTool.Flags</a></td>
<td class="colLast">
<div class="block">Run flags.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/schema/Sequence.html" title="class in org.apache.openjpa.jdbc.schema">Sequence</a></td>
<td class="colLast">
<div class="block">Represents a database sequence.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/schema/SimpleDriverDataSource.html" title="class in org.apache.openjpa.jdbc.schema">SimpleDriverDataSource</a></td>
<td class="colLast">
<div class="block">Non-pooling driver data source.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</a></td>
<td class="colLast">
<div class="block">Represents a database table.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/schema/TableSchemaFactory.html" title="class in org.apache.openjpa.jdbc.schema">TableSchemaFactory</a></td>
<td class="colLast">
<div class="block">Factory that uses an XML schema definition stored in a database table
to record the system schema.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/schema/Unique.html" title="class in org.apache.openjpa.jdbc.schema">Unique</a></td>
<td class="colLast">
<div class="block">Represents a unique constraint.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/schema/XMLSchemaParser.html" title="class in org.apache.openjpa.jdbc.schema">XMLSchemaParser</a></td>
<td class="colLast">
<div class="block">Custom SAX parser used to parse <a href="../../../../../org/apache/openjpa/jdbc/schema/Schema.html" title="class in org.apache.openjpa.jdbc.schema"><code>Schema</code></a> objects.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/schema/XMLSchemaParser.UniqueInfo.html" title="class in org.apache.openjpa.jdbc.schema">XMLSchemaParser.UniqueInfo</a></td>
<td class="colLast">
<div class="block">Used to hold unique constraint info before it is resolved.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/openjpa/jdbc/schema/XMLSchemaSerializer.html" title="class in org.apache.openjpa.jdbc.schema">XMLSchemaSerializer</a></td>
<td class="colLast">
<div class="block">Serializes <a href="../../../../../org/apache/openjpa/jdbc/schema/Schema.html" title="class in org.apache.openjpa.jdbc.schema"><code>Schema</code></a>s to XML matching the document
type definition defined by the <a href="../../../../../org/apache/openjpa/jdbc/schema/XMLSchemaParser.html" title="class in org.apache.openjpa.jdbc.schema"><code>XMLSchemaParser</code></a>.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package_description">
<!-- -->
</a>
<h2 title="Package org.apache.openjpa.jdbc.schema Description">Package org.apache.openjpa.jdbc.schema Description</h2>
<div class="block"><p><strong>OpenJPA-JDBC Schema Management</strong></p>
<p>
This package provides utilities for managing the schema of
persistent objects stored in a relational database.
</p>
<p>
Schema components themselves are little more than standard Java beans.
Helper classes are responsible for added functionality such as XML
serialization/deserialization, etc.
</p></div>
</div>
<!-- ======= 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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/meta/strats/package-summary.html">Prev Package</a></li>
<li><a href="../../../../../org/apache/openjpa/jdbc/sql/package-summary.html">Next Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/openjpa/jdbc/schema/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2006&#x2013;2018 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>