| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="it"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_80) on Thu Jun 14 10:04:01 CEST 2018 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>ClassMetaData (OpenJPA Parent POM 2.4.3 API)</title> |
| <meta name="date" content="2018-06-14"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="ClassMetaData (OpenJPA Parent POM 2.4.3 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="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"> |
| <li><a href="../../../../org/apache/openjpa/meta/AccessCode.html" title="class in org.apache.openjpa.meta"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/openjpa/meta/DelegatingMetaDataFactory.html" title="class in org.apache.openjpa.meta"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/openjpa/meta/ClassMetaData.html" target="_top">Frames</a></li> |
| <li><a href="ClassMetaData.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field_summary">Field</a> | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.openjpa.meta</div> |
| <h2 title="Class ClassMetaData" class="title">Class ClassMetaData</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../org/apache/openjpa/meta/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><a href="http://docs.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a><<a href="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a>>, <a href="../../../../org/apache/openjpa/lib/conf/ValueListener.html" title="interface in org.apache.openjpa.lib.conf">ValueListener</a>, <a href="../../../../org/apache/openjpa/lib/meta/SourceTracker.html" title="interface in org.apache.openjpa.lib.meta">SourceTracker</a>, <a href="../../../../org/apache/openjpa/lib/xml/Commentable.html" title="interface in org.apache.openjpa.lib.xml">Commentable</a>, <a href="../../../../org/apache/openjpa/meta/MetaDataContext.html" title="interface in org.apache.openjpa.meta">MetaDataContext</a>, <a href="../../../../org/apache/openjpa/meta/MetaDataModes.html" title="interface in org.apache.openjpa.meta">MetaDataModes</a></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../org/apache/openjpa/jdbc/meta/ClassMapping.html" title="class in org.apache.openjpa.jdbc.meta">ClassMapping</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="strong">ClassMetaData</span> |
| extends <a href="../../../../org/apache/openjpa/meta/Extensions.html" title="class in org.apache.openjpa.meta">Extensions</a> |
| implements <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a><<a href="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a>>, <a href="../../../../org/apache/openjpa/lib/meta/SourceTracker.html" title="interface in org.apache.openjpa.lib.meta">SourceTracker</a>, <a href="../../../../org/apache/openjpa/meta/MetaDataContext.html" title="interface in org.apache.openjpa.meta">MetaDataContext</a>, <a href="../../../../org/apache/openjpa/meta/MetaDataModes.html" title="interface in org.apache.openjpa.meta">MetaDataModes</a>, <a href="../../../../org/apache/openjpa/lib/xml/Commentable.html" title="interface in org.apache.openjpa.lib.xml">Commentable</a>, <a href="../../../../org/apache/openjpa/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="../../../../org/apache/openjpa/meta/ClassMetaData.html#getPrimaryKeyFields()"><code>getPrimaryKeyFields()</code></a>.</div> |
| <dl><dt><span class="strong">Author:</span></dt> |
| <dd>Abe White</dd> |
| <dt><span class="strong">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 =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#ACCESS_EXPLICIT">ACCESS_EXPLICIT</a></strong></code> |
| <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> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#ACCESS_FIELD">ACCESS_FIELD</a></strong></code> |
| <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> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#ACCESS_PROPERTY">ACCESS_PROPERTY</a></strong></code> |
| <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> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#ACCESS_UNKNOWN">ACCESS_UNKNOWN</a></strong></code> |
| <div class="block">Unknown access type.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected static <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#DEFAULT_STRING">DEFAULT_STRING</a></strong></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#ID_APPLICATION">ID_APPLICATION</a></strong></code> |
| <div class="block">Application identity type.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#ID_DATASTORE">ID_DATASTORE</a></strong></code> |
| <div class="block">Datastore identity type.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#ID_UNKNOWN">ID_UNKNOWN</a></strong></code> |
| <div class="block">Unknown identity type.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#SYNTHETIC">SYNTHETIC</a></strong></code> |
| <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 name="fields_inherited_from_class_org.apache.openjpa.meta.Extensions"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.openjpa.meta.<a href="../../../../org/apache/openjpa/meta/Extensions.html" title="class in org.apache.openjpa.meta">Extensions</a></h3> |
| <code><a href="../../../../org/apache/openjpa/meta/Extensions.html#OPENJPA">OPENJPA</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields_inherited_from_class_org.apache.openjpa.lib.meta.SourceTracker"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.openjpa.lib.meta.<a href="../../../../org/apache/openjpa/lib/meta/SourceTracker.html" title="interface in org.apache.openjpa.lib.meta">SourceTracker</a></h3> |
| <code><a href="../../../../org/apache/openjpa/lib/meta/SourceTracker.html#SRC_ANNOTATIONS">SRC_ANNOTATIONS</a>, <a href="../../../../org/apache/openjpa/lib/meta/SourceTracker.html#SRC_OTHER">SRC_OTHER</a>, <a href="../../../../org/apache/openjpa/lib/meta/SourceTracker.html#SRC_XML">SRC_XML</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields_inherited_from_class_org.apache.openjpa.meta.MetaDataModes"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.openjpa.meta.<a href="../../../../org/apache/openjpa/meta/MetaDataModes.html" title="interface in org.apache.openjpa.meta">MetaDataModes</a></h3> |
| <code><a href="../../../../org/apache/openjpa/meta/MetaDataModes.html#MODE_ALL">MODE_ALL</a>, <a href="../../../../org/apache/openjpa/meta/MetaDataModes.html#MODE_ANN_MAPPING">MODE_ANN_MAPPING</a>, <a href="../../../../org/apache/openjpa/meta/MetaDataModes.html#MODE_MAPPING">MODE_MAPPING</a>, <a href="../../../../org/apache/openjpa/meta/MetaDataModes.html#MODE_MAPPING_INIT">MODE_MAPPING_INIT</a>, <a href="../../../../org/apache/openjpa/meta/MetaDataModes.html#MODE_META">MODE_META</a>, <a href="../../../../org/apache/openjpa/meta/MetaDataModes.html#MODE_NONE">MODE_NONE</a>, <a href="../../../../org/apache/openjpa/meta/MetaDataModes.html#MODE_QUERY">MODE_QUERY</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields_inherited_from_class_org.apache.openjpa.lib.xml.Commentable"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.openjpa.lib.xml.<a href="../../../../org/apache/openjpa/lib/xml/Commentable.html" title="interface in org.apache.openjpa.lib.xml">Commentable</a></h3> |
| <code><a href="../../../../org/apache/openjpa/lib/xml/Commentable.html#EMPTY_COMMENTS">EMPTY_COMMENTS</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier</th> |
| <th class="colLast" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#ClassMetaData(java.lang.Class,%20org.apache.openjpa.meta.MetaDataRepository)">ClassMetaData</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> type, |
| <a href="../../../../org/apache/openjpa/meta/MetaDataRepository.html" title="class in org.apache.openjpa.meta">MetaDataRepository</a> repos)</code> |
| <div class="block">Constructor.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#ClassMetaData(org.apache.openjpa.meta.ValueMetaData)">ClassMetaData</a></strong>(<a href="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a> owner)</code> |
| <div class="block">Embedded constructor.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/meta/FetchGroup.html" title="class in org.apache.openjpa.meta">FetchGroup</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#addDeclaredFetchGroup(java.lang.String)">addDeclaredFetchGroup</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> |
| <div class="block">Adds fetch group of the given name, or returns existing instance.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#addDeclaredField(java.lang.String,%20java.lang.Class)">addDeclaredField</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> type)</code> |
| <div class="block">Add a new field metadata to this class.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#addDeclaredInterface(java.lang.Class)">addDeclaredInterface</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> iface)</code> |
| <div class="block">Explicitly declare the given interface among the ones this |
| class implements.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#addDefinedSuperclassField(java.lang.String,%20java.lang.Class,%20java.lang.Class)">addDefinedSuperclassField</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> type, |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> sup)</code> |
| <div class="block">Add a new defined superclass field metadata to this class.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#addExtensionKeys(java.util.Collection)">addExtensionKeys</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> exts)</code> |
| <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 class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#clearAllFieldCache()">clearAllFieldCache</a></strong>()</code> |
| <div class="block">Clear cached field data.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#clearDefinedFieldCache()">clearDefinedFieldCache</a></strong>()</code> |
| <div class="block">Clear defined field data.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#clearFieldCache()">clearFieldCache</a></strong>()</code> |
| <div class="block">Clear cached field data.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#clearSubclassCache()">clearSubclassCache</a></strong>()</code> |
| <div class="block">Clear cached subclass data.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#compareTo(org.apache.openjpa.meta.ClassMetaData)">compareTo</a></strong>(<a href="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a> other)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#copy(org.apache.openjpa.meta.ClassMetaData)">copy</a></strong>(<a href="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a> meta)</code> |
| <div class="block">Copy the metadata from the given instance to this one.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#defineSuperclassFields(boolean)">defineSuperclassFields</a></strong>(boolean force)</code> |
| <div class="block">Incorporate superclass fields redefined in this subclass into this |
| metadata.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#equals(java.lang.Object)">equals</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> other)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getAccessType()">getAccessType</a></strong>()</code> |
| <div class="block">The access type used by this class.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getCacheEnabled()">getCacheEnabled</a></strong>()</code> |
| <div class="block">Returns tri-state status on whether this class has been enabled for caching.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getColNumber()">getColNumber</a></strong>()</code> |
| <div class="block">Return the column number in the line of the file at which this |
| instance was parsed.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getComments()">getComments</a></strong>()</code> |
| <div class="block">Return comments, or empty array if none.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/meta/FetchGroup.html" title="class in org.apache.openjpa.meta">FetchGroup</a>[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getCustomFetchGroups()">getCustomFetchGroups</a></strong>()</code> |
| <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 class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getDataCache()">getDataCache</a></strong>()</code> |
| <div class="block">Return the data cache for this class, or null if it is not cachable.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getDataCacheEnabled()">getDataCacheEnabled</a></strong>()</code> |
| <div class="block">Affirms true if this receiver is annotated with @DataCache and is not disabled.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getDataCacheName()">getDataCacheName</a></strong>()</code> |
| <div class="block">The name of the data cache that stores the managed instance of this class, by default.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getDataCacheTimeout()">getDataCacheTimeout</a></strong>()</code> |
| <div class="block">The cache timeout for this class. -1 indicates no timeout.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/meta/FetchGroup.html" title="class in org.apache.openjpa.meta">FetchGroup</a>[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getDeclaredFetchGroups()">getDeclaredFetchGroups</a></strong>()</code> |
| <div class="block">Return the fetch groups declared explicitly in this type.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getDeclaredField(int)">getDeclaredField</a></strong>(int index)</code> |
| <div class="block">Return the metadata for the persistent or transactional field with |
| the given relative index.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getDeclaredField(java.lang.String)">getDeclaredField</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> |
| <div class="block">Return the metadata for the persistent or transactional field with |
| the given name, without including superclass fields.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getDeclaredFieldNames()">getDeclaredFieldNames</a></strong>()</code> |
| <div class="block">Utility method to get names of all declared fields excluding the |
| superclasses' sorted in lexical order.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a>[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getDeclaredFields()">getDeclaredFields</a></strong>()</code> |
| <div class="block">Return only the fields for this class, without superclass fields.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?>[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getDeclaredInterfaces()">getDeclaredInterfaces</a></strong>()</code> |
| <div class="block">Return all explicitly declared interfaces this class implements.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a>[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getDeclaredUnmanagedFields()">getDeclaredUnmanagedFields</a></strong>()</code> |
| <div class="block">Return any fields that were added as non-managed.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a>[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getDefaultFetchGroupFields()">getDefaultFetchGroupFields</a></strong>()</code> |
| <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 class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a>[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getDefinedFields()">getDefinedFields</a></strong>()</code> |
| <div class="block">Returns an array of all the fields defined by this class.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a>[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getDefinedFieldsInListingOrder()">getDefinedFieldsInListingOrder</a></strong>()</code> |
| <div class="block">Returns all fields defined by this class in the order they are listed |
| in the metadata file.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getDefinedSuperclassField(java.lang.String)">getDefinedSuperclassField</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> |
| <div class="block">Return the defined superclass field with the given name, or null if none.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getDescribedType()">getDescribedType</a></strong>()</code> |
| <div class="block">The persistence capable class described by this metadata.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getDescribedTypeString()">getDescribedTypeString</a></strong>()</code> |
| <div class="block">The persistence capable stringified class described by this metadata.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getDetachedState()">getDetachedState</a></strong>()</code> |
| <div class="block">The name of the detach state field, or null if none.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/reflect/Field.html?is-external=true" title="class or interface in java.lang.reflect">Field</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getDetachedStateField()">getDetachedStateField</a></strong>()</code> |
| <div class="block">Return the detach state field, or null if none.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getEmbeddingMetaData()">getEmbeddingMetaData</a></strong>()</code> |
| <div class="block">If this metadata is for an embedded object, returning the owning value.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getEnvClassLoader()">getEnvClassLoader</a></strong>()</code> |
| <div class="block">The environmental loader used when loading this metadata.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getExtraFieldDataIndex(int)">getExtraFieldDataIndex</a></strong>(int field)</code> |
| <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 class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getExtraFieldDataLength()">getExtraFieldDataLength</a></strong>()</code> |
| <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 class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/meta/FetchGroup.html" title="class in org.apache.openjpa.meta">FetchGroup</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getFetchGroup(java.lang.String)">getFetchGroup</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> |
| <div class="block">Gets a named fetch group.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getField(int)">getField</a></strong>(int index)</code> |
| <div class="block">Return the metadata for the persistent or transactional field with |
| the given absolute index.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getField(java.lang.String)">getField</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> |
| <div class="block">Return the metadata for the persistent or transactional field with |
| the given name.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getFieldNames()">getFieldNames</a></strong>()</code> |
| <div class="block">Utility method to get names of all fields including the superclasses' |
| sorted in lexical order.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a>[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getFields()">getFields</a></strong>()</code> |
| <div class="block">Return all field metadata, including superclass fields.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a>[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getFieldsInListingOrder()">getFieldsInListingOrder</a></strong>()</code> |
| <div class="block">Returns all fields in the order they are listed in the metadata |
| file.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getIdClass()">getIdClass</a></strong>()</code> |
| <div class="block">The class specified with the @IdClass annotation if used</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/meta/SequenceMetaData.html" title="class in org.apache.openjpa.meta">SequenceMetaData</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getIdentitySequenceMetaData()">getIdentitySequenceMetaData</a></strong>()</code> |
| <div class="block">Metadata for the datastore identity sequence.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getIdentitySequenceName()">getIdentitySequenceName</a></strong>()</code> |
| <div class="block">The datastore identity sequence name, or null for none.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getIdentityStrategy()">getIdentityStrategy</a></strong>()</code> |
| <div class="block">The strategy to use for datastore identity generation.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getIdentityType()">getIdentityType</a></strong>()</code> |
| <div class="block">The type of identity being used.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getInterfaceAliasedProperties(java.lang.Class)">getInterfaceAliasedProperties</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> iface)</code> |
| <div class="block">Return all aliases property named for the given interface.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getInterfaceImpl()">getInterfaceImpl</a></strong>()</code> |
| <div class="block">Return the managed interface implementor if any.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getInterfacePropertyAlias(java.lang.Class,%20java.lang.String)">getInterfacePropertyAlias</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> iface, |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> orig)</code> |
| <div class="block">Get local field alias for the given interface property.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/meta/LifecycleMetaData.html" title="class in org.apache.openjpa.meta">LifecycleMetaData</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getLifecycleMetaData()">getLifecycleMetaData</a></strong>()</code> |
| <div class="block">Information about lifecycle callbacks for this class.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getLineNumber()">getLineNumber</a></strong>()</code> |
| <div class="block">Return the line number of the file at which this instance was parsed.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getListingIndex()">getListingIndex</a></strong>()</code> |
| <div class="block">The index in which this class was listed in the metadata.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a>[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getLrsFields()">getLrsFields</a></strong>()</code> |
| <div class="block">Return all large result set fields.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a>[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getMappedPCSubclassMetaDatas()">getMappedPCSubclassMetaDatas</a></strong>()</code> |
| <div class="block">Return all mapped subclasses.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getMappedPCSuperclassMetaData()">getMappedPCSuperclassMetaData</a></strong>()</code> |
| <div class="block">Return the closest mapped superclass.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getMappyedByIdFields()">getMappyedByIdFields</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getObjectIdType()">getObjectIdType</a></strong>()</code> |
| <div class="block">The metadata-specified class to use for the object ID.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?>[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getPCSubclasses()">getPCSubclasses</a></strong>()</code> |
| <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 class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a>[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getPCSubclassMetaDatas()">getPCSubclassMetaDatas</a></strong>()</code> |
| <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 class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getPCSuperclass()">getPCSuperclass</a></strong>()</code> |
| <div class="block">The persistence capable superclass of the described type.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getPCSuperclassMetaData()">getPCSuperclassMetaData</a></strong>()</code> |
| <div class="block">The metadata for this class' superclass.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getPkAndNonPersistentManagedFmdIndexes()">getPkAndNonPersistentManagedFmdIndexes</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a>[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getPrimaryKeyFields()">getPrimaryKeyFields</a></strong>()</code> |
| <div class="block">Return primary key fields, or empty array if none.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a>[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getProxyFields()">getProxyFields</a></strong>()</code> |
| <div class="block">Return all fields that are types that need to be wrappered by a proxy.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/meta/MetaDataRepository.html" title="class in org.apache.openjpa.meta">MetaDataRepository</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getRepository()">getRepository</a></strong>()</code> |
| <div class="block">Return the owning repository.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getRequiresExtent()">getRequiresExtent</a></strong>()</code> |
| <div class="block">Whether the type requires extent management.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getResolve()">getResolve</a></strong>()</code> |
| <div class="block">The resolve mode for this metadata.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getResourceName()">getResourceName</a></strong>()</code> |
| <div class="block">Return the domain-meaningful name of the resource that was loaded |
| from this source.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getSourceFile()">getSourceFile</a></strong>()</code> |
| <div class="block">Return the file from which this instance was parsed.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getSourceMode()">getSourceMode</a></strong>()</code> |
| <div class="block">The source mode this metadata has been loaded under.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getSourceName()">getSourceName</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getSourceScope()">getSourceScope</a></strong>()</code> |
| <div class="block">Return the domain-dependent scope of this instance within its file.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getSourceType()">getSourceType</a></strong>()</code> |
| <div class="block">Return the type of source.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getSuperclassField(org.apache.openjpa.meta.FieldMetaData)">getSuperclassField</a></strong>(<a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a> supField)</code> |
| <div class="block">Return the superclass copy of the given field.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getTypeAlias()">getTypeAlias</a></strong>()</code> |
| <div class="block">Returns the alias for the described type, or <code>null</code> if none |
| has been set.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getUseSchemaElement()">getUseSchemaElement</a></strong>()</code> |
| <div class="block">Set whether to include schema name in generated class files</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getVersionField()">getVersionField</a></strong>()</code> |
| <div class="block">Return the version field for this class, if any.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#hasAbstractPKField()">hasAbstractPKField</a></strong>()</code> |
| <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 class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#hashCode()">hashCode</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#hasInverseManagedFields()">hasInverseManagedFields</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#hasPKFieldsFromAbstractClass()">hasPKFieldsFromAbstractClass</a></strong>()</code> |
| <div class="block">Convenience method to determine if this type is a direct |
| decendent of an abstract type declaring PKFields.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#initializeMapping()">initializeMapping</a></strong>()</code> |
| <div class="block">Initialize mapping.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#isAbstract()">isAbstract</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#isAccessibleField(java.lang.String)">isAccessibleField</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> field)</code> |
| <div class="block">Return whether the given name represents a managed or static field of |
| this class, including superclass fields.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#isDetachable()">isDetachable</a></strong>()</code> |
| <div class="block">Whether instances are detachable.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#isEmbeddable()">isEmbeddable</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#isEmbeddedOnly()">isEmbeddedOnly</a></strong>()</code> |
| <div class="block">Whether the type can only be used as an embedded object.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#isExplicitAccess()">isExplicitAccess</a></strong>()</code> |
| <div class="block">Affirms if access style is explicitly defined.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#isIntercepting()">isIntercepting</a></strong>()</code> |
| <div class="block">Whether the type's fields are actively intercepted, either by |
| redefinition or enhancement.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#isManagedInterface()">isManagedInterface</a></strong>()</code> |
| <div class="block">Whether the type is a managed interface.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#isMapped()">isMapped</a></strong>()</code> |
| <div class="block">Whether this class is mapped to the datastore.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#isMixedAccess()">isMixedAccess</a></strong>()</code> |
| <div class="block">Affirms if attributes of this class use mixed access types.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#isObjectIdTypeShared()">isObjectIdTypeShared</a></strong>()</code> |
| <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="../../../../org/apache/openjpa/util/ObjectId.html" title="class in org.apache.openjpa.util"><code>ObjectId</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#isOpenJPAIdentity()">isOpenJPAIdentity</a></strong>()</code> |
| <div class="block">Whether this type uses OpenJPA identity.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#registerForValueUpdate(java.lang.String...)">registerForValueUpdate</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... values)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#removeDeclaredFetchGroup(org.apache.openjpa.meta.FetchGroup)">removeDeclaredFetchGroup</a></strong>(<a href="../../../../org/apache/openjpa/meta/FetchGroup.html" title="class in org.apache.openjpa.meta">FetchGroup</a> fg)</code> |
| <div class="block">Remove a declared fetch group.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#removeDeclaredField(org.apache.openjpa.meta.FieldMetaData)">removeDeclaredField</a></strong>(<a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a> field)</code> |
| <div class="block">Remove the given field from management.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#removeDeclaredInterface(java.lang.Class)">removeDeclaredInterface</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> iface)</code> |
| <div class="block">Remove the given interface from the declared list.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#removeDefinedSuperclassField(org.apache.openjpa.meta.FieldMetaData)">removeDefinedSuperclassField</a></strong>(<a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a> field)</code> |
| <div class="block">Remove the given field from management.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#resolve(int)">resolve</a></strong>(int mode)</code> |
| <div class="block">Resolve and validate metadata.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#resolveMapping(boolean)">resolveMapping</a></strong>(boolean runtime)</code> |
| <div class="block">Resolve mapping data.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#resolveMeta(boolean)">resolveMeta</a></strong>(boolean runtime)</code> |
| <div class="block">Resolve metadata.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#setAbstract(boolean)">setAbstract</a></strong>(boolean flag)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#setAccessType(int)">setAccessType</a></strong>(int type)</code> |
| <div class="block">Sets the access type.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#setCacheEnabled(boolean)">setCacheEnabled</a></strong>(boolean enabled)</code> |
| <div class="block">Sets the eligibility status of this class for cache.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#setColNumber(int)">setColNumber</a></strong>(int colNum)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#setComments(java.lang.String[])">setComments</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] comments)</code> |
| <div class="block">Set comments.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#setDataCacheName(java.lang.String)">setDataCacheName</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> |
| <div class="block">Set the cache name for this class.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#setDataCacheTimeout(int)">setDataCacheTimeout</a></strong>(int timeout)</code> |
| <div class="block">The cache timeout for this class. -1 indicates no timeout.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#setDescribedType(java.lang.Class)">setDescribedType</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> type)</code> |
| <div class="block">Set the class described by this metadata.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#setDetachable(boolean)">setDetachable</a></strong>(boolean detachable)</code> |
| <div class="block">Whether instances are detachable.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#setDetachedState(java.lang.String)">setDetachedState</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> field)</code> |
| <div class="block">The name of the detach state field, or null if none.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#setEmbeddable()">setEmbeddable</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#setEmbeddedOnly(boolean)">setEmbeddedOnly</a></strong>(boolean embed)</code> |
| <div class="block">Whether the type can only be used as an embedded object.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#setEnvClassLoader(java.lang.ClassLoader)">setEnvClassLoader</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> loader)</code> |
| <div class="block">The class environmental loader used when loading this metadata.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#setIdentitySequenceName(java.lang.String)">setIdentitySequenceName</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> seqName)</code> |
| <div class="block">The datastore identity sequence name, or null for none.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#setIdentityStrategy(int)">setIdentityStrategy</a></strong>(int strategy)</code> |
| <div class="block">The strategy to use for datastore identity generation.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#setIdentityType(int)">setIdentityType</a></strong>(int type)</code> |
| <div class="block">The type of identity being used.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#setIntercepting(boolean)">setIntercepting</a></strong>(boolean intercepting)</code> |
| <div class="block">Whether the type's fields are actively intercepted, either by |
| redefinition or enhancement.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#setInterfaceImpl(java.lang.Class)">setInterfaceImpl</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> impl)</code> |
| <div class="block">Set the managed interface implementor class.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#setInterfacePropertyAlias(java.lang.Class,%20java.lang.String,%20java.lang.String)">setInterfacePropertyAlias</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> iface, |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> orig, |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> local)</code> |
| <div class="block">Alias properties from the given interface during queries to |
| the local field.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#setLineNumber(int)">setLineNumber</a></strong>(int lineNum)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#setListingIndex(int)">setListingIndex</a></strong>(int index)</code> |
| <div class="block">The index in which this field was listed in the metadata.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#setManagedInterface(boolean)">setManagedInterface</a></strong>(boolean managedInterface)</code> |
| <div class="block">Whether the type is a managed interface</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#setObjectIdType(java.lang.Class,%20boolean)">setObjectIdType</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> cls, |
| boolean shared)</code> |
| <div class="block">The metadata-specified class to use for the object ID.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#setPCSuperclass(java.lang.Class)">setPCSuperclass</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> pc)</code> |
| <div class="block">The persistence capable superclass of the described type.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#setPCSuperclassMetaData(org.apache.openjpa.meta.ClassMetaData)">setPCSuperclassMetaData</a></strong>(<a href="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a> meta)</code> |
| <div class="block">The metadata for this class' superclass.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#setRequiresExtent(boolean)">setRequiresExtent</a></strong>(boolean req)</code> |
| <div class="block">Whether the type requires extent management.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#setResolve(int)">setResolve</a></strong>(int mode)</code> |
| <div class="block">The resolve mode for this metadata.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#setResolve(int,%20boolean)">setResolve</a></strong>(int mode, |
| boolean on)</code> |
| <div class="block">The resolve mode for this metadata.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#setSource(java.io.File,%20int,%20java.lang.String)">setSource</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file, |
| int srcType, |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> srcName)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#setSourceMode(int)">setSourceMode</a></strong>(int mode)</code> |
| <div class="block">The source mode this metadata has been loaded under.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#setSourceMode(int,%20boolean)">setSourceMode</a></strong>(int mode, |
| boolean on)</code> |
| <div class="block">The source mode this metadata has been loaded under.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#setTypeAlias(java.lang.String)">setTypeAlias</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> alias)</code> |
| <div class="block">Sets the alias for the described type.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#setUseSchemaElement(boolean)">setUseSchemaElement</a></strong>(boolean useSchemaElement)</code> |
| <div class="block">Get whether to include schema name in generated class files</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#toString()">toString</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#useIdClassFromParent()">useIdClassFromParent</a></strong>()</code> |
| <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 class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#usesDetachedState()">usesDetachedState</a></strong>()</code> |
| <div class="block">Whether an instance of this type has detached state.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#validateMapping(boolean)">validateMapping</a></strong>(boolean runtime)</code> |
| <div class="block">Validate mapping data.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#validateMeta(boolean)">validateMeta</a></strong>(boolean runtime)</code> |
| <div class="block">Validate resolved metadata.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#valueChanged(org.apache.openjpa.lib.conf.Value)">valueChanged</a></strong>(<a href="../../../../org/apache/openjpa/lib/conf/Value.html" title="class in org.apache.openjpa.lib.conf">Value</a> val)</code> |
| <div class="block">Callback used by <a href="../../../../org/apache/openjpa/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 name="methods_inherited_from_class_org.apache.openjpa.meta.Extensions"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.openjpa.meta.<a href="../../../../org/apache/openjpa/meta/Extensions.html" title="class in org.apache.openjpa.meta">Extensions</a></h3> |
| <code><a href="../../../../org/apache/openjpa/meta/Extensions.html#addExtension(java.lang.String,%20java.lang.Object)">addExtension</a>, <a href="../../../../org/apache/openjpa/meta/Extensions.html#addExtension(java.lang.String,%20java.lang.String,%20java.lang.Object)">addExtension</a>, <a href="../../../../org/apache/openjpa/meta/Extensions.html#copy(org.apache.openjpa.meta.Extensions)">copy</a>, <a href="../../../../org/apache/openjpa/meta/Extensions.html#getBooleanExtension(java.lang.String)">getBooleanExtension</a>, <a href="../../../../org/apache/openjpa/meta/Extensions.html#getBooleanExtension(java.lang.String,%20java.lang.String)">getBooleanExtension</a>, <a href="../../../../org/apache/openjpa/meta/Extensions.html#getDoubleExtension(java.lang.String)">getDoubleExtension</a>, <a href="../../../../org/apache/openjpa/meta/Extensions.html#getDoubleExtension(java.lang.String,%20java.lang.String)">getDoubleExtension</a>, <a href="../../../../org/apache/openjpa/meta/Extensions.html#getEmbeddedExtensions(java.lang.String,%20boolean)">getEmbeddedExtensions</a>, <a href="../../../../org/apache/openjpa/meta/Extensions.html#getEmbeddedExtensions(java.lang.String,%20java.lang.String,%20boolean)">getEmbeddedExtensions</a>, <a href="../../../../org/apache/openjpa/meta/Extensions.html#getExtensionKeys()">getExtensionKeys</a>, <a href="../../../../org/apache/openjpa/meta/Extensions.html#getExtensionKeys(java.lang.String)">getExtensionKeys</a>, <a href="../../../../org/apache/openjpa/meta/Extensions.html#getExtensionVendors()">getExtensionVendors</a>, <a href="../../../../org/apache/openjpa/meta/Extensions.html#getIntExtension(java.lang.String)">getIntExtension</a>, <a href="../../../../org/apache/openjpa/meta/Extensions.html#getIntExtension(java.lang.String,%20java.lang.String)">getIntExtension</a>, <a href="../../../../org/apache/openjpa/meta/Extensions.html#getObjectExtension(java.lang.String)">getObjectExtension</a>, <a href="../../../../org/apache/openjpa/meta/Extensions.html#getObjectExtension(java.lang.String,%20java.lang.String)">getObjectExtension</a>, <a href="../../../../org/apache/openjpa/meta/Extensions.html#getStringExtension(java.lang.String)">getStringExtension</a>, <a href="../../../../org/apache/openjpa/meta/Extensions.html#getStringExtension(java.lang.String,%20java.lang.String)">getStringExtension</a>, <a href="../../../../org/apache/openjpa/meta/Extensions.html#hasExtension(java.lang.String)">hasExtension</a>, <a href="../../../../org/apache/openjpa/meta/Extensions.html#hasExtension(java.lang.String,%20java.lang.String)">hasExtension</a>, <a href="../../../../org/apache/openjpa/meta/Extensions.html#isEmpty()">isEmpty</a>, <a href="../../../../org/apache/openjpa/meta/Extensions.html#removeEmbeddedExtensions(java.lang.String)">removeEmbeddedExtensions</a>, <a href="../../../../org/apache/openjpa/meta/Extensions.html#removeEmbeddedExtensions(java.lang.String,%20java.lang.String)">removeEmbeddedExtensions</a>, <a href="../../../../org/apache/openjpa/meta/Extensions.html#removeExtension(java.lang.String)">removeExtension</a>, <a href="../../../../org/apache/openjpa/meta/Extensions.html#removeExtension(java.lang.String,%20java.lang.String)">removeExtension</a>, <a href="../../../../org/apache/openjpa/meta/Extensions.html#validateDataStoreExtensionPrefix(java.lang.String)">validateDataStoreExtensionPrefix</a>, <a href="../../../../org/apache/openjpa/meta/Extensions.html#validateExtensionKeys()">validateExtensionKeys</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="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="strong">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 name="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="strong">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 name="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="strong">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 name="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 name="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 name="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 name="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 name="SYNTHETIC"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SYNTHETIC</h4> |
| <pre>public static final <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> SYNTHETIC</pre> |
| <div class="block">Value for using a synthetic detached state field, which is the default.</div> |
| <dl><dt><span class="strong">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 name="DEFAULT_STRING"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DEFAULT_STRING</h4> |
| <pre>protected static final <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> DEFAULT_STRING</pre> |
| <dl><dt><span class="strong">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> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="ClassMetaData(java.lang.Class, org.apache.openjpa.meta.MetaDataRepository)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ClassMetaData</h4> |
| <pre>protected ClassMetaData(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> type, |
| <a href="../../../../org/apache/openjpa/meta/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 name="ClassMetaData(org.apache.openjpa.meta.ValueMetaData)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ClassMetaData</h4> |
| <pre>protected ClassMetaData(<a href="../../../../org/apache/openjpa/meta/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> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getRepository()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRepository</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/meta/MetaDataRepository.html" title="class in org.apache.openjpa.meta">MetaDataRepository</a> getRepository()</pre> |
| <div class="block">Return the owning repository.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/meta/MetaDataContext.html#getRepository()">getRepository</a></code> in interface <code><a href="../../../../org/apache/openjpa/meta/MetaDataContext.html" title="interface in org.apache.openjpa.meta">MetaDataContext</a></code></dd> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/meta/Extensions.html#getRepository()">getRepository</a></code> in class <code><a href="../../../../org/apache/openjpa/meta/Extensions.html" title="class in org.apache.openjpa.meta">Extensions</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEmbeddingMetaData()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEmbeddingMetaData</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/meta/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 name="getDescribedType()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDescribedType</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> getDescribedType()</pre> |
| <div class="block">The persistence capable class described by this metadata.</div> |
| </li> |
| </ul> |
| <a name="getDescribedTypeString()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDescribedTypeString</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getDescribedTypeString()</pre> |
| <div class="block">The persistence capable stringified class described by this metadata.</div> |
| </li> |
| </ul> |
| <a name="setDescribedType(java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDescribedType</h4> |
| <pre>protected void setDescribedType(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">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 name="getEnvClassLoader()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEnvClassLoader</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">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 name="setEnvClassLoader(java.lang.ClassLoader)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEnvClassLoader</h4> |
| <pre>public void setEnvClassLoader(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">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 name="getPCSuperclass()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPCSuperclass</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> getPCSuperclass()</pre> |
| <div class="block">The persistence capable superclass of the described type.</div> |
| </li> |
| </ul> |
| <a name="setPCSuperclass(java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPCSuperclass</h4> |
| <pre>public void setPCSuperclass(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> pc)</pre> |
| <div class="block">The persistence capable superclass of the described type.</div> |
| </li> |
| </ul> |
| <a name="getPCSuperclassMetaData()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPCSuperclassMetaData</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/meta/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 name="setPCSuperclassMetaData(org.apache.openjpa.meta.ClassMetaData)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPCSuperclassMetaData</h4> |
| <pre>public void setPCSuperclassMetaData(<a href="../../../../org/apache/openjpa/meta/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 name="isMapped()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isMapped</h4> |
| <pre>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 name="getMappedPCSuperclassMetaData()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMappedPCSuperclassMetaData</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/meta/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 name="getPCSubclasses()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPCSubclasses</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">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 name="getPCSubclassMetaDatas()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPCSubclassMetaDatas</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/meta/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 name="getMappedPCSubclassMetaDatas()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMappedPCSubclassMetaDatas</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a>[] getMappedPCSubclassMetaDatas()</pre> |
| <div class="block">Return all mapped subclasses.</div> |
| </li> |
| </ul> |
| <a name="getIdentityType()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIdentityType</h4> |
| <pre>public int getIdentityType()</pre> |
| <div class="block">The type of identity being used. This will be one of: |
| <ul> |
| <li><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#ID_UNKNOWN"><code>ID_UNKNOWN</code></a>: unknown identity type</li> |
| <li><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#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="../../../../org/apache/openjpa/meta/ClassMetaData.html#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="../../../../org/apache/openjpa/meta/ClassMetaData.html#ID_DATASTORE"><code>ID_DATASTORE</code></a> if there are no |
| primary key fields, and <a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#ID_APPLICATION"><code>ID_APPLICATION</code></a> otherwise.</div> |
| </li> |
| </ul> |
| <a name="setIdentityType(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIdentityType</h4> |
| <pre>public void setIdentityType(int type)</pre> |
| <div class="block">The type of identity being used. This will be one of: |
| <ul> |
| <li><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#ID_UNKNOWN"><code>ID_UNKNOWN</code></a>: unknown identity type</li> |
| <li><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#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="../../../../org/apache/openjpa/meta/ClassMetaData.html#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="../../../../org/apache/openjpa/meta/ClassMetaData.html#ID_DATASTORE"><code>ID_DATASTORE</code></a> if there are no |
| primary key fields, and <a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#ID_APPLICATION"><code>ID_APPLICATION</code></a> otherwise.</div> |
| </li> |
| </ul> |
| <a name="getObjectIdType()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getObjectIdType</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> getObjectIdType()</pre> |
| <div class="block">The metadata-specified class to use for the object ID.</div> |
| </li> |
| </ul> |
| <a name="setObjectIdType(java.lang.Class, boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setObjectIdType</h4> |
| <pre>public void setObjectIdType(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">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 name="isObjectIdTypeShared()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isObjectIdTypeShared</h4> |
| <pre>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="../../../../org/apache/openjpa/util/ObjectId.html" title="class in org.apache.openjpa.util"><code>ObjectId</code></a>.</div> |
| </li> |
| </ul> |
| <a name="isOpenJPAIdentity()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isOpenJPAIdentity</h4> |
| <pre>public boolean isOpenJPAIdentity()</pre> |
| <div class="block">Whether this type uses OpenJPA identity.</div> |
| </li> |
| </ul> |
| <a name="getIdentityStrategy()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIdentityStrategy</h4> |
| <pre>public int getIdentityStrategy()</pre> |
| <div class="block">The strategy to use for datastore identity generation. |
| One of the constants from <a href="../../../../org/apache/openjpa/meta/ValueStrategies.html" title="class in org.apache.openjpa.meta"><code>ValueStrategies</code></a>.</div> |
| </li> |
| </ul> |
| <a name="setIdentityStrategy(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIdentityStrategy</h4> |
| <pre>public void setIdentityStrategy(int strategy)</pre> |
| <div class="block">The strategy to use for datastore identity generation. |
| One of the constants from <a href="../../../../org/apache/openjpa/meta/ValueStrategies.html" title="class in org.apache.openjpa.meta"><code>ValueStrategies</code></a>.</div> |
| </li> |
| </ul> |
| <a name="getIdentitySequenceName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIdentitySequenceName</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getIdentitySequenceName()</pre> |
| <div class="block">The datastore identity sequence name, or null for none.</div> |
| </li> |
| </ul> |
| <a name="setIdentitySequenceName(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIdentitySequenceName</h4> |
| <pre>public void setIdentitySequenceName(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> seqName)</pre> |
| <div class="block">The datastore identity sequence name, or null for none.</div> |
| </li> |
| </ul> |
| <a name="getIdentitySequenceMetaData()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIdentitySequenceMetaData</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/meta/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 name="getLifecycleMetaData()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLifecycleMetaData</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/meta/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 name="getTypeAlias()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTypeAlias</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">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="strong">See Also:</span></dt><dd><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#setTypeAlias(java.lang.String)"><code>setTypeAlias(java.lang.String)</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="setTypeAlias(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTypeAlias</h4> |
| <pre>public void setTypeAlias(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">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="strong">Parameters:</span></dt><dd><code>alias</code> - the alias name to apply to the described type</dd></dl> |
| </li> |
| </ul> |
| <a name="getAccessType()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAccessType</h4> |
| <pre>public int getAccessType()</pre> |
| <div class="block">The access type used by this class.</div> |
| </li> |
| </ul> |
| <a name="setAccessType(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAccessType</h4> |
| <pre>public void setAccessType(int type)</pre> |
| <div class="block">Sets the access type.</div> |
| </li> |
| </ul> |
| <a name="isExplicitAccess()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isExplicitAccess</h4> |
| <pre>public boolean isExplicitAccess()</pre> |
| <div class="block">Affirms if access style is explicitly defined.</div> |
| </li> |
| </ul> |
| <a name="isMixedAccess()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isMixedAccess</h4> |
| <pre>public boolean isMixedAccess()</pre> |
| <div class="block">Affirms if attributes of this class use mixed access types.</div> |
| </li> |
| </ul> |
| <a name="getRequiresExtent()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRequiresExtent</h4> |
| <pre>public boolean getRequiresExtent()</pre> |
| <div class="block">Whether the type requires extent management.</div> |
| </li> |
| </ul> |
| <a name="setRequiresExtent(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRequiresExtent</h4> |
| <pre>public void setRequiresExtent(boolean req)</pre> |
| <div class="block">Whether the type requires extent management.</div> |
| </li> |
| </ul> |
| <a name="isEmbeddedOnly()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isEmbeddedOnly</h4> |
| <pre>public boolean isEmbeddedOnly()</pre> |
| <div class="block">Whether the type can only be used as an embedded object.</div> |
| </li> |
| </ul> |
| <a name="setEmbeddedOnly(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEmbeddedOnly</h4> |
| <pre>public void setEmbeddedOnly(boolean embed)</pre> |
| <div class="block">Whether the type can only be used as an embedded object.</div> |
| </li> |
| </ul> |
| <a name="isEmbeddable()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isEmbeddable</h4> |
| <pre>public boolean isEmbeddable()</pre> |
| </li> |
| </ul> |
| <a name="setEmbeddable()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEmbeddable</h4> |
| <pre>public void setEmbeddable()</pre> |
| </li> |
| </ul> |
| <a name="isIntercepting()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isIntercepting</h4> |
| <pre>public boolean isIntercepting()</pre> |
| <div class="block">Whether the type's fields are actively intercepted, either by |
| redefinition or enhancement.</div> |
| </li> |
| </ul> |
| <a name="setIntercepting(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIntercepting</h4> |
| <pre>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 name="isManagedInterface()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isManagedInterface</h4> |
| <pre>public boolean isManagedInterface()</pre> |
| <div class="block">Whether the type is a managed interface.</div> |
| </li> |
| </ul> |
| <a name="setManagedInterface(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setManagedInterface</h4> |
| <pre>public void setManagedInterface(boolean managedInterface)</pre> |
| <div class="block">Whether the type is a managed interface</div> |
| </li> |
| </ul> |
| <a name="getInterfaceImpl()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInterfaceImpl</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> getInterfaceImpl()</pre> |
| <div class="block">Return the managed interface implementor if any.</div> |
| </li> |
| </ul> |
| <a name="setInterfaceImpl(java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setInterfaceImpl</h4> |
| <pre>public void setInterfaceImpl(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> impl)</pre> |
| <div class="block">Set the managed interface implementor class.</div> |
| </li> |
| </ul> |
| <a name="getDeclaredInterfaces()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDeclaredInterfaces</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?>[] getDeclaredInterfaces()</pre> |
| <div class="block">Return all explicitly declared interfaces this class implements.</div> |
| </li> |
| </ul> |
| <a name="addDeclaredInterface(java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addDeclaredInterface</h4> |
| <pre>public void addDeclaredInterface(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> iface)</pre> |
| <div class="block">Explicitly declare the given interface among the ones this |
| class implements.</div> |
| </li> |
| </ul> |
| <a name="removeDeclaredInterface(java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeDeclaredInterface</h4> |
| <pre>public boolean removeDeclaredInterface(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> iface)</pre> |
| <div class="block">Remove the given interface from the declared list.</div> |
| </li> |
| </ul> |
| <a name="setInterfacePropertyAlias(java.lang.Class, java.lang.String, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setInterfacePropertyAlias</h4> |
| <pre>public void setInterfacePropertyAlias(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> iface, |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> orig, |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> local)</pre> |
| <div class="block">Alias properties from the given interface during queries to |
| the local field.</div> |
| </li> |
| </ul> |
| <a name="getInterfacePropertyAlias(java.lang.Class, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInterfacePropertyAlias</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getInterfacePropertyAlias(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> iface, |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> orig)</pre> |
| <div class="block">Get local field alias for the given interface property.</div> |
| </li> |
| </ul> |
| <a name="getInterfaceAliasedProperties(java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInterfaceAliasedProperties</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] getInterfaceAliasedProperties(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> iface)</pre> |
| <div class="block">Return all aliases property named for the given interface.</div> |
| </li> |
| </ul> |
| <a name="getExtraFieldDataLength()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExtraFieldDataLength</h4> |
| <pre>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 name="getExtraFieldDataIndex(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExtraFieldDataIndex</h4> |
| <pre>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="strong">See Also:</span></dt><dd><a href="../../../../org/apache/openjpa/meta/ClassMetaData.html#getExtraFieldDataLength()"><code>getExtraFieldDataLength()</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="isAccessibleField(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isAccessibleField</h4> |
| <pre>public boolean isAccessibleField(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">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 name="getProxyFields()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProxyFields</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/meta/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 name="getLrsFields()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLrsFields</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/meta/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 name="getFields()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFields</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/meta/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 name="getSuperclassField(org.apache.openjpa.meta.FieldMetaData)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSuperclassField</h4> |
| <pre>protected <a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a> getSuperclassField(<a href="../../../../org/apache/openjpa/meta/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 name="getDeclaredFields()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDeclaredFields</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/meta/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 name="getPrimaryKeyFields()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPrimaryKeyFields</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/meta/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 name="getDefaultFetchGroupFields()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDefaultFetchGroupFields</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/meta/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 name="getVersionField()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getVersionField</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/meta/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 name="getField(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getField</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/meta/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="strong">Returns:</span></dt><dd>the field's metadata, or null if not found</dd></dl> |
| </li> |
| </ul> |
| <a name="getDeclaredField(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDeclaredField</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/meta/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="strong">Returns:</span></dt><dd>the field's metadata, or null if not found</dd></dl> |
| </li> |
| </ul> |
| <a name="getField(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getField</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a> getField(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">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="strong">Returns:</span></dt><dd>the field's metadata, or null if not found</dd></dl> |
| </li> |
| </ul> |
| <a name="getDeclaredField(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDeclaredField</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a> getDeclaredField(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">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="strong">Returns:</span></dt><dd>the field's metadata, or null if not found</dd></dl> |
| </li> |
| </ul> |
| <a name="getDeclaredUnmanagedFields()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDeclaredUnmanagedFields</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/meta/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 name="addDeclaredField(java.lang.String, java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addDeclaredField</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a> addDeclaredField(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> type)</pre> |
| <div class="block">Add a new field metadata to this class.</div> |
| </li> |
| </ul> |
| <a name="removeDeclaredField(org.apache.openjpa.meta.FieldMetaData)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeDeclaredField</h4> |
| <pre>public boolean removeDeclaredField(<a href="../../../../org/apache/openjpa/meta/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="strong">Returns:</span></dt><dd>true if the field was removed, false otherwise</dd></dl> |
| </li> |
| </ul> |
| <a name="getDefinedSuperclassField(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDefinedSuperclassField</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a> getDefinedSuperclassField(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| <div class="block">Return the defined superclass field with the given name, or null if none.</div> |
| </li> |
| </ul> |
| <a name="addDefinedSuperclassField(java.lang.String, java.lang.Class, java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addDefinedSuperclassField</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a> addDefinedSuperclassField(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> type, |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> sup)</pre> |
| <div class="block">Add a new defined superclass field metadata to this class.</div> |
| </li> |
| </ul> |
| <a name="removeDefinedSuperclassField(org.apache.openjpa.meta.FieldMetaData)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeDefinedSuperclassField</h4> |
| <pre>public boolean removeDefinedSuperclassField(<a href="../../../../org/apache/openjpa/meta/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="strong">Returns:</span></dt><dd>true if the field was removed, false otherwise</dd></dl> |
| </li> |
| </ul> |
| <a name="defineSuperclassFields(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>defineSuperclassFields</h4> |
| <pre>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="strong">Parameters:</span></dt><dd><code>force</code> - whether to force re-mapping of even mapped superclass fields</dd></dl> |
| </li> |
| </ul> |
| <a name="getDefinedFields()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDefinedFields</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/meta/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 name="getFieldsInListingOrder()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFieldsInListingOrder</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/meta/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 name="getDefinedFieldsInListingOrder()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDefinedFieldsInListingOrder</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/meta/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 name="getDataCacheName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDataCacheName</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">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="../../../../org/apache/openjpa/datacache/CacheDistributionPolicy.html" title="interface in org.apache.openjpa.datacache">cache distribution policy</a>.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>null if this class is disabled from cache by @DataCache(enabled=false). |
| <a href="../../../../org/apache/openjpa/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 name="setDataCacheName(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDataCacheName</h4> |
| <pre>public void setDataCacheName(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| <div class="block">Set the cache name for this class.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>can</code> - be null to disable cache.</dd></dl> |
| </li> |
| </ul> |
| <a name="getDataCacheEnabled()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDataCacheEnabled</h4> |
| <pre>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 name="getDataCacheTimeout()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDataCacheTimeout</h4> |
| <pre>public int getDataCacheTimeout()</pre> |
| <div class="block">The cache timeout for this class. -1 indicates no timeout.</div> |
| </li> |
| </ul> |
| <a name="setDataCacheTimeout(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDataCacheTimeout</h4> |
| <pre>public void setDataCacheTimeout(int timeout)</pre> |
| <div class="block">The cache timeout for this class. -1 indicates no timeout.</div> |
| </li> |
| </ul> |
| <a name="getDataCache()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDataCache</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/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 name="isDetachable()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDetachable</h4> |
| <pre>public boolean isDetachable()</pre> |
| <div class="block">Whether instances are detachable.</div> |
| </li> |
| </ul> |
| <a name="setDetachable(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDetachable</h4> |
| <pre>public void setDetachable(boolean detachable)</pre> |
| <div class="block">Whether instances are detachable.</div> |
| </li> |
| </ul> |
| <a name="getDetachedState()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDetachedState</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getDetachedState()</pre> |
| <div class="block">The name of the detach state field, or null if none.</div> |
| </li> |
| </ul> |
| <a name="setDetachedState(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDetachedState</h4> |
| <pre>public void setDetachedState(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> field)</pre> |
| <div class="block">The name of the detach state field, or null if none.</div> |
| </li> |
| </ul> |
| <a name="getDetachedStateField()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDetachedStateField</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/reflect/Field.html?is-external=true" title="class or interface in java.lang.reflect">Field</a> getDetachedStateField()</pre> |
| <div class="block">Return the detach state field, or null if none.</div> |
| </li> |
| </ul> |
| <a name="usesDetachedState()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>usesDetachedState</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> usesDetachedState()</pre> |
| <div class="block">Whether an instance of this type has detached state.</div> |
| <dl><dt><span class="strong">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 name="clearAllFieldCache()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clearAllFieldCache</h4> |
| <pre>protected void clearAllFieldCache()</pre> |
| <div class="block">Clear cached field data.</div> |
| </li> |
| </ul> |
| <a name="clearDefinedFieldCache()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clearDefinedFieldCache</h4> |
| <pre>protected void clearDefinedFieldCache()</pre> |
| <div class="block">Clear defined field data.</div> |
| </li> |
| </ul> |
| <a name="clearFieldCache()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clearFieldCache</h4> |
| <pre>protected void clearFieldCache()</pre> |
| <div class="block">Clear cached field data.</div> |
| </li> |
| </ul> |
| <a name="clearSubclassCache()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clearSubclassCache</h4> |
| <pre>protected void clearSubclassCache()</pre> |
| <div class="block">Clear cached subclass data.</div> |
| </li> |
| </ul> |
| <a name="hashCode()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hashCode</h4> |
| <pre>public int hashCode()</pre> |
| <dl> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a></code> in class <code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="equals(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>equals</h4> |
| <pre>public boolean equals(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> other)</pre> |
| <dl> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a></code> in class <code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="compareTo(org.apache.openjpa.meta.ClassMetaData)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>compareTo</h4> |
| <pre>public int compareTo(<a href="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a> other)</pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true#compareTo(T)" title="class or interface in java.lang">compareTo</a></code> in interface <code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a><<a href="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toString()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> toString()</pre> |
| <dl> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a></code> in class <code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getResolve()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getResolve</h4> |
| <pre>public int getResolve()</pre> |
| <div class="block">The resolve mode for this metadata.</div> |
| </li> |
| </ul> |
| <a name="setResolve(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setResolve</h4> |
| <pre>public void setResolve(int mode)</pre> |
| <div class="block">The resolve mode for this metadata.</div> |
| </li> |
| </ul> |
| <a name="setResolve(int, boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setResolve</h4> |
| <pre>public void setResolve(int mode, |
| boolean on)</pre> |
| <div class="block">The resolve mode for this metadata.</div> |
| </li> |
| </ul> |
| <a name="resolve(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resolve</h4> |
| <pre>public boolean resolve(int mode)</pre> |
| <div class="block">Resolve and validate metadata. Return true if already resolved.</div> |
| </li> |
| </ul> |
| <a name="resolveMeta(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resolveMeta</h4> |
| <pre>protected void resolveMeta(boolean runtime)</pre> |
| <div class="block">Resolve metadata.</div> |
| </li> |
| </ul> |
| <a name="validateMeta(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validateMeta</h4> |
| <pre>protected void validateMeta(boolean runtime)</pre> |
| <div class="block">Validate resolved metadata.</div> |
| </li> |
| </ul> |
| <a name="resolveMapping(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resolveMapping</h4> |
| <pre>protected void resolveMapping(boolean runtime)</pre> |
| <div class="block">Resolve mapping data. Logs resolve message and resolves super by default.</div> |
| </li> |
| </ul> |
| <a name="validateMapping(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validateMapping</h4> |
| <pre>protected void validateMapping(boolean runtime)</pre> |
| <div class="block">Validate mapping data.</div> |
| </li> |
| </ul> |
| <a name="initializeMapping()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>initializeMapping</h4> |
| <pre>protected void initializeMapping()</pre> |
| <div class="block">Initialize mapping. Logs init message by default.</div> |
| </li> |
| </ul> |
| <a name="useIdClassFromParent()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>useIdClassFromParent</h4> |
| <pre>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 name="getDeclaredFetchGroups()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDeclaredFetchGroups</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/meta/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 name="getCustomFetchGroups()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCustomFetchGroups</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/meta/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 name="getFetchGroup(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFetchGroup</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/meta/FetchGroup.html" title="class in org.apache.openjpa.meta">FetchGroup</a> getFetchGroup(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">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="strong">Parameters:</span></dt><dd><code>name</code> - name of a fetch group.</dd> |
| <dt><span class="strong">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 name="addDeclaredFetchGroup(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addDeclaredFetchGroup</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/meta/FetchGroup.html" title="class in org.apache.openjpa.meta">FetchGroup</a> addDeclaredFetchGroup(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| <div class="block">Adds fetch group of the given name, or returns existing instance.</div> |
| <dl><dt><span class="strong">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 name="removeDeclaredFetchGroup(org.apache.openjpa.meta.FetchGroup)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeDeclaredFetchGroup</h4> |
| <pre>public boolean removeDeclaredFetchGroup(<a href="../../../../org/apache/openjpa/meta/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 name="getSourceFile()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSourceFile</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> getSourceFile()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/lib/meta/SourceTracker.html#getSourceFile()">SourceTracker</a></code></strong></div> |
| <div class="block">Return the file from which this instance was parsed.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/lib/meta/SourceTracker.html#getSourceFile()">getSourceFile</a></code> in interface <code><a href="../../../../org/apache/openjpa/lib/meta/SourceTracker.html" title="interface in org.apache.openjpa.lib.meta">SourceTracker</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSourceScope()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSourceScope</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> getSourceScope()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/lib/meta/SourceTracker.html#getSourceScope()">SourceTracker</a></code></strong></div> |
| <div class="block">Return the domain-dependent scope of this instance within its file.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/lib/meta/SourceTracker.html#getSourceScope()">getSourceScope</a></code> in interface <code><a href="../../../../org/apache/openjpa/lib/meta/SourceTracker.html" title="interface in org.apache.openjpa.lib.meta">SourceTracker</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSourceType()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSourceType</h4> |
| <pre>public int getSourceType()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/lib/meta/SourceTracker.html#getSourceType()">SourceTracker</a></code></strong></div> |
| <div class="block">Return the type of source.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/lib/meta/SourceTracker.html#getSourceType()">getSourceType</a></code> in interface <code><a href="../../../../org/apache/openjpa/lib/meta/SourceTracker.html" title="interface in org.apache.openjpa.lib.meta">SourceTracker</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSource(java.io.File, int, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSource</h4> |
| <pre>public void setSource(<a href="http://docs.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file, |
| int srcType, |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> srcName)</pre> |
| </li> |
| </ul> |
| <a name="getResourceName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getResourceName</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getResourceName()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/lib/meta/SourceTracker.html#getResourceName()">SourceTracker</a></code></strong></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><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/lib/meta/SourceTracker.html#getResourceName()">getResourceName</a></code> in interface <code><a href="../../../../org/apache/openjpa/lib/meta/SourceTracker.html" title="interface in org.apache.openjpa.lib.meta">SourceTracker</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLineNumber()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLineNumber</h4> |
| <pre>public int getLineNumber()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/lib/meta/SourceTracker.html#getLineNumber()">SourceTracker</a></code></strong></div> |
| <div class="block">Return the line number of the file at which this instance was parsed.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/lib/meta/SourceTracker.html#getLineNumber()">getLineNumber</a></code> in interface <code><a href="../../../../org/apache/openjpa/lib/meta/SourceTracker.html" title="interface in org.apache.openjpa.lib.meta">SourceTracker</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setLineNumber(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLineNumber</h4> |
| <pre>public void setLineNumber(int lineNum)</pre> |
| </li> |
| </ul> |
| <a name="getColNumber()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getColNumber</h4> |
| <pre>public int getColNumber()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/lib/meta/SourceTracker.html#getColNumber()">SourceTracker</a></code></strong></div> |
| <div class="block">Return the column number in the line of the file at which this |
| instance was parsed.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/lib/meta/SourceTracker.html#getColNumber()">getColNumber</a></code> in interface <code><a href="../../../../org/apache/openjpa/lib/meta/SourceTracker.html" title="interface in org.apache.openjpa.lib.meta">SourceTracker</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setColNumber(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setColNumber</h4> |
| <pre>public void setColNumber(int colNum)</pre> |
| </li> |
| </ul> |
| <a name="getSourceMode()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSourceMode</h4> |
| <pre>public int getSourceMode()</pre> |
| <div class="block">The source mode this metadata has been loaded under.</div> |
| </li> |
| </ul> |
| <a name="setSourceMode(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSourceMode</h4> |
| <pre>public void setSourceMode(int mode)</pre> |
| <div class="block">The source mode this metadata has been loaded under.</div> |
| </li> |
| </ul> |
| <a name="setSourceMode(int, boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSourceMode</h4> |
| <pre>public void setSourceMode(int mode, |
| boolean on)</pre> |
| <div class="block">The source mode this metadata has been loaded under.</div> |
| </li> |
| </ul> |
| <a name="getListingIndex()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getListingIndex</h4> |
| <pre>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 name="setListingIndex(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setListingIndex</h4> |
| <pre>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 name="getComments()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getComments</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] getComments()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/lib/xml/Commentable.html#getComments()">Commentable</a></code></strong></div> |
| <div class="block">Return comments, or empty array if none.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/lib/xml/Commentable.html#getComments()">getComments</a></code> in interface <code><a href="../../../../org/apache/openjpa/lib/xml/Commentable.html" title="interface in org.apache.openjpa.lib.xml">Commentable</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setComments(java.lang.String[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setComments</h4> |
| <pre>public void setComments(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] comments)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/lib/xml/Commentable.html#setComments(java.lang.String[])">Commentable</a></code></strong></div> |
| <div class="block">Set comments.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/lib/xml/Commentable.html#setComments(java.lang.String[])">setComments</a></code> in interface <code><a href="../../../../org/apache/openjpa/lib/xml/Commentable.html" title="interface in org.apache.openjpa.lib.xml">Commentable</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="copy(org.apache.openjpa.meta.ClassMetaData)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>copy</h4> |
| <pre>public void copy(<a href="../../../../org/apache/openjpa/meta/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 name="addExtensionKeys(java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addExtensionKeys</h4> |
| <pre>protected void addExtensionKeys(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> exts)</pre> |
| <div class="block"><strong>Description copied from class: <code><a href="../../../../org/apache/openjpa/meta/Extensions.html#addExtensionKeys(java.util.Collection)">Extensions</a></code></strong></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><strong>Overrides:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/meta/Extensions.html#addExtensionKeys(java.util.Collection)">addExtensionKeys</a></code> in class <code><a href="../../../../org/apache/openjpa/meta/Extensions.html" title="class in org.apache.openjpa.meta">Extensions</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="registerForValueUpdate(java.lang.String...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>registerForValueUpdate</h4> |
| <pre>public void registerForValueUpdate(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... values)</pre> |
| </li> |
| </ul> |
| <a name="valueChanged(org.apache.openjpa.lib.conf.Value)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>valueChanged</h4> |
| <pre>public void valueChanged(<a href="../../../../org/apache/openjpa/lib/conf/Value.html" title="class in org.apache.openjpa.lib.conf">Value</a> val)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/lib/conf/ValueListener.html#valueChanged(org.apache.openjpa.lib.conf.Value)">ValueListener</a></code></strong></div> |
| <div class="block">Callback used by <a href="../../../../org/apache/openjpa/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><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/lib/conf/ValueListener.html#valueChanged(org.apache.openjpa.lib.conf.Value)">valueChanged</a></code> in interface <code><a href="../../../../org/apache/openjpa/lib/conf/ValueListener.html" title="interface in org.apache.openjpa.lib.conf">ValueListener</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFieldNames()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFieldNames</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">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 name="getDeclaredFieldNames()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDeclaredFieldNames</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">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 name="isAbstract()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isAbstract</h4> |
| <pre>public boolean isAbstract()</pre> |
| </li> |
| </ul> |
| <a name="setAbstract(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAbstract</h4> |
| <pre>public void setAbstract(boolean flag)</pre> |
| </li> |
| </ul> |
| <a name="hasAbstractPKField()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasAbstractPKField</h4> |
| <pre>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 name="hasPKFieldsFromAbstractClass()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasPKFieldsFromAbstractClass</h4> |
| <pre>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 name="setCacheEnabled(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCacheEnabled</h4> |
| <pre>public void setCacheEnabled(boolean enabled)</pre> |
| <div class="block">Sets the eligibility status of this class for cache.</div> |
| </li> |
| </ul> |
| <a name="getCacheEnabled()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCacheEnabled</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">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="strong">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 name="getSourceName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSourceName</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getSourceName()</pre> |
| </li> |
| </ul> |
| <a name="getPkAndNonPersistentManagedFmdIndexes()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPkAndNonPersistentManagedFmdIndexes</h4> |
| <pre>public int[] getPkAndNonPersistentManagedFmdIndexes()</pre> |
| </li> |
| </ul> |
| <a name="hasInverseManagedFields()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasInverseManagedFields</h4> |
| <pre>public boolean hasInverseManagedFields()</pre> |
| </li> |
| </ul> |
| <a name="getMappyedByIdFields()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMappyedByIdFields</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a>> getMappyedByIdFields()</pre> |
| </li> |
| </ul> |
| <a name="getUseSchemaElement()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUseSchemaElement</h4> |
| <pre>public boolean getUseSchemaElement()</pre> |
| <div class="block">Set whether to include schema name in generated class files</div> |
| </li> |
| </ul> |
| <a name="setUseSchemaElement(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setUseSchemaElement</h4> |
| <pre>public void setUseSchemaElement(boolean useSchemaElement)</pre> |
| <div class="block">Get whether to include schema name in generated class files</div> |
| </li> |
| </ul> |
| <a name="getIdClass()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getIdClass</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> getIdClass()</pre> |
| <div class="block">The class specified with the @IdClass annotation if used</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="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"> |
| <li><a href="../../../../org/apache/openjpa/meta/AccessCode.html" title="class in org.apache.openjpa.meta"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/openjpa/meta/DelegatingMetaDataFactory.html" title="class in org.apache.openjpa.meta"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/openjpa/meta/ClassMetaData.html" target="_top">Frames</a></li> |
| <li><a href="ClassMetaData.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field_summary">Field</a> | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2006–2018 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |