api/3.0/org/eclipse/persistence/tools/schemaframework/FieldDefinition.html - gerrit/www.eclipse.org/eclipselink - Git at Google

 <!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>FieldDefinition (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="FieldDefinition (EclipseLink 3.0.2, API Reference)";
         }
     }
     catch(err) {
     }
 //-->
 var methods = {"i0":10,"i1":10,"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":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10};
 var tabs = {65535:["t0","All Methods"],2:["t2","Instance 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><a href="../../../../../org/eclipse/persistence/tools/schemaframework/DynamicSchemaManager.html" title="class in org.eclipse.persistence.tools.schemaframework"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../../../../org/eclipse/persistence/tools/schemaframework/ForeignKeyConstraint.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/FieldDefinition.html" target="_top">Frames</a></li>
 <li><a href="FieldDefinition.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 FieldDefinition" class="title">Class FieldDefinition</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.FieldDefinition</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>
 <hr>
 <br>
 <pre>public class <span class="typeNameLabel">FieldDefinition</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/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></pre>
 <div class="block"><p>
  <b>Purpose</b>: Define a database field definition for creation within a table.
  This differs from DatabaseField in that it is used only table creation not a runtime.
  <p>
  <b>Responsibilities</b>:
  <ul>
  <li> Store the name, java type, size and sub-size.
  The sizes are optional and the name of the java class is used for the type.
  </ul></div>
 <dl>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../../../serialized-form.html#org.eclipse.persistence.tools.schemaframework.FieldDefinition">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>protected <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/FieldDefinition.html#additional">additional</a></span></code>&nbsp;</td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>protected <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/FieldDefinition.html#constraint">constraint</a></span></code>&nbsp;</td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>protected org.eclipse.persistence.internal.helper.DatabaseField</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/FieldDefinition.html#field">field</a></span></code>
 <div class="block">DatabaseField stores the field name with case and delimiting information.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>protected <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/FieldDefinition.html#foreignKeyFieldName">foreignKeyFieldName</a></span></code>&nbsp;</td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>protected boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/FieldDefinition.html#isIdentity">isIdentity</a></span></code>&nbsp;</td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>protected boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/FieldDefinition.html#isPrimaryKey">isPrimaryKey</a></span></code>&nbsp;</td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>protected boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/FieldDefinition.html#isUnique">isUnique</a></span></code>&nbsp;</td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>protected <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/FieldDefinition.html#name">name</a></span></code>&nbsp;</td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>protected boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/FieldDefinition.html#shouldAllowNull">shouldAllowNull</a></span></code>&nbsp;</td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>protected int</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/FieldDefinition.html#size">size</a></span></code>&nbsp;</td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>protected int</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/FieldDefinition.html#subSize">subSize</a></span></code>&nbsp;</td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>protected <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></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/FieldDefinition.html#type">type</a></span></code>
 <div class="block">Java type class for the field.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>protected <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/FieldDefinition.html#typeDefinition">typeDefinition</a></span></code>
 <div class="block">Database-specific complete type definition like "VARCHAR2(50) UNIQUE NOT NULL".</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>protected <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/FieldDefinition.html#typeName">typeName</a></span></code>
 <div class="block">Generic database type name for the field, which can be used instead of the Java class 'type'.</div>
 </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/FieldDefinition.html#FieldDefinition--">FieldDefinition</a></span>()</code>&nbsp;</td>
 </tr>
 <tr class="rowColor">
 <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/FieldDefinition.html#FieldDefinition-java.lang.String-java.lang.Class-">FieldDefinition</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,
                <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)</code>&nbsp;</td>
 </tr>
 <tr class="altColor">
 <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/FieldDefinition.html#FieldDefinition-java.lang.String-java.lang.Class-int-">FieldDefinition</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,
                <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,
                int&nbsp;size)</code>&nbsp;</td>
 </tr>
 <tr class="rowColor">
 <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/FieldDefinition.html#FieldDefinition-java.lang.String-java.lang.Class-int-int-">FieldDefinition</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,
                <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,
                int&nbsp;size,
                int&nbsp;subSize)</code>&nbsp;</td>
 </tr>
 <tr class="altColor">
 <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/FieldDefinition.html#FieldDefinition-java.lang.String-java.lang.String-">FieldDefinition</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,
                <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;typeName)</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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance 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>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/FieldDefinition.html#appendDBString-java.io.Writer-org.eclipse.persistence.internal.sessions.AbstractSession-org.eclipse.persistence.tools.schemaframework.TableDefinition-">appendDBString</a></span>(<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,
               org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session,
               <a href="../../../../../org/eclipse/persistence/tools/schemaframework/TableDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">TableDefinition</a>&nbsp;table)</code>
 <div class="block">INTERNAL:
  Append the database field definition string to the table creation statement.</div>
 </td>
 </tr>
 <tr id="i1" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/FieldDefinition.html#appendTypeString-java.io.Writer-org.eclipse.persistence.internal.sessions.AbstractSession-">appendTypeString</a></span>(<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,
                 org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)</code>
 <div class="block">INTERNAL:
  Append the database field definition string to the type creation statement.</div>
 </td>
 </tr>
 <tr id="i2" class="altColor">
 <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/FieldDefinition.html#clone--">clone</a></span>()</code>
 <div class="block">PUBLIC:</div>
 </td>
 </tr>
 <tr id="i3" 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/FieldDefinition.html#getAdditional--">getAdditional</a></span>()</code>
 <div class="block">PUBLIC:
  Return any additional information about this field to be given when the table is created.</div>
 </td>
 </tr>
 <tr id="i4" 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/FieldDefinition.html#getConstraint--">getConstraint</a></span>()</code>
 <div class="block">PUBLIC:
  Return any constraint of this field.</div>
 </td>
 </tr>
 <tr id="i5" class="rowColor">
 <td class="colFirst"><code>org.eclipse.persistence.internal.helper.DatabaseField</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/FieldDefinition.html#getDatabaseField--">getDatabaseField</a></span>()</code>
 <div class="block">INTERNAL:
  Return the databasefield.</div>
 </td>
 </tr>
 <tr id="i6" 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/FieldDefinition.html#getForeignKeyFieldName--">getForeignKeyFieldName</a></span>()</code>&nbsp;</td>
 </tr>
 <tr id="i7" 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/FieldDefinition.html#getName--">getName</a></span>()</code>
 <div class="block">PUBLIC:
  Return the name of the field.</div>
 </td>
 </tr>
 <tr id="i8" class="altColor">
 <td class="colFirst"><code>int</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/FieldDefinition.html#getSize--">getSize</a></span>()</code>
 <div class="block">PUBLIC:
  Return the size of the field, this is only required for some field types.</div>
 </td>
 </tr>
 <tr id="i9" class="rowColor">
 <td class="colFirst"><code>int</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/FieldDefinition.html#getSubSize--">getSubSize</a></span>()</code>
 <div class="block">PUBLIC:
  Return the sub-size of the field.</div>
 </td>
 </tr>
 <tr id="i10" class="altColor">
 <td class="colFirst"><code><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></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/FieldDefinition.html#getType--">getType</a></span>()</code>
 <div class="block">PUBLIC:
  Return the type of the field.</div>
 </td>
 </tr>
 <tr id="i11" 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/FieldDefinition.html#getTypeDefinition--">getTypeDefinition</a></span>()</code>
 <div class="block">PUBLIC:
  Return the type definition of the field.</div>
 </td>
 </tr>
 <tr id="i12" 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/FieldDefinition.html#getTypeName--">getTypeName</a></span>()</code>
 <div class="block">PUBLIC:
  Return the type name of the field.</div>
 </td>
 </tr>
 <tr id="i13" class="rowColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/FieldDefinition.html#isIdentity--">isIdentity</a></span>()</code>
 <div class="block">PUBLIC:
  Answer whether the receiver is an identity field.</div>
 </td>
 </tr>
 <tr id="i14" class="altColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/FieldDefinition.html#isPrimaryKey--">isPrimaryKey</a></span>()</code>
 <div class="block">PUBLIC:
  Answer whether the receiver is a primary key.</div>
 </td>
 </tr>
 <tr id="i15" class="rowColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/FieldDefinition.html#isUnique--">isUnique</a></span>()</code>
 <div class="block">PUBLIC:
  Answer whether the receiver is a unique constraint field.</div>
 </td>
 </tr>
 <tr id="i16" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/FieldDefinition.html#setAdditional-java.lang.String-">setAdditional</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;string)</code>
 <div class="block">PUBLIC:
  Set any additional information about this field to be given when the table is created.</div>
 </td>
 </tr>
 <tr id="i17" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/FieldDefinition.html#setConstraint-java.lang.String-">setConstraint</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;string)</code>
 <div class="block">PUBLIC:
  Set any constraint of this field.</div>
 </td>
 </tr>
 <tr id="i18" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/FieldDefinition.html#setDatabaseField-org.eclipse.persistence.internal.helper.DatabaseField-">setDatabaseField</a></span>(org.eclipse.persistence.internal.helper.DatabaseField&nbsp;field)</code>
 <div class="block">INTERNAL:
  Set the DatabaseField that is associated to this FieldDefinition object.</div>
 </td>
 </tr>
 <tr id="i19" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/FieldDefinition.html#setForeignKeyFieldName-java.lang.String-">setForeignKeyFieldName</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;foreignKeyFieldName)</code>&nbsp;</td>
 </tr>
 <tr id="i20" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/FieldDefinition.html#setIsIdentity-boolean-">setIsIdentity</a></span>(boolean&nbsp;value)</code>
 <div class="block">PUBLIC:
  Set whether the receiver is an identity field.</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/FieldDefinition.html#setIsPrimaryKey-boolean-">setIsPrimaryKey</a></span>(boolean&nbsp;value)</code>
 <div class="block">PUBLIC:
  Set whether the receiver is a primary key.</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/FieldDefinition.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 field.</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/FieldDefinition.html#setShouldAllowNull-boolean-">setShouldAllowNull</a></span>(boolean&nbsp;value)</code>
 <div class="block">PUBLIC:
  Set whether the receiver should allow null values.</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/FieldDefinition.html#setSize-int-">setSize</a></span>(int&nbsp;size)</code>
 <div class="block">PUBLIC:
  Set the size of the field, this is only required for some field types.</div>
 </td>
 </tr>
 <tr id="i25" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/FieldDefinition.html#setSubSize-int-">setSubSize</a></span>(int&nbsp;subSize)</code>
 <div class="block">PUBLIC:
  Set the sub-size of the field.</div>
 </td>
 </tr>
 <tr id="i26" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/FieldDefinition.html#setType-java.lang.Class-">setType</a></span>(<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)</code>
 <div class="block">PUBLIC:
  Set the type of the field.</div>
 </td>
 </tr>
 <tr id="i27" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/FieldDefinition.html#setTypeDefinition-java.lang.String-">setTypeDefinition</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;typeDefinition)</code>
 <div class="block">PUBLIC:
  Set the type definition of the field.</div>
 </td>
 </tr>
 <tr id="i28" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/FieldDefinition.html#setTypeName-java.lang.String-">setTypeName</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;typeName)</code>
 <div class="block">PUBLIC:
  Set the type name of the field.</div>
 </td>
 </tr>
 <tr id="i29" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/FieldDefinition.html#setUnique-boolean-">setUnique</a></span>(boolean&nbsp;value)</code>
 <div class="block">PUBLIC:
  Set whether the receiver is a unique constraint field.</div>
 </td>
 </tr>
 <tr id="i30" class="altColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/tools/schemaframework/FieldDefinition.html#shouldAllowNull--">shouldAllowNull</a></span>()</code>
 <div class="block">PUBLIC:
  Return whether the receiver should allow null values.</div>
 </td>
 </tr>
 <tr id="i31" 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/FieldDefinition.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>protected&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="type">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>type</h4>
 <pre>protected&nbsp;<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> type</pre>
 <div class="block">Java type class for the field.
  Particular database type is generated based on platform from this.</div>
 </li>
 </ul>
 <a name="typeName">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>typeName</h4>
 <pre>protected&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> typeName</pre>
 <div class="block">Generic database type name for the field, which can be used instead of the Java class 'type'.
  This is translated to a particular database type based on platform.</div>
 </li>
 </ul>
 <a name="field">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>field</h4>
 <pre>protected&nbsp;org.eclipse.persistence.internal.helper.DatabaseField field</pre>
 <div class="block">DatabaseField stores the field name with case and delimiting information.
  Used if the field needs to be found in the table metadata, for extending tables.
  if null, name is used for comparison to determine if this field already exists.</div>
 </li>
 </ul>
 <a name="typeDefinition">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>typeDefinition</h4>
 <pre>protected&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> typeDefinition</pre>
 <div class="block">Database-specific complete type definition like "VARCHAR2(50) UNIQUE NOT NULL".
  If this is given, other additional type constraint fields(size, unique, null) are meaningless.</div>
 </li>
 </ul>
 <a name="size">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>size</h4>
 <pre>protected&nbsp;int size</pre>
 </li>
 </ul>
 <a name="subSize">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>subSize</h4>
 <pre>protected&nbsp;int subSize</pre>
 </li>
 </ul>
 <a name="shouldAllowNull">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>shouldAllowNull</h4>
 <pre>protected&nbsp;boolean shouldAllowNull</pre>
 </li>
 </ul>
 <a name="isIdentity">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>isIdentity</h4>
 <pre>protected&nbsp;boolean isIdentity</pre>
 </li>
 </ul>
 <a name="isPrimaryKey">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>isPrimaryKey</h4>
 <pre>protected&nbsp;boolean isPrimaryKey</pre>
 </li>
 </ul>
 <a name="isUnique">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>isUnique</h4>
 <pre>protected&nbsp;boolean isUnique</pre>
 </li>
 </ul>
 <a name="additional">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>additional</h4>
 <pre>protected&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> additional</pre>
 </li>
 </ul>
 <a name="constraint">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>constraint</h4>
 <pre>protected&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> constraint</pre>
 </li>
 </ul>
 <a name="foreignKeyFieldName">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>foreignKeyFieldName</h4>
 <pre>protected&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> foreignKeyFieldName</pre>
 </li>
 </ul>
 </li>
 </ul>
 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 <ul class="blockList">
 <li class="blockList"><a name="constructor.detail">
 <!--   -->
 </a>
 <h3>Constructor Detail</h3>
 <a name="FieldDefinition--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>FieldDefinition</h4>
 <pre>public&nbsp;FieldDefinition()</pre>
 </li>
 </ul>
 <a name="FieldDefinition-java.lang.String-java.lang.Class-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>FieldDefinition</h4>
 <pre>public&nbsp;FieldDefinition(<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,
                        <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)</pre>
 </li>
 </ul>
 <a name="FieldDefinition-java.lang.String-java.lang.Class-int-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>FieldDefinition</h4>
 <pre>public&nbsp;FieldDefinition(<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,
                        <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,
                        int&nbsp;size)</pre>
 </li>
 </ul>
 <a name="FieldDefinition-java.lang.String-java.lang.Class-int-int-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>FieldDefinition</h4>
 <pre>public&nbsp;FieldDefinition(<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,
                        <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,
                        int&nbsp;size,
                        int&nbsp;subSize)</pre>
 </li>
 </ul>
 <a name="FieldDefinition-java.lang.String-java.lang.String-">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>FieldDefinition</h4>
 <pre>public&nbsp;FieldDefinition(<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,
                        <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;typeName)</pre>
 </li>
 </ul>
 </li>
 </ul>
 <!-- ============ METHOD DETAIL ========== -->
 <ul class="blockList">
 <li class="blockList"><a name="method.detail">
 <!--   -->
 </a>
 <h3>Method Detail</h3>
 <a name="appendDBString-java.io.Writer-org.eclipse.persistence.internal.sessions.AbstractSession-org.eclipse.persistence.tools.schemaframework.TableDefinition-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>appendDBString</h4>
 <pre>public&nbsp;void&nbsp;appendDBString(<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,
                            org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session,
                            <a href="../../../../../org/eclipse/persistence/tools/schemaframework/TableDefinition.html" title="class in org.eclipse.persistence.tools.schemaframework">TableDefinition</a>&nbsp;table)
                     throws <a href="../../../../../org/eclipse/persistence/exceptions/ValidationException.html" title="class in org.eclipse.persistence.exceptions">ValidationException</a></pre>
 <div class="block">INTERNAL:
  Append the database field definition string to the table creation statement.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>writer</code> - Target writer where to write field definition string.</dd>
 <dd><code>session</code> - Current session context.</dd>
 <dd><code>table</code> - Database table being processed.</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 invalid or inconsistent data were found.</dd>
 </dl>
 </li>
 </ul>
 <a name="appendTypeString-java.io.Writer-org.eclipse.persistence.internal.sessions.AbstractSession-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>appendTypeString</h4>
 <pre>public&nbsp;void&nbsp;appendTypeString(<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,
                              org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;session)
                       throws <a href="../../../../../org/eclipse/persistence/exceptions/ValidationException.html" title="class in org.eclipse.persistence.exceptions">ValidationException</a></pre>
 <div class="block">INTERNAL:
  Append the database field definition string to the type creation statement.
  Types do not support constraints.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>writer</code> - Target writer where to write field definition string.</dd>
 <dd><code>session</code> - Current session context.</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 invalid or inconsistent data were found.</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="getAdditional--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getAdditional</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;getAdditional()</pre>
 <div class="block">PUBLIC:
  Return any additional information about this field to be given when the table is created.</div>
 </li>
 </ul>
 <a name="getConstraint--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getConstraint</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;getConstraint()</pre>
 <div class="block">PUBLIC:
  Return any constraint of this field.
  i.e. "BETWEEN 0 AND 1000000".</div>
 </li>
 </ul>
 <a name="getForeignKeyFieldName--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getForeignKeyFieldName</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;getForeignKeyFieldName()</pre>
 </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 field.</div>
 </li>
 </ul>
 <a name="getDatabaseField--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getDatabaseField</h4>
 <pre>public&nbsp;org.eclipse.persistence.internal.helper.DatabaseField&nbsp;getDatabaseField()</pre>
 <div class="block">INTERNAL:
  Return the databasefield.</div>
 </li>
 </ul>
 <a name="getSize--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getSize</h4>
 <pre>public&nbsp;int&nbsp;getSize()</pre>
 <div class="block">PUBLIC:
  Return the size of the field, this is only required for some field types.</div>
 </li>
 </ul>
 <a name="getSubSize--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getSubSize</h4>
 <pre>public&nbsp;int&nbsp;getSubSize()</pre>
 <div class="block">PUBLIC:
  Return the sub-size of the field.
  This is used as the decimal precision for numeric values only.</div>
 </li>
 </ul>
 <a name="getType--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getType</h4>
 <pre>public&nbsp;<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;getType()</pre>
 <div class="block">PUBLIC:
  Return the type of the field.
  This should be set to a java class, such as String.class, Integer.class or Date.class.</div>
 </li>
 </ul>
 <a name="getTypeName--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getTypeName</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;getTypeName()</pre>
 <div class="block">PUBLIC:
  Return the type name of the field.
  This is the generic database type name, which can be used instead of the Java class 'type'.
  This is translated to a particular database type based on platform.</div>
 </li>
 </ul>
 <a name="getTypeDefinition--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getTypeDefinition</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;getTypeDefinition()</pre>
 <div class="block">PUBLIC:
  Return the type definition of the field.
  This is database-specific complete type definition like "VARCHAR2(50) UNIQUE NOT NULL".
  If this is given, other additional type constraint fields(size, unique, null) are meaningless.</div>
 </li>
 </ul>
 <a name="isIdentity--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>isIdentity</h4>
 <pre>public&nbsp;boolean&nbsp;isIdentity()</pre>
 <div class="block">PUBLIC:
  Answer whether the receiver is an identity field.
  Identity fields are Sybase specific,
  they insure that on insert a unique sequential value is stored in the row.</div>
 </li>
 </ul>
 <a name="isPrimaryKey--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>isPrimaryKey</h4>
 <pre>public&nbsp;boolean&nbsp;isPrimaryKey()</pre>
 <div class="block">PUBLIC:
  Answer whether the receiver is a primary key.
  If the table has a multipart primary key this should be set in each field.</div>
 </li>
 </ul>
 <a name="isUnique--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>isUnique</h4>
 <pre>public&nbsp;boolean&nbsp;isUnique()</pre>
 <div class="block">PUBLIC:
  Answer whether the receiver is a unique constraint field.</div>
 </li>
 </ul>
 <a name="setAdditional-java.lang.String-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setAdditional</h4>
 <pre>public&nbsp;void&nbsp;setAdditional(<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;string)</pre>
 <div class="block">PUBLIC:
  Set any additional information about this field to be given when the table is created.</div>
 </li>
 </ul>
 <a name="setConstraint-java.lang.String-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setConstraint</h4>
 <pre>public&nbsp;void&nbsp;setConstraint(<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;string)</pre>
 <div class="block">PUBLIC:
  Set any constraint of this field.
  i.e. "BETWEEN 0 AND 1000000".</div>
 </li>
 </ul>
 <a name="setForeignKeyFieldName-java.lang.String-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setForeignKeyFieldName</h4>
 <pre>public&nbsp;void&nbsp;setForeignKeyFieldName(<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;foreignKeyFieldName)</pre>
 </li>
 </ul>
 <a name="setIsIdentity-boolean-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setIsIdentity</h4>
 <pre>public&nbsp;void&nbsp;setIsIdentity(boolean&nbsp;value)</pre>
 <div class="block">PUBLIC:
  Set whether the receiver is an identity field.
  Identity fields are Sybase specific,
  they insure that on insert a unique sequential value is stored in the row.</div>
 </li>
 </ul>
 <a name="setIsPrimaryKey-boolean-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setIsPrimaryKey</h4>
 <pre>public&nbsp;void&nbsp;setIsPrimaryKey(boolean&nbsp;value)</pre>
 <div class="block">PUBLIC:
  Set whether the receiver is a primary key.
  If the table has a multipart primary key this should be set in each field.</div>
 </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 field.</div>
 </li>
 </ul>
 <a name="setDatabaseField-org.eclipse.persistence.internal.helper.DatabaseField-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setDatabaseField</h4>
 <pre>public&nbsp;void&nbsp;setDatabaseField(org.eclipse.persistence.internal.helper.DatabaseField&nbsp;field)</pre>
 <div class="block">INTERNAL:
  Set the DatabaseField that is associated to this FieldDefinition object.
  The databaesField is used when extending tables to see if this field already exists.</div>
 </li>
 </ul>
 <a name="setShouldAllowNull-boolean-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setShouldAllowNull</h4>
 <pre>public&nbsp;void&nbsp;setShouldAllowNull(boolean&nbsp;value)</pre>
 <div class="block">PUBLIC:
  Set whether the receiver should allow null values.</div>
 </li>
 </ul>
 <a name="setSize-int-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setSize</h4>
 <pre>public&nbsp;void&nbsp;setSize(int&nbsp;size)</pre>
 <div class="block">PUBLIC:
  Set the size of the field, this is only required for some field types.</div>
 </li>
 </ul>
 <a name="setSubSize-int-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setSubSize</h4>
 <pre>public&nbsp;void&nbsp;setSubSize(int&nbsp;subSize)</pre>
 <div class="block">PUBLIC:
  Set the sub-size of the field.
  This is used as the decimal precision for numeric values only.</div>
 </li>
 </ul>
 <a name="setType-java.lang.Class-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setType</h4>
 <pre>public&nbsp;void&nbsp;setType(<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)</pre>
 <div class="block">PUBLIC:
  Set the type of the field.
  This should be set to a java class, such as String.class, Integer.class or Date.class.</div>
 </li>
 </ul>
 <a name="setTypeName-java.lang.String-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setTypeName</h4>
 <pre>public&nbsp;void&nbsp;setTypeName(<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;typeName)</pre>
 <div class="block">PUBLIC:
  Set the type name of the field.
  This is the generic database type name, which can be used instead of the Java class 'type'.
  This is translated to a particular database type based on platform.</div>
 </li>
 </ul>
 <a name="setTypeDefinition-java.lang.String-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setTypeDefinition</h4>
 <pre>public&nbsp;void&nbsp;setTypeDefinition(<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;typeDefinition)</pre>
 <div class="block">PUBLIC:
  Set the type definition of the field.
  This is database-specific complete type definition like "VARCHAR2(50) UNIQUE NOT NULL".
  If this is given, other additional type constraint fields(size, unique, null) are meaningless.</div>
 </li>
 </ul>
 <a name="setUnique-boolean-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setUnique</h4>
 <pre>public&nbsp;void&nbsp;setUnique(boolean&nbsp;value)</pre>
 <div class="block">PUBLIC:
  Set whether the receiver is a unique constraint field.</div>
 </li>
 </ul>
 <a name="shouldAllowNull--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>shouldAllowNull</h4>
 <pre>public&nbsp;boolean&nbsp;shouldAllowNull()</pre>
 <div class="block">PUBLIC:
  Return whether the receiver should allow null values.</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><a href="../../../../../org/eclipse/persistence/tools/schemaframework/DynamicSchemaManager.html" title="class in org.eclipse.persistence.tools.schemaframework"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../../../../org/eclipse/persistence/tools/schemaframework/ForeignKeyConstraint.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/FieldDefinition.html" target="_top">Frames</a></li>
 <li><a href="FieldDefinition.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>