| <!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>FieldMetaData (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="FieldMetaData (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/FieldMetaData.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/FetchGroup.html" title="class in org.apache.openjpa.meta"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/openjpa/meta/FieldMetaData.MemberProvider.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/FieldMetaData.html" target="_top">Frames</a></li> |
| <li><a href="FieldMetaData.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><a href="#nested_class_summary">Nested</a> | </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 FieldMetaData" class="title">Class FieldMetaData</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.FieldMetaData</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="../../../../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>, <a href="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../org/apache/openjpa/jdbc/meta/FieldMapping.html" title="class in org.apache.openjpa.jdbc.meta">FieldMapping</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="strong">FieldMetaData</span> |
| extends <a href="../../../../org/apache/openjpa/meta/Extensions.html" title="class in org.apache.openjpa.meta">Extensions</a> |
| implements <a href="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</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></pre> |
| <div class="block">Metadata for a managed class field.</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.FieldMetaData">Serialized Form</a></dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested_class_summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.MemberProvider.html" title="class in org.apache.openjpa.meta">FieldMetaData.MemberProvider</a></strong></code> |
| <div class="block">Serializable wrapper around a <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/reflect/Method.html?is-external=true" title="class or interface in java.lang.reflect"><code>Method</code></a> or <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"><code>Field</code></a>.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- =========== 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/FieldMetaData.html#MANAGE_NONE">MANAGE_NONE</a></strong></code> |
| <div class="block">Constant specifying the management level of a field.</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/FieldMetaData.html#MANAGE_PERSISTENT">MANAGE_PERSISTENT</a></strong></code> |
| <div class="block">Constant specifying the management level of a field.</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/FieldMetaData.html#MANAGE_TRANSACTIONAL">MANAGE_TRANSACTIONAL</a></strong></code> |
| <div class="block">Constant specifying the management level of a field.</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/FieldMetaData.html#MANY_TO_MANY">MANY_TO_MANY</a></strong></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#MANY_TO_ONE">MANY_TO_ONE</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/FieldMetaData.html#NULL_DEFAULT">NULL_DEFAULT</a></strong></code> |
| <div class="block">Constant specifying to use a datastore default value to persist null |
| values in object fields.</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/FieldMetaData.html#NULL_EXCEPTION">NULL_EXCEPTION</a></strong></code> |
| <div class="block">Constant specifying to throw an exception when attempting to persist |
| null values in object fields.</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/FieldMetaData.html#NULL_NONE">NULL_NONE</a></strong></code> |
| <div class="block">Constant specifying to use a datastore null to persist null values |
| in object fields.</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/FieldMetaData.html#NULL_UNSET">NULL_UNSET</a></strong></code> |
| <div class="block">Constant specifying that no null-value was given.</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/FieldMetaData.html#ONE_TO_MANY">ONE_TO_MANY</a></strong></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#ONE_TO_ONE">ONE_TO_ONE</a></strong></code> </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.meta.ValueMetaData"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.openjpa.meta.<a href="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a></h3> |
| <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#CASCADE_AUTO">CASCADE_AUTO</a>, <a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#CASCADE_IMMEDIATE">CASCADE_IMMEDIATE</a>, <a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#CASCADE_NONE">CASCADE_NONE</a>, <a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#MAPPED_BY_PK">MAPPED_BY_PK</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/FieldMetaData.html#FieldMetaData(java.lang.String,%20java.lang.Class,%20org.apache.openjpa.meta.ClassMetaData)">FieldMetaData</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="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a> owner)</code> |
| <div class="block">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/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#addEmbeddedMetaData()">addEmbeddedMetaData</a></strong>()</code> |
| <div class="block">Add embedded metadata for this value.</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/FieldMetaData.html#addEmbeddedMetaData(int)">addEmbeddedMetaData</a></strong>(int access)</code> |
| <div class="block">Add embedded metadata for this value with the given access type</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/FieldMetaData.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>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#backingMember(java.lang.reflect.Member)">backingMember</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/reflect/Member.html?is-external=true" title="class or interface in java.lang.reflect">Member</a> member)</code> |
| <div class="block">Supply the backing member object; this allows us to utilize |
| parameterized type information if available.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#compareTo(java.lang.Object)">compareTo</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>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#copy(org.apache.openjpa.meta.FieldMetaData)">copy</a></strong>(<a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a> field)</code> |
| <div class="block">Copy state from the given field to this one.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#copy(org.apache.openjpa.meta.ValueMetaData)">copy</a></strong>(<a href="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a> vmd)</code> |
| <div class="block">Copy state from the given value to this one.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.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="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#getAccessType()">getAccessType</a></strong>()</code> |
| <div class="block">Gets the access type used by this field.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#getAssociationType()">getAssociationType</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/reflect/Member.html?is-external=true" title="class or interface in java.lang.reflect">Member</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#getBackingMember()">getBackingMember</a></strong>()</code> |
| <div class="block">Return the backing member supplied in <a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#backingMember(java.lang.reflect.Member)"><code>backingMember(java.lang.reflect.Member)</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#getCascadeAttach()">getCascadeAttach</a></strong>()</code> |
| <div class="block">Cascade behavior for attach operation.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#getCascadeDelete()">getCascadeDelete</a></strong>()</code> |
| <div class="block">Cascade behavior for delete operation.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#getCascadeDetach()">getCascadeDetach</a></strong>()</code> |
| <div class="block">Cascade behavior for detach operation.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#getCascadePersist()">getCascadePersist</a></strong>()</code> |
| <div class="block">Cascade behavior for persist operation.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#getCascadeRefresh()">getCascadeRefresh</a></strong>()</code> |
| <div class="block">Cascade behavior for refresh operation.</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/FieldMetaData.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="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/FieldMetaData.html#getCustomFetchGroups()">getCustomFetchGroups</a></strong>()</code> |
| <div class="block">Gets the name of the custom fetch groups those are associated to this |
| receiver.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#getDeclaredIndex()">getDeclaredIndex</a></strong>()</code> |
| <div class="block">The relative index of this persistent/transactional field.</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/FieldMetaData.html#getDeclaredType()">getDeclaredType</a></strong>()</code> |
| <div class="block">Return the declared class of the value.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#getDeclaredTypeCode()">getDeclaredTypeCode</a></strong>()</code> |
| <div class="block">Return the declared type code of the value.</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/FieldMetaData.html#getDeclaredTypeMetaData()">getDeclaredTypeMetaData</a></strong>()</code> |
| <div class="block">Return metadata for the value's class, if the type is persistent.</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/FieldMetaData.html#getDeclaringMetaData()">getDeclaringMetaData</a></strong>()</code> |
| <div class="block">The declaring class.</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/FieldMetaData.html#getDeclaringType()">getDeclaringType</a></strong>()</code> |
| <div class="block">The declaring class.</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/FieldMetaData.html#getDefiningMetaData()">getDefiningMetaData</a></strong>()</code> |
| <div class="block">The class that defines the metadata for this field.</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/FieldMetaData.html#getElement()">getElement</a></strong>()</code> |
| <div class="block">Metadata about the element value.</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/FieldMetaData.html#getEmbeddedMetaData()">getEmbeddedMetaData</a></strong>()</code> |
| <div class="block">The embedded class metadata for the value.</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/FieldMetaData.html#getExternalizer()">getExternalizer</a></strong>()</code> |
| <div class="block">The name of this field's externalizer, 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/Method.html?is-external=true" title="class or interface in java.lang.reflect">Method</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#getExternalizerMethod()">getExternalizerMethod</a></strong>()</code> |
| <div class="block">The externalizer method.</div> |
| </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/FieldMetaData.html#getExternalValue(java.lang.Object,%20org.apache.openjpa.kernel.StoreContext)">getExternalValue</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> val, |
| <a href="../../../../org/apache/openjpa/kernel/StoreContext.html" title="interface in org.apache.openjpa.kernel">StoreContext</a> ctx)</code> |
| <div class="block">Convert the given field value to its external value through the |
| provided externalizer, or return the value as-is if no externalizer.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#getExternalValueMap()">getExternalValueMap</a></strong>()</code> |
| <div class="block">Return the mapping of field values to external values.</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/FieldMetaData.html#getExternalValues()">getExternalValues</a></strong>()</code> |
| <div class="block">Properties string mapping field values to external values.</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/FieldMetaData.html#getFactory()">getFactory</a></strong>()</code> |
| <div class="block">The name of this field's factory, 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/reflect/Member.html?is-external=true" title="class or interface in java.lang.reflect">Member</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#getFactoryMethod()">getFactoryMethod</a></strong>()</code> |
| <div class="block">The factory method or constructor.</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/FieldMetaData.html#getFieldMetaData()">getFieldMetaData</a></strong>()</code> |
| <div class="block">Return the owning field for this value.</div> |
| </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/FieldMetaData.html#getFieldValue(java.lang.Object,%20org.apache.openjpa.kernel.StoreContext)">getFieldValue</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> val, |
| <a href="../../../../org/apache/openjpa/kernel/StoreContext.html" title="interface in org.apache.openjpa.kernel">StoreContext</a> ctx)</code> |
| <div class="block">Return the result of passing the given external value through the |
| factory to get the field value.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#getFieldValueMap()">getFieldValueMap</a></strong>()</code> |
| <div class="block">Return the mapping of external values to field values.</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/FieldMetaData.html#getFullName()">getFullName</a></strong>()</code> |
| <div class="block"><strong>Deprecated.</strong> |
| <div class="block"><i>Use getFullName(boolean) instead.</i></div> |
| </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/FieldMetaData.html#getFullName(boolean)">getFullName</a></strong>(boolean embedOwner)</code> |
| <div class="block">The field name, qualified by the owning class and optionally the |
| embedding owner's name (if any).</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#getIndex()">getIndex</a></strong>()</code> |
| <div class="block">The absolute index of this persistent/transactional field.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <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/FieldMetaData.html#getInitializer()">getInitializer</a></strong>()</code> |
| <div class="block">The initializer used by the field, 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/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/FieldMetaData.html#getInverse()">getInverse</a></strong>()</code> |
| <div class="block">Logical inverse field.</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/FieldMetaData.html#getInverseMetaDatas()">getInverseMetaDatas</a></strong>()</code> |
| <div class="block">Return all inverses of this field.</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/FieldMetaData.html#getKey()">getKey</a></strong>()</code> |
| <div class="block">Metadata about the key value.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#getListingIndex()">getListingIndex</a></strong>()</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><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/FieldMetaData.html#getLoadFetchGroup()">getLoadFetchGroup</a></strong>()</code> |
| <div class="block">The fetch group that is to be loaded when this receiver is loaded, or |
| null if none set.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#getManagement()">getManagement</a></strong>()</code> |
| <div class="block">Return the management level for the field.</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/FieldMetaData.html#getMappedBy()">getMappedBy</a></strong>()</code> |
| <div class="block">The field that this field shares a mapping with.</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/FieldMetaData.html#getMappedByField(org.apache.openjpa.meta.ClassMetaData,%20java.lang.String)">getMappedByField</a></strong>(<a href="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a> meta, |
| <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> mappedBy)</code> </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/FieldMetaData.html#getMappedByIdValue()">getMappedByIdValue</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/FieldMetaData.html#getMappedByMetaData()">getMappedByMetaData</a></strong>()</code> |
| <div class="block">The field that this field shares a mapping with.</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/FieldMetaData.html#getName()">getName</a></strong>()</code> |
| <div class="block">The field name.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#getNullValue()">getNullValue</a></strong>()</code> |
| <div class="block">How the data store should treat null values for this field: |
| |
| <a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#NULL_UNSET"><code>NULL_UNSET</code></a>: no value supplied |
| <a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#NULL_NONE"><code>NULL_NONE</code></a>: leave null values as null in the data store |
| <a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#NULL_EXCEPTION"><code>NULL_EXCEPTION</code></a>: throw an exception if this field is null |
| at commit |
| <a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#NULL_DEFAULT"><code>NULL_DEFAULT</code></a>: use the database default if this field is |
| null at commit |
| Defaults to <a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#NULL_UNSET"><code>NULL_UNSET</code></a>.</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/FieldMetaData.html#getObjectIdFieldType()">getObjectIdFieldType</a></strong>()</code> |
| <div class="block">For a primary key field, return the type of the corresponding object id |
| class field.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#getObjectIdFieldTypeCode()">getObjectIdFieldTypeCode</a></strong>()</code> |
| <div class="block">For a primary key field, return the type of the corresponding object id |
| class field.</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/FieldMetaData.html#getOrderDeclaration()">getOrderDeclaration</a></strong>()</code> |
| <div class="block">String declaring the orderings for this field to be applied on load, |
| or null.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/meta/Order.html" title="interface in org.apache.openjpa.meta">Order</a>[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#getOrders()">getOrders</a></strong>()</code> |
| <div class="block">The orderings for this field to be applied on load, or empty array.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#getPrimaryKeyIndex()">getPrimaryKeyIndex</a></strong>()</code> |
| <div class="block">The absolute primary key index for this field, or -1 if not a primary |
| key.</div> |
| </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/FieldMetaData.html#getProxyType()">getProxyType</a></strong>()</code> |
| <div class="block">The type this field was initialized with, and therefore the |
| type to use for proxies when loading data into this field.</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/FieldMetaData.html#getRealName()">getRealName</a></strong>()</code> |
| <div class="block">The field name, qualified by the defining class.</div> |
| </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/FieldMetaData.html#getRelationType()">getRelationType</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <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/FieldMetaData.html#getRepository()">getRepository</a></strong>()</code> |
| <div class="block">The metadata repository.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#getResolve()">getResolve</a></strong>()</code> |
| <div class="block">Resolve mode for this field.</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/FieldMetaData.html#getSetterName()">getSetterName</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/FieldMetaData.html#getType()">getType</a></strong>()</code> |
| <div class="block">The value class.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#getTypeCode()">getTypeCode</a></strong>()</code> |
| <div class="block">The type code of the value class.</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/FieldMetaData.html#getTypeMetaData()">getTypeMetaData</a></strong>()</code> |
| <div class="block">The metadata for the value class, if the type is persistent.</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/FieldMetaData.html#getTypeOverride()">getTypeOverride</a></strong>()</code> |
| <div class="block">User-supplied type overriding assumed type based on field.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#getUpdateStrategy()">getUpdateStrategy</a></strong>()</code> |
| <div class="block">The strategy to use when updating the field.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#getUseSchemaElement()">getUseSchemaElement</a></strong>()</code> |
| <div class="block">Whether to include schema name in generated files</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <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/FieldMetaData.html#getValue()">getValue</a></strong>()</code> |
| <div class="block">MetaData about the field value.</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/FieldMetaData.html#getValueMappedBy()">getValueMappedBy</a></strong>()</code> |
| <div class="block">The field that this value shares a mapping with.</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/FieldMetaData.html#getValueMappedByMetaData()">getValueMappedByMetaData</a></strong>()</code> |
| <div class="block">The field that this value shares a mapping with.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <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/FieldMetaData.html#getValueSequenceMetaData()">getValueSequenceMetaData</a></strong>()</code> |
| <div class="block">Metadata for the value sequence.</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/FieldMetaData.html#getValueSequenceName()">getValueSequenceName</a></strong>()</code> |
| <div class="block">The value sequence name, or null for none.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#getValueStrategy()">getValueStrategy</a></strong>()</code> |
| <div class="block">The strategy to use for insert value generation.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.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/FieldMetaData.html#isDeclaredTypePC()">isDeclaredTypePC</a></strong>()</code> |
| <div class="block">Whether the type is a persistence capable instance.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#isDefaultFetchGroupExplicit()">isDefaultFetchGroupExplicit</a></strong>()</code> |
| <div class="block">Whether the default fetch group setting is explicit.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#isDelayCapable()">isDelayCapable</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/FieldMetaData.html#isElementCollection()">isElementCollection</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/FieldMetaData.html#isEmbedded()">isEmbedded</a></strong>()</code> |
| <div class="block">This attribute is a hint to the implementation to store this value |
| in the same structure as the class, rather than as a separate datastore |
| structure.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#isEmbeddedPC()">isEmbeddedPC</a></strong>()</code> |
| <div class="block">Whether this is an embedded persistence capable value.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#isExplicit()">isExplicit</a></strong>()</code> |
| <div class="block">Whether this field is explicitly declared in the 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/FieldMetaData.html#isExternalized()">isExternalized</a></strong>()</code> |
| <div class="block">Whether the field is externalized.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#isInDefaultFetchGroup()">isInDefaultFetchGroup</a></strong>()</code> |
| <div class="block">Whether this field is in the default 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/FieldMetaData.html#isInFetchGroup(java.lang.String)">isInFetchGroup</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> fg)</code> |
| <div class="block">Whether this field is in the given fetch group.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#isLRS()">isLRS</a></strong>()</code> |
| <div class="block">Whether this field is backed by a large result set.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#isMapped()">isMapped</a></strong>()</code> |
| <div class="block">Return whether this field 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/FieldMetaData.html#isMappedById()">isMappedById</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/FieldMetaData.html#isPersistentCollection()">isPersistentCollection</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/FieldMetaData.html#isPrimaryKey()">isPrimaryKey</a></strong>()</code> |
| <div class="block">Whether this is a primary key field.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#isSerialized()">isSerialized</a></strong>()</code> |
| <div class="block">Whether this value is serialized when stored.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#isStream()">isStream</a></strong>()</code> |
| <div class="block">Whether this field is backed by a stream.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#isTransient()">isTransient</a></strong>()</code> |
| <div class="block">Return whether this is a transient field.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#isTypePC()">isTypePC</a></strong>()</code> |
| <div class="block">Whether the type is a persistence capable instance.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#isUsedInOrderBy()">isUsedInOrderBy</a></strong>()</code> |
| <div class="block">Check if this field is used by other field as "order by" value.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#isValueGenerated()">isValueGenerated</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/FieldMetaData.html#isVersion()">isVersion</a></strong>()</code> |
| <div class="block">Whether this field holds optimistic version information.</div> |
| </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/FieldMetaData.html#order(java.lang.Object)">order</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> val)</code> |
| <div class="block">Order this field value when it is loaded.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#resolve(int)">resolve</a></strong>(int mode)</code> |
| <div class="block">Resolve and validate 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/FieldMetaData.html#setAccessType(int)">setAccessType</a></strong>(int fCode)</code> |
| <div class="block">Sets access type of this field.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#setAssociationType(int)">setAssociationType</a></strong>(int type)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#setCascadeAttach(int)">setCascadeAttach</a></strong>(int attach)</code> |
| <div class="block">Cascade behavior for attach operation.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#setCascadeDelete(int)">setCascadeDelete</a></strong>(int delete)</code> |
| <div class="block">Cascade behavior for deletion.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#setCascadeDetach(int)">setCascadeDetach</a></strong>(int detach)</code> |
| <div class="block">Cascade behavior for detach operation.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#setCascadePersist(int)">setCascadePersist</a></strong>(int persist)</code> |
| <div class="block">Cascade behavior for persist operation.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#setCascadePersist(int,%20boolean)">setCascadePersist</a></strong>(int cascade, |
| boolean checkPUDefault)</code> |
| <div class="block">Cascade behavior for persist operation.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#setCascadeRefresh(int)">setCascadeRefresh</a></strong>(int refresh)</code> |
| <div class="block">Cascade behavior for refresh operation.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.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="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#setDeclaredIndex(int)">setDeclaredIndex</a></strong>(int index)</code> |
| <div class="block">The relative index of this persistent/transactional 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/FieldMetaData.html#setDeclaredType(java.lang.Class)">setDeclaredType</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 declared class of the value.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#setDeclaredTypeCode(int)">setDeclaredTypeCode</a></strong>(int type)</code> |
| <div class="block">Set the type code for the value.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#setDeclaringType(java.lang.Class)">setDeclaringType</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)</code> |
| <div class="block">The declaring 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/FieldMetaData.html#setDefaultFetchGroupExplicit(boolean)">setDefaultFetchGroupExplicit</a></strong>(boolean explicit)</code> |
| <div class="block">Whether the default fetch group setting is explicit.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#setDelayCapable(java.lang.Boolean)">setDelayCapable</a></strong>(<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> delayCapable)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#setElementCollection(boolean)">setElementCollection</a></strong>(boolean isElementCollection)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#setEmbedded(boolean)">setEmbedded</a></strong>(boolean embedded)</code> |
| <div class="block">This attribute is a hint to the implementation to store this value |
| in the same structure as the class, rather than as a separate datastore |
| structure.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#setExplicit(boolean)">setExplicit</a></strong>(boolean explicit)</code> |
| <div class="block">Whether this field is explicitly declared 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/FieldMetaData.html#setExternalizer(java.lang.String)">setExternalizer</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> externalizer)</code> |
| <div class="block">The name of this field's externalizer, 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/FieldMetaData.html#setExternalValues(java.lang.String)">setExternalValues</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> |
| <div class="block">Properties string mapping field values to external values.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#setFactory(java.lang.String)">setFactory</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> factory)</code> |
| <div class="block">The name of this field's factory, 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/FieldMetaData.html#setInDefaultFetchGroup(boolean)">setInDefaultFetchGroup</a></strong>(boolean dfg)</code> |
| <div class="block">Whether this field is in the default fetch group.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#setIndex(int)">setIndex</a></strong>(int index)</code> |
| <div class="block">The absolute index of this persistent/transactional field.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#setInFetchGroup(java.lang.String,%20boolean)">setInFetchGroup</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> fg, |
| boolean in)</code> |
| <div class="block">Set whether this field is in the given fetch group.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#setInitializer(java.lang.Object)">setInitializer</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> initializer)</code> |
| <div class="block">The initializer used by the 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/FieldMetaData.html#setInverse(java.lang.String)">setInverse</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> inverse)</code> |
| <div class="block">Logical inverse 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/FieldMetaData.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="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#setLoadFetchGroup(java.lang.String)">setLoadFetchGroup</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> lfg)</code> |
| <div class="block">The fetch group that is to be loaded when this receiver is loaded, or |
| null if none set.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#setLRS(boolean)">setLRS</a></strong>(boolean lrs)</code> |
| <div class="block">Whether this field is backed by a large result set.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#setManagement(int)">setManagement</a></strong>(int manage)</code> |
| <div class="block">Return the management level for the 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/FieldMetaData.html#setMappedBy(java.lang.String)">setMappedBy</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> mapped)</code> |
| <div class="block">The field that this field shares a mapping with.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#setMappedByIdValue(java.lang.String)">setMappedByIdValue</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> mappedByIdValue)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#setNullValue(int)">setNullValue</a></strong>(int nullValue)</code> |
| <div class="block">How the data store should treat null values for this field: |
| |
| <a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#NULL_UNSET"><code>NULL_UNSET</code></a>: no value supplied |
| <a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#NULL_NONE"><code>NULL_NONE</code></a>: leave null values as null in the data store |
| <a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#NULL_EXCEPTION"><code>NULL_EXCEPTION</code></a>: throw an exception if this field is null |
| at commit |
| <a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#NULL_DEFAULT"><code>NULL_DEFAULT</code></a>: use the database default if this field is |
| null at commit |
| Defaults to <a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#NULL_UNSET"><code>NULL_UNSET</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#setOrderDeclaration(java.lang.String)">setOrderDeclaration</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> dec)</code> |
| <div class="block">String declaring the orderings for this field to be applied on load, |
| or null.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#setOrders(org.apache.openjpa.meta.Order[])">setOrders</a></strong>(<a href="../../../../org/apache/openjpa/meta/Order.html" title="interface in org.apache.openjpa.meta">Order</a>[] orders)</code> |
| <div class="block">The orderings for this field to be applied on load.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#setPersistentCollection(boolean)">setPersistentCollection</a></strong>(boolean persistentCollection)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#setPrimaryKey(boolean)">setPrimaryKey</a></strong>(boolean primKey)</code> |
| <div class="block">Whether this is a primary key field.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#setPrimaryKeyIndex(int)">setPrimaryKeyIndex</a></strong>(int index)</code> |
| <div class="block">The absolute primary key index for this field, or -1 if not a primary |
| key.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#setProxyType(java.lang.Class)">setProxyType</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">The type this field was initialized with, and therefore the |
| type to use for proxies when loading data into this field.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#setResolve(int)">setResolve</a></strong>(int mode)</code> |
| <div class="block">Resolve mode for this 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/FieldMetaData.html#setResolve(int,%20boolean)">setResolve</a></strong>(int mode, |
| boolean on)</code> |
| <div class="block">Resolve mode for this field.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#setSerialized(boolean)">setSerialized</a></strong>(boolean serialized)</code> |
| <div class="block">Whether this value is serialized when stored.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#setStream(boolean)">setStream</a></strong>(boolean stream)</code> |
| <div class="block">Whether this field is backed by a stream.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#setTransient(boolean)">setTransient</a></strong>(boolean trans)</code> |
| <div class="block">Return whether this is a transient 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/FieldMetaData.html#setType(java.lang.Class)">setType</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">The value 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/FieldMetaData.html#setTypeCode(int)">setTypeCode</a></strong>(int code)</code> |
| <div class="block">The type code of the value class.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#setTypeOverride(java.lang.Class)">setTypeOverride</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">User-supplied type overriding assumed type based on field.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#setUpdateStrategy(int)">setUpdateStrategy</a></strong>(int strategy)</code> |
| <div class="block">Set the update strategy.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#setUsedInOrderBy(boolean)">setUsedInOrderBy</a></strong>(boolean isUsed)</code> |
| <div class="block">Whether this field is used by other field as "order by" value .</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#setUseSchemaElement(boolean)">setUseSchemaElement</a></strong>(boolean _useSchemaElement)</code> |
| <div class="block">Whether to include schema name in generated files</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#setUsesImplData(java.lang.Boolean)">setUsesImplData</a></strong>(<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> implData)</code> |
| <div class="block">Whether this field uses impl data in conjunction with standard |
| field data when acting on a <a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel"><code>OpenJPAStateManager</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#setUsesIntermediate(boolean)">setUsesIntermediate</a></strong>(boolean intermediate)</code> |
| <div class="block">Whether this field uses intermediate data when loading/storing |
| information through a <a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel"><code>OpenJPAStateManager</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#setValueGenerated(boolean)">setValueGenerated</a></strong>(boolean generated)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#setValueMappedBy(java.lang.String)">setValueMappedBy</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> mapped)</code> |
| <div class="block">The field that this value shares a mapping with.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#setValueSequenceName(java.lang.String)">setValueSequenceName</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 value 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/FieldMetaData.html#setValueStrategy(int)">setValueStrategy</a></strong>(int strategy)</code> |
| <div class="block">The strategy to use for insert value 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/FieldMetaData.html#setVersion(boolean)">setVersion</a></strong>(boolean version)</code> |
| <div class="block">Whether this field holds optimistic version information.</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/FieldMetaData.html#toString()">toString</a></strong>()</code> </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/FieldMetaData.html#usesImplData()">usesImplData</a></strong>()</code> |
| <div class="block">Whether this field uses impl data in conjunction with standard |
| field data when acting on a <a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel"><code>OpenJPAStateManager</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#usesIntermediate()">usesIntermediate</a></strong>()</code> |
| <div class="block">Whether this field uses intermediate data when loading/storing |
| information through a <a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel"><code>OpenJPAStateManager</code></a>.</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="NULL_UNSET"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>NULL_UNSET</h4> |
| <pre>public static final int NULL_UNSET</pre> |
| <div class="block">Constant specifying that no null-value was given.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.openjpa.meta.FieldMetaData.NULL_UNSET">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="NULL_NONE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>NULL_NONE</h4> |
| <pre>public static final int NULL_NONE</pre> |
| <div class="block">Constant specifying to use a datastore null to persist null values |
| in object fields.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.openjpa.meta.FieldMetaData.NULL_NONE">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="NULL_DEFAULT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>NULL_DEFAULT</h4> |
| <pre>public static final int NULL_DEFAULT</pre> |
| <div class="block">Constant specifying to use a datastore default value to persist null |
| values in object fields.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.openjpa.meta.FieldMetaData.NULL_DEFAULT">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="NULL_EXCEPTION"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>NULL_EXCEPTION</h4> |
| <pre>public static final int NULL_EXCEPTION</pre> |
| <div class="block">Constant specifying to throw an exception when attempting to persist |
| null values in object fields.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.openjpa.meta.FieldMetaData.NULL_EXCEPTION">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="MANAGE_PERSISTENT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>MANAGE_PERSISTENT</h4> |
| <pre>public static final int MANAGE_PERSISTENT</pre> |
| <div class="block">Constant specifying the management level of a field.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.openjpa.meta.FieldMetaData.MANAGE_PERSISTENT">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="MANAGE_TRANSACTIONAL"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>MANAGE_TRANSACTIONAL</h4> |
| <pre>public static final int MANAGE_TRANSACTIONAL</pre> |
| <div class="block">Constant specifying the management level of a field.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.openjpa.meta.FieldMetaData.MANAGE_TRANSACTIONAL">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="MANAGE_NONE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>MANAGE_NONE</h4> |
| <pre>public static final int MANAGE_NONE</pre> |
| <div class="block">Constant specifying the management level of a field.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.openjpa.meta.FieldMetaData.MANAGE_NONE">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="ONE_TO_ONE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ONE_TO_ONE</h4> |
| <pre>public static final int ONE_TO_ONE</pre> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.openjpa.meta.FieldMetaData.ONE_TO_ONE">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="ONE_TO_MANY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ONE_TO_MANY</h4> |
| <pre>public static final int ONE_TO_MANY</pre> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.openjpa.meta.FieldMetaData.ONE_TO_MANY">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="MANY_TO_ONE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>MANY_TO_ONE</h4> |
| <pre>public static final int MANY_TO_ONE</pre> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.openjpa.meta.FieldMetaData.MANY_TO_ONE">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="MANY_TO_MANY"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>MANY_TO_MANY</h4> |
| <pre>public static final int MANY_TO_MANY</pre> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.openjpa.meta.FieldMetaData.MANY_TO_MANY">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="FieldMetaData(java.lang.String, java.lang.Class, org.apache.openjpa.meta.ClassMetaData)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>FieldMetaData</h4> |
| <pre>protected FieldMetaData(<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="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a> owner)</pre> |
| <div class="block">Constructor.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the field name</dd><dd><code>type</code> - the field type</dd><dd><code>owner</code> - the owning class metadata</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="backingMember(java.lang.reflect.Member)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>backingMember</h4> |
| <pre>public void backingMember(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/reflect/Member.html?is-external=true" title="class or interface in java.lang.reflect">Member</a> member)</pre> |
| <div class="block">Supply the backing member object; this allows us to utilize |
| parameterized type information if available. |
| Sets the access style of this receiver based on whether the given |
| member represents a field or getter method.</div> |
| </li> |
| </ul> |
| <a name="getBackingMember()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBackingMember</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/reflect/Member.html?is-external=true" title="class or interface in java.lang.reflect">Member</a> getBackingMember()</pre> |
| <div class="block">Return the backing member supplied in <a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#backingMember(java.lang.reflect.Member)"><code>backingMember(java.lang.reflect.Member)</code></a>.</div> |
| </li> |
| </ul> |
| <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">The metadata 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="getDefiningMetaData()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDefiningMetaData</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a> getDefiningMetaData()</pre> |
| <div class="block">The class that defines the metadata for this field.</div> |
| </li> |
| </ul> |
| <a name="getDeclaringType()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDeclaringType</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><?> getDeclaringType()</pre> |
| <div class="block">The declaring class.</div> |
| </li> |
| </ul> |
| <a name="setDeclaringType(java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDeclaringType</h4> |
| <pre>public void setDeclaringType(<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)</pre> |
| <div class="block">The declaring class.</div> |
| </li> |
| </ul> |
| <a name="getDeclaringMetaData()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDeclaringMetaData</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a> getDeclaringMetaData()</pre> |
| <div class="block">The declaring class.</div> |
| </li> |
| </ul> |
| <a name="getName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getName</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> getName()</pre> |
| <div class="block">The field name.</div> |
| </li> |
| </ul> |
| <a name="getFullName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFullName</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> getFullName()</pre> |
| <div class="block"><span class="strong">Deprecated.</span> <i>Use getFullName(boolean) instead.</i></div> |
| <div class="block">The field name, qualified by the owning class.</div> |
| </li> |
| </ul> |
| <a name="getFullName(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFullName</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> getFullName(boolean embedOwner)</pre> |
| <div class="block">The field name, qualified by the owning class and optionally the |
| embedding owner's name (if any).</div> |
| </li> |
| </ul> |
| <a name="getRealName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRealName</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> getRealName()</pre> |
| <div class="block">The field name, qualified by the defining class.</div> |
| </li> |
| </ul> |
| <a name="getValue()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValue</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a> getValue()</pre> |
| <div class="block">MetaData about the field value.</div> |
| </li> |
| </ul> |
| <a name="getKey()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getKey</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a> getKey()</pre> |
| <div class="block">Metadata about the key value.</div> |
| </li> |
| </ul> |
| <a name="getElement()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getElement</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a> getElement()</pre> |
| <div class="block">Metadata about the element value.</div> |
| </li> |
| </ul> |
| <a name="isMapped()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isMapped</h4> |
| <pre>public boolean isMapped()</pre> |
| <div class="block">Return whether this field is mapped to the datastore. By default, |
| returns true for all persistent fields whose defining class is mapped.</div> |
| </li> |
| </ul> |
| <a name="getProxyType()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProxyType</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><?> getProxyType()</pre> |
| <div class="block">The type this field was initialized with, and therefore the |
| type to use for proxies when loading data into this field.</div> |
| </li> |
| </ul> |
| <a name="setProxyType(java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setProxyType</h4> |
| <pre>public void setProxyType(<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">The type this field was initialized with, and therefore the |
| type to use for proxies when loading data into this field.</div> |
| </li> |
| </ul> |
| <a name="getInitializer()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInitializer</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> getInitializer()</pre> |
| <div class="block">The initializer used by the field, or null if none. This |
| is additional information for initializing the field, such as |
| a custom <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util"><code>Comparator</code></a> used by a <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util"><code>Set</code></a> or |
| a <a href="http://docs.oracle.com/javase/6/docs/api/java/util/TimeZone.html?is-external=true" title="class or interface in java.util"><code>TimeZone</code></a> used by a <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Calendar.html?is-external=true" title="class or interface in java.util"><code>Calendar</code></a>.</div> |
| </li> |
| </ul> |
| <a name="setInitializer(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setInitializer</h4> |
| <pre>public void setInitializer(<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> initializer)</pre> |
| <div class="block">The initializer used by the field, or null if none. This |
| is additional information for initializing the field, such as |
| a custom <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util"><code>Comparator</code></a> used by a <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util"><code>Set</code></a> or |
| a <a href="http://docs.oracle.com/javase/6/docs/api/java/util/TimeZone.html?is-external=true" title="class or interface in java.util"><code>TimeZone</code></a> used by a <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Calendar.html?is-external=true" title="class or interface in java.util"><code>Calendar</code></a>.</div> |
| </li> |
| </ul> |
| <a name="isTransient()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isTransient</h4> |
| <pre>public boolean isTransient()</pre> |
| <div class="block">Return whether this is a transient field.</div> |
| </li> |
| </ul> |
| <a name="setTransient(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTransient</h4> |
| <pre>public void setTransient(boolean trans)</pre> |
| <div class="block">Return whether this is a transient field.</div> |
| </li> |
| </ul> |
| <a name="getIndex()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIndex</h4> |
| <pre>public int getIndex()</pre> |
| <div class="block">The absolute index of this persistent/transactional field.</div> |
| </li> |
| </ul> |
| <a name="setIndex(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIndex</h4> |
| <pre>public void setIndex(int index)</pre> |
| <div class="block">The absolute index of this persistent/transactional field.</div> |
| </li> |
| </ul> |
| <a name="getDeclaredIndex()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDeclaredIndex</h4> |
| <pre>public int getDeclaredIndex()</pre> |
| <div class="block">The relative index of this persistent/transactional field.</div> |
| </li> |
| </ul> |
| <a name="setDeclaredIndex(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDeclaredIndex</h4> |
| <pre>public void setDeclaredIndex(int index)</pre> |
| <div class="block">The relative index of this persistent/transactional field.</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 field was listed in the metadata. Defaults to |
| <code>-1</code> if this field 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 field was not listed in the metadata.</div> |
| </li> |
| </ul> |
| <a name="getPrimaryKeyIndex()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPrimaryKeyIndex</h4> |
| <pre>public int getPrimaryKeyIndex()</pre> |
| <div class="block">The absolute primary key index for this field, or -1 if not a primary |
| key. The first primary key field has index 0, the second index 1, etc.</div> |
| </li> |
| </ul> |
| <a name="setPrimaryKeyIndex(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPrimaryKeyIndex</h4> |
| <pre>public void setPrimaryKeyIndex(int index)</pre> |
| <div class="block">The absolute primary key index for this field, or -1 if not a primary |
| key. The first primary key field has index 0, the second index 1, etc.</div> |
| </li> |
| </ul> |
| <a name="getManagement()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getManagement</h4> |
| <pre>public int getManagement()</pre> |
| <div class="block">Return the management level for the field. Will be one of: |
| <ul> |
| <li><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#MANAGE_PERSISTENT"><code>MANAGE_PERSISTENT</code></a>: the field is persistent</li> |
| <li><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#MANAGE_TRANSACTIONAL"><code>MANAGE_TRANSACTIONAL</code></a>: the field is transactional but not |
| persistent</li> |
| <li><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#MANAGE_NONE"><code>MANAGE_NONE</code></a>: the field is not managed</li> |
| </ul> Defaults to <a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#MANAGE_PERSISTENT"><code>MANAGE_PERSISTENT</code></a>.</div> |
| </li> |
| </ul> |
| <a name="setManagement(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setManagement</h4> |
| <pre>public void setManagement(int manage)</pre> |
| <div class="block">Return the management level for the field. Will be one of: |
| <ul> |
| <li><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#MANAGE_PERSISTENT"><code>MANAGE_PERSISTENT</code></a>: the field is persistent</li> |
| <li><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#MANAGE_TRANSACTIONAL"><code>MANAGE_TRANSACTIONAL</code></a>: the field is transactional but not |
| persistent</li> |
| <li><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#MANAGE_NONE"><code>MANAGE_NONE</code></a>: the field is not managed</li> |
| </ul> |
| Defaults to <a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#MANAGE_PERSISTENT"><code>MANAGE_PERSISTENT</code></a>.</div> |
| </li> |
| </ul> |
| <a name="isPrimaryKey()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isPrimaryKey</h4> |
| <pre>public boolean isPrimaryKey()</pre> |
| <div class="block">Whether this is a primary key field.</div> |
| </li> |
| </ul> |
| <a name="setPrimaryKey(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPrimaryKey</h4> |
| <pre>public void setPrimaryKey(boolean primKey)</pre> |
| <div class="block">Whether this is a primary key field.</div> |
| </li> |
| </ul> |
| <a name="getObjectIdFieldTypeCode()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getObjectIdFieldTypeCode</h4> |
| <pre>public int getObjectIdFieldTypeCode()</pre> |
| <div class="block">For a primary key field, return the type of the corresponding object id |
| class field.</div> |
| </li> |
| </ul> |
| <a name="getObjectIdFieldType()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getObjectIdFieldType</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><?> getObjectIdFieldType()</pre> |
| <div class="block">For a primary key field, return the type of the corresponding object id |
| class field.</div> |
| </li> |
| </ul> |
| <a name="isVersion()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isVersion</h4> |
| <pre>public boolean isVersion()</pre> |
| <div class="block">Whether this field holds optimistic version information.</div> |
| </li> |
| </ul> |
| <a name="setVersion(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setVersion</h4> |
| <pre>public void setVersion(boolean version)</pre> |
| <div class="block">Whether this field holds optimistic version information.</div> |
| </li> |
| </ul> |
| <a name="isInDefaultFetchGroup()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isInDefaultFetchGroup</h4> |
| <pre>public boolean isInDefaultFetchGroup()</pre> |
| <div class="block">Whether this field is in the default fetch group.</div> |
| </li> |
| </ul> |
| <a name="setInDefaultFetchGroup(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setInDefaultFetchGroup</h4> |
| <pre>public void setInDefaultFetchGroup(boolean dfg)</pre> |
| <div class="block">Whether this field is in the default fetch group.</div> |
| </li> |
| </ul> |
| <a name="isDefaultFetchGroupExplicit()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDefaultFetchGroupExplicit</h4> |
| <pre>public boolean isDefaultFetchGroupExplicit()</pre> |
| <div class="block">Whether the default fetch group setting is explicit.</div> |
| </li> |
| </ul> |
| <a name="setDefaultFetchGroupExplicit(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDefaultFetchGroupExplicit</h4> |
| <pre>public void setDefaultFetchGroupExplicit(boolean explicit)</pre> |
| <div class="block">Whether the default fetch group setting is explicit. Allow setting |
| for testing.</div> |
| </li> |
| </ul> |
| <a name="getCustomFetchGroups()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCustomFetchGroups</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>[] getCustomFetchGroups()</pre> |
| <div class="block">Gets the name of the custom fetch groups those are associated to this |
| receiver. This does not include the "default" and "all" fetch groups.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the set of fetch group names, not including the default and |
| all fetch groups.</dd></dl> |
| </li> |
| </ul> |
| <a name="getLoadFetchGroup()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLoadFetchGroup</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> getLoadFetchGroup()</pre> |
| <div class="block">The fetch group that is to be loaded when this receiver is loaded, or |
| null if none set.</div> |
| </li> |
| </ul> |
| <a name="setLoadFetchGroup(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLoadFetchGroup</h4> |
| <pre>public void setLoadFetchGroup(<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> lfg)</pre> |
| <div class="block">The fetch group that is to be loaded when this receiver is loaded, or |
| null if none set.</div> |
| </li> |
| </ul> |
| <a name="isInFetchGroup(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isInFetchGroup</h4> |
| <pre>public boolean isInFetchGroup(<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> fg)</pre> |
| <div class="block">Whether this field is in the given fetch group.</div> |
| </li> |
| </ul> |
| <a name="setInFetchGroup(java.lang.String, boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setInFetchGroup</h4> |
| <pre>public void setInFetchGroup(<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> fg, |
| boolean in)</pre> |
| <div class="block">Set whether this field is in the given fetch group.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>fg</code> - is the name of a fetch group that must be present in the |
| class that declared this field or any of its persistent superclasses.</dd></dl> |
| </li> |
| </ul> |
| <a name="getNullValue()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNullValue</h4> |
| <pre>public int getNullValue()</pre> |
| <div class="block">How the data store should treat null values for this field: |
| <ul> |
| <li><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#NULL_UNSET"><code>NULL_UNSET</code></a>: no value supplied</li> |
| <li><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#NULL_NONE"><code>NULL_NONE</code></a>: leave null values as null in the data store</li> |
| <li><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#NULL_EXCEPTION"><code>NULL_EXCEPTION</code></a>: throw an exception if this field is null |
| at commit</li> |
| <li><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#NULL_DEFAULT"><code>NULL_DEFAULT</code></a>: use the database default if this field is |
| null at commit</li> |
| </ul> Defaults to <a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#NULL_UNSET"><code>NULL_UNSET</code></a>.</div> |
| </li> |
| </ul> |
| <a name="setNullValue(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setNullValue</h4> |
| <pre>public void setNullValue(int nullValue)</pre> |
| <div class="block">How the data store should treat null values for this field: |
| <ul> |
| <li><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#NULL_UNSET"><code>NULL_UNSET</code></a>: no value supplied</li> |
| <li><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#NULL_NONE"><code>NULL_NONE</code></a>: leave null values as null in the data store</li> |
| <li><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#NULL_EXCEPTION"><code>NULL_EXCEPTION</code></a>: throw an exception if this field is null |
| at commit</li> |
| <li><a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#NULL_DEFAULT"><code>NULL_DEFAULT</code></a>: use the database default if this field is |
| null at commit</li> |
| </ul> Defaults to <a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#NULL_UNSET"><code>NULL_UNSET</code></a>.</div> |
| </li> |
| </ul> |
| <a name="isExplicit()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isExplicit</h4> |
| <pre>public boolean isExplicit()</pre> |
| <div class="block">Whether this field is explicitly declared in the metadata.</div> |
| </li> |
| </ul> |
| <a name="setExplicit(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setExplicit</h4> |
| <pre>public void setExplicit(boolean explicit)</pre> |
| <div class="block">Whether this field is explicitly declared in the metadata.</div> |
| </li> |
| </ul> |
| <a name="getMappedBy()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMappedBy</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> getMappedBy()</pre> |
| <div class="block">The field that this field shares a mapping with.</div> |
| </li> |
| </ul> |
| <a name="setMappedBy(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMappedBy</h4> |
| <pre>public void setMappedBy(<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> mapped)</pre> |
| <div class="block">The field that this field shares a mapping with.</div> |
| </li> |
| </ul> |
| <a name="getMappedByMetaData()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMappedByMetaData</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a> getMappedByMetaData()</pre> |
| <div class="block">The field that this field shares a mapping with.</div> |
| </li> |
| </ul> |
| <a name="getMappedByField(org.apache.openjpa.meta.ClassMetaData, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMappedByField</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a> getMappedByField(<a href="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a> meta, |
| <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> mappedBy)</pre> |
| </li> |
| </ul> |
| <a name="getInverse()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInverse</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> getInverse()</pre> |
| <div class="block">Logical inverse field.</div> |
| </li> |
| </ul> |
| <a name="setInverse(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setInverse</h4> |
| <pre>public void setInverse(<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> inverse)</pre> |
| <div class="block">Logical inverse field.</div> |
| </li> |
| </ul> |
| <a name="getInverseMetaDatas()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInverseMetaDatas</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a>[] getInverseMetaDatas()</pre> |
| <div class="block">Return all inverses of this field.</div> |
| </li> |
| </ul> |
| <a name="getValueStrategy()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValueStrategy</h4> |
| <pre>public int getValueStrategy()</pre> |
| <div class="block">The strategy to use for insert value 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="setValueStrategy(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setValueStrategy</h4> |
| <pre>public void setValueStrategy(int strategy)</pre> |
| <div class="block">The strategy to use for insert value 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="getValueSequenceName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValueSequenceName</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> getValueSequenceName()</pre> |
| <div class="block">The value sequence name, or null for none.</div> |
| </li> |
| </ul> |
| <a name="setValueSequenceName(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setValueSequenceName</h4> |
| <pre>public void setValueSequenceName(<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 value sequence name, or null for none.</div> |
| </li> |
| </ul> |
| <a name="getValueSequenceMetaData()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValueSequenceMetaData</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/meta/SequenceMetaData.html" title="class in org.apache.openjpa.meta">SequenceMetaData</a> getValueSequenceMetaData()</pre> |
| <div class="block">Metadata for the value sequence.</div> |
| </li> |
| </ul> |
| <a name="getUpdateStrategy()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUpdateStrategy</h4> |
| <pre>public int getUpdateStrategy()</pre> |
| <div class="block">The strategy to use when updating the field.</div> |
| </li> |
| </ul> |
| <a name="setUpdateStrategy(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setUpdateStrategy</h4> |
| <pre>public void setUpdateStrategy(int strategy)</pre> |
| <div class="block">Set the update strategy.</div> |
| </li> |
| </ul> |
| <a name="isLRS()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isLRS</h4> |
| <pre>public boolean isLRS()</pre> |
| <div class="block">Whether this field is backed by a large result set.</div> |
| </li> |
| </ul> |
| <a name="setLRS(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLRS</h4> |
| <pre>public void setLRS(boolean lrs)</pre> |
| <div class="block">Whether this field is backed by a large result set.</div> |
| </li> |
| </ul> |
| <a name="isStream()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isStream</h4> |
| <pre>public boolean isStream()</pre> |
| <div class="block">Whether this field is backed by a stream.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.1.0</dd></dl> |
| </li> |
| </ul> |
| <a name="setStream(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setStream</h4> |
| <pre>public void setStream(boolean stream)</pre> |
| <div class="block">Whether this field is backed by a stream.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.1.0</dd></dl> |
| </li> |
| </ul> |
| <a name="usesIntermediate()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>usesIntermediate</h4> |
| <pre>public boolean usesIntermediate()</pre> |
| <div class="block">Whether this field uses intermediate data when loading/storing |
| information through a <a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel"><code>OpenJPAStateManager</code></a>. Defaults to true.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#setIntermediate(int,%20java.lang.Object)"><code>OpenJPAStateManager.setIntermediate(int,Object)</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="setUsesIntermediate(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setUsesIntermediate</h4> |
| <pre>public void setUsesIntermediate(boolean intermediate)</pre> |
| <div class="block">Whether this field uses intermediate data when loading/storing |
| information through a <a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel"><code>OpenJPAStateManager</code></a>. Defaults to true.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#setIntermediate(int,%20java.lang.Object)"><code>OpenJPAStateManager.setIntermediate(int,Object)</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="usesImplData()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>usesImplData</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> usesImplData()</pre> |
| <div class="block">Whether this field uses impl data in conjunction with standard |
| field data when acting on a <a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel"><code>OpenJPAStateManager</code></a>. |
| Defaults to <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true#TRUE" title="class or interface in java.lang"><code>Boolean.TRUE</code></a> (non-cachable impl data).</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true#FALSE" title="class or interface in java.lang"><code>Boolean.FALSE</code></a> if this field does not use impl data, |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true#TRUE" title="class or interface in java.lang"><code>Boolean.TRUE</code></a> if this field uses non-cachable impl |
| data, or <code>null</code> if this field uses impl data that |
| should be cached across instances</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#setImplData(int,%20java.lang.Object)"><code>OpenJPAStateManager.setImplData(int,Object)</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="setUsesImplData(java.lang.Boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setUsesImplData</h4> |
| <pre>public void setUsesImplData(<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> implData)</pre> |
| <div class="block">Whether this field uses impl data in conjunction with standard |
| field data when acting on a <a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel"><code>OpenJPAStateManager</code></a>.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#setImplData(int,%20java.lang.Object)"><code>OpenJPAStateManager.setImplData(int,Object)</code></a>, |
| <a href="../../../../org/apache/openjpa/meta/FieldMetaData.html#usesImplData()"><code>usesImplData()</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="getOrders()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOrders</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/meta/Order.html" title="interface in org.apache.openjpa.meta">Order</a>[] getOrders()</pre> |
| <div class="block">The orderings for this field to be applied on load, or empty array.</div> |
| </li> |
| </ul> |
| <a name="setOrders(org.apache.openjpa.meta.Order[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setOrders</h4> |
| <pre>public void setOrders(<a href="../../../../org/apache/openjpa/meta/Order.html" title="interface in org.apache.openjpa.meta">Order</a>[] orders)</pre> |
| <div class="block">The orderings for this field to be applied on load.</div> |
| </li> |
| </ul> |
| <a name="getOrderDeclaration()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOrderDeclaration</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> getOrderDeclaration()</pre> |
| <div class="block">String declaring the orderings for this field to be applied on load, |
| or null. The string is of the form:<br /> |
| <code>orderable[ asc|desc][, ...]</code><br /> |
| The orderable <code>#element</code> is used to denote the value of |
| the field's elements.</div> |
| </li> |
| </ul> |
| <a name="setOrderDeclaration(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setOrderDeclaration</h4> |
| <pre>public void setOrderDeclaration(<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> dec)</pre> |
| <div class="block">String declaring the orderings for this field to be applied on load, |
| or null. The string is of the form:<br /> |
| <code>orderable[ asc|desc][, ...]</code><br /> |
| The orderable <code>#element</code> is used to denote the value of |
| the field's elements.</div> |
| </li> |
| </ul> |
| <a name="order(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>order</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> order(<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> val)</pre> |
| <div class="block">Order this field value when it is loaded.</div> |
| </li> |
| </ul> |
| <a name="isExternalized()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isExternalized</h4> |
| <pre>public boolean isExternalized()</pre> |
| <div class="block">Whether the field is externalized.</div> |
| </li> |
| </ul> |
| <a name="getExternalValue(java.lang.Object, org.apache.openjpa.kernel.StoreContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExternalValue</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> getExternalValue(<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> val, |
| <a href="../../../../org/apache/openjpa/kernel/StoreContext.html" title="interface in org.apache.openjpa.kernel">StoreContext</a> ctx)</pre> |
| <div class="block">Convert the given field value to its external value through the |
| provided externalizer, or return the value as-is if no externalizer.</div> |
| </li> |
| </ul> |
| <a name="getFieldValue(java.lang.Object, org.apache.openjpa.kernel.StoreContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFieldValue</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> getFieldValue(<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> val, |
| <a href="../../../../org/apache/openjpa/kernel/StoreContext.html" title="interface in org.apache.openjpa.kernel">StoreContext</a> ctx)</pre> |
| <div class="block">Return the result of passing the given external value through the |
| factory to get the field value. If no factory is present, |
| the given value is returned as-is.</div> |
| </li> |
| </ul> |
| <a name="getExternalizer()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExternalizer</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> getExternalizer()</pre> |
| <div class="block">The name of this field's externalizer, or null if none.</div> |
| </li> |
| </ul> |
| <a name="setExternalizer(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setExternalizer</h4> |
| <pre>public void setExternalizer(<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> externalizer)</pre> |
| <div class="block">The name of this field's externalizer, or null if none.</div> |
| </li> |
| </ul> |
| <a name="getFactory()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFactory</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> getFactory()</pre> |
| <div class="block">The name of this field's factory, or null if none.</div> |
| </li> |
| </ul> |
| <a name="setFactory(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFactory</h4> |
| <pre>public void setFactory(<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> factory)</pre> |
| <div class="block">The name of this field's factory, or null if none.</div> |
| </li> |
| </ul> |
| <a name="getExternalValues()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExternalValues</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> getExternalValues()</pre> |
| <div class="block">Properties string mapping field values to external values.</div> |
| </li> |
| </ul> |
| <a name="setExternalValues(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setExternalValues</h4> |
| <pre>public void setExternalValues(<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> |
| <div class="block">Properties string mapping field values to external values.</div> |
| </li> |
| </ul> |
| <a name="getExternalValueMap()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExternalValueMap</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> getExternalValueMap()</pre> |
| <div class="block">Return the mapping of field values to external values.</div> |
| </li> |
| </ul> |
| <a name="getFieldValueMap()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFieldValueMap</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> getFieldValueMap()</pre> |
| <div class="block">Return the mapping of external values to field values.</div> |
| </li> |
| </ul> |
| <a name="getExternalizerMethod()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExternalizerMethod</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/reflect/Method.html?is-external=true" title="class or interface in java.lang.reflect">Method</a> getExternalizerMethod()</pre> |
| <div class="block">The externalizer method.</div> |
| </li> |
| </ul> |
| <a name="getFactoryMethod()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFactoryMethod</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/reflect/Member.html?is-external=true" title="class or interface in java.lang.reflect">Member</a> getFactoryMethod()</pre> |
| <div class="block">The factory method or constructor.</div> |
| </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="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="compareTo(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>compareTo</h4> |
| <pre>public int compareTo(<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> |
| </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">Resolve mode for this field.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#getResolve()">getResolve</a></code> in interface <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a></code></dd> |
| </dl> |
| </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">Resolve mode for this field.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#setResolve(int)">setResolve</a></code> in interface <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a></code></dd> |
| </dl> |
| </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">Resolve mode for this field.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#setResolve(int,%20boolean)">setResolve</a></code> in interface <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a></code></dd> |
| </dl> |
| </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> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#resolve(int)">resolve</a></code> in interface <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="copy(org.apache.openjpa.meta.FieldMetaData)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>copy</h4> |
| <pre>public void copy(<a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a> field)</pre> |
| <div class="block">Copy state from the given field 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="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="getFieldMetaData()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFieldMetaData</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a> getFieldMetaData()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#getFieldMetaData()">ValueMetaData</a></code></strong></div> |
| <div class="block">Return the owning field for this value.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#getFieldMetaData()">getFieldMetaData</a></code> in interface <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getType()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getType</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> getType()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#getType()">ValueMetaData</a></code></strong></div> |
| <div class="block">The value class.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#getType()">getType</a></code> in interface <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setType(java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setType</h4> |
| <pre>public void setType(<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"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#setType(java.lang.Class)">ValueMetaData</a></code></strong></div> |
| <div class="block">The value class.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#setType(java.lang.Class)">setType</a></code> in interface <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTypeCode()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTypeCode</h4> |
| <pre>public int getTypeCode()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#getTypeCode()">ValueMetaData</a></code></strong></div> |
| <div class="block">The type code of the value class.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#getTypeCode()">getTypeCode</a></code> in interface <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setTypeCode(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTypeCode</h4> |
| <pre>public void setTypeCode(int code)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#setTypeCode(int)">ValueMetaData</a></code></strong></div> |
| <div class="block">The type code of the value class.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#setTypeCode(int)">setTypeCode</a></code> in interface <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isTypePC()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isTypePC</h4> |
| <pre>public boolean isTypePC()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#isTypePC()">ValueMetaData</a></code></strong></div> |
| <div class="block">Whether the type is a persistence capable instance.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#isTypePC()">isTypePC</a></code> in interface <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTypeMetaData()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTypeMetaData</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a> getTypeMetaData()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#getTypeMetaData()">ValueMetaData</a></code></strong></div> |
| <div class="block">The metadata for the value class, if the type is persistent.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#getTypeMetaData()">getTypeMetaData</a></code> in interface <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDeclaredType()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDeclaredType</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> getDeclaredType()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#getDeclaredType()">ValueMetaData</a></code></strong></div> |
| <div class="block">Return the declared class of the value. This can differ |
| from the return value of <a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#getType()"><code>ValueMetaData.getType()</code></a> if the user indicates |
| a different type or the value has an externalizer.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#getDeclaredType()">getDeclaredType</a></code> in interface <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setDeclaredType(java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDeclaredType</h4> |
| <pre>public void setDeclaredType(<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"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#setDeclaredType(java.lang.Class)">ValueMetaData</a></code></strong></div> |
| <div class="block">Set the declared class of the value.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#setDeclaredType(java.lang.Class)">setDeclaredType</a></code> in interface <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDeclaredTypeCode()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDeclaredTypeCode</h4> |
| <pre>public int getDeclaredTypeCode()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#getDeclaredTypeCode()">ValueMetaData</a></code></strong></div> |
| <div class="block">Return the declared type code of the value. This can differ |
| from the return value of <a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#getTypeCode()"><code>ValueMetaData.getTypeCode()</code></a> if the user indicates |
| a different type or the value has an externalizer.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#getDeclaredTypeCode()">getDeclaredTypeCode</a></code> in interface <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setDeclaredTypeCode(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDeclaredTypeCode</h4> |
| <pre>public void setDeclaredTypeCode(int type)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#setDeclaredTypeCode(int)">ValueMetaData</a></code></strong></div> |
| <div class="block">Set the type code for the value. The type code is usually |
| computed automatically, but it can be useful to set it explicitly |
| when creating metadatas from scratch.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#setDeclaredTypeCode(int)">setDeclaredTypeCode</a></code> in interface <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isDeclaredTypePC()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDeclaredTypePC</h4> |
| <pre>public boolean isDeclaredTypePC()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#isDeclaredTypePC()">ValueMetaData</a></code></strong></div> |
| <div class="block">Whether the type is a persistence capable instance.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#isDeclaredTypePC()">isDeclaredTypePC</a></code> in interface <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDeclaredTypeMetaData()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDeclaredTypeMetaData</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a> getDeclaredTypeMetaData()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#getDeclaredTypeMetaData()">ValueMetaData</a></code></strong></div> |
| <div class="block">Return metadata for the value's class, if the type is persistent.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#getDeclaredTypeMetaData()">getDeclaredTypeMetaData</a></code> in interface <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isEmbedded()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isEmbedded</h4> |
| <pre>public boolean isEmbedded()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#isEmbedded()">ValueMetaData</a></code></strong></div> |
| <div class="block">This attribute is a hint to the implementation to store this value |
| in the same structure as the class, rather than as a separate datastore |
| structure. Defaults to true if the field is not a collection or map |
| or persistence-capable object; defaults to false otherwise. |
| Implementations are permitted to ignore this attribute.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#isEmbedded()">isEmbedded</a></code> in interface <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setEmbedded(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEmbedded</h4> |
| <pre>public void setEmbedded(boolean embedded)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#setEmbedded(boolean)">ValueMetaData</a></code></strong></div> |
| <div class="block">This attribute is a hint to the implementation to store this value |
| in the same structure as the class, rather than as a separate datastore |
| structure. Defaults to true if the field is not a collection or map |
| or persistence-capable objects; defaults to false otherwise. |
| Implementations are permitted to ignore this attribute.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#setEmbedded(boolean)">setEmbedded</a></code> in interface <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isEmbeddedPC()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isEmbeddedPC</h4> |
| <pre>public boolean isEmbeddedPC()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#isEmbeddedPC()">ValueMetaData</a></code></strong></div> |
| <div class="block">Whether this is an embedded persistence capable value.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#isEmbeddedPC()">isEmbeddedPC</a></code> in interface <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEmbeddedMetaData()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEmbeddedMetaData</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a> getEmbeddedMetaData()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#getEmbeddedMetaData()">ValueMetaData</a></code></strong></div> |
| <div class="block">The embedded class metadata for the value.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#getEmbeddedMetaData()">getEmbeddedMetaData</a></code> in interface <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addEmbeddedMetaData(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addEmbeddedMetaData</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a> addEmbeddedMetaData(int access)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#addEmbeddedMetaData(int)">ValueMetaData</a></code></strong></div> |
| <div class="block">Add embedded metadata for this value with the given access type</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#addEmbeddedMetaData(int)">addEmbeddedMetaData</a></code> in interface <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addEmbeddedMetaData()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addEmbeddedMetaData</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</a> addEmbeddedMetaData()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#addEmbeddedMetaData()">ValueMetaData</a></code></strong></div> |
| <div class="block">Add embedded metadata for this value.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#addEmbeddedMetaData()">addEmbeddedMetaData</a></code> in interface <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCascadeDelete()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCascadeDelete</h4> |
| <pre>public int getCascadeDelete()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#getCascadeDelete()">ValueMetaData</a></code></strong></div> |
| <div class="block">Cascade behavior for delete operation. Only applies to |
| persistence-capable values. Options are:<br /> |
| <ul> |
| <li><code>CASCADE_NONE</code>: No cascades.</li> |
| <li><code>CASCADE_IMMEDIATE</code>: Value is deleted immediately when |
| the owning object is deleted.</li> |
| <li><code>CASCADE_AUTO</code>: Value will be deleted on flush |
| if the owning object is deleted or if the value is removed from the |
| owning object, and if the value is not assigned to another relation in |
| the same transaction.</li> |
| </ul></div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#getCascadeDelete()">getCascadeDelete</a></code> in interface <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setCascadeDelete(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCascadeDelete</h4> |
| <pre>public void setCascadeDelete(int delete)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#setCascadeDelete(int)">ValueMetaData</a></code></strong></div> |
| <div class="block">Cascade behavior for deletion.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#setCascadeDelete(int)">setCascadeDelete</a></code> in interface <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a></code></dd> |
| <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#getCascadeDelete()"><code>ValueMetaData.getCascadeDelete()</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="getCascadePersist()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCascadePersist</h4> |
| <pre>public int getCascadePersist()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#getCascadePersist()">ValueMetaData</a></code></strong></div> |
| <div class="block">Cascade behavior for persist operation. Only applies to |
| persistence-capable values. Options are:<br /> |
| <ul> |
| <li><code>CASCADE_NONE</code>: No cascades. If a transient relation |
| is held at flush, an error is thrown.</li> |
| <li><code>CASCADE_IMMEDIATE</code>: Value is persisted immediately when |
| the owning object is persisted.</li> |
| <li><code>CASCADE_AUTO</code>: Value will be persisted on flush.</li> |
| </ul></div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#getCascadePersist()">getCascadePersist</a></code> in interface <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setCascadePersist(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCascadePersist</h4> |
| <pre>public void setCascadePersist(int persist)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#setCascadePersist(int)">ValueMetaData</a></code></strong></div> |
| <div class="block">Cascade behavior for persist operation.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#setCascadePersist(int)">setCascadePersist</a></code> in interface <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a></code></dd> |
| <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#getCascadePersist()"><code>ValueMetaData.getCascadePersist()</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="setCascadePersist(int, boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCascadePersist</h4> |
| <pre>public void setCascadePersist(int cascade, |
| boolean checkPUDefault)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#setCascadePersist(int,%20boolean)">ValueMetaData</a></code></strong></div> |
| <div class="block">Cascade behavior for persist operation.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#setCascadePersist(int,%20boolean)">setCascadePersist</a></code> in interface <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a></code></dd> |
| <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#getCascadePersist()"><code>ValueMetaData.getCascadePersist()</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="getCascadeAttach()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCascadeAttach</h4> |
| <pre>public int getCascadeAttach()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#getCascadeAttach()">ValueMetaData</a></code></strong></div> |
| <div class="block">Cascade behavior for attach operation. Only applies to |
| persistence-capable values. Options are:<br /> |
| <ul> |
| <li><code>CASCADE_NONE</code>: No cascades of attach. Relation |
| remains detached.</li> |
| <li><code>CASCADE_IMMEDIATE</code>: Value is attached immediately.</li> |
| </ul></div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#getCascadeAttach()">getCascadeAttach</a></code> in interface <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setCascadeAttach(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCascadeAttach</h4> |
| <pre>public void setCascadeAttach(int attach)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#setCascadeAttach(int)">ValueMetaData</a></code></strong></div> |
| <div class="block">Cascade behavior for attach operation.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#setCascadeAttach(int)">setCascadeAttach</a></code> in interface <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a></code></dd> |
| <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#getCascadeAttach()"><code>ValueMetaData.getCascadeAttach()</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="getCascadeDetach()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCascadeDetach</h4> |
| <pre>public int getCascadeDetach()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#getCascadeDetach()">ValueMetaData</a></code></strong></div> |
| <div class="block">Cascade behavior for detach operation. Only applies to |
| persistence-capable values. Options are:<br /> |
| <ul> |
| <li><code>CASCADE_NONE</code>: No cascades of detach. Relation |
| remains attached.</li> |
| <li><code>CASCADE_IMMEDIATE</code>: Value is detached immediately.</li> |
| </ul></div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#getCascadeDetach()">getCascadeDetach</a></code> in interface <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setCascadeDetach(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCascadeDetach</h4> |
| <pre>public void setCascadeDetach(int detach)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#setCascadeDetach(int)">ValueMetaData</a></code></strong></div> |
| <div class="block">Cascade behavior for detach operation.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#setCascadeDetach(int)">setCascadeDetach</a></code> in interface <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a></code></dd> |
| <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#getCascadeDetach()"><code>ValueMetaData.getCascadeDetach()</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="getCascadeRefresh()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCascadeRefresh</h4> |
| <pre>public int getCascadeRefresh()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#getCascadeRefresh()">ValueMetaData</a></code></strong></div> |
| <div class="block">Cascade behavior for refresh operation. Only applies to |
| persistence-capable values. Options are:<br /> |
| <ul> |
| <li><code>CASCADE_NONE</code>: No cascades of refresh.</li> |
| <li><code>CASCADE_IMMEDIATE</code>: Persistent value object is also |
| refreshed.</li> |
| <li><code>CASCADE_AUTO</code>: Value will be refreshed if it is |
| in the current fetch groups.</li> |
| </ul></div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#getCascadeRefresh()">getCascadeRefresh</a></code> in interface <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setCascadeRefresh(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCascadeRefresh</h4> |
| <pre>public void setCascadeRefresh(int refresh)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#setCascadeRefresh(int)">ValueMetaData</a></code></strong></div> |
| <div class="block">Cascade behavior for refresh operation.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#setCascadeRefresh(int)">setCascadeRefresh</a></code> in interface <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a></code></dd> |
| <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#getCascadeRefresh()"><code>ValueMetaData.getCascadeRefresh()</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="isSerialized()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isSerialized</h4> |
| <pre>public boolean isSerialized()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#isSerialized()">ValueMetaData</a></code></strong></div> |
| <div class="block">Whether this value is serialized when stored.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#isSerialized()">isSerialized</a></code> in interface <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSerialized(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSerialized</h4> |
| <pre>public void setSerialized(boolean serialized)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#setSerialized(boolean)">ValueMetaData</a></code></strong></div> |
| <div class="block">Whether this value is serialized when stored.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#setSerialized(boolean)">setSerialized</a></code> in interface <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getValueMappedBy()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValueMappedBy</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> getValueMappedBy()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#getValueMappedBy()">ValueMetaData</a></code></strong></div> |
| <div class="block">The field that this value shares a mapping with. Currently the only |
| supported use for a mapped-by value is when a map field key is |
| determined by a field of the persistence-capable map value.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#getValueMappedBy()">getValueMappedBy</a></code> in interface <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setValueMappedBy(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setValueMappedBy</h4> |
| <pre>public void setValueMappedBy(<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> mapped)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#setValueMappedBy(java.lang.String)">ValueMetaData</a></code></strong></div> |
| <div class="block">The field that this value shares a mapping with. Currently the only |
| supported use for a mapped-by value is when a map field key is |
| determined by a field of the persistence-capable map value.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#setValueMappedBy(java.lang.String)">setValueMappedBy</a></code> in interface <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getValueMappedByMetaData()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValueMappedByMetaData</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</a> getValueMappedByMetaData()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#getValueMappedByMetaData()">ValueMetaData</a></code></strong></div> |
| <div class="block">The field that this value shares a mapping with. Currently the only |
| supported use for a mapped-by value is when a map field key is |
| determined by a field of the persistence-capable map value.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#getValueMappedByMetaData()">getValueMappedByMetaData</a></code> in interface <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTypeOverride()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTypeOverride</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><?> getTypeOverride()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#getTypeOverride()">ValueMetaData</a></code></strong></div> |
| <div class="block">User-supplied type overriding assumed type based on field.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#getTypeOverride()">getTypeOverride</a></code> in interface <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setTypeOverride(java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTypeOverride</h4> |
| <pre>public void setTypeOverride(<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"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#setTypeOverride(java.lang.Class)">ValueMetaData</a></code></strong></div> |
| <div class="block">User-supplied type overriding assumed type based on field.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#setTypeOverride(java.lang.Class)">setTypeOverride</a></code> in interface <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="copy(org.apache.openjpa.meta.ValueMetaData)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>copy</h4> |
| <pre>public void copy(<a href="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a> vmd)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#copy(org.apache.openjpa.meta.ValueMetaData)">ValueMetaData</a></code></strong></div> |
| <div class="block">Copy state from the given value to this one. Do not copy mapping |
| information.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html#copy(org.apache.openjpa.meta.ValueMetaData)">copy</a></code> in interface <code><a href="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isUsedInOrderBy()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isUsedInOrderBy</h4> |
| <pre>public boolean isUsedInOrderBy()</pre> |
| <div class="block">Check if this field is used by other field as "order by" value.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.1.0</dd></dl> |
| </li> |
| </ul> |
| <a name="setUsedInOrderBy(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setUsedInOrderBy</h4> |
| <pre>public void setUsedInOrderBy(boolean isUsed)</pre> |
| <div class="block">Whether this field is used by other field as "order by" value .</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.1.0</dd></dl> |
| </li> |
| </ul> |
| <a name="isValueGenerated()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isValueGenerated</h4> |
| <pre>public boolean isValueGenerated()</pre> |
| </li> |
| </ul> |
| <a name="setValueGenerated(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setValueGenerated</h4> |
| <pre>public void setValueGenerated(boolean generated)</pre> |
| </li> |
| </ul> |
| <a name="isElementCollection()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isElementCollection</h4> |
| <pre>public boolean isElementCollection()</pre> |
| </li> |
| </ul> |
| <a name="setElementCollection(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setElementCollection</h4> |
| <pre>public void setElementCollection(boolean isElementCollection)</pre> |
| </li> |
| </ul> |
| <a name="getMappedByIdValue()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMappedByIdValue</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> getMappedByIdValue()</pre> |
| </li> |
| </ul> |
| <a name="setMappedByIdValue(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMappedByIdValue</h4> |
| <pre>public void setMappedByIdValue(<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> mappedByIdValue)</pre> |
| </li> |
| </ul> |
| <a name="isMappedById()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isMappedById</h4> |
| <pre>public boolean isMappedById()</pre> |
| </li> |
| </ul> |
| <a name="getAccessType()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAccessType</h4> |
| <pre>public int getAccessType()</pre> |
| <div class="block">Gets the access type used by this field. If no access type is set for |
| this field then return the access type used by the declaring class.</div> |
| </li> |
| </ul> |
| <a name="setAccessType(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAccessType</h4> |
| <pre>public void setAccessType(int fCode)</pre> |
| <div class="block">Sets access type of this field. The access code is verified for validity |
| as well as against the access style used by the declaring class.</div> |
| </li> |
| </ul> |
| <a name="getAssociationType()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAssociationType</h4> |
| <pre>public int getAssociationType()</pre> |
| </li> |
| </ul> |
| <a name="setAssociationType(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAssociationType</h4> |
| <pre>public void setAssociationType(int type)</pre> |
| </li> |
| </ul> |
| <a name="isPersistentCollection()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isPersistentCollection</h4> |
| <pre>public boolean isPersistentCollection()</pre> |
| </li> |
| </ul> |
| <a name="setPersistentCollection(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPersistentCollection</h4> |
| <pre>public void setPersistentCollection(boolean persistentCollection)</pre> |
| </li> |
| </ul> |
| <a name="getRelationType()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRelationType</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><?> getRelationType()</pre> |
| </li> |
| </ul> |
| <a name="isDelayCapable()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDelayCapable</h4> |
| <pre>public boolean isDelayCapable()</pre> |
| </li> |
| </ul> |
| <a name="setDelayCapable(java.lang.Boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDelayCapable</h4> |
| <pre>public void setDelayCapable(<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> delayCapable)</pre> |
| </li> |
| </ul> |
| <a name="getUseSchemaElement()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUseSchemaElement</h4> |
| <pre>public boolean getUseSchemaElement()</pre> |
| <div class="block">Whether to include schema name in generated 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">Whether to include schema name in generated files</div> |
| </li> |
| </ul> |
| <a name="getSetterName()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getSetterName</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> getSetterName()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><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/FieldMetaData.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/FetchGroup.html" title="class in org.apache.openjpa.meta"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/openjpa/meta/FieldMetaData.MemberProvider.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/FieldMetaData.html" target="_top">Frames</a></li> |
| <li><a href="FieldMetaData.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><a href="#nested_class_summary">Nested</a> | </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> |