| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>ClassMetaData (OpenJPA Parent POM 4.1.1 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../jquery/jquery-3.7.1.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.min.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="ClassMetaData (OpenJPA Parent POM 4.1.1 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"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,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10,"i47":10,"i48":10,"i49":10,"i50":10,"i51":10,"i52":10,"i53":10,"i54":10,"i55":10,"i56":10,"i57":10,"i58":10,"i59":10,"i60":10,"i61":10,"i62":10,"i63":10,"i64":10,"i65":10,"i66":10,"i67":10,"i68":10,"i69":10,"i70":10,"i71":10,"i72":10,"i73":10,"i74":10,"i75":10,"i76":10,"i77":10,"i78":10,"i79":10,"i80":10,"i81":10,"i82":10,"i83":10,"i84":10,"i85":10,"i86":10,"i87":10,"i88":10,"i89":10,"i90":10,"i91":10,"i92":10,"i93":10,"i94":10,"i95":10,"i96":10,"i97":10,"i98":10,"i99":10,"i100":10,"i101":10,"i102":10,"i103":10,"i104":10,"i105":10,"i106":10,"i107":10,"i108":10,"i109":10,"i110":10,"i111":10,"i112":10,"i113":10,"i114":10,"i115":10,"i116":10,"i117":10,"i118":10,"i119":10,"i120":10,"i121":10,"i122":10,"i123":10,"i124":10,"i125":10,"i126":10,"i127":10,"i128":10,"i129":10,"i130":10,"i131":10,"i132":10,"i133":10,"i134":10,"i135":10,"i136":10,"i137":10,"i138":10,"i139":10,"i140":10,"i141":10,"i142":10,"i143":10,"i144":10,"i145":10,"i146":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"; |
| var pathtoroot = "../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ClassMetaData.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </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 id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.openjpa.meta</a></div> |
| <h2 title="Class ClassMetaData" class="title">Class ClassMetaData</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="Extensions.html" title="class in org.apache.openjpa.meta">org.apache.openjpa.meta.Extensions</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.openjpa.meta.ClassMetaData</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Comparable</a><<a href="ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a>></code>, <code><a href="../lib/conf/ValueListener.html" title="interface in org.apache.openjpa.lib.conf">ValueListener</a></code>, <code><a href="../lib/meta/SourceTracker.html" title="interface in org.apache.openjpa.lib.meta">SourceTracker</a></code>, <code><a href="../lib/xml/Commentable.html" title="interface in org.apache.openjpa.lib.xml">Commentable</a></code>, <code><a href="MetaDataContext.html" title="interface in org.apache.openjpa.meta">MetaDataContext</a></code>, <code><a href="MetaDataModes.html" title="interface in org.apache.openjpa.meta">MetaDataModes</a></code></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="../jdbc/meta/ClassMapping.html" title="class in org.apache.openjpa.jdbc.meta">ClassMapping</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">ClassMetaData</span> |
| extends <a href="Extensions.html" title="class in org.apache.openjpa.meta">Extensions</a> |
| implements <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Comparable</a><<a href="ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a>>, <a href="../lib/meta/SourceTracker.html" title="interface in org.apache.openjpa.lib.meta">SourceTracker</a>, <a href="MetaDataContext.html" title="interface in org.apache.openjpa.meta">MetaDataContext</a>, <a href="MetaDataModes.html" title="interface in org.apache.openjpa.meta">MetaDataModes</a>, <a href="../lib/xml/Commentable.html" title="interface in org.apache.openjpa.lib.xml">Commentable</a>, <a href="../lib/conf/ValueListener.html" title="interface in org.apache.openjpa.lib.conf">ValueListener</a></pre> |
| <div class="block">Contains metadata about a persistent type. |
| This metadata is available both at enhancement time and runtime. |
| Note that this class employs aggressive caching, and therefore it is |
| important to finalize the configuration of field metadatas before invoking |
| methods that depend on that configuration, such as |
| <a href="#getPrimaryKeyFields()"><code>getPrimaryKeyFields()</code></a>.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd>Abe White</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../serialized-form.html#org.apache.openjpa.meta.ClassMetaData">Serialized Form</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ACCESS_EXPLICIT">ACCESS_EXPLICIT</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Persistent class has explicitly defined an access type.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ACCESS_FIELD">ACCESS_FIELD</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Persistent attributes are accessed via direct field access.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ACCESS_PROPERTY">ACCESS_PROPERTY</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Persistent attributes are accessed via setters and getters.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ACCESS_UNKNOWN">ACCESS_UNKNOWN</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Unknown access type.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_STRING">DEFAULT_STRING</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ID_APPLICATION">ID_APPLICATION</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Application identity type.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ID_DATASTORE">ID_DATASTORE</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Datastore identity type.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ID_UNKNOWN">ID_UNKNOWN</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Unknown identity type.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#SYNTHETIC">SYNTHETIC</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Value for using a synthetic detached state field, which is the default.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.org.apache.openjpa.meta.Extensions"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.openjpa.meta.<a href="Extensions.html" title="class in org.apache.openjpa.meta">Extensions</a></h3> |
| <code><a href="Extensions.html#OPENJPA">OPENJPA</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.org.apache.openjpa.lib.xml.Commentable"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.openjpa.lib.xml.<a href="../lib/xml/Commentable.html" title="interface in org.apache.openjpa.lib.xml">Commentable</a></h3> |
| <code><a href="../lib/xml/Commentable.html#EMPTY_COMMENTS">EMPTY_COMMENTS</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.org.apache.openjpa.meta.MetaDataModes"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.openjpa.meta.<a href="MetaDataModes.html" title="interface in org.apache.openjpa.meta">MetaDataModes</a></h3> |
| <code><a href="MetaDataModes.html#MODE_ALL">MODE_ALL</a>, <a href="MetaDataModes.html#MODE_ANN_MAPPING">MODE_ANN_MAPPING</a>, <a href="MetaDataModes.html#MODE_MAPPING">MODE_MAPPING</a>, <a href="MetaDataModes.html#MODE_MAPPING_INIT">MODE_MAPPING_INIT</a>, <a href="MetaDataModes.html#MODE_META">MODE_META</a>, <a href="MetaDataModes.html#MODE_NONE">MODE_NONE</a>, <a href="MetaDataModes.html#MODE_QUERY">MODE_QUERY</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.org.apache.openjpa.lib.meta.SourceTracker"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.openjpa.lib.meta.<a href="../lib/meta/SourceTracker.html" title="interface in org.apache.openjpa.lib.meta">SourceTracker</a></h3> |
| <code><a href="../lib/meta/SourceTracker.html#SRC_ANNOTATIONS">SRC_ANNOTATIONS</a>, <a href="../lib/meta/SourceTracker.html#SRC_OTHER">SRC_OTHER</a>, <a href="../lib/meta/SourceTracker.html#SRC_XML">SRC_XML</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier</th> |
| <th class="colSecond" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.Class,org.apache.openjpa.meta.MetaDataRepository)">ClassMetaData</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?> type, |
| <a href="MetaDataRepository.html" title="class in org.apache.openjpa.meta">MetaDataRepository</a> repos)</code></th> |
| <td class="colLast"> |
| <div class="block">Constructor.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.openjpa.meta.ValueMetaData)">ClassMetaData</a></span>​(<a href="ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a> owner)</code></th> |
| <td class="colLast"> |
| <div class="block">Embedded constructor.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</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="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="FetchGroup.html" title="class in org.apache.openjpa.meta">FetchGroup</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addDeclaredFetchGroup(java.lang.String)">addDeclaredFetchGroup</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</code></th> |
| <td class="colLast"> |
| <div class="block">Adds fetch group of the given name, or returns existing instance.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addDeclaredField(java.lang.String,java.lang.Class)">addDeclaredField</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?> type)</code></th> |
| <td class="colLast"> |
| <div class="block">Add a new field metadata to this class.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addDeclaredInterface(java.lang.Class)">addDeclaredInterface</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?> iface)</code></th> |
| <td class="colLast"> |
| <div class="block">Explicitly declare the given interface among the ones this |
| class implements.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addDefinedSuperclassField(java.lang.String,java.lang.Class,java.lang.Class)">addDefinedSuperclassField</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?> type, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?> sup)</code></th> |
| <td class="colLast"> |
| <div class="block">Add a new defined superclass field metadata to this class.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addExtensionKeys(java.util.Collection)">addExtensionKeys</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a> exts)</code></th> |
| <td class="colLast"> |
| <div class="block">Add all the known extension keys to the specified collection; any |
| implementation that utilized new extensions should override this |
| method to include both the known extensions of its superclass as well |
| as its own extension keys.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clearAllFieldCache()">clearAllFieldCache</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Clear cached field data.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clearDefinedFieldCache()">clearDefinedFieldCache</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Clear defined field data.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clearFieldCache()">clearFieldCache</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Clear cached field data.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clearSubclassCache()">clearSubclassCache</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Clear cached subclass data.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#compareTo(org.apache.openjpa.meta.ClassMetaData)">compareTo</a></span>​(<a href="ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a> other)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#copy(org.apache.openjpa.meta.ClassMetaData)">copy</a></span>​(<a href="ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a> meta)</code></th> |
| <td class="colLast"> |
| <div class="block">Copy the metadata from the given instance to this one.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#defineSuperclassFields(boolean)">defineSuperclassFields</a></span>​(boolean force)</code></th> |
| <td class="colLast"> |
| <div class="block">Incorporate superclass fields redefined in this subclass into this |
| metadata.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#equals(java.lang.Object)">equals</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> other)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAccessType()">getAccessType</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The access type used by this class.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang" class="externalLink">Boolean</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCacheEnabled()">getCacheEnabled</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns tri-state status on whether this class has been enabled for caching.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getColNumber()">getColNumber</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return the column number in the line of the file at which this |
| instance was parsed.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getComments()">getComments</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return comments, or empty array if none.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><a href="FetchGroup.html" title="class in org.apache.openjpa.meta">FetchGroup</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCustomFetchGroups()">getCustomFetchGroups</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return all fetch groups for this type, including superclass groups but excluding the standard groups |
| such as "default" or "all".</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="../datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDataCache()">getDataCache</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return the data cache for this class, or null if it is not cachable.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDataCacheEnabled()">getDataCacheEnabled</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Affirms true if this receiver is annotated with @DataCache and is not disabled.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDataCacheName()">getDataCacheName</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The name of the data cache that stores the managed instance of this class, by default.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDataCacheTimeout()">getDataCacheTimeout</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The cache timeout for this class. -1 indicates no timeout.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code><a href="FetchGroup.html" title="class in org.apache.openjpa.meta">FetchGroup</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDeclaredFetchGroups()">getDeclaredFetchGroups</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return the fetch groups declared explicitly in this type.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code><a href="FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDeclaredField(int)">getDeclaredField</a></span>​(int index)</code></th> |
| <td class="colLast"> |
| <div class="block">Return the metadata for the persistent or transactional field with |
| the given relative index.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code><a href="FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDeclaredField(java.lang.String)">getDeclaredField</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</code></th> |
| <td class="colLast"> |
| <div class="block">Return the metadata for the persistent or transactional field with |
| the given name, without including superclass fields.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDeclaredFieldNames()">getDeclaredFieldNames</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Utility method to get names of all declared fields excluding the |
| superclasses' sorted in lexical order.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code><a href="FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDeclaredFields()">getDeclaredFields</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return only the fields for this class, without superclass fields.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDeclaredInterfaces()">getDeclaredInterfaces</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return all explicitly declared interfaces this class implements.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code><a href="FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDeclaredUnmanagedFields()">getDeclaredUnmanagedFields</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return any fields that were added as non-managed.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code><a href="FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDefaultFetchGroupFields()">getDefaultFetchGroupFields</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return the list of fields in the default fetch group, |
| including superclass fields, or an empty array if none.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code><a href="FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDefinedFields()">getDefinedFields</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns an array of all the fields defined by this class.</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code><a href="FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDefinedFieldsInListingOrder()">getDefinedFieldsInListingOrder</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns all fields defined by this class in the order they are listed |
| in the metadata file.</div> |
| </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code><a href="FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDefinedSuperclassField(java.lang.String)">getDefinedSuperclassField</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</code></th> |
| <td class="colLast"> |
| <div class="block">Return the defined superclass field with the given name, or null if none.</div> |
| </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDescribedType()">getDescribedType</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The persistence capable class described by this metadata.</div> |
| </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDescribedTypeString()">getDescribedTypeString</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The persistence capable stringified class described by this metadata.</div> |
| </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDetachedState()">getDetachedState</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The name of the detach state field, or null if none.</div> |
| </td> |
| </tr> |
| <tr id="i36" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/reflect/Field.html?is-external=true" title="class or interface in java.lang.reflect" class="externalLink">Field</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDetachedStateField()">getDetachedStateField</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return the detach state field, or null if none.</div> |
| </td> |
| </tr> |
| <tr id="i37" class="rowColor"> |
| <td class="colFirst"><code><a href="ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEmbeddingMetaData()">getEmbeddingMetaData</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">If this metadata is for an embedded object, returning the owning value.</div> |
| </td> |
| </tr> |
| <tr id="i38" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang" class="externalLink">ClassLoader</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEnvClassLoader()">getEnvClassLoader</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The environmental loader used when loading this metadata.</div> |
| </td> |
| </tr> |
| <tr id="i39" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExtraFieldDataIndex(int)">getExtraFieldDataIndex</a></span>​(int field)</code></th> |
| <td class="colLast"> |
| <div class="block">Return the intermediate field data index of the given field |
| in the compacted array, or -1 if the field does not use extra data.</div> |
| </td> |
| </tr> |
| <tr id="i40" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExtraFieldDataLength()">getExtraFieldDataLength</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return the number of fields that use impl or intermediate data, in |
| order to create a compacted array for storage of said data.</div> |
| </td> |
| </tr> |
| <tr id="i41" class="rowColor"> |
| <td class="colFirst"><code><a href="FetchGroup.html" title="class in org.apache.openjpa.meta">FetchGroup</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFetchGroup(java.lang.String)">getFetchGroup</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</code></th> |
| <td class="colLast"> |
| <div class="block">Gets a named fetch group.</div> |
| </td> |
| </tr> |
| <tr id="i42" class="altColor"> |
| <td class="colFirst"><code><a href="FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getField(int)">getField</a></span>​(int index)</code></th> |
| <td class="colLast"> |
| <div class="block">Return the metadata for the persistent or transactional field with |
| the given absolute index.</div> |
| </td> |
| </tr> |
| <tr id="i43" class="rowColor"> |
| <td class="colFirst"><code><a href="FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getField(java.lang.String)">getField</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</code></th> |
| <td class="colLast"> |
| <div class="block">Return the metadata for the persistent or transactional field with |
| the given name.</div> |
| </td> |
| </tr> |
| <tr id="i44" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFieldNames()">getFieldNames</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Utility method to get names of all fields including the superclasses' |
| sorted in lexical order.</div> |
| </td> |
| </tr> |
| <tr id="i45" class="rowColor"> |
| <td class="colFirst"><code><a href="FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFields()">getFields</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return all field metadata, including superclass fields.</div> |
| </td> |
| </tr> |
| <tr id="i46" class="altColor"> |
| <td class="colFirst"><code><a href="FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFieldsInListingOrder()">getFieldsInListingOrder</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns all fields in the order they are listed in the metadata |
| file.</div> |
| </td> |
| </tr> |
| <tr id="i47" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIdClass()">getIdClass</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The class specified with the @IdClass annotation if used</div> |
| </td> |
| </tr> |
| <tr id="i48" class="altColor"> |
| <td class="colFirst"><code><a href="SequenceMetaData.html" title="class in org.apache.openjpa.meta">SequenceMetaData</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIdentitySequenceMetaData()">getIdentitySequenceMetaData</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Metadata for the datastore identity sequence.</div> |
| </td> |
| </tr> |
| <tr id="i49" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIdentitySequenceName()">getIdentitySequenceName</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The datastore identity sequence name, or null for none.</div> |
| </td> |
| </tr> |
| <tr id="i50" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIdentityStrategy()">getIdentityStrategy</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The strategy to use for datastore identity generation.</div> |
| </td> |
| </tr> |
| <tr id="i51" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIdentityType()">getIdentityType</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The type of identity being used.</div> |
| </td> |
| </tr> |
| <tr id="i52" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInterfaceAliasedProperties(java.lang.Class)">getInterfaceAliasedProperties</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?> iface)</code></th> |
| <td class="colLast"> |
| <div class="block">Return all aliases property named for the given interface.</div> |
| </td> |
| </tr> |
| <tr id="i53" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInterfaceImpl()">getInterfaceImpl</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return the managed interface implementor if any.</div> |
| </td> |
| </tr> |
| <tr id="i54" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInterfacePropertyAlias(java.lang.Class,java.lang.String)">getInterfacePropertyAlias</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?> iface, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> orig)</code></th> |
| <td class="colLast"> |
| <div class="block">Get local field alias for the given interface property.</div> |
| </td> |
| </tr> |
| <tr id="i55" class="rowColor"> |
| <td class="colFirst"><code><a href="LifecycleMetaData.html" title="class in org.apache.openjpa.meta">LifecycleMetaData</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLifecycleMetaData()">getLifecycleMetaData</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Information about lifecycle callbacks for this class.</div> |
| </td> |
| </tr> |
| <tr id="i56" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLineNumber()">getLineNumber</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return the line number of the file at which this instance was parsed.</div> |
| </td> |
| </tr> |
| <tr id="i57" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getListingIndex()">getListingIndex</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The index in which this class was listed in the metadata.</div> |
| </td> |
| </tr> |
| <tr id="i58" class="altColor"> |
| <td class="colFirst"><code><a href="FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLrsFields()">getLrsFields</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return all large result set fields.</div> |
| </td> |
| </tr> |
| <tr id="i59" class="rowColor"> |
| <td class="colFirst"><code><a href="ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMappedPCSubclassMetaDatas()">getMappedPCSubclassMetaDatas</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return all mapped subclasses.</div> |
| </td> |
| </tr> |
| <tr id="i60" class="altColor"> |
| <td class="colFirst"><code><a href="ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMappedPCSuperclassMetaData()">getMappedPCSuperclassMetaData</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return the closest mapped superclass.</div> |
| </td> |
| </tr> |
| <tr id="i61" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMappyedByIdFields()">getMappyedByIdFields</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i62" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getObjectIdType()">getObjectIdType</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The metadata-specified class to use for the object ID.</div> |
| </td> |
| </tr> |
| <tr id="i63" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPCSubclasses()">getPCSubclasses</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return the known persistence capable subclasses of the described type, |
| or empty array if none or if this is embedded metadata.</div> |
| </td> |
| </tr> |
| <tr id="i64" class="altColor"> |
| <td class="colFirst"><code><a href="ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPCSubclassMetaDatas()">getPCSubclassMetaDatas</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return the metadata for the known persistence capable subclasses of |
| the described type, or empty array if none or if this is embedded |
| metadata.</div> |
| </td> |
| </tr> |
| <tr id="i65" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPCSuperclass()">getPCSuperclass</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The persistence capable superclass of the described type.</div> |
| </td> |
| </tr> |
| <tr id="i66" class="altColor"> |
| <td class="colFirst"><code><a href="ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPCSuperclassMetaData()">getPCSuperclassMetaData</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The metadata for this class' superclass.</div> |
| </td> |
| </tr> |
| <tr id="i67" class="rowColor"> |
| <td class="colFirst"><code>int[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPkAndNonPersistentManagedFmdIndexes()">getPkAndNonPersistentManagedFmdIndexes</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i68" class="altColor"> |
| <td class="colFirst"><code><a href="FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPrimaryKeyFields()">getPrimaryKeyFields</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return primary key fields, or empty array if none.</div> |
| </td> |
| </tr> |
| <tr id="i69" class="rowColor"> |
| <td class="colFirst"><code><a href="FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getProxyFields()">getProxyFields</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return all fields that are types that need to be wrappered by a proxy.</div> |
| </td> |
| </tr> |
| <tr id="i70" class="altColor"> |
| <td class="colFirst"><code><a href="MetaDataRepository.html" title="class in org.apache.openjpa.meta">MetaDataRepository</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRepository()">getRepository</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return the owning repository.</div> |
| </td> |
| </tr> |
| <tr id="i71" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRequiresExtent()">getRequiresExtent</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Whether the type requires extent management.</div> |
| </td> |
| </tr> |
| <tr id="i72" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getResolve()">getResolve</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The resolve mode for this metadata.</div> |
| </td> |
| </tr> |
| <tr id="i73" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getResourceName()">getResourceName</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return the domain-meaningful name of the resource that was loaded |
| from this source.</div> |
| </td> |
| </tr> |
| <tr id="i74" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html?is-external=true" title="class or interface in java.io" class="externalLink">File</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSourceFile()">getSourceFile</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return the file from which this instance was parsed.</div> |
| </td> |
| </tr> |
| <tr id="i75" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSourceMode()">getSourceMode</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The source mode this metadata has been loaded under.</div> |
| </td> |
| </tr> |
| <tr id="i76" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSourceName()">getSourceName</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i77" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSourceScope()">getSourceScope</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return the domain-dependent scope of this instance within its file.</div> |
| </td> |
| </tr> |
| <tr id="i78" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSourceType()">getSourceType</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return the type of source.</div> |
| </td> |
| </tr> |
| <tr id="i79" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSuperclassField(org.apache.openjpa.meta.FieldMetaData)">getSuperclassField</a></span>​(<a href="FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a> supField)</code></th> |
| <td class="colLast"> |
| <div class="block">Return the superclass copy of the given field.</div> |
| </td> |
| </tr> |
| <tr id="i80" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTypeAlias()">getTypeAlias</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the alias for the described type, or <code>null</code> if none |
| has been set.</div> |
| </td> |
| </tr> |
| <tr id="i81" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getUseSchemaElement()">getUseSchemaElement</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Set whether to include schema name in generated class files</div> |
| </td> |
| </tr> |
| <tr id="i82" class="altColor"> |
| <td class="colFirst"><code><a href="FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getVersionField()">getVersionField</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return the version field for this class, if any.</div> |
| </td> |
| </tr> |
| <tr id="i83" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasAbstractPKField()">hasAbstractPKField</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Convenience method to determine if the pcType modeled by |
| this ClassMetaData object is both abstract and declares PKFields.</div> |
| </td> |
| </tr> |
| <tr id="i84" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hashCode()">hashCode</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i85" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasInverseManagedFields()">hasInverseManagedFields</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i86" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasPKFieldsFromAbstractClass()">hasPKFieldsFromAbstractClass</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Convenience method to determine if this type is a direct |
| decendent of an abstract type declaring PKFields.</div> |
| </td> |
| </tr> |
| <tr id="i87" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#initializeMapping()">initializeMapping</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Initialize mapping.</div> |
| </td> |
| </tr> |
| <tr id="i88" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isAbstract()">isAbstract</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i89" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isAccessibleField(java.lang.String)">isAccessibleField</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> field)</code></th> |
| <td class="colLast"> |
| <div class="block">Return whether the given name represents a managed or static field of |
| this class, including superclass fields.</div> |
| </td> |
| </tr> |
| <tr id="i90" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isDetachable()">isDetachable</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Whether instances are detachable.</div> |
| </td> |
| </tr> |
| <tr id="i91" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isEmbeddable()">isEmbeddable</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i92" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isEmbeddedOnly()">isEmbeddedOnly</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Whether the type can only be used as an embedded object.</div> |
| </td> |
| </tr> |
| <tr id="i93" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isExplicitAccess()">isExplicitAccess</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Affirms if access style is explicitly defined.</div> |
| </td> |
| </tr> |
| <tr id="i94" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isIntercepting()">isIntercepting</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Whether the type's fields are actively intercepted, either by |
| redefinition or enhancement.</div> |
| </td> |
| </tr> |
| <tr id="i95" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isManagedInterface()">isManagedInterface</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Whether the type is a managed interface.</div> |
| </td> |
| </tr> |
| <tr id="i96" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isMapped()">isMapped</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Whether this class is mapped to the datastore.</div> |
| </td> |
| </tr> |
| <tr id="i97" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isMixedAccess()">isMixedAccess</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Affirms if attributes of this class use mixed access types.</div> |
| </td> |
| </tr> |
| <tr id="i98" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isObjectIdTypeShared()">isObjectIdTypeShared</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Whether this type uses an application identity class that is shared |
| with other classes, and is therefore wrapped in an <a href="../util/ObjectId.html" title="class in org.apache.openjpa.util"><code>ObjectId</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i99" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isOpenJPAIdentity()">isOpenJPAIdentity</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Whether this type uses OpenJPA identity.</div> |
| </td> |
| </tr> |
| <tr id="i100" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#registerForValueUpdate(java.lang.String...)">registerForValueUpdate</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>... values)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i101" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeDeclaredFetchGroup(org.apache.openjpa.meta.FetchGroup)">removeDeclaredFetchGroup</a></span>​(<a href="FetchGroup.html" title="class in org.apache.openjpa.meta">FetchGroup</a> fg)</code></th> |
| <td class="colLast"> |
| <div class="block">Remove a declared fetch group.</div> |
| </td> |
| </tr> |
| <tr id="i102" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeDeclaredField(org.apache.openjpa.meta.FieldMetaData)">removeDeclaredField</a></span>​(<a href="FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a> field)</code></th> |
| <td class="colLast"> |
| <div class="block">Remove the given field from management.</div> |
| </td> |
| </tr> |
| <tr id="i103" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeDeclaredInterface(java.lang.Class)">removeDeclaredInterface</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?> iface)</code></th> |
| <td class="colLast"> |
| <div class="block">Remove the given interface from the declared list.</div> |
| </td> |
| </tr> |
| <tr id="i104" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeDefinedSuperclassField(org.apache.openjpa.meta.FieldMetaData)">removeDefinedSuperclassField</a></span>​(<a href="FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a> field)</code></th> |
| <td class="colLast"> |
| <div class="block">Remove the given field from management.</div> |
| </td> |
| </tr> |
| <tr id="i105" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resolve(int)">resolve</a></span>​(int mode)</code></th> |
| <td class="colLast"> |
| <div class="block">Resolve and validate metadata.</div> |
| </td> |
| </tr> |
| <tr id="i106" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resolveMapping(boolean)">resolveMapping</a></span>​(boolean runtime)</code></th> |
| <td class="colLast"> |
| <div class="block">Resolve mapping data.</div> |
| </td> |
| </tr> |
| <tr id="i107" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resolveMeta(boolean)">resolveMeta</a></span>​(boolean runtime)</code></th> |
| <td class="colLast"> |
| <div class="block">Resolve metadata.</div> |
| </td> |
| </tr> |
| <tr id="i108" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setAbstract(boolean)">setAbstract</a></span>​(boolean flag)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i109" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setAccessType(int)">setAccessType</a></span>​(int type)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the access type.</div> |
| </td> |
| </tr> |
| <tr id="i110" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCacheEnabled(boolean)">setCacheEnabled</a></span>​(boolean enabled)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the eligibility status of this class for cache.</div> |
| </td> |
| </tr> |
| <tr id="i111" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setColNumber(int)">setColNumber</a></span>​(int colNum)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i112" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setComments(java.lang.String%5B%5D)">setComments</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>[] comments)</code></th> |
| <td class="colLast"> |
| <div class="block">Set comments.</div> |
| </td> |
| </tr> |
| <tr id="i113" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDataCacheName(java.lang.String)">setDataCacheName</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the cache name for this class.</div> |
| </td> |
| </tr> |
| <tr id="i114" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDataCacheTimeout(int)">setDataCacheTimeout</a></span>​(int timeout)</code></th> |
| <td class="colLast"> |
| <div class="block">The cache timeout for this class. -1 indicates no timeout.</div> |
| </td> |
| </tr> |
| <tr id="i115" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDescribedType(java.lang.Class)">setDescribedType</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?> type)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the class described by this metadata.</div> |
| </td> |
| </tr> |
| <tr id="i116" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDetachable(boolean)">setDetachable</a></span>​(boolean detachable)</code></th> |
| <td class="colLast"> |
| <div class="block">Whether instances are detachable.</div> |
| </td> |
| </tr> |
| <tr id="i117" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDetachedState(java.lang.String)">setDetachedState</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> field)</code></th> |
| <td class="colLast"> |
| <div class="block">The name of the detach state field, or null if none.</div> |
| </td> |
| </tr> |
| <tr id="i118" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setEmbeddable()">setEmbeddable</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i119" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setEmbeddedOnly(boolean)">setEmbeddedOnly</a></span>​(boolean embed)</code></th> |
| <td class="colLast"> |
| <div class="block">Whether the type can only be used as an embedded object.</div> |
| </td> |
| </tr> |
| <tr id="i120" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setEnvClassLoader(java.lang.ClassLoader)">setEnvClassLoader</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang" class="externalLink">ClassLoader</a> loader)</code></th> |
| <td class="colLast"> |
| <div class="block">The class environmental loader used when loading this metadata.</div> |
| </td> |
| </tr> |
| <tr id="i121" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setIdentitySequenceName(java.lang.String)">setIdentitySequenceName</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> seqName)</code></th> |
| <td class="colLast"> |
| <div class="block">The datastore identity sequence name, or null for none.</div> |
| </td> |
| </tr> |
| <tr id="i122" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setIdentityStrategy(int)">setIdentityStrategy</a></span>​(int strategy)</code></th> |
| <td class="colLast"> |
| <div class="block">The strategy to use for datastore identity generation.</div> |
| </td> |
| </tr> |
| <tr id="i123" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setIdentityType(int)">setIdentityType</a></span>​(int type)</code></th> |
| <td class="colLast"> |
| <div class="block">The type of identity being used.</div> |
| </td> |
| </tr> |
| <tr id="i124" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setIntercepting(boolean)">setIntercepting</a></span>​(boolean intercepting)</code></th> |
| <td class="colLast"> |
| <div class="block">Whether the type's fields are actively intercepted, either by |
| redefinition or enhancement.</div> |
| </td> |
| </tr> |
| <tr id="i125" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setInterfaceImpl(java.lang.Class)">setInterfaceImpl</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?> impl)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the managed interface implementor class.</div> |
| </td> |
| </tr> |
| <tr id="i126" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setInterfacePropertyAlias(java.lang.Class,java.lang.String,java.lang.String)">setInterfacePropertyAlias</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?> iface, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> orig, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> local)</code></th> |
| <td class="colLast"> |
| <div class="block">Alias properties from the given interface during queries to |
| the local field.</div> |
| </td> |
| </tr> |
| <tr id="i127" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setLineNumber(int)">setLineNumber</a></span>​(int lineNum)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i128" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setListingIndex(int)">setListingIndex</a></span>​(int index)</code></th> |
| <td class="colLast"> |
| <div class="block">The index in which this field was listed in the metadata.</div> |
| </td> |
| </tr> |
| <tr id="i129" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setManagedInterface(boolean)">setManagedInterface</a></span>​(boolean managedInterface)</code></th> |
| <td class="colLast"> |
| <div class="block">Whether the type is a managed interface</div> |
| </td> |
| </tr> |
| <tr id="i130" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setObjectIdType(java.lang.Class,boolean)">setObjectIdType</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?> cls, |
| boolean shared)</code></th> |
| <td class="colLast"> |
| <div class="block">The metadata-specified class to use for the object ID.</div> |
| </td> |
| </tr> |
| <tr id="i131" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setPCSuperclass(java.lang.Class)">setPCSuperclass</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?> pc)</code></th> |
| <td class="colLast"> |
| <div class="block">The persistence capable superclass of the described type.</div> |
| </td> |
| </tr> |
| <tr id="i132" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setPCSuperclassMetaData(org.apache.openjpa.meta.ClassMetaData)">setPCSuperclassMetaData</a></span>​(<a href="ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a> meta)</code></th> |
| <td class="colLast"> |
| <div class="block">The metadata for this class' superclass.</div> |
| </td> |
| </tr> |
| <tr id="i133" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setRequiresExtent(boolean)">setRequiresExtent</a></span>​(boolean req)</code></th> |
| <td class="colLast"> |
| <div class="block">Whether the type requires extent management.</div> |
| </td> |
| </tr> |
| <tr id="i134" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setResolve(int)">setResolve</a></span>​(int mode)</code></th> |
| <td class="colLast"> |
| <div class="block">The resolve mode for this metadata.</div> |
| </td> |
| </tr> |
| <tr id="i135" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setResolve(int,boolean)">setResolve</a></span>​(int mode, |
| boolean on)</code></th> |
| <td class="colLast"> |
| <div class="block">The resolve mode for this metadata.</div> |
| </td> |
| </tr> |
| <tr id="i136" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSource(java.io.File,int,java.lang.String)">setSource</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html?is-external=true" title="class or interface in java.io" class="externalLink">File</a> file, |
| int srcType, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> srcName)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i137" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSourceMode(int)">setSourceMode</a></span>​(int mode)</code></th> |
| <td class="colLast"> |
| <div class="block">The source mode this metadata has been loaded under.</div> |
| </td> |
| </tr> |
| <tr id="i138" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSourceMode(int,boolean)">setSourceMode</a></span>​(int mode, |
| boolean on)</code></th> |
| <td class="colLast"> |
| <div class="block">The source mode this metadata has been loaded under.</div> |
| </td> |
| </tr> |
| <tr id="i139" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTypeAlias(java.lang.String)">setTypeAlias</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> alias)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the alias for the described type.</div> |
| </td> |
| </tr> |
| <tr id="i140" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setUseSchemaElement(boolean)">setUseSchemaElement</a></span>​(boolean useSchemaElement)</code></th> |
| <td class="colLast"> |
| <div class="block">Get whether to include schema name in generated class files</div> |
| </td> |
| </tr> |
| <tr id="i141" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i142" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#useIdClassFromParent()">useIdClassFromParent</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return true if this class uses IdClass derived from idClass of the |
| parent entity which annotated as id in the child class.</div> |
| </td> |
| </tr> |
| <tr id="i143" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang" class="externalLink">Boolean</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#usesDetachedState()">usesDetachedState</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Whether an instance of this type has detached state.</div> |
| </td> |
| </tr> |
| <tr id="i144" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#validateMapping(boolean)">validateMapping</a></span>​(boolean runtime)</code></th> |
| <td class="colLast"> |
| <div class="block">Validate mapping data.</div> |
| </td> |
| </tr> |
| <tr id="i145" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#validateMeta(boolean)">validateMeta</a></span>​(boolean runtime)</code></th> |
| <td class="colLast"> |
| <div class="block">Validate resolved metadata.</div> |
| </td> |
| </tr> |
| <tr id="i146" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#valueChanged(org.apache.openjpa.lib.conf.Value)">valueChanged</a></span>​(<a href="../lib/conf/Value.html" title="class in org.apache.openjpa.lib.conf">Value</a> val)</code></th> |
| <td class="colLast"> |
| <div class="block">Callback used by <a href="../lib/conf/Value.html" title="class in org.apache.openjpa.lib.conf"><code>Value</code></a> objects to notify listener of change.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.openjpa.meta.Extensions"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.openjpa.meta.<a href="Extensions.html" title="class in org.apache.openjpa.meta">Extensions</a></h3> |
| <code><a href="Extensions.html#addExtension(java.lang.String,java.lang.Object)">addExtension</a>, <a href="Extensions.html#addExtension(java.lang.String,java.lang.String,java.lang.Object)">addExtension</a>, <a href="Extensions.html#copy(org.apache.openjpa.meta.Extensions)">copy</a>, <a href="Extensions.html#getBooleanExtension(java.lang.String)">getBooleanExtension</a>, <a href="Extensions.html#getBooleanExtension(java.lang.String,java.lang.String)">getBooleanExtension</a>, <a href="Extensions.html#getDoubleExtension(java.lang.String)">getDoubleExtension</a>, <a href="Extensions.html#getDoubleExtension(java.lang.String,java.lang.String)">getDoubleExtension</a>, <a href="Extensions.html#getEmbeddedExtensions(java.lang.String,boolean)">getEmbeddedExtensions</a>, <a href="Extensions.html#getEmbeddedExtensions(java.lang.String,java.lang.String,boolean)">getEmbeddedExtensions</a>, <a href="Extensions.html#getExtensionKeys()">getExtensionKeys</a>, <a href="Extensions.html#getExtensionKeys(java.lang.String)">getExtensionKeys</a>, <a href="Extensions.html#getExtensionVendors()">getExtensionVendors</a>, <a href="Extensions.html#getIntExtension(java.lang.String)">getIntExtension</a>, <a href="Extensions.html#getIntExtension(java.lang.String,java.lang.String)">getIntExtension</a>, <a href="Extensions.html#getObjectExtension(java.lang.String)">getObjectExtension</a>, <a href="Extensions.html#getObjectExtension(java.lang.String,java.lang.String)">getObjectExtension</a>, <a href="Extensions.html#getStringExtension(java.lang.String)">getStringExtension</a>, <a href="Extensions.html#getStringExtension(java.lang.String,java.lang.String)">getStringExtension</a>, <a href="Extensions.html#hasExtension(java.lang.String)">hasExtension</a>, <a href="Extensions.html#hasExtension(java.lang.String,java.lang.String)">hasExtension</a>, <a href="Extensions.html#isEmpty()">isEmpty</a>, <a href="Extensions.html#removeEmbeddedExtensions(java.lang.String)">removeEmbeddedExtensions</a>, <a href="Extensions.html#removeEmbeddedExtensions(java.lang.String,java.lang.String)">removeEmbeddedExtensions</a>, <a href="Extensions.html#removeExtension(java.lang.String)">removeExtension</a>, <a href="Extensions.html#removeExtension(java.lang.String,java.lang.String)">removeExtension</a>, <a href="Extensions.html#validateDataStoreExtensionPrefix(java.lang.String)">validateDataStoreExtensionPrefix</a>, <a href="Extensions.html#validateExtensionKeys()">validateExtensionKeys</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a id="ID_UNKNOWN"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ID_UNKNOWN</h4> |
| <pre>public static final int ID_UNKNOWN</pre> |
| <div class="block">Unknown identity type.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.openjpa.meta.ClassMetaData.ID_UNKNOWN">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="ID_DATASTORE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ID_DATASTORE</h4> |
| <pre>public static final int ID_DATASTORE</pre> |
| <div class="block">Datastore identity type.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.openjpa.meta.ClassMetaData.ID_DATASTORE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="ID_APPLICATION"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ID_APPLICATION</h4> |
| <pre>public static final int ID_APPLICATION</pre> |
| <div class="block">Application identity type.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.openjpa.meta.ClassMetaData.ID_APPLICATION">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="ACCESS_UNKNOWN"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ACCESS_UNKNOWN</h4> |
| <pre>public static final int ACCESS_UNKNOWN</pre> |
| <div class="block">Unknown access type.</div> |
| </li> |
| </ul> |
| <a id="ACCESS_FIELD"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ACCESS_FIELD</h4> |
| <pre>public static final int ACCESS_FIELD</pre> |
| <div class="block">Persistent attributes are accessed via direct field access. Bit flag.</div> |
| </li> |
| </ul> |
| <a id="ACCESS_PROPERTY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ACCESS_PROPERTY</h4> |
| <pre>public static final int ACCESS_PROPERTY</pre> |
| <div class="block">Persistent attributes are accessed via setters and getters. Bit flag.</div> |
| </li> |
| </ul> |
| <a id="ACCESS_EXPLICIT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ACCESS_EXPLICIT</h4> |
| <pre>public static final int ACCESS_EXPLICIT</pre> |
| <div class="block">Persistent class has explicitly defined an access type. |
| This will allow the attributes to use mixed access i.e. some field |
| may use ACCESS_FIELD while others ACCESS_PROPERTY.</div> |
| </li> |
| </ul> |
| <a id="SYNTHETIC"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SYNTHETIC</h4> |
| <pre>public static final <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> SYNTHETIC</pre> |
| <div class="block">Value for using a synthetic detached state field, which is the default.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.openjpa.meta.ClassMetaData.SYNTHETIC">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="DEFAULT_STRING"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DEFAULT_STRING</h4> |
| <pre>protected static final <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> DEFAULT_STRING</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.openjpa.meta.ClassMetaData.DEFAULT_STRING">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>(java.lang.Class,org.apache.openjpa.meta.MetaDataRepository)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ClassMetaData</h4> |
| <pre>protected ClassMetaData​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?> type, |
| <a href="MetaDataRepository.html" title="class in org.apache.openjpa.meta">MetaDataRepository</a> repos)</pre> |
| <div class="block">Constructor. Supply described type and repository.</div> |
| </li> |
| </ul> |
| <a id="<init>(org.apache.openjpa.meta.ValueMetaData)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ClassMetaData</h4> |
| <pre>protected ClassMetaData​(<a href="ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a> owner)</pre> |
| <div class="block">Embedded constructor. Supply embedding value.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="getRepository()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRepository</h4> |
| <pre class="methodSignature">public <a href="MetaDataRepository.html" title="class in org.apache.openjpa.meta">MetaDataRepository</a> getRepository()</pre> |
| <div class="block">Return the owning repository.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="MetaDataContext.html#getRepository()">getRepository</a></code> in interface <code><a href="MetaDataContext.html" title="interface in org.apache.openjpa.meta">MetaDataContext</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="Extensions.html#getRepository()">getRepository</a></code> in class <code><a href="Extensions.html" title="class in org.apache.openjpa.meta">Extensions</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getEmbeddingMetaData()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEmbeddingMetaData</h4> |
| <pre class="methodSignature">public <a href="ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a> getEmbeddingMetaData()</pre> |
| <div class="block">If this metadata is for an embedded object, returning the owning value.</div> |
| </li> |
| </ul> |
| <a id="getDescribedType()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDescribedType</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?> getDescribedType()</pre> |
| <div class="block">The persistence capable class described by this metadata.</div> |
| </li> |
| </ul> |
| <a id="getDescribedTypeString()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDescribedTypeString</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getDescribedTypeString()</pre> |
| <div class="block">The persistence capable stringified class described by this metadata.</div> |
| </li> |
| </ul> |
| <a id="setDescribedType(java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDescribedType</h4> |
| <pre class="methodSignature">protected void setDescribedType​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?> type)</pre> |
| <div class="block">Set the class described by this metadata. The type may be reset when |
| an embedded value changes its declared type.</div> |
| </li> |
| </ul> |
| <a id="getEnvClassLoader()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEnvClassLoader</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang" class="externalLink">ClassLoader</a> getEnvClassLoader()</pre> |
| <div class="block">The environmental loader used when loading this metadata. |
| The class metadata should use this loader when loading metadata for |
| its superclass and field types.</div> |
| </li> |
| </ul> |
| <a id="setEnvClassLoader(java.lang.ClassLoader)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEnvClassLoader</h4> |
| <pre class="methodSignature">public void setEnvClassLoader​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang" class="externalLink">ClassLoader</a> loader)</pre> |
| <div class="block">The class environmental loader used when loading this metadata. |
| The class metadata should use this loader when loading metadata for |
| its superclass and field types.</div> |
| </li> |
| </ul> |
| <a id="getPCSuperclass()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPCSuperclass</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?> getPCSuperclass()</pre> |
| <div class="block">The persistence capable superclass of the described type.</div> |
| </li> |
| </ul> |
| <a id="setPCSuperclass(java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPCSuperclass</h4> |
| <pre class="methodSignature">public void setPCSuperclass​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?> pc)</pre> |
| <div class="block">The persistence capable superclass of the described type.</div> |
| </li> |
| </ul> |
| <a id="getPCSuperclassMetaData()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPCSuperclassMetaData</h4> |
| <pre class="methodSignature">public <a href="ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a> getPCSuperclassMetaData()</pre> |
| <div class="block">The metadata for this class' superclass.</div> |
| </li> |
| </ul> |
| <a id="setPCSuperclassMetaData(org.apache.openjpa.meta.ClassMetaData)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPCSuperclassMetaData</h4> |
| <pre class="methodSignature">public void setPCSuperclassMetaData​(<a href="ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a> meta)</pre> |
| <div class="block">The metadata for this class' superclass.</div> |
| </li> |
| </ul> |
| <a id="isMapped()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isMapped</h4> |
| <pre class="methodSignature">public boolean isMapped()</pre> |
| <div class="block">Whether this class is mapped to the datastore. By default, only |
| returns false if class is embedded-only, but subclasses might override |
| to allow unmapped other types.</div> |
| </li> |
| </ul> |
| <a id="getMappedPCSuperclassMetaData()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMappedPCSuperclassMetaData</h4> |
| <pre class="methodSignature">public <a href="ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a> getMappedPCSuperclassMetaData()</pre> |
| <div class="block">Return the closest mapped superclass.</div> |
| </li> |
| </ul> |
| <a id="getPCSubclasses()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPCSubclasses</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?>[] getPCSubclasses()</pre> |
| <div class="block">Return the known persistence capable subclasses of the described type, |
| or empty array if none or if this is embedded metadata.</div> |
| </li> |
| </ul> |
| <a id="getPCSubclassMetaDatas()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPCSubclassMetaDatas</h4> |
| <pre class="methodSignature">public <a href="ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a>[] getPCSubclassMetaDatas()</pre> |
| <div class="block">Return the metadata for the known persistence capable subclasses of |
| the described type, or empty array if none or if this is embedded |
| metadata.</div> |
| </li> |
| </ul> |
| <a id="getMappedPCSubclassMetaDatas()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMappedPCSubclassMetaDatas</h4> |
| <pre class="methodSignature">public <a href="ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a>[] getMappedPCSubclassMetaDatas()</pre> |
| <div class="block">Return all mapped subclasses.</div> |
| </li> |
| </ul> |
| <a id="getIdentityType()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIdentityType</h4> |
| <pre class="methodSignature">public int getIdentityType()</pre> |
| <div class="block">The type of identity being used. This will be one of: |
| <ul> |
| <li><a href="#ID_UNKNOWN"><code>ID_UNKNOWN</code></a>: unknown identity type</li> |
| <li><a href="#ID_DATASTORE"><code>ID_DATASTORE</code></a>: identity managed by the data store and |
| independent of the fields of the instance</li> |
| <li><a href="#ID_APPLICATION"><code>ID_APPLICATION</code></a>: identity managed by the application and |
| defined by one or more fields of the instance</li> |
| </ul> If unspecified, defaults to <a href="#ID_DATASTORE"><code>ID_DATASTORE</code></a> if there are no |
| primary key fields, and <a href="#ID_APPLICATION"><code>ID_APPLICATION</code></a> otherwise.</div> |
| </li> |
| </ul> |
| <a id="setIdentityType(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIdentityType</h4> |
| <pre class="methodSignature">public void setIdentityType​(int type)</pre> |
| <div class="block">The type of identity being used. This will be one of: |
| <ul> |
| <li><a href="#ID_UNKNOWN"><code>ID_UNKNOWN</code></a>: unknown identity type</li> |
| <li><a href="#ID_DATASTORE"><code>ID_DATASTORE</code></a>: identity managed by the data store and |
| independent of the fields of the instance</li> |
| <li><a href="#ID_APPLICATION"><code>ID_APPLICATION</code></a>: identity managed by the application and |
| defined by one or more fields of the instance</li> |
| </ul> If unspecified, defaults to <a href="#ID_DATASTORE"><code>ID_DATASTORE</code></a> if there are no |
| primary key fields, and <a href="#ID_APPLICATION"><code>ID_APPLICATION</code></a> otherwise.</div> |
| </li> |
| </ul> |
| <a id="getObjectIdType()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getObjectIdType</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?> getObjectIdType()</pre> |
| <div class="block">The metadata-specified class to use for the object ID.</div> |
| </li> |
| </ul> |
| <a id="setObjectIdType(java.lang.Class,boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setObjectIdType</h4> |
| <pre class="methodSignature">public void setObjectIdType​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?> cls, |
| boolean shared)</pre> |
| <div class="block">The metadata-specified class to use for the object ID. |
| When there is IdClass annotation, AnnotationMetaDataParser |
| will call this method to set ObjectId type. However, if |
| this is a derived identity in the child entity where a |
| relation field (parent entity) is used as an id, and this |
| relation field has an IdClass, the IdClass annotation in |
| the child entity can be ignored as Openjpa will automatically |
| wrap parent's IdClass as child's IdClass.</div> |
| </li> |
| </ul> |
| <a id="isObjectIdTypeShared()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isObjectIdTypeShared</h4> |
| <pre class="methodSignature">public boolean isObjectIdTypeShared()</pre> |
| <div class="block">Whether this type uses an application identity class that is shared |
| with other classes, and is therefore wrapped in an <a href="../util/ObjectId.html" title="class in org.apache.openjpa.util"><code>ObjectId</code></a>.</div> |
| </li> |
| </ul> |
| <a id="isOpenJPAIdentity()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isOpenJPAIdentity</h4> |
| <pre class="methodSignature">public boolean isOpenJPAIdentity()</pre> |
| <div class="block">Whether this type uses OpenJPA identity.</div> |
| </li> |
| </ul> |
| <a id="getIdentityStrategy()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIdentityStrategy</h4> |
| <pre class="methodSignature">public int getIdentityStrategy()</pre> |
| <div class="block">The strategy to use for datastore identity generation. |
| One of the constants from <a href="ValueStrategies.html" title="class in org.apache.openjpa.meta"><code>ValueStrategies</code></a>.</div> |
| </li> |
| </ul> |
| <a id="setIdentityStrategy(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIdentityStrategy</h4> |
| <pre class="methodSignature">public void setIdentityStrategy​(int strategy)</pre> |
| <div class="block">The strategy to use for datastore identity generation. |
| One of the constants from <a href="ValueStrategies.html" title="class in org.apache.openjpa.meta"><code>ValueStrategies</code></a>.</div> |
| </li> |
| </ul> |
| <a id="getIdentitySequenceName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIdentitySequenceName</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getIdentitySequenceName()</pre> |
| <div class="block">The datastore identity sequence name, or null for none.</div> |
| </li> |
| </ul> |
| <a id="setIdentitySequenceName(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIdentitySequenceName</h4> |
| <pre class="methodSignature">public void setIdentitySequenceName​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> seqName)</pre> |
| <div class="block">The datastore identity sequence name, or null for none.</div> |
| </li> |
| </ul> |
| <a id="getIdentitySequenceMetaData()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIdentitySequenceMetaData</h4> |
| <pre class="methodSignature">public <a href="SequenceMetaData.html" title="class in org.apache.openjpa.meta">SequenceMetaData</a> getIdentitySequenceMetaData()</pre> |
| <div class="block">Metadata for the datastore identity sequence.</div> |
| </li> |
| </ul> |
| <a id="getLifecycleMetaData()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLifecycleMetaData</h4> |
| <pre class="methodSignature">public <a href="LifecycleMetaData.html" title="class in org.apache.openjpa.meta">LifecycleMetaData</a> getLifecycleMetaData()</pre> |
| <div class="block">Information about lifecycle callbacks for this class.</div> |
| </li> |
| </ul> |
| <a id="getTypeAlias()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTypeAlias</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getTypeAlias()</pre> |
| <div class="block">Returns the alias for the described type, or <code>null</code> if none |
| has been set.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#setTypeAlias(java.lang.String)"><code>setTypeAlias(java.lang.String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setTypeAlias(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTypeAlias</h4> |
| <pre class="methodSignature">public void setTypeAlias​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> alias)</pre> |
| <div class="block">Sets the alias for the described type. The alias can be |
| any arbitrary string that the implementation can later use to |
| refer to the class. Note that at runtime, only the alias |
| computed when the persistent type was enhanced is used.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>alias</code> - the alias name to apply to the described type</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getAccessType()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAccessType</h4> |
| <pre class="methodSignature">public int getAccessType()</pre> |
| <div class="block">The access type used by this class.</div> |
| </li> |
| </ul> |
| <a id="setAccessType(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAccessType</h4> |
| <pre class="methodSignature">public void setAccessType​(int type)</pre> |
| <div class="block">Sets the access type.</div> |
| </li> |
| </ul> |
| <a id="isExplicitAccess()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isExplicitAccess</h4> |
| <pre class="methodSignature">public boolean isExplicitAccess()</pre> |
| <div class="block">Affirms if access style is explicitly defined.</div> |
| </li> |
| </ul> |
| <a id="isMixedAccess()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isMixedAccess</h4> |
| <pre class="methodSignature">public boolean isMixedAccess()</pre> |
| <div class="block">Affirms if attributes of this class use mixed access types.</div> |
| </li> |
| </ul> |
| <a id="getRequiresExtent()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRequiresExtent</h4> |
| <pre class="methodSignature">public boolean getRequiresExtent()</pre> |
| <div class="block">Whether the type requires extent management.</div> |
| </li> |
| </ul> |
| <a id="setRequiresExtent(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRequiresExtent</h4> |
| <pre class="methodSignature">public void setRequiresExtent​(boolean req)</pre> |
| <div class="block">Whether the type requires extent management.</div> |
| </li> |
| </ul> |
| <a id="isEmbeddedOnly()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isEmbeddedOnly</h4> |
| <pre class="methodSignature">public boolean isEmbeddedOnly()</pre> |
| <div class="block">Whether the type can only be used as an embedded object.</div> |
| </li> |
| </ul> |
| <a id="setEmbeddedOnly(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEmbeddedOnly</h4> |
| <pre class="methodSignature">public void setEmbeddedOnly​(boolean embed)</pre> |
| <div class="block">Whether the type can only be used as an embedded object.</div> |
| </li> |
| </ul> |
| <a id="isEmbeddable()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isEmbeddable</h4> |
| <pre class="methodSignature">public boolean isEmbeddable()</pre> |
| </li> |
| </ul> |
| <a id="setEmbeddable()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEmbeddable</h4> |
| <pre class="methodSignature">public void setEmbeddable()</pre> |
| </li> |
| </ul> |
| <a id="isIntercepting()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isIntercepting</h4> |
| <pre class="methodSignature">public boolean isIntercepting()</pre> |
| <div class="block">Whether the type's fields are actively intercepted, either by |
| redefinition or enhancement.</div> |
| </li> |
| </ul> |
| <a id="setIntercepting(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIntercepting</h4> |
| <pre class="methodSignature">public void setIntercepting​(boolean intercepting)</pre> |
| <div class="block">Whether the type's fields are actively intercepted, either by |
| redefinition or enhancement.</div> |
| </li> |
| </ul> |
| <a id="isManagedInterface()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isManagedInterface</h4> |
| <pre class="methodSignature">public boolean isManagedInterface()</pre> |
| <div class="block">Whether the type is a managed interface.</div> |
| </li> |
| </ul> |
| <a id="setManagedInterface(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setManagedInterface</h4> |
| <pre class="methodSignature">public void setManagedInterface​(boolean managedInterface)</pre> |
| <div class="block">Whether the type is a managed interface</div> |
| </li> |
| </ul> |
| <a id="getInterfaceImpl()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInterfaceImpl</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?> getInterfaceImpl()</pre> |
| <div class="block">Return the managed interface implementor if any.</div> |
| </li> |
| </ul> |
| <a id="setInterfaceImpl(java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setInterfaceImpl</h4> |
| <pre class="methodSignature">public void setInterfaceImpl​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?> impl)</pre> |
| <div class="block">Set the managed interface implementor class.</div> |
| </li> |
| </ul> |
| <a id="getDeclaredInterfaces()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDeclaredInterfaces</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?>[] getDeclaredInterfaces()</pre> |
| <div class="block">Return all explicitly declared interfaces this class implements.</div> |
| </li> |
| </ul> |
| <a id="addDeclaredInterface(java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addDeclaredInterface</h4> |
| <pre class="methodSignature">public void addDeclaredInterface​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?> iface)</pre> |
| <div class="block">Explicitly declare the given interface among the ones this |
| class implements.</div> |
| </li> |
| </ul> |
| <a id="removeDeclaredInterface(java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeDeclaredInterface</h4> |
| <pre class="methodSignature">public boolean removeDeclaredInterface​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?> iface)</pre> |
| <div class="block">Remove the given interface from the declared list.</div> |
| </li> |
| </ul> |
| <a id="setInterfacePropertyAlias(java.lang.Class,java.lang.String,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setInterfacePropertyAlias</h4> |
| <pre class="methodSignature">public void setInterfacePropertyAlias​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?> iface, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> orig, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> local)</pre> |
| <div class="block">Alias properties from the given interface during queries to |
| the local field.</div> |
| </li> |
| </ul> |
| <a id="getInterfacePropertyAlias(java.lang.Class,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInterfacePropertyAlias</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getInterfacePropertyAlias​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?> iface, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> orig)</pre> |
| <div class="block">Get local field alias for the given interface property.</div> |
| </li> |
| </ul> |
| <a id="getInterfaceAliasedProperties(java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInterfaceAliasedProperties</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>[] getInterfaceAliasedProperties​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?> iface)</pre> |
| <div class="block">Return all aliases property named for the given interface.</div> |
| </li> |
| </ul> |
| <a id="getExtraFieldDataLength()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExtraFieldDataLength</h4> |
| <pre class="methodSignature">public int getExtraFieldDataLength()</pre> |
| <div class="block">Return the number of fields that use impl or intermediate data, in |
| order to create a compacted array for storage of said data.</div> |
| </li> |
| </ul> |
| <a id="getExtraFieldDataIndex(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExtraFieldDataIndex</h4> |
| <pre class="methodSignature">public int getExtraFieldDataIndex​(int field)</pre> |
| <div class="block">Return the intermediate field data index of the given field |
| in the compacted array, or -1 if the field does not use extra data.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#getExtraFieldDataLength()"><code>getExtraFieldDataLength()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isAccessibleField(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isAccessibleField</h4> |
| <pre class="methodSignature">public boolean isAccessibleField​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> field)</pre> |
| <div class="block">Return whether the given name represents a managed or static field of |
| this class, including superclass fields.</div> |
| </li> |
| </ul> |
| <a id="getProxyFields()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProxyFields</h4> |
| <pre class="methodSignature">public <a href="FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a>[] getProxyFields()</pre> |
| <div class="block">Return all fields that are types that need to be wrappered by a proxy. |
| The types that need to be proxied are: |
| <p> |
| <li>org.apache.openjpa.meta.JavaTypes.CALENDAR |
| <li>org.apache.openjpa.meta.JavaTypes.COLLECTION |
| <li>org.apache.openjpa.meta.JavaTypes.DATE |
| <li>org.apache.openjpa.meta.JavaTypes.MAP |
| <li>org.apache.openjpa.meta.JavaTypes.OBJECT</div> |
| </li> |
| </ul> |
| <a id="getLrsFields()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLrsFields</h4> |
| <pre class="methodSignature">public <a href="FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a>[] getLrsFields()</pre> |
| <div class="block">Return all large result set fields. Will never return null.</div> |
| </li> |
| </ul> |
| <a id="getFields()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFields</h4> |
| <pre class="methodSignature">public <a href="FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a>[] getFields()</pre> |
| <div class="block">Return all field metadata, including superclass fields.</div> |
| </li> |
| </ul> |
| <a id="getSuperclassField(org.apache.openjpa.meta.FieldMetaData)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSuperclassField</h4> |
| <pre class="methodSignature">protected <a href="FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a> getSuperclassField​(<a href="FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a> supField)</pre> |
| <div class="block">Return the superclass copy of the given field.</div> |
| </li> |
| </ul> |
| <a id="getDeclaredFields()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDeclaredFields</h4> |
| <pre class="methodSignature">public <a href="FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a>[] getDeclaredFields()</pre> |
| <div class="block">Return only the fields for this class, without superclass fields.</div> |
| </li> |
| </ul> |
| <a id="getPrimaryKeyFields()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPrimaryKeyFields</h4> |
| <pre class="methodSignature">public <a href="FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a>[] getPrimaryKeyFields()</pre> |
| <div class="block">Return primary key fields, or empty array if none. The order |
| in which the keys are returned will be the order in which |
| the fields are declared, starting at the least-derived superclass |
| and ending with the primary key fields of the most-derived subclass.</div> |
| </li> |
| </ul> |
| <a id="getDefaultFetchGroupFields()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDefaultFetchGroupFields</h4> |
| <pre class="methodSignature">public <a href="FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a>[] getDefaultFetchGroupFields()</pre> |
| <div class="block">Return the list of fields in the default fetch group, |
| including superclass fields, or an empty array if none.</div> |
| </li> |
| </ul> |
| <a id="getVersionField()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getVersionField</h4> |
| <pre class="methodSignature">public <a href="FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a> getVersionField()</pre> |
| <div class="block">Return the version field for this class, if any.</div> |
| </li> |
| </ul> |
| <a id="getField(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getField</h4> |
| <pre class="methodSignature">public <a href="FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a> getField​(int index)</pre> |
| <div class="block">Return the metadata for the persistent or transactional field with |
| the given absolute index.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the field's metadata, or null if not found</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getDeclaredField(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDeclaredField</h4> |
| <pre class="methodSignature">public <a href="FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a> getDeclaredField​(int index)</pre> |
| <div class="block">Return the metadata for the persistent or transactional field with |
| the given relative index.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the field's metadata, or null if not found</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getField(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getField</h4> |
| <pre class="methodSignature">public <a href="FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a> getField​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</pre> |
| <div class="block">Return the metadata for the persistent or transactional field with |
| the given name.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the field's metadata, or null if not found</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getDeclaredField(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDeclaredField</h4> |
| <pre class="methodSignature">public <a href="FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a> getDeclaredField​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</pre> |
| <div class="block">Return the metadata for the persistent or transactional field with |
| the given name, without including superclass fields.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the field's metadata, or null if not found</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getDeclaredUnmanagedFields()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDeclaredUnmanagedFields</h4> |
| <pre class="methodSignature">public <a href="FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a>[] getDeclaredUnmanagedFields()</pre> |
| <div class="block">Return any fields that were added as non-managed. |
| All other methods to get fields return only those that are managed.</div> |
| </li> |
| </ul> |
| <a id="addDeclaredField(java.lang.String,java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addDeclaredField</h4> |
| <pre class="methodSignature">public <a href="FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a> addDeclaredField​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?> type)</pre> |
| <div class="block">Add a new field metadata to this class.</div> |
| </li> |
| </ul> |
| <a id="removeDeclaredField(org.apache.openjpa.meta.FieldMetaData)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeDeclaredField</h4> |
| <pre class="methodSignature">public boolean removeDeclaredField​(<a href="FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a> field)</pre> |
| <div class="block">Remove the given field from management.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the field was removed, false otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getDefinedSuperclassField(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDefinedSuperclassField</h4> |
| <pre class="methodSignature">public <a href="FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a> getDefinedSuperclassField​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</pre> |
| <div class="block">Return the defined superclass field with the given name, or null if none.</div> |
| </li> |
| </ul> |
| <a id="addDefinedSuperclassField(java.lang.String,java.lang.Class,java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addDefinedSuperclassField</h4> |
| <pre class="methodSignature">public <a href="FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a> addDefinedSuperclassField​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?> type, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?> sup)</pre> |
| <div class="block">Add a new defined superclass field metadata to this class.</div> |
| </li> |
| </ul> |
| <a id="removeDefinedSuperclassField(org.apache.openjpa.meta.FieldMetaData)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeDefinedSuperclassField</h4> |
| <pre class="methodSignature">public boolean removeDefinedSuperclassField​(<a href="FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a> field)</pre> |
| <div class="block">Remove the given field from management.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the field was removed, false otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="defineSuperclassFields(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>defineSuperclassFields</h4> |
| <pre class="methodSignature">public void defineSuperclassFields​(boolean force)</pre> |
| <div class="block">Incorporate superclass fields redefined in this subclass into this |
| metadata. This method is generally called after metadata is resolved |
| and mapping information is loaded, but before mapping resolve.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>force</code> - whether to force re-mapping of even mapped superclass fields</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getDefinedFields()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDefinedFields</h4> |
| <pre class="methodSignature">public <a href="FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a>[] getDefinedFields()</pre> |
| <div class="block">Returns an array of all the fields defined by this class. |
| This includes mapped declared fields and any concrete mapping of |
| unmapped superclass fields performed by this class.</div> |
| </li> |
| </ul> |
| <a id="getFieldsInListingOrder()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFieldsInListingOrder</h4> |
| <pre class="methodSignature">public <a href="FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a>[] getFieldsInListingOrder()</pre> |
| <div class="block">Returns all fields in the order they are listed in the metadata |
| file. Unlisted fields are placed after listed ones.</div> |
| </li> |
| </ul> |
| <a id="getDefinedFieldsInListingOrder()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDefinedFieldsInListingOrder</h4> |
| <pre class="methodSignature">public <a href="FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a>[] getDefinedFieldsInListingOrder()</pre> |
| <div class="block">Returns all fields defined by this class in the order they are listed |
| in the metadata file. Unlisted fields are placed after listed ones. |
| This array includes declared transactional and unmanaged fields.</div> |
| </li> |
| </ul> |
| <a id="getDataCacheName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDataCacheName</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getDataCacheName()</pre> |
| <div class="block">The name of the data cache that stores the managed instance of this class, by default. |
| This can be overwritten by per-instance basis <a href="../datacache/CacheDistributionPolicy.html" title="interface in org.apache.openjpa.datacache">cache distribution policy</a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>null if this class is disabled from cache by @DataCache(enabled=false). |
| <a href="../datacache/DataCache.html#NAME_DEFAULT">default</a> if @DataCache(enabled=true) without a name. |
| Otherwise, data cache name set by the user via @DataCache name attribute.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setDataCacheName(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDataCacheName</h4> |
| <pre class="methodSignature">public void setDataCacheName​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</pre> |
| <div class="block">Set the cache name for this class.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - can be <code>null</code> to disable cache.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getDataCacheEnabled()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDataCacheEnabled</h4> |
| <pre class="methodSignature">public boolean getDataCacheEnabled()</pre> |
| <div class="block">Affirms true if this receiver is annotated with @DataCache and is not disabled. |
| A separate state variable is necessary besides the name of the cache defaulted to a special string.</div> |
| </li> |
| </ul> |
| <a id="getDataCacheTimeout()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDataCacheTimeout</h4> |
| <pre class="methodSignature">public int getDataCacheTimeout()</pre> |
| <div class="block">The cache timeout for this class. -1 indicates no timeout.</div> |
| </li> |
| </ul> |
| <a id="setDataCacheTimeout(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDataCacheTimeout</h4> |
| <pre class="methodSignature">public void setDataCacheTimeout​(int timeout)</pre> |
| <div class="block">The cache timeout for this class. -1 indicates no timeout.</div> |
| </li> |
| </ul> |
| <a id="getDataCache()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDataCache</h4> |
| <pre class="methodSignature">public <a href="../datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a> getDataCache()</pre> |
| <div class="block">Return the data cache for this class, or null if it is not cachable.</div> |
| </li> |
| </ul> |
| <a id="isDetachable()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDetachable</h4> |
| <pre class="methodSignature">public boolean isDetachable()</pre> |
| <div class="block">Whether instances are detachable.</div> |
| </li> |
| </ul> |
| <a id="setDetachable(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDetachable</h4> |
| <pre class="methodSignature">public void setDetachable​(boolean detachable)</pre> |
| <div class="block">Whether instances are detachable.</div> |
| </li> |
| </ul> |
| <a id="getDetachedState()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDetachedState</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getDetachedState()</pre> |
| <div class="block">The name of the detach state field, or null if none.</div> |
| </li> |
| </ul> |
| <a id="setDetachedState(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDetachedState</h4> |
| <pre class="methodSignature">public void setDetachedState​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> field)</pre> |
| <div class="block">The name of the detach state field, or null if none.</div> |
| </li> |
| </ul> |
| <a id="getDetachedStateField()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDetachedStateField</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/reflect/Field.html?is-external=true" title="class or interface in java.lang.reflect" class="externalLink">Field</a> getDetachedStateField()</pre> |
| <div class="block">Return the detach state field, or null if none.</div> |
| </li> |
| </ul> |
| <a id="usesDetachedState()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>usesDetachedState</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang" class="externalLink">Boolean</a> usesDetachedState()</pre> |
| <div class="block">Whether an instance of this type has detached state.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if a detached instance must have detached state, false |
| if it does not, and null if it may use a |
| manually-constructed instance without detached state</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="clearAllFieldCache()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clearAllFieldCache</h4> |
| <pre class="methodSignature">protected void clearAllFieldCache()</pre> |
| <div class="block">Clear cached field data.</div> |
| </li> |
| </ul> |
| <a id="clearDefinedFieldCache()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clearDefinedFieldCache</h4> |
| <pre class="methodSignature">protected void clearDefinedFieldCache()</pre> |
| <div class="block">Clear defined field data.</div> |
| </li> |
| </ul> |
| <a id="clearFieldCache()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clearFieldCache</h4> |
| <pre class="methodSignature">protected void clearFieldCache()</pre> |
| <div class="block">Clear cached field data.</div> |
| </li> |
| </ul> |
| <a id="clearSubclassCache()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clearSubclassCache</h4> |
| <pre class="methodSignature">protected void clearSubclassCache()</pre> |
| <div class="block">Clear cached subclass data.</div> |
| </li> |
| </ul> |
| <a id="hashCode()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hashCode</h4> |
| <pre class="methodSignature">public int hashCode()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="equals(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>equals</h4> |
| <pre class="methodSignature">public boolean equals​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> other)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="compareTo(org.apache.openjpa.meta.ClassMetaData)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>compareTo</h4> |
| <pre class="methodSignature">public int compareTo​(<a href="ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a> other)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Comparable.html?is-external=true#compareTo(T)" title="class or interface in java.lang" class="externalLink">compareTo</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Comparable</a><<a href="ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toString()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> toString()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getResolve()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getResolve</h4> |
| <pre class="methodSignature">public int getResolve()</pre> |
| <div class="block">The resolve mode for this metadata.</div> |
| </li> |
| </ul> |
| <a id="setResolve(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setResolve</h4> |
| <pre class="methodSignature">public void setResolve​(int mode)</pre> |
| <div class="block">The resolve mode for this metadata.</div> |
| </li> |
| </ul> |
| <a id="setResolve(int,boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setResolve</h4> |
| <pre class="methodSignature">public void setResolve​(int mode, |
| boolean on)</pre> |
| <div class="block">The resolve mode for this metadata.</div> |
| </li> |
| </ul> |
| <a id="resolve(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resolve</h4> |
| <pre class="methodSignature">public boolean resolve​(int mode)</pre> |
| <div class="block">Resolve and validate metadata. Return true if already resolved.</div> |
| </li> |
| </ul> |
| <a id="resolveMeta(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resolveMeta</h4> |
| <pre class="methodSignature">protected void resolveMeta​(boolean runtime)</pre> |
| <div class="block">Resolve metadata.</div> |
| </li> |
| </ul> |
| <a id="validateMeta(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validateMeta</h4> |
| <pre class="methodSignature">protected void validateMeta​(boolean runtime)</pre> |
| <div class="block">Validate resolved metadata.</div> |
| </li> |
| </ul> |
| <a id="resolveMapping(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resolveMapping</h4> |
| <pre class="methodSignature">protected void resolveMapping​(boolean runtime)</pre> |
| <div class="block">Resolve mapping data. Logs resolve message and resolves super by default.</div> |
| </li> |
| </ul> |
| <a id="validateMapping(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validateMapping</h4> |
| <pre class="methodSignature">protected void validateMapping​(boolean runtime)</pre> |
| <div class="block">Validate mapping data.</div> |
| </li> |
| </ul> |
| <a id="initializeMapping()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>initializeMapping</h4> |
| <pre class="methodSignature">protected void initializeMapping()</pre> |
| <div class="block">Initialize mapping. Logs init message by default.</div> |
| </li> |
| </ul> |
| <a id="useIdClassFromParent()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>useIdClassFromParent</h4> |
| <pre class="methodSignature">public boolean useIdClassFromParent()</pre> |
| <div class="block">Return true if this class uses IdClass derived from idClass of the |
| parent entity which annotated as id in the child class. |
| In this case, there are no key fields in the child entity corresponding |
| to the fields in the IdClass.</div> |
| </li> |
| </ul> |
| <a id="getDeclaredFetchGroups()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDeclaredFetchGroups</h4> |
| <pre class="methodSignature">public <a href="FetchGroup.html" title="class in org.apache.openjpa.meta">FetchGroup</a>[] getDeclaredFetchGroups()</pre> |
| <div class="block">Return the fetch groups declared explicitly in this type.</div> |
| </li> |
| </ul> |
| <a id="getCustomFetchGroups()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCustomFetchGroups</h4> |
| <pre class="methodSignature">public <a href="FetchGroup.html" title="class in org.apache.openjpa.meta">FetchGroup</a>[] getCustomFetchGroups()</pre> |
| <div class="block">Return all fetch groups for this type, including superclass groups but excluding the standard groups |
| such as "default" or "all".</div> |
| </li> |
| </ul> |
| <a id="getFetchGroup(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFetchGroup</h4> |
| <pre class="methodSignature">public <a href="FetchGroup.html" title="class in org.apache.openjpa.meta">FetchGroup</a> getFetchGroup​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</pre> |
| <div class="block">Gets a named fetch group. If not available in this receiver then looks |
| up the inheritance hierarchy.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - name of a fetch group.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an existing fetch group of the given name if known to this |
| receiver or any of its superclasses. Otherwise null.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addDeclaredFetchGroup(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addDeclaredFetchGroup</h4> |
| <pre class="methodSignature">public <a href="FetchGroup.html" title="class in org.apache.openjpa.meta">FetchGroup</a> addDeclaredFetchGroup​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</pre> |
| <div class="block">Adds fetch group of the given name, or returns existing instance.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - a non-null, non-empty name. Must be unique within this |
| receiver's scope. The super class <em>may</em> have a group with |
| the same name.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="removeDeclaredFetchGroup(org.apache.openjpa.meta.FetchGroup)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeDeclaredFetchGroup</h4> |
| <pre class="methodSignature">public boolean removeDeclaredFetchGroup​(<a href="FetchGroup.html" title="class in org.apache.openjpa.meta">FetchGroup</a> fg)</pre> |
| <div class="block">Remove a declared fetch group.</div> |
| </li> |
| </ul> |
| <a id="getSourceFile()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSourceFile</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html?is-external=true" title="class or interface in java.io" class="externalLink">File</a> getSourceFile()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../lib/meta/SourceTracker.html#getSourceFile()">SourceTracker</a></code></span></div> |
| <div class="block">Return the file from which this instance was parsed.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../lib/meta/SourceTracker.html#getSourceFile()">getSourceFile</a></code> in interface <code><a href="../lib/meta/SourceTracker.html" title="interface in org.apache.openjpa.lib.meta">SourceTracker</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSourceScope()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSourceScope</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> getSourceScope()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../lib/meta/SourceTracker.html#getSourceScope()">SourceTracker</a></code></span></div> |
| <div class="block">Return the domain-dependent scope of this instance within its file.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../lib/meta/SourceTracker.html#getSourceScope()">getSourceScope</a></code> in interface <code><a href="../lib/meta/SourceTracker.html" title="interface in org.apache.openjpa.lib.meta">SourceTracker</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSourceType()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSourceType</h4> |
| <pre class="methodSignature">public int getSourceType()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../lib/meta/SourceTracker.html#getSourceType()">SourceTracker</a></code></span></div> |
| <div class="block">Return the type of source.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../lib/meta/SourceTracker.html#getSourceType()">getSourceType</a></code> in interface <code><a href="../lib/meta/SourceTracker.html" title="interface in org.apache.openjpa.lib.meta">SourceTracker</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setSource(java.io.File,int,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSource</h4> |
| <pre class="methodSignature">public void setSource​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html?is-external=true" title="class or interface in java.io" class="externalLink">File</a> file, |
| int srcType, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> srcName)</pre> |
| </li> |
| </ul> |
| <a id="getResourceName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getResourceName</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getResourceName()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../lib/meta/SourceTracker.html#getResourceName()">SourceTracker</a></code></span></div> |
| <div class="block">Return the domain-meaningful name of the resource that was loaded |
| from this source. I.e., if we had loaded the source for a Java |
| class, this would return the name of the class.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../lib/meta/SourceTracker.html#getResourceName()">getResourceName</a></code> in interface <code><a href="../lib/meta/SourceTracker.html" title="interface in org.apache.openjpa.lib.meta">SourceTracker</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getLineNumber()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLineNumber</h4> |
| <pre class="methodSignature">public int getLineNumber()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../lib/meta/SourceTracker.html#getLineNumber()">SourceTracker</a></code></span></div> |
| <div class="block">Return the line number of the file at which this instance was parsed.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../lib/meta/SourceTracker.html#getLineNumber()">getLineNumber</a></code> in interface <code><a href="../lib/meta/SourceTracker.html" title="interface in org.apache.openjpa.lib.meta">SourceTracker</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setLineNumber(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLineNumber</h4> |
| <pre class="methodSignature">public void setLineNumber​(int lineNum)</pre> |
| </li> |
| </ul> |
| <a id="getColNumber()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getColNumber</h4> |
| <pre class="methodSignature">public int getColNumber()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../lib/meta/SourceTracker.html#getColNumber()">SourceTracker</a></code></span></div> |
| <div class="block">Return the column number in the line of the file at which this |
| instance was parsed.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../lib/meta/SourceTracker.html#getColNumber()">getColNumber</a></code> in interface <code><a href="../lib/meta/SourceTracker.html" title="interface in org.apache.openjpa.lib.meta">SourceTracker</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setColNumber(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setColNumber</h4> |
| <pre class="methodSignature">public void setColNumber​(int colNum)</pre> |
| </li> |
| </ul> |
| <a id="getSourceMode()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSourceMode</h4> |
| <pre class="methodSignature">public int getSourceMode()</pre> |
| <div class="block">The source mode this metadata has been loaded under.</div> |
| </li> |
| </ul> |
| <a id="setSourceMode(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSourceMode</h4> |
| <pre class="methodSignature">public void setSourceMode​(int mode)</pre> |
| <div class="block">The source mode this metadata has been loaded under.</div> |
| </li> |
| </ul> |
| <a id="setSourceMode(int,boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSourceMode</h4> |
| <pre class="methodSignature">public void setSourceMode​(int mode, |
| boolean on)</pre> |
| <div class="block">The source mode this metadata has been loaded under.</div> |
| </li> |
| </ul> |
| <a id="getListingIndex()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getListingIndex</h4> |
| <pre class="methodSignature">public int getListingIndex()</pre> |
| <div class="block">The index in which this class was listed in the metadata. Defaults to |
| <code>-1</code> if this class was not listed in the metadata.</div> |
| </li> |
| </ul> |
| <a id="setListingIndex(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setListingIndex</h4> |
| <pre class="methodSignature">public void setListingIndex​(int index)</pre> |
| <div class="block">The index in which this field was listed in the metadata. Defaults to |
| <code>-1</code> if this class was not listed in the metadata.</div> |
| </li> |
| </ul> |
| <a id="getComments()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getComments</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>[] getComments()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../lib/xml/Commentable.html#getComments()">Commentable</a></code></span></div> |
| <div class="block">Return comments, or empty array if none.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../lib/xml/Commentable.html#getComments()">getComments</a></code> in interface <code><a href="../lib/xml/Commentable.html" title="interface in org.apache.openjpa.lib.xml">Commentable</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setComments(java.lang.String[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setComments</h4> |
| <pre class="methodSignature">public void setComments​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>[] comments)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../lib/xml/Commentable.html#setComments(java.lang.String%5B%5D)">Commentable</a></code></span></div> |
| <div class="block">Set comments.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../lib/xml/Commentable.html#setComments(java.lang.String%5B%5D)">setComments</a></code> in interface <code><a href="../lib/xml/Commentable.html" title="interface in org.apache.openjpa.lib.xml">Commentable</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="copy(org.apache.openjpa.meta.ClassMetaData)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>copy</h4> |
| <pre class="methodSignature">public void copy​(<a href="ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a> meta)</pre> |
| <div class="block">Copy the metadata from the given instance to this one. Do not |
| copy mapping information.</div> |
| </li> |
| </ul> |
| <a id="addExtensionKeys(java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addExtensionKeys</h4> |
| <pre class="methodSignature">protected void addExtensionKeys​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a> exts)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="Extensions.html#addExtensionKeys(java.util.Collection)">Extensions</a></code></span></div> |
| <div class="block">Add all the known extension keys to the specified collection; any |
| implementation that utilized new extensions should override this |
| method to include both the known extensions of its superclass as well |
| as its own extension keys.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="Extensions.html#addExtensionKeys(java.util.Collection)">addExtensionKeys</a></code> in class <code><a href="Extensions.html" title="class in org.apache.openjpa.meta">Extensions</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="registerForValueUpdate(java.lang.String...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>registerForValueUpdate</h4> |
| <pre class="methodSignature">public void registerForValueUpdate​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>... values)</pre> |
| </li> |
| </ul> |
| <a id="valueChanged(org.apache.openjpa.lib.conf.Value)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>valueChanged</h4> |
| <pre class="methodSignature">public void valueChanged​(<a href="../lib/conf/Value.html" title="class in org.apache.openjpa.lib.conf">Value</a> val)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../lib/conf/ValueListener.html#valueChanged(org.apache.openjpa.lib.conf.Value)">ValueListener</a></code></span></div> |
| <div class="block">Callback used by <a href="../lib/conf/Value.html" title="class in org.apache.openjpa.lib.conf"><code>Value</code></a> objects to notify listener of change.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../lib/conf/ValueListener.html#valueChanged(org.apache.openjpa.lib.conf.Value)">valueChanged</a></code> in interface <code><a href="../lib/conf/ValueListener.html" title="interface in org.apache.openjpa.lib.conf">ValueListener</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getFieldNames()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFieldNames</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>[] getFieldNames()</pre> |
| <div class="block">Utility method to get names of all fields including the superclasses' |
| sorted in lexical order.</div> |
| </li> |
| </ul> |
| <a id="getDeclaredFieldNames()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDeclaredFieldNames</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>[] getDeclaredFieldNames()</pre> |
| <div class="block">Utility method to get names of all declared fields excluding the |
| superclasses' sorted in lexical order.</div> |
| </li> |
| </ul> |
| <a id="isAbstract()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isAbstract</h4> |
| <pre class="methodSignature">public boolean isAbstract()</pre> |
| </li> |
| </ul> |
| <a id="setAbstract(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAbstract</h4> |
| <pre class="methodSignature">public void setAbstract​(boolean flag)</pre> |
| </li> |
| </ul> |
| <a id="hasAbstractPKField()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasAbstractPKField</h4> |
| <pre class="methodSignature">public boolean hasAbstractPKField()</pre> |
| <div class="block">Convenience method to determine if the pcType modeled by |
| this ClassMetaData object is both abstract and declares PKFields. This |
| method is used by the PCEnhancer to determine if special handling is |
| required.</div> |
| </li> |
| </ul> |
| <a id="hasPKFieldsFromAbstractClass()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasPKFieldsFromAbstractClass</h4> |
| <pre class="methodSignature">public boolean hasPKFieldsFromAbstractClass()</pre> |
| <div class="block">Convenience method to determine if this type is a direct |
| decendent of an abstract type declaring PKFields. Returns true if there |
| are no pcTypes mapped to a table between this type and an abstract pcType |
| declaring PKFields. Returns false if there no such abstract pcTypes in |
| the inheritance hierarchy or if there are any pcTypes mapped to tables in |
| between the type represented by this ClassMetaData object and the |
| abstract pcType declaring PKFields.</div> |
| </li> |
| </ul> |
| <a id="setCacheEnabled(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCacheEnabled</h4> |
| <pre class="methodSignature">public void setCacheEnabled​(boolean enabled)</pre> |
| <div class="block">Sets the eligibility status of this class for cache.</div> |
| </li> |
| </ul> |
| <a id="getCacheEnabled()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCacheEnabled</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang" class="externalLink">Boolean</a> getCacheEnabled()</pre> |
| <div class="block">Returns tri-state status on whether this class has been enabled for caching.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>TRUE or FALSE denote this class has been explicitly enabled or disabled for caching. |
| If no status has been explicitly set, then the status of the persistent super class, if any, is returned.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSourceName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSourceName</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getSourceName()</pre> |
| </li> |
| </ul> |
| <a id="getPkAndNonPersistentManagedFmdIndexes()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPkAndNonPersistentManagedFmdIndexes</h4> |
| <pre class="methodSignature">public int[] getPkAndNonPersistentManagedFmdIndexes()</pre> |
| </li> |
| </ul> |
| <a id="hasInverseManagedFields()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasInverseManagedFields</h4> |
| <pre class="methodSignature">public boolean hasInverseManagedFields()</pre> |
| </li> |
| </ul> |
| <a id="getMappyedByIdFields()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMappyedByIdFields</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a>> getMappyedByIdFields()</pre> |
| </li> |
| </ul> |
| <a id="getUseSchemaElement()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUseSchemaElement</h4> |
| <pre class="methodSignature">public boolean getUseSchemaElement()</pre> |
| <div class="block">Set whether to include schema name in generated class files</div> |
| </li> |
| </ul> |
| <a id="setUseSchemaElement(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setUseSchemaElement</h4> |
| <pre class="methodSignature">public void setUseSchemaElement​(boolean useSchemaElement)</pre> |
| <div class="block">Get whether to include schema name in generated class files</div> |
| </li> |
| </ul> |
| <a id="getIdClass()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getIdClass</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><?> getIdClass()</pre> |
| <div class="block">The class specified with the @IdClass annotation if used</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ClassMetaData.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </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 id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2006–2025 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
