| <!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:38:48 UTC 2021 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>DynamicTypeBuilder (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="DynamicTypeBuilder (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":9,"i15":9,"i16":9,"i17":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/dynamic/DynamicType.html" title="interface in org.eclipse.persistence.dynamic"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/eclipse/persistence/dynamic/EclipseLinkClassWriter.html" title="interface in org.eclipse.persistence.dynamic"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/eclipse/persistence/dynamic/DynamicTypeBuilder.html" target="_top">Frames</a></li> |
| <li><a href="DynamicTypeBuilder.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.dynamic</div> |
| <h2 title="Class DynamicTypeBuilder" class="title">Class DynamicTypeBuilder</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.dynamic.DynamicTypeBuilder</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../org/eclipse/persistence/jpa/dynamic/JPADynamicTypeBuilder.html" title="class in org.eclipse.persistence.jpa.dynamic">JPADynamicTypeBuilder</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">DynamicTypeBuilder</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></pre> |
| <div class="block">The EntityTypeBuilder is a factory class for creating and extending dynamic |
| entity types. After being constructed in either usage the application can |
| then use the provided API to customize mapping information of the type.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd>dclarke, mnorman</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>EclipseLink 1.2</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"> </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 org.eclipse.persistence.internal.dynamic.DynamicTypeImpl</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/dynamic/DynamicTypeBuilder.html#entityType">entityType</a></span></code> |
| <div class="block">The type being configured for dynamic use or being created/extended</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"> </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/dynamic/DynamicTypeBuilder.html#DynamicTypeBuilder-java.lang.Class-org.eclipse.persistence.dynamic.DynamicType-java.lang.String...-">DynamicTypeBuilder</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><?> dynamicClass, |
| <a href="../../../../org/eclipse/persistence/dynamic/DynamicType.html" title="interface in org.eclipse.persistence.dynamic">DynamicType</a> parentType, |
| <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>... tableNames)</code> |
| <div class="block">Create an EntityType for a new dynamic type.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/dynamic/DynamicTypeBuilder.html#DynamicTypeBuilder-org.eclipse.persistence.dynamic.DynamicClassLoader-org.eclipse.persistence.descriptors.ClassDescriptor-org.eclipse.persistence.dynamic.DynamicType-">DynamicTypeBuilder</a></span>(<a href="../../../../org/eclipse/persistence/dynamic/DynamicClassLoader.html" title="class in org.eclipse.persistence.dynamic">DynamicClassLoader</a> dcl, |
| <a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a> descriptor, |
| <a href="../../../../org/eclipse/persistence/dynamic/DynamicType.html" title="interface in org.eclipse.persistence.dynamic">DynamicType</a> parentType)</code> |
| <div class="block">Create an EntityTypeBuilder for an existing descriptor.</div> |
| </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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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><a href="../../../../org/eclipse/persistence/mappings/AggregateObjectMapping.html" title="class in org.eclipse.persistence.mappings">AggregateObjectMapping</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/dynamic/DynamicTypeBuilder.html#addAggregateObjectMapping-java.lang.String-org.eclipse.persistence.dynamic.DynamicType-boolean-">addAggregateObjectMapping</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> name, |
| <a href="../../../../org/eclipse/persistence/dynamic/DynamicType.html" title="interface in org.eclipse.persistence.dynamic">DynamicType</a> refType, |
| boolean allowsNull)</code> |
| <div class="block">Add a <a href="../../../../org/eclipse/persistence/mappings/AggregateObjectMapping.html" title="class in org.eclipse.persistence.mappings"><code>AggregateObjectMapping</code></a> (<code>Embeddable</code> in JPA) to the |
| <a href="../../../../org/eclipse/persistence/dynamic/DynamicTypeBuilder.html#entityType"><code>entityType</code></a> being built or extended.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/eclipse/persistence/mappings/DirectCollectionMapping.html" title="class in org.eclipse.persistence.mappings">DirectCollectionMapping</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/dynamic/DynamicTypeBuilder.html#addDirectCollectionMapping-java.lang.String-java.lang.String-java.lang.String-java.lang.Class-java.lang.String...-">addDirectCollectionMapping</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> 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> targetTable, |
| <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> valueColumn, |
| <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><?> valueType, |
| <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>... fkFieldNames)</code> |
| <div class="block">Add a <a href="../../../../org/eclipse/persistence/mappings/DirectCollectionMapping.html" title="class in org.eclipse.persistence.mappings"><code>DirectCollectionMapping</code></a> to the <a href="../../../../org/eclipse/persistence/dynamic/DynamicTypeBuilder.html#entityType"><code>entityType</code></a> being |
| built or extended.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/eclipse/persistence/mappings/DirectToFieldMapping.html" title="class in org.eclipse.persistence.mappings">DirectToFieldMapping</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/dynamic/DynamicTypeBuilder.html#addDirectMapping-java.lang.String-java.lang.Class-java.lang.String-">addDirectMapping</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> 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><?> javaType, |
| <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> fieldName)</code> |
| <div class="block">Allows <a href="../../../../org/eclipse/persistence/mappings/DirectToFieldMapping.html" title="class in org.eclipse.persistence.mappings"><code>DirectToFieldMapping</code></a> (@Basic) mapping to be added to a |
| dynamic type through API.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/eclipse/persistence/mappings/foundation/AbstractDirectMapping.html" title="class in org.eclipse.persistence.mappings.foundation">AbstractDirectMapping</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/dynamic/DynamicTypeBuilder.html#addDirectMappingForEnum-java.lang.String-java.lang.String-java.lang.String-">addDirectMappingForEnum</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> fieldName, |
| <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> className, |
| <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> columnName)</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/dynamic/DynamicTypeBuilder.html#addDynamicClasses-org.eclipse.persistence.dynamic.DynamicClassLoader-java.lang.String-org.eclipse.persistence.dynamic.DynamicType-">addDynamicClasses</a></span>(<a href="../../../../org/eclipse/persistence/dynamic/DynamicClassLoader.html" title="class in org.eclipse.persistence.dynamic">DynamicClassLoader</a> dcl, |
| <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> className, |
| <a href="../../../../org/eclipse/persistence/dynamic/DynamicType.html" title="interface in org.eclipse.persistence.dynamic">DynamicType</a> parentType)</code> |
| <div class="block">Register a <a href="../../../../org/eclipse/persistence/dynamic/DynamicClassWriter.html" title="class in org.eclipse.persistence.dynamic"><code>DynamicClassWriter</code></a> with the provided |
| <a href="../../../../org/eclipse/persistence/dynamic/DynamicClassLoader.html" title="class in org.eclipse.persistence.dynamic"><code>DynamicClassLoader</code></a> so that a dynamic class can be generated when |
| needed.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/eclipse/persistence/dynamic/DynamicEnumBuilder.html" title="class in org.eclipse.persistence.dynamic">DynamicEnumBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/dynamic/DynamicTypeBuilder.html#addEnum-java.lang.String-java.lang.String-java.lang.String-org.eclipse.persistence.dynamic.DynamicClassLoader-">addEnum</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> fieldName, |
| <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> className, |
| <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> columnName, |
| <a href="../../../../org/eclipse/persistence/dynamic/DynamicClassLoader.html" title="class in org.eclipse.persistence.dynamic">DynamicClassLoader</a> dcl)</code> </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/dynamic/DynamicTypeBuilder.html#addManyToManyMapping-java.lang.String-org.eclipse.persistence.dynamic.DynamicType-java.lang.String-">addManyToManyMapping</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> name, |
| <a href="../../../../org/eclipse/persistence/dynamic/DynamicType.html" title="interface in org.eclipse.persistence.dynamic">DynamicType</a> refType, |
| <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> relationshipTableName)</code> |
| <div class="block">Add a <a href="../../../../org/eclipse/persistence/mappings/ManyToManyMapping.html" title="class in org.eclipse.persistence.mappings"><code>ManyToManyMapping</code></a> to the <a href="../../../../org/eclipse/persistence/dynamic/DynamicTypeBuilder.html#entityType"><code>entityType</code></a> being built or |
| extended.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/dynamic/DynamicTypeBuilder.html#addMapping-org.eclipse.persistence.mappings.DatabaseMapping-">addMapping</a></span>(<a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a> mapping)</code> |
| <div class="block">Add the mapping to the <a href="../../../../org/eclipse/persistence/dynamic/DynamicTypeBuilder.html#entityType"><code>entityType</code></a>'s descriptor being built or |
| extended.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/eclipse/persistence/mappings/OneToManyMapping.html" title="class in org.eclipse.persistence.mappings">OneToManyMapping</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/dynamic/DynamicTypeBuilder.html#addOneToManyMapping-java.lang.String-org.eclipse.persistence.dynamic.DynamicType-java.lang.String...-">addOneToManyMapping</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> name, |
| <a href="../../../../org/eclipse/persistence/dynamic/DynamicType.html" title="interface in org.eclipse.persistence.dynamic">DynamicType</a> refType, |
| <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>... fkFieldNames)</code> |
| <div class="block">Add a <a href="../../../../org/eclipse/persistence/mappings/OneToManyMapping.html" title="class in org.eclipse.persistence.mappings"><code>OneToManyMapping</code></a> to the <a href="../../../../org/eclipse/persistence/dynamic/DynamicTypeBuilder.html#entityType"><code>entityType</code></a> being built or |
| extended.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/eclipse/persistence/mappings/OneToOneMapping.html" title="class in org.eclipse.persistence.mappings">OneToOneMapping</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/dynamic/DynamicTypeBuilder.html#addOneToOneMapping-java.lang.String-org.eclipse.persistence.dynamic.DynamicType-java.lang.String...-">addOneToOneMapping</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> name, |
| <a href="../../../../org/eclipse/persistence/dynamic/DynamicType.html" title="interface in org.eclipse.persistence.dynamic">DynamicType</a> refType, |
| <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>... fkFieldNames)</code> |
| <div class="block">Allows <a href="../../../../org/eclipse/persistence/mappings/OneToOneMapping.html" title="class in org.eclipse.persistence.mappings"><code>OneToOneMapping</code></a> (@OneToOne and @ManyToOne) mappings to be |
| added to a dynamic type through API.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/dynamic/DynamicTypeBuilder.html#configure-org.eclipse.persistence.descriptors.ClassDescriptor-java.lang.String...-">configure</a></span>(<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a> descriptor, |
| <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>... tableNames)</code> |
| <div class="block">Initialize a new or existing descriptor configuring the necessary |
| policies as well as</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/dynamic/DynamicTypeBuilder.html#configureSequencing-org.eclipse.persistence.sequencing.Sequence-java.lang.String-java.lang.String-">configureSequencing</a></span>(<a href="../../../../org/eclipse/persistence/sequencing/Sequence.html" title="class in org.eclipse.persistence.sequencing">Sequence</a> sequence, |
| <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> numberName, |
| <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> numberFieldName)</code> |
| <div class="block">Configure sequencing specifying the sequence type to use.</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/dynamic/DynamicTypeBuilder.html#configureSequencing-java.lang.String-java.lang.String-">configureSequencing</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> numberName, |
| <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> numberFieldName)</code> |
| <div class="block">Configure default sequencing.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/eclipse/persistence/dynamic/DynamicType.html" title="interface in org.eclipse.persistence.dynamic">DynamicType</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/dynamic/DynamicTypeBuilder.html#getType--">getType</a></span>()</code> </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/eclipse/persistence/sessions/Project.html" title="class in org.eclipse.persistence.sessions">Project</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/dynamic/DynamicTypeBuilder.html#loadDynamicProject-java.io.InputStream-org.eclipse.persistence.sessions.DatabaseLogin-org.eclipse.persistence.dynamic.DynamicClassLoader-">loadDynamicProject</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> resourceStream, |
| <a href="../../../../org/eclipse/persistence/sessions/DatabaseLogin.html" title="class in org.eclipse.persistence.sessions">DatabaseLogin</a> login, |
| <a href="../../../../org/eclipse/persistence/dynamic/DynamicClassLoader.html" title="class in org.eclipse.persistence.dynamic">DynamicClassLoader</a> dynamicClassLoader)</code> |
| <div class="block">Load a dynamic project from deployment XML creating dynamic types for all |
| descriptors where the provided class name does not exist.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/eclipse/persistence/sessions/Project.html" title="class in org.eclipse.persistence.sessions">Project</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/dynamic/DynamicTypeBuilder.html#loadDynamicProject-org.eclipse.persistence.sessions.Project-org.eclipse.persistence.sessions.DatabaseLogin-org.eclipse.persistence.dynamic.DynamicClassLoader-">loadDynamicProject</a></span>(<a href="../../../../org/eclipse/persistence/sessions/Project.html" title="class in org.eclipse.persistence.sessions">Project</a> project, |
| <a href="../../../../org/eclipse/persistence/sessions/DatabaseLogin.html" title="class in org.eclipse.persistence.sessions">DatabaseLogin</a> login, |
| <a href="../../../../org/eclipse/persistence/dynamic/DynamicClassLoader.html" title="class in org.eclipse.persistence.dynamic">DynamicClassLoader</a> dynamicClassLoader)</code> </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/eclipse/persistence/sessions/Project.html" title="class in org.eclipse.persistence.sessions">Project</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/dynamic/DynamicTypeBuilder.html#loadDynamicProject-java.lang.String-org.eclipse.persistence.sessions.DatabaseLogin-org.eclipse.persistence.dynamic.DynamicClassLoader-">loadDynamicProject</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> resourcePath, |
| <a href="../../../../org/eclipse/persistence/sessions/DatabaseLogin.html" title="class in org.eclipse.persistence.sessions">DatabaseLogin</a> login, |
| <a href="../../../../org/eclipse/persistence/dynamic/DynamicClassLoader.html" title="class in org.eclipse.persistence.dynamic">DynamicClassLoader</a> dynamicClassLoader)</code> |
| <div class="block">Load a dynamic project from deployment XML creating dynamic types for all |
| descriptors where the provided class name does not exist.</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/dynamic/DynamicTypeBuilder.html#setPrimaryKeyFields-java.lang.String...-">setPrimaryKeyFields</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>... pkFieldNames)</code> |
| <div class="block">Set the PK field names on the underlying descriptor ensuring no duplicate |
| names are added.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class 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#clone--" title="class or interface in java.lang">clone</a>, <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#toString--" title="class or interface in java.lang">toString</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="entityType"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>entityType</h4> |
| <pre>protected org.eclipse.persistence.internal.dynamic.DynamicTypeImpl entityType</pre> |
| <div class="block">The type being configured for dynamic use or being created/extended</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="DynamicTypeBuilder-java.lang.Class-org.eclipse.persistence.dynamic.DynamicType-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DynamicTypeBuilder</h4> |
| <pre>public DynamicTypeBuilder(<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><?> dynamicClass, |
| <a href="../../../../org/eclipse/persistence/dynamic/DynamicType.html" title="interface in org.eclipse.persistence.dynamic">DynamicType</a> parentType, |
| <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>... tableNames)</pre> |
| <div class="block">Create an EntityType for a new dynamic type. The contained EntityType and |
| its wrapped descriptor are not automatically added to any session. This |
| must be done by the application after the type's is fully configured. |
| <p> |
| <b>Creating new type Example</b>: <code> |
| DynamicHelper helper = new DynamicHelper(session); |
| DynamicClassLoader dcl = helper.getDynamicClassLoader();<br> |
| <br> |
| Class<?> javaType = dcl.creatDynamicClass("model.Simple");<br> |
| <br> |
| DynamicTypeBuilder typeBuilder = new JPADynamicTypeBuilder(javaType, null, "SIMPLE_TYPE");<br> |
| typeBuilder.setPrimaryKeyFields("SID");<br> |
| typeBuilder.addDirectMapping("id", int.class, "SID");<br> |
| typeBuilder.addDirectMapping("value1", String.class, "VAL_1");<br> |
| typeBuilder.addDirectMapping("value2", boolean.class, "VAL_2");<br> |
| typeBuilder.addDirectMapping("value3", Calendar.class, "VAL_3");<br> |
| typeBuilder.addDirectMapping("value4", Character.class, "VAL_4");<br> |
| <br> |
| helper.addTypes(true, true, typeBuilder.getType());<br> |
| </code></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>dynamicClass</code> - </dd> |
| <dd><code>parentType</code> - </dd> |
| <dd><code>tableNames</code> - </dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DynamicTypeBuilder-org.eclipse.persistence.dynamic.DynamicClassLoader-org.eclipse.persistence.descriptors.ClassDescriptor-org.eclipse.persistence.dynamic.DynamicType-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DynamicTypeBuilder</h4> |
| <pre>public DynamicTypeBuilder(<a href="../../../../org/eclipse/persistence/dynamic/DynamicClassLoader.html" title="class in org.eclipse.persistence.dynamic">DynamicClassLoader</a> dcl, |
| <a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a> descriptor, |
| <a href="../../../../org/eclipse/persistence/dynamic/DynamicType.html" title="interface in org.eclipse.persistence.dynamic">DynamicType</a> parentType)</pre> |
| <div class="block">Create an EntityTypeBuilder for an existing descriptor. This is used</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>dcl</code> - </dd> |
| <dd><code>descriptor</code> - </dd> |
| <dd><code>parentType</code> - provided since the InheritancePolicy on the descriptor may not |
| have its parent descriptor initialized.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="addDynamicClasses-org.eclipse.persistence.dynamic.DynamicClassLoader-java.lang.String-org.eclipse.persistence.dynamic.DynamicType-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addDynamicClasses</h4> |
| <pre>protected void addDynamicClasses(<a href="../../../../org/eclipse/persistence/dynamic/DynamicClassLoader.html" title="class in org.eclipse.persistence.dynamic">DynamicClassLoader</a> dcl, |
| <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> className, |
| <a href="../../../../org/eclipse/persistence/dynamic/DynamicType.html" title="interface in org.eclipse.persistence.dynamic">DynamicType</a> parentType)</pre> |
| <div class="block">Register a <a href="../../../../org/eclipse/persistence/dynamic/DynamicClassWriter.html" title="class in org.eclipse.persistence.dynamic"><code>DynamicClassWriter</code></a> with the provided |
| <a href="../../../../org/eclipse/persistence/dynamic/DynamicClassLoader.html" title="class in org.eclipse.persistence.dynamic"><code>DynamicClassLoader</code></a> so that a dynamic class can be generated when |
| needed.</div> |
| </li> |
| </ul> |
| <a name="configure-org.eclipse.persistence.descriptors.ClassDescriptor-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>configure</h4> |
| <pre>protected void configure(<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a> descriptor, |
| <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>... tableNames)</pre> |
| <div class="block">Initialize a new or existing descriptor configuring the necessary |
| policies as well as</div> |
| </li> |
| </ul> |
| <a name="getType--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getType</h4> |
| <pre>public <a href="../../../../org/eclipse/persistence/dynamic/DynamicType.html" title="interface in org.eclipse.persistence.dynamic">DynamicType</a> getType()</pre> |
| </li> |
| </ul> |
| <a name="setPrimaryKeyFields-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPrimaryKeyFields</h4> |
| <pre>public void setPrimaryKeyFields(<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>... pkFieldNames)</pre> |
| <div class="block">Set the PK field names on the underlying descriptor ensuring no duplicate |
| names are added.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pkFieldNames</code> - qualified or unqualified field names</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addDirectMapping-java.lang.String-java.lang.Class-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addDirectMapping</h4> |
| <pre>public <a href="../../../../org/eclipse/persistence/mappings/DirectToFieldMapping.html" title="class in org.eclipse.persistence.mappings">DirectToFieldMapping</a> addDirectMapping(<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, |
| <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><?> javaType, |
| <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> fieldName)</pre> |
| <div class="block">Allows <a href="../../../../org/eclipse/persistence/mappings/DirectToFieldMapping.html" title="class in org.eclipse.persistence.mappings"><code>DirectToFieldMapping</code></a> (@Basic) mapping to be added to a |
| dynamic type through API. This method can be used on a new |
| <code>DynamicTypeImpl</code> that has yet to be added to a session and have |
| its descriptor initialized, or it can be called on an active |
| (initialized) descriptor. |
| <p> |
| There is no support currently for having the EclipseLink |
| <a href="../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html" title="class in org.eclipse.persistence.tools.schemaframework"><code>SchemaManager</code></a> generate ALTER TABLE calls so any new columns |
| expected must be added without the help of EclipseLink or use the |
| <a href="../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#replaceObject-org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition-"><code>SchemaManager.replaceObject(org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition)</code></a> |
| to DROP and CREATE the table. WARNING: This will cause data loss.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>javaType</code> - is the type of the attribute. If the type is a primitive it |
| will be converted to the comparable non-primitive type.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addOneToOneMapping-java.lang.String-org.eclipse.persistence.dynamic.DynamicType-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addOneToOneMapping</h4> |
| <pre>public <a href="../../../../org/eclipse/persistence/mappings/OneToOneMapping.html" title="class in org.eclipse.persistence.mappings">OneToOneMapping</a> addOneToOneMapping(<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, |
| <a href="../../../../org/eclipse/persistence/dynamic/DynamicType.html" title="interface in org.eclipse.persistence.dynamic">DynamicType</a> refType, |
| <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>... fkFieldNames)</pre> |
| <div class="block">Allows <a href="../../../../org/eclipse/persistence/mappings/OneToOneMapping.html" title="class in org.eclipse.persistence.mappings"><code>OneToOneMapping</code></a> (@OneToOne and @ManyToOne) mappings to be |
| added to a dynamic type through API. This method can be used on a new |
| <code>DynamicTypeImpl</code> that has yet to be added to a session and have |
| its descriptor initialized, or it can be called on an active |
| (initialized) descriptor. |
| <p> |
| There is no support currently for having the EclipseLink |
| <a href="../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html" title="class in org.eclipse.persistence.tools.schemaframework"><code>SchemaManager</code></a> generate ALTER TABLE calls so any new columns |
| expected must be added without the help of EclipseLink or use the |
| <a href="../../../../org/eclipse/persistence/tools/schemaframework/SchemaManager.html#replaceObject-org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition-"><code>SchemaManager.replaceObject(org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition)</code></a> |
| to DROP and CREATE the table. WARNING: This will cause data loss.</div> |
| </li> |
| </ul> |
| <a name="addOneToManyMapping-java.lang.String-org.eclipse.persistence.dynamic.DynamicType-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addOneToManyMapping</h4> |
| <pre>public <a href="../../../../org/eclipse/persistence/mappings/OneToManyMapping.html" title="class in org.eclipse.persistence.mappings">OneToManyMapping</a> addOneToManyMapping(<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, |
| <a href="../../../../org/eclipse/persistence/dynamic/DynamicType.html" title="interface in org.eclipse.persistence.dynamic">DynamicType</a> refType, |
| <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>... fkFieldNames)</pre> |
| <div class="block">Add a <a href="../../../../org/eclipse/persistence/mappings/OneToManyMapping.html" title="class in org.eclipse.persistence.mappings"><code>OneToManyMapping</code></a> to the <a href="../../../../org/eclipse/persistence/dynamic/DynamicTypeBuilder.html#entityType"><code>entityType</code></a> being built or |
| extended. This mapping is created using standard foreign keys from the |
| source table(s) to the target table(s) and transparent indirection ( |
| <a href="../../../../org/eclipse/persistence/indirection/IndirectList.html" title="class in org.eclipse.persistence.indirection"><code>IndirectList</code></a>).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - attribute name to use in the dynamic entity. Also the property |
| name used to access the state of the entity</dd> |
| <dd><code>refType</code> - </dd> |
| <dd><code>fkFieldNames</code> - the FK field names specified in the same order to match the PK |
| field names of the target class</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the newly created, configured mappin. It will be initialized if |
| the descriptor is already initialized.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addDirectCollectionMapping-java.lang.String-java.lang.String-java.lang.String-java.lang.Class-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addDirectCollectionMapping</h4> |
| <pre>public <a href="../../../../org/eclipse/persistence/mappings/DirectCollectionMapping.html" title="class in org.eclipse.persistence.mappings">DirectCollectionMapping</a> addDirectCollectionMapping(<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, |
| <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> targetTable, |
| <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> valueColumn, |
| <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><?> valueType, |
| <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>... fkFieldNames) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></pre> |
| <div class="block">Add a <a href="../../../../org/eclipse/persistence/mappings/DirectCollectionMapping.html" title="class in org.eclipse.persistence.mappings"><code>DirectCollectionMapping</code></a> to the <a href="../../../../org/eclipse/persistence/dynamic/DynamicTypeBuilder.html#entityType"><code>entityType</code></a> being |
| built or extended. This mapping is created using standard foreign keys |
| from the target table(s) to the source table(s) and transparent |
| indirection ( <a href="../../../../org/eclipse/persistence/indirection/IndirectList.html" title="class in org.eclipse.persistence.indirection"><code>IndirectList</code></a>).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - attribute name to use in the dynamic entity. Also the property |
| name used to access the state of the entity</dd> |
| <dd><code>targetTable</code> - name of table holding the direct values</dd> |
| <dd><code>valueColumn</code> - name of column in target table holding the direct value for |
| the collection</dd> |
| <dd><code>valueType</code> - the type of the attribute assumed to be a known basic type</dd> |
| <dd><code>fkFieldNames</code> - the FK field names on the source table specified in order to |
| match the PK field names on the source.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the new mapping configured and initialized (if the descriptor is |
| already initialized.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addAggregateObjectMapping-java.lang.String-org.eclipse.persistence.dynamic.DynamicType-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addAggregateObjectMapping</h4> |
| <pre>public <a href="../../../../org/eclipse/persistence/mappings/AggregateObjectMapping.html" title="class in org.eclipse.persistence.mappings">AggregateObjectMapping</a> addAggregateObjectMapping(<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, |
| <a href="../../../../org/eclipse/persistence/dynamic/DynamicType.html" title="interface in org.eclipse.persistence.dynamic">DynamicType</a> refType, |
| boolean allowsNull)</pre> |
| <div class="block">Add a <a href="../../../../org/eclipse/persistence/mappings/AggregateObjectMapping.html" title="class in org.eclipse.persistence.mappings"><code>AggregateObjectMapping</code></a> (<code>Embeddable</code> in JPA) to the |
| <a href="../../../../org/eclipse/persistence/dynamic/DynamicTypeBuilder.html#entityType"><code>entityType</code></a> being built or extended.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - attribute name to use in the dynamic entity. Also the property |
| name used to access the state of the entity</dd> |
| <dd><code>refType</code> - dynamic type re[presenting the Embeddable/AggregateObject</dd> |
| <dd><code>allowsNull</code> - true indicates that the attribute can be null if all values |
| are null.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the new mapping configured and initialized (if the descriptor has |
| been initialized).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addManyToManyMapping-java.lang.String-org.eclipse.persistence.dynamic.DynamicType-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addManyToManyMapping</h4> |
| <pre>public void addManyToManyMapping(<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, |
| <a href="../../../../org/eclipse/persistence/dynamic/DynamicType.html" title="interface in org.eclipse.persistence.dynamic">DynamicType</a> refType, |
| <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> relationshipTableName)</pre> |
| <div class="block">Add a <a href="../../../../org/eclipse/persistence/mappings/ManyToManyMapping.html" title="class in org.eclipse.persistence.mappings"><code>ManyToManyMapping</code></a> to the <a href="../../../../org/eclipse/persistence/dynamic/DynamicTypeBuilder.html#entityType"><code>entityType</code></a> being built or |
| extended. This method assumes that the columns names on the relationship |
| table match the PK columns names they relate to. In the case of the |
| target keys from the relationship table a '_' will be appended to the |
| column names if they collide with the names from the source table.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - attribute name to use in the dynamic entity. Also the property |
| name used to access the state of the entity</dd> |
| <dd><code>refType</code> - target dynamic entity</dd> |
| <dd><code>relationshipTableName</code> - </dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addMapping-org.eclipse.persistence.mappings.DatabaseMapping-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addMapping</h4> |
| <pre>public <a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a> addMapping(<a href="../../../../org/eclipse/persistence/mappings/DatabaseMapping.html" title="class in org.eclipse.persistence.mappings">DatabaseMapping</a> mapping)</pre> |
| <div class="block">Add the mapping to the <a href="../../../../org/eclipse/persistence/dynamic/DynamicTypeBuilder.html#entityType"><code>entityType</code></a>'s descriptor being built or |
| extended. This is where the <code>ValuesAccessor</code> is created and the |
| position of the mapping in the descriptor is captured to use as its |
| index.</div> |
| </li> |
| </ul> |
| <a name="configureSequencing-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>configureSequencing</h4> |
| <pre>public void configureSequencing(<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> numberName, |
| <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> numberFieldName)</pre> |
| <div class="block">Configure default sequencing.</div> |
| </li> |
| </ul> |
| <a name="configureSequencing-org.eclipse.persistence.sequencing.Sequence-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>configureSequencing</h4> |
| <pre>public void configureSequencing(<a href="../../../../org/eclipse/persistence/sequencing/Sequence.html" title="class in org.eclipse.persistence.sequencing">Sequence</a> sequence, |
| <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> numberName, |
| <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> numberFieldName)</pre> |
| <div class="block">Configure sequencing specifying the sequence type to use.</div> |
| </li> |
| </ul> |
| <a name="addEnum-java.lang.String-java.lang.String-java.lang.String-org.eclipse.persistence.dynamic.DynamicClassLoader-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addEnum</h4> |
| <pre>public <a href="../../../../org/eclipse/persistence/dynamic/DynamicEnumBuilder.html" title="class in org.eclipse.persistence.dynamic">DynamicEnumBuilder</a> addEnum(<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> fieldName, |
| <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> className, |
| <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> columnName, |
| <a href="../../../../org/eclipse/persistence/dynamic/DynamicClassLoader.html" title="class in org.eclipse.persistence.dynamic">DynamicClassLoader</a> dcl)</pre> |
| </li> |
| </ul> |
| <a name="addDirectMappingForEnum-java.lang.String-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addDirectMappingForEnum</h4> |
| <pre>protected <a href="../../../../org/eclipse/persistence/mappings/foundation/AbstractDirectMapping.html" title="class in org.eclipse.persistence.mappings.foundation">AbstractDirectMapping</a> addDirectMappingForEnum(<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> fieldName, |
| <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> className, |
| <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> columnName)</pre> |
| </li> |
| </ul> |
| <a name="loadDynamicProject-java.lang.String-org.eclipse.persistence.sessions.DatabaseLogin-org.eclipse.persistence.dynamic.DynamicClassLoader-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>loadDynamicProject</h4> |
| <pre>public static <a href="../../../../org/eclipse/persistence/sessions/Project.html" title="class in org.eclipse.persistence.sessions">Project</a> loadDynamicProject(<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> resourcePath, |
| <a href="../../../../org/eclipse/persistence/sessions/DatabaseLogin.html" title="class in org.eclipse.persistence.sessions">DatabaseLogin</a> login, |
| <a href="../../../../org/eclipse/persistence/dynamic/DynamicClassLoader.html" title="class in org.eclipse.persistence.dynamic">DynamicClassLoader</a> dynamicClassLoader) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Load a dynamic project from deployment XML creating dynamic types for all |
| descriptors where the provided class name does not exist.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>resourcePath</code> - </dd> |
| <dd><code>login</code> - </dd> |
| <dd><code>dynamicClassLoader</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a Project with <a href="../../../../org/eclipse/persistence/dynamic/DynamicClassLoader.html" title="class in org.eclipse.persistence.dynamic"><code>DynamicClassLoader</code></a> and associated |
| <a href="../../../../org/eclipse/persistence/dynamic/DynamicClassWriter.html" title="class in org.eclipse.persistence.dynamic"><code>DynamicClassWriter</code></a> configured. Ensure if a new |
| Login/Platform is being configured that the |
| <code>ConversionManager.getLoader()</code> is maintained. |
| <p> |
| <code>null</code> is returned if the resourcePath cannot locate a |
| deployment XML</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="loadDynamicProject-java.io.InputStream-org.eclipse.persistence.sessions.DatabaseLogin-org.eclipse.persistence.dynamic.DynamicClassLoader-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>loadDynamicProject</h4> |
| <pre>public static <a href="../../../../org/eclipse/persistence/sessions/Project.html" title="class in org.eclipse.persistence.sessions">Project</a> loadDynamicProject(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> resourceStream, |
| <a href="../../../../org/eclipse/persistence/sessions/DatabaseLogin.html" title="class in org.eclipse.persistence.sessions">DatabaseLogin</a> login, |
| <a href="../../../../org/eclipse/persistence/dynamic/DynamicClassLoader.html" title="class in org.eclipse.persistence.dynamic">DynamicClassLoader</a> dynamicClassLoader) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Load a dynamic project from deployment XML creating dynamic types for all |
| descriptors where the provided class name does not exist.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>resourceStream</code> - </dd> |
| <dd><code>login</code> - </dd> |
| <dd><code>dynamicClassLoader</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a Project with <a href="../../../../org/eclipse/persistence/dynamic/DynamicClassLoader.html" title="class in org.eclipse.persistence.dynamic"><code>DynamicClassLoader</code></a> and associated |
| <a href="../../../../org/eclipse/persistence/dynamic/DynamicClassWriter.html" title="class in org.eclipse.persistence.dynamic"><code>DynamicClassWriter</code></a> configured. Ensure if a new |
| Login/Platform is being configured that the |
| <code>ConversionManager.getLoader()</code> is maintained. |
| <p> |
| <code>null</code> is returned if the resourcePath cannot locate a |
| deployment XML</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="loadDynamicProject-org.eclipse.persistence.sessions.Project-org.eclipse.persistence.sessions.DatabaseLogin-org.eclipse.persistence.dynamic.DynamicClassLoader-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>loadDynamicProject</h4> |
| <pre>public static <a href="../../../../org/eclipse/persistence/sessions/Project.html" title="class in org.eclipse.persistence.sessions">Project</a> loadDynamicProject(<a href="../../../../org/eclipse/persistence/sessions/Project.html" title="class in org.eclipse.persistence.sessions">Project</a> project, |
| <a href="../../../../org/eclipse/persistence/sessions/DatabaseLogin.html" title="class in org.eclipse.persistence.sessions">DatabaseLogin</a> login, |
| <a href="../../../../org/eclipse/persistence/dynamic/DynamicClassLoader.html" title="class in org.eclipse.persistence.dynamic">DynamicClassLoader</a> dynamicClassLoader)</pre> |
| </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/dynamic/DynamicType.html" title="interface in org.eclipse.persistence.dynamic"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/eclipse/persistence/dynamic/EclipseLinkClassWriter.html" title="interface in org.eclipse.persistence.dynamic"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/eclipse/persistence/dynamic/DynamicTypeBuilder.html" target="_top">Frames</a></li> |
| <li><a href="DynamicTypeBuilder.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 © 2007–2021 <a href="http://www.eclipse.org/eclipselink">Eclipse.org - EclipseLink Project</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
