blob: 355cf9f643e37ce9cf8cbe69821bc1f606b47fb6 [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:10 UTC 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>DatabaseObjectDefinition (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="DatabaseObjectDefinition (EclipseLink 3.0.2, API Reference)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":9,"i16":9,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">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>Prev&nbsp;Class</li>
<li><a href="../../../../../org/eclipse/persistence/tools/schemaframework/DefaultTableGenerator.html" title="class in org.eclipse.persistence.tools.schemaframework"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/persistence/tools/schemaframework/DatabaseObjectDefinition.html" target="_top">Frames</a></li>
<li><a href="DatabaseObjectDefinition.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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.eclipse.persistence.tools.schemaframework</div>
<h2 title="Class DatabaseObjectDefinition" class="title">Class DatabaseObjectDefinition</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../org/eclipse/persistence/tools/schemaframework/IndexDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">IndexDefinition</a>, <a href="../../../../../org/eclipse/persistence/tools/schemaframework/NestedTableDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">NestedTableDefinition</a>, <a href="../../../../../org/eclipse/persistence/tools/schemaframework/PackageDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">PackageDefinition</a>, <a href="../../../../../org/eclipse/persistence/tools/schemaframework/SequenceDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">SequenceDefinition</a>, <a href="../../../../../org/eclipse/persistence/tools/schemaframework/StoredProcedureDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">StoredProcedureDefinition</a>, <a href="../../../../../org/eclipse/persistence/tools/schemaframework/TableDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">TableDefinition</a>, <a href="../../../../../org/eclipse/persistence/tools/schemaframework/TypeDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">TypeDefinition</a>, <a href="../../../../../org/eclipse/persistence/tools/schemaframework/VarrayDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">VarrayDefinition</a>, <a href="../../../../../org/eclipse/persistence/tools/schemaframework/ViewDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">ViewDefinition</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">DatabaseObjectDefinition</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre>
<div class="block"><p>
<b>Purpose</b>: Define a database object for the purpose of creation and deletion.
A database object is an entity such as a table, view, proc, sequence...
<p>
<b>Responsibilities</b>:
<ul>
<li> Be able to create and drop the object from the database.
</ul></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../serialized-form.html#org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition">Serialized Form</a></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>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/DatabaseObjectDefinition.html#name">name</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/DatabaseObjectDefinition.html#qualifier">qualifier</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/DatabaseObjectDefinition.html#DatabaseObjectDefinition--">DatabaseObjectDefinition</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/DatabaseObjectDefinition.html#buildCreationWriter-org.eclipse.persistence.internal.sessions.AbstractSession-java.io.Writer-">buildCreationWriter</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a>&nbsp;writer)</code>
<div class="block">INTERNAL:
Returns the writer used for creation of this object.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/DatabaseObjectDefinition.html#buildDeletionWriter-org.eclipse.persistence.internal.sessions.AbstractSession-java.io.Writer-">buildDeletionWriter</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a>&nbsp;writer)</code>
<div class="block">INTERNAL:
Returns the writer used for deletion of this object.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/DatabaseObjectDefinition.html#buildVPDCreationFunctionWriter-org.eclipse.persistence.internal.sessions.AbstractSession-java.io.Writer-">buildVPDCreationFunctionWriter</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a>&nbsp;writer)</code>
<div class="block">INTERNAL:
Sub classes should override.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/DatabaseObjectDefinition.html#buildVPDCreationPolicyWriter-org.eclipse.persistence.internal.sessions.AbstractSession-java.io.Writer-">buildVPDCreationPolicyWriter</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a>&nbsp;writer)</code>
<div class="block">INTERNAL:
Sub classes should override.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/DatabaseObjectDefinition.html#buildVPDDeletionWriter-org.eclipse.persistence.internal.sessions.AbstractSession-java.io.Writer-">buildVPDDeletionWriter</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a>&nbsp;writer)</code>
<div class="block">INTERNAL:
Sub classes should override.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/DatabaseObjectDefinition.html#clone--">clone</a></span>()</code>
<div class="block">PUBLIC:</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/DatabaseObjectDefinition.html#createDatabaseSchema-org.eclipse.persistence.internal.sessions.AbstractSession-java.io.Writer-java.util.Set-">createDatabaseSchema</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a>&nbsp;writer,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;createdDatabaseSchemas)</code>
<div class="block">INTERNAL:
Execute the DDL to create the database schema for this object.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/DatabaseObjectDefinition.html#createDatabaseSchemaOnDatabase-org.eclipse.persistence.internal.sessions.AbstractSession-java.util.Set-">createDatabaseSchemaOnDatabase</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;createdDatabaseSchemas)</code>
<div class="block">INTERNAL:
Execute the DDL to create the database schema for this object.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/DatabaseObjectDefinition.html#createObject-org.eclipse.persistence.internal.sessions.AbstractSession-java.io.Writer-">createObject</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a>&nbsp;schemaWriter)</code>
<div class="block">INTERNAL:
Either drop from the database directly or write the statement to a file.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/DatabaseObjectDefinition.html#createOnDatabase-org.eclipse.persistence.internal.sessions.AbstractSession-">createOnDatabase</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</code>
<div class="block">INTERNAL:
Execute the DDL to create this object.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/DatabaseObjectDefinition.html#dropDatabaseSchema-org.eclipse.persistence.internal.sessions.AbstractSession-java.io.Writer-">dropDatabaseSchema</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a>&nbsp;writer)</code>
<div class="block">INTERNAL:
Execute the DDL to drop the database schema for this object.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/DatabaseObjectDefinition.html#dropDatabaseSchemaOnDatabase-org.eclipse.persistence.internal.sessions.AbstractSession-">dropDatabaseSchemaOnDatabase</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</code>
<div class="block">INTERNAL:
Execute the DDL to drop the database schema for this object.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/DatabaseObjectDefinition.html#dropFromDatabase-org.eclipse.persistence.internal.sessions.AbstractSession-">dropFromDatabase</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</code>
<div class="block">INTERNAL:
Execute the DDL to drop the object.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/DatabaseObjectDefinition.html#dropObject-org.eclipse.persistence.internal.sessions.AbstractSession-java.io.Writer-boolean-">dropObject</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a>&nbsp;schemaWriter,
boolean&nbsp;createSQLFiles)</code>
<div class="block">INTERNAL:
Execute the DDL to drop the object.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/DatabaseObjectDefinition.html#getDatabaseSchema--">getDatabaseSchema</a></span>()</code>
<div class="block">PUBLIC:
Return the database schema associated with this database object.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>protected static org.eclipse.persistence.internal.databaseaccess.FieldTypeDefinition</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/DatabaseObjectDefinition.html#getFieldTypeDefinition-org.eclipse.persistence.internal.sessions.AbstractSession-java.lang.Class-java.lang.String-">getFieldTypeDefinition</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;type,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">INTERNAL:
Retrieve a database platform specific definition from session for
existing type instance or build a new one when type is <code>null</code>.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>protected static org.eclipse.persistence.internal.databaseaccess.FieldTypeDefinition</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/DatabaseObjectDefinition.html#getFieldTypeDefinition-org.eclipse.persistence.internal.databaseaccess.DatabasePlatform-java.lang.Class-java.lang.String-">getFieldTypeDefinition</a></span>(org.eclipse.persistence.internal.databaseaccess.DatabasePlatform&nbsp;platform,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;type,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">INTERNAL:
Retrieve database platform specific field definition from database
specific platform handler for existing type or build a new one when type
is <code>null</code> and type for type name could not be found.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/DatabaseObjectDefinition.html#getFullName--">getFullName</a></span>()</code>
<div class="block">INTERNAL:
Most major databases support a creator name scope.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/DatabaseObjectDefinition.html#getName--">getName</a></span>()</code>
<div class="block">PUBLIC:
Return the name of the object.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/DatabaseObjectDefinition.html#getQualifier--">getQualifier</a></span>()</code>
<div class="block">PUBLIC:
Most major databases support a creator name scope.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/DatabaseObjectDefinition.html#hasDatabaseSchema--">hasDatabaseSchema</a></span>()</code>
<div class="block">INTERNAL:
Return true is this database object definition has a schema definition.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/DatabaseObjectDefinition.html#postCreateObject-org.eclipse.persistence.internal.sessions.AbstractSession-java.io.Writer-boolean-">postCreateObject</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a>&nbsp;createSchemaWriter,
boolean&nbsp;createSQLFiles)</code>
<div class="block">Execute any statements required after the creation of the object</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/DatabaseObjectDefinition.html#preDropObject-org.eclipse.persistence.internal.sessions.AbstractSession-java.io.Writer-boolean-">preDropObject</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a>&nbsp;dropSchemaWriter,
boolean&nbsp;createSQLFiles)</code>
<div class="block">Execute any statements required before the deletion of the object</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/DatabaseObjectDefinition.html#setName-java.lang.String-">setName</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">PUBLIC:
Set the name of the object.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/DatabaseObjectDefinition.html#setQualifier-java.lang.String-">setQualifier</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;qualifier)</code>
<div class="block">PUBLIC:
Most major databases support a creator name scope.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/DatabaseObjectDefinition.html#shouldCreateDatabaseSchema-java.util.Set-">shouldCreateDatabaseSchema</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;createdDatabaseSchemas)</code>
<div class="block">INTERNAL:
Subclasses who care should override this method, e.g.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/DatabaseObjectDefinition.html#shouldCreateVPDCalls-org.eclipse.persistence.internal.sessions.AbstractSession-">shouldCreateVPDCalls</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</code>
<div class="block">INTERNAL:
Subclasses who care should override this method.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/DatabaseObjectDefinition.html#toString--">toString</a></span>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="name">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>name</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name</pre>
</li>
</ul>
<a name="qualifier">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>qualifier</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> qualifier</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="DatabaseObjectDefinition--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DatabaseObjectDefinition</h4>
<pre>public&nbsp;DatabaseObjectDefinition()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getFieldTypeDefinition-org.eclipse.persistence.internal.sessions.AbstractSession-java.lang.Class-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFieldTypeDefinition</h4>
<pre>protected static final&nbsp;org.eclipse.persistence.internal.databaseaccess.FieldTypeDefinition&nbsp;getFieldTypeDefinition(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;type,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
<div class="block">INTERNAL:
Retrieve a database platform specific definition from session for
existing type instance or build a new one when type is <code>null</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>session</code> - Session to search for already existing instances.</dd>
<dd><code>type</code> - Field type class.</dd>
<dd><code>name</code> - Filed type name.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Database platform specific definition instance.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/eclipse/persistence/exceptions/ValidationException.html" title="class in org.eclipse.persistence.exceptions">ValidationException</a></code> - when provided type is not valid database type.</dd>
</dl>
</li>
</ul>
<a name="getFieldTypeDefinition-org.eclipse.persistence.internal.databaseaccess.DatabasePlatform-java.lang.Class-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFieldTypeDefinition</h4>
<pre>protected static final&nbsp;org.eclipse.persistence.internal.databaseaccess.FieldTypeDefinition&nbsp;getFieldTypeDefinition(org.eclipse.persistence.internal.databaseaccess.DatabasePlatform&nbsp;platform,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;type,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
<div class="block">INTERNAL:
Retrieve database platform specific field definition from database
specific platform handler for existing type or build a new one when type
is <code>null</code> and type for type name could not be found.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>platform</code> - Specific database platform handler.</dd>
<dd><code>type</code> - Field type (will be processed first when available).</dd>
<dd><code>name</code> - Field type name (will be processed as backup option when
type class is not available).</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/eclipse/persistence/exceptions/ValidationException.html" title="class in org.eclipse.persistence.exceptions">ValidationException</a></code> - when provided type is not valid database type.</dd>
</dl>
</li>
</ul>
<a name="buildCreationWriter-org.eclipse.persistence.internal.sessions.AbstractSession-java.io.Writer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildCreationWriter</h4>
<pre>public abstract&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a>&nbsp;buildCreationWriter(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a>&nbsp;writer)
throws <a href="../../../../../org/eclipse/persistence/exceptions/ValidationException.html" title="class in org.eclipse.persistence.exceptions">ValidationException</a></pre>
<div class="block">INTERNAL:
Returns the writer used for creation of this object.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/eclipse/persistence/exceptions/ValidationException.html" title="class in org.eclipse.persistence.exceptions">ValidationException</a></code></dd>
</dl>
</li>
</ul>
<a name="buildVPDCreationPolicyWriter-org.eclipse.persistence.internal.sessions.AbstractSession-java.io.Writer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildVPDCreationPolicyWriter</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a>&nbsp;buildVPDCreationPolicyWriter(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a>&nbsp;writer)</pre>
<div class="block">INTERNAL:
Sub classes should override.</div>
</li>
</ul>
<a name="buildVPDCreationFunctionWriter-org.eclipse.persistence.internal.sessions.AbstractSession-java.io.Writer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildVPDCreationFunctionWriter</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a>&nbsp;buildVPDCreationFunctionWriter(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a>&nbsp;writer)</pre>
<div class="block">INTERNAL:
Sub classes should override.</div>
</li>
</ul>
<a name="buildVPDDeletionWriter-org.eclipse.persistence.internal.sessions.AbstractSession-java.io.Writer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildVPDDeletionWriter</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a>&nbsp;buildVPDDeletionWriter(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a>&nbsp;writer)</pre>
<div class="block">INTERNAL:
Sub classes should override.</div>
</li>
</ul>
<a name="buildDeletionWriter-org.eclipse.persistence.internal.sessions.AbstractSession-java.io.Writer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildDeletionWriter</h4>
<pre>public abstract&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a>&nbsp;buildDeletionWriter(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a>&nbsp;writer)
throws <a href="../../../../../org/eclipse/persistence/exceptions/ValidationException.html" title="class in org.eclipse.persistence.exceptions">ValidationException</a></pre>
<div class="block">INTERNAL:
Returns the writer used for deletion of this object.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/eclipse/persistence/exceptions/ValidationException.html" title="class in org.eclipse.persistence.exceptions">ValidationException</a></code></dd>
</dl>
</li>
</ul>
<a name="clone--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clone</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;clone()</pre>
<div class="block">PUBLIC:</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>
<a name="createDatabaseSchema-org.eclipse.persistence.internal.sessions.AbstractSession-java.io.Writer-java.util.Set-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createDatabaseSchema</h4>
<pre>public&nbsp;void&nbsp;createDatabaseSchema(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a>&nbsp;writer,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;createdDatabaseSchemas)
throws <a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></pre>
<div class="block">INTERNAL:
Execute the DDL to create the database schema for this object.
Does nothing at this level, subclasses that support this must override
this method.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/eclipse/persistence/tools/schemaframework/TableDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework"><code>TableDefinition</code></a></dd>
</dl>
</li>
</ul>
<a name="createDatabaseSchemaOnDatabase-org.eclipse.persistence.internal.sessions.AbstractSession-java.util.Set-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createDatabaseSchemaOnDatabase</h4>
<pre>public&nbsp;void&nbsp;createDatabaseSchemaOnDatabase(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;createdDatabaseSchemas)
throws <a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></pre>
<div class="block">INTERNAL:
Execute the DDL to create the database schema for this object.
Does nothing at this level, subclasses that support this must override
this method.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/eclipse/persistence/tools/schemaframework/TableDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework"><code>TableDefinition</code></a></dd>
</dl>
</li>
</ul>
<a name="createObject-org.eclipse.persistence.internal.sessions.AbstractSession-java.io.Writer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createObject</h4>
<pre>public&nbsp;void&nbsp;createObject(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a>&nbsp;schemaWriter)
throws <a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></pre>
<div class="block">INTERNAL:
Either drop from the database directly or write the statement to a file.
Database objects are root level entities such as tables, views, procs, sequences...</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></code></dd>
</dl>
</li>
</ul>
<a name="createOnDatabase-org.eclipse.persistence.internal.sessions.AbstractSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createOnDatabase</h4>
<pre>public&nbsp;void&nbsp;createOnDatabase(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)
throws <a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></pre>
<div class="block">INTERNAL:
Execute the DDL to create this object.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></code></dd>
</dl>
</li>
</ul>
<a name="shouldCreateDatabaseSchema-java.util.Set-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shouldCreateDatabaseSchema</h4>
<pre>public&nbsp;boolean&nbsp;shouldCreateDatabaseSchema(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;createdDatabaseSchemas)</pre>
<div class="block">INTERNAL:
Subclasses who care should override this method, e.g. TableDefinition.</div>
</li>
</ul>
<a name="shouldCreateVPDCalls-org.eclipse.persistence.internal.sessions.AbstractSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shouldCreateVPDCalls</h4>
<pre>public&nbsp;boolean&nbsp;shouldCreateVPDCalls(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</pre>
<div class="block">INTERNAL:
Subclasses who care should override this method.</div>
</li>
</ul>
<a name="dropDatabaseSchema-org.eclipse.persistence.internal.sessions.AbstractSession-java.io.Writer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dropDatabaseSchema</h4>
<pre>public&nbsp;void&nbsp;dropDatabaseSchema(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a>&nbsp;writer)
throws <a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></pre>
<div class="block">INTERNAL:
Execute the DDL to drop the database schema for this object.
Does nothing at this level, subclasses that support this must override
this method.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/eclipse/persistence/tools/schemaframework/TableDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework"><code>TableDefinition</code></a></dd>
</dl>
</li>
</ul>
<a name="dropDatabaseSchemaOnDatabase-org.eclipse.persistence.internal.sessions.AbstractSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dropDatabaseSchemaOnDatabase</h4>
<pre>public&nbsp;void&nbsp;dropDatabaseSchemaOnDatabase(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)
throws <a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></pre>
<div class="block">INTERNAL:
Execute the DDL to drop the database schema for this object.
Does nothing at this level, subclasses that support this must override
this method.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/eclipse/persistence/tools/schemaframework/TableDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework"><code>TableDefinition</code></a></dd>
</dl>
</li>
</ul>
<a name="dropFromDatabase-org.eclipse.persistence.internal.sessions.AbstractSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dropFromDatabase</h4>
<pre>public&nbsp;void&nbsp;dropFromDatabase(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)
throws <a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></pre>
<div class="block">INTERNAL:
Execute the DDL to drop the object.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></code></dd>
</dl>
</li>
</ul>
<a name="dropObject-org.eclipse.persistence.internal.sessions.AbstractSession-java.io.Writer-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dropObject</h4>
<pre>public&nbsp;void&nbsp;dropObject(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a>&nbsp;schemaWriter,
boolean&nbsp;createSQLFiles)
throws <a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></pre>
<div class="block">INTERNAL:
Execute the DDL to drop the object. Either directly from the database
of write out the statement to a file.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/eclipse/persistence/exceptions/EclipseLinkException.html" title="class in org.eclipse.persistence.exceptions">EclipseLinkException</a></code></dd>
</dl>
</li>
</ul>
<a name="getDatabaseSchema--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDatabaseSchema</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getDatabaseSchema()</pre>
<div class="block">PUBLIC:
Return the database schema associated with this database object.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/eclipse/persistence/tools/schemaframework/TableDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework"><code>TableDefinition</code></a></dd>
</dl>
</li>
</ul>
<a name="getFullName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFullName</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getFullName()</pre>
<div class="block">INTERNAL:
Most major databases support a creator name scope.
This means whenever the database object is referenced, it must be qualified.</div>
</li>
</ul>
<a name="getName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getName()</pre>
<div class="block">PUBLIC:
Return the name of the object.
i.e. the table name or the sequence name.</div>
</li>
</ul>
<a name="getQualifier--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQualifier</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getQualifier()</pre>
<div class="block">PUBLIC:
Most major databases support a creator name scope.
This means whenever the database object is referenced, it must be qualified.</div>
</li>
</ul>
<a name="hasDatabaseSchema--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasDatabaseSchema</h4>
<pre>protected&nbsp;boolean&nbsp;hasDatabaseSchema()</pre>
<div class="block">INTERNAL:
Return true is this database object definition has a schema definition.</div>
</li>
</ul>
<a name="postCreateObject-org.eclipse.persistence.internal.sessions.AbstractSession-java.io.Writer-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>postCreateObject</h4>
<pre>public&nbsp;void&nbsp;postCreateObject(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a>&nbsp;createSchemaWriter,
boolean&nbsp;createSQLFiles)</pre>
<div class="block">Execute any statements required after the creation of the object</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>session</code> - </dd>
<dd><code>createSchemaWriter</code> - </dd>
</dl>
</li>
</ul>
<a name="preDropObject-org.eclipse.persistence.internal.sessions.AbstractSession-java.io.Writer-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>preDropObject</h4>
<pre>public&nbsp;void&nbsp;preDropObject(org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io">Writer</a>&nbsp;dropSchemaWriter,
boolean&nbsp;createSQLFiles)</pre>
<div class="block">Execute any statements required before the deletion of the object</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>session</code> - </dd>
<dd><code>dropSchemaWriter</code> - </dd>
</dl>
</li>
</ul>
<a name="setName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setName</h4>
<pre>public&nbsp;void&nbsp;setName(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
<div class="block">PUBLIC:
Set the name of the object.
i.e. the table name or the sequence name.</div>
</li>
</ul>
<a name="setQualifier-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setQualifier</h4>
<pre>public&nbsp;void&nbsp;setQualifier(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;qualifier)</pre>
<div class="block">PUBLIC:
Most major databases support a creator name scope.
This means whenever the database object is referenced, it must be qualified.</div>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= 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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">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>Prev&nbsp;Class</li>
<li><a href="../../../../../org/eclipse/persistence/tools/schemaframework/DefaultTableGenerator.html" title="class in org.eclipse.persistence.tools.schemaframework"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/persistence/tools/schemaframework/DatabaseObjectDefinition.html" target="_top">Frames</a></li>
<li><a href="DatabaseObjectDefinition.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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; 2007&#x2013;2021 <a href="http://www.eclipse.org/eclipselink">Eclipse.org - EclipseLink Project</a>. All rights reserved.</small></p>
</body>
</html>