blob: da80d5354ea38ef5b1a692399f165c367d6b01be [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 (1.8.0_252) on Fri Jul 16 09:39:16 UTC 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.eclipse.persistence.tools.schemaframework (EclipseLink 3.0.2, API Reference)</title>
<meta name="date" content="2021-07-16">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="org.eclipse.persistence.tools.schemaframework (EclipseLink 3.0.2, API Reference)";
}
}
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>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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-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 class="aboutLanguage">EclipseLink 3.0.2, API Reference</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/eclipse/persistence/tools/profiler/oracle/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../org/eclipse/persistence/tools/tuning/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/persistence/tools/schemaframework/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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.eclipse.persistence.tools.schemaframework</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" 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/eclipse/persistence/tools/schemaframework/DatabaseObjectDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">DatabaseObjectDefinition</a></td>
<td class="colLast">
<div class="block">
<b>Purpose</b>: Define a database object for the purpose of creation and deletion.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/DefaultTableGenerator.html" title="class in org.eclipse.persistence.tools.schemaframework">DefaultTableGenerator</a></td>
<td class="colLast">
<div class="block">DefaultTableGenerator is a utility class used to generate a default table schema for a EclipseLink project object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/DynamicSchemaManager.html" title="class in org.eclipse.persistence.tools.schemaframework">DynamicSchemaManager</a></td>
<td class="colLast">
<div class="block">Extended SchemaManager to handle the creation of tables for dynamic types.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/FieldDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">FieldDefinition</a></td>
<td class="colLast">
<div class="block">
<b>Purpose</b>: Define a database field definition for creation within a table.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/ForeignKeyConstraint.html" title="class in org.eclipse.persistence.tools.schemaframework">ForeignKeyConstraint</a></td>
<td class="colLast">
<div class="block">
<b>Purpose</b>: Define a foreign key from one table to another.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/IndexDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">IndexDefinition</a></td>
<td class="colLast">
<div class="block">
<b>Purpose</b>: Allow for indexes to be created.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/NestedTableDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">NestedTableDefinition</a></td>
<td class="colLast">
<div class="block">
<b>Purpose</b>: Allow for creation of nested table types.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/ObjectVarrayDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">ObjectVarrayDefinition</a></td>
<td class="colLast">
<div class="block">
<b>Purpose</b>: Allow for creation of object varray type.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/PackageDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">PackageDefinition</a></td>
<td class="colLast">
<div class="block">
<b>Purpose</b>: Allow a semi-generic way of creating packages.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/PopulationManager.html" title="class in org.eclipse.persistence.tools.schemaframework">PopulationManager</a></td>
<td class="colLast">
<div class="block">
<b>Purpose</b>: This class is used to populate example data into the database, it allows for circular references to be resolved.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html" title="class in org.eclipse.persistence.tools.schemaframework">SchemaManager</a></td>
<td class="colLast">
<div class="block">
<b>Purpose</b>: Define all user level protocol for development time database manipulation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SequenceDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">SequenceDefinition</a></td>
<td class="colLast">
<div class="block">
<b>Purpose</b>: Allow a generic way of creating sequences on the different platforms,
and allow optional parameters to be specified.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/SequenceObjectDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">SequenceObjectDefinition</a></td>
<td class="colLast">
<div class="block">
<b>Purpose</b>: Sequence definition Native Sequence object.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/StoredFunctionDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">StoredFunctionDefinition</a></td>
<td class="colLast">
<div class="block">
<b>Purpose</b>: Allow a semi-generic way of creating store function.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/StoredProcedureDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">StoredProcedureDefinition</a></td>
<td class="colLast">
<div class="block"><b>Purpose</b>: Allow a semi-generic way of creating stored procedures.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/StoredProcedureGenerator.html" title="class in org.eclipse.persistence.tools.schemaframework">StoredProcedureGenerator</a></td>
<td class="colLast">
<div class="block"><b>Purpose</b>: To generate StoredProcedures from EclipseLink Projects</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/TableCreator.html" title="class in org.eclipse.persistence.tools.schemaframework">TableCreator</a></td>
<td class="colLast">
<div class="block"><b>Purpose</b>: This class is responsible for creating the tables defined in the project.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/TableDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">TableDefinition</a></td>
<td class="colLast">
<div class="block">
<b>Purpose</b>: Allow a generic way of creating tables on the different platforms.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/TableSequenceDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">TableSequenceDefinition</a></td>
<td class="colLast">
<div class="block">
<b>Purpose</b>: Allow a generic way of creating sequences on the different platforms,
and allow optional parameters to be specified.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/TypeDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">TypeDefinition</a></td>
<td class="colLast">
<div class="block">
<b>Purpose</b>: Allow for Oracle 8 object-relational user defined type to be created.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/TypeTableDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">TypeTableDefinition</a></td>
<td class="colLast">
<div class="block">
<b>Purpose</b>: Allow for tabels of Oracle 8 object-relational user defined type to be created.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/UnaryTableSequenceDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">UnaryTableSequenceDefinition</a></td>
<td class="colLast">
<div class="block">
<b>Purpose</b>: Creates / drops an unary sequence table:
the name of the table is sequence name; its only field is named unarySequenceCounterFieldName</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/UniqueKeyConstraint.html" title="class in org.eclipse.persistence.tools.schemaframework">UniqueKeyConstraint</a></td>
<td class="colLast">
<div class="block">
<b>Purpose</b>: Define a unique key constraint for a table.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/VarrayDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">VarrayDefinition</a></td>
<td class="colLast">
<div class="block">
<b>Purpose</b>: Allow for creation of varray type.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/ViewDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">ViewDefinition</a></td>
<td class="colLast">
<div class="block">
<b>Purpose</b>: Allow for creation of views.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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-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 class="aboutLanguage">EclipseLink 3.0.2, API Reference</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/eclipse/persistence/tools/profiler/oracle/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../org/eclipse/persistence/tools/tuning/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/persistence/tools/schemaframework/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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; 2007&#x2013;2021 <a href="http://www.eclipse.org/eclipselink">Eclipse.org - EclipseLink Project</a>. All rights reserved.</small></p>
</body>
</html>