| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc (build 1.5.0_19) on Wed Jan 13 14:47:58 CST 2010 --> |
| <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> |
| <TITLE> |
| FieldMetaData (OpenJPA 1.2.2 API) |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.apache.openjpa.meta.FieldMetaData class"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="FieldMetaData (OpenJPA 1.2.2 API)"; |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <A NAME="navbar_top"><!-- --></A> |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/FieldMetaData.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/apache/openjpa/meta/FetchGroup.html" title="class in org.apache.openjpa.meta"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.MemberProvider.html" title="class in org.apache.openjpa.meta"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/openjpa/meta/FieldMetaData.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="FieldMetaData.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.apache.openjpa.meta</FONT> |
| <BR> |
| Class FieldMetaData</H2> |
| <PRE> |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">java.lang.Object</A> |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../org/apache/openjpa/meta/Extensions.html" title="class in org.apache.openjpa.meta">org.apache.openjpa.meta.Extensions</A> |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.openjpa.meta.FieldMetaData</B> |
| </PRE> |
| <DL> |
| <DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/Serializable.html" 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><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/apache/openjpa/jdbc/meta/FieldMapping.html" title="class in org.apache.openjpa.jdbc.meta">FieldMapping</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public class <B>FieldMetaData</B><DT>extends <A HREF="../../../../org/apache/openjpa/meta/Extensions.html" title="class in org.apache.openjpa.meta">Extensions</A><DT>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></DL> |
| </PRE> |
| |
| <P> |
| Metadata for a managed class field. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Author:</B></DT> |
| <DD>Abe White</DD> |
| <DT><B>See Also:</B><DD><A HREF="../../../../serialized-form.html#org.apache.openjpa.meta.FieldMetaData">Serialized Form</A></DL> |
| <HR> |
| |
| <P> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| |
| <A NAME="nested_class_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Nested Class Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static class</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.MemberProvider.html" title="class in org.apache.openjpa.meta">FieldMetaData.MemberProvider</A></B></CODE> |
| |
| <BR> |
| Serializable wrapper around a <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/reflect/Method.html" title="class or interface in java.lang.reflect"><CODE>Method</CODE></A> or <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/reflect/Field.html" title="class or interface in java.lang.reflect"><CODE>Field</CODE></A>.</TD> |
| </TR> |
| </TABLE> |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| <A NAME="field_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Field Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#MANAGE_NONE">MANAGE_NONE</A></B></CODE> |
| |
| <BR> |
| Constant specifying the management level of a field.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#MANAGE_PERSISTENT">MANAGE_PERSISTENT</A></B></CODE> |
| |
| <BR> |
| Constant specifying the management level of a field.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#MANAGE_TRANSACTIONAL">MANAGE_TRANSACTIONAL</A></B></CODE> |
| |
| <BR> |
| Constant specifying the management level of a field.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#NULL_DEFAULT">NULL_DEFAULT</A></B></CODE> |
| |
| <BR> |
| Constant specifying to use a datastore default value to persist null |
| values in object fields.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#NULL_EXCEPTION">NULL_EXCEPTION</A></B></CODE> |
| |
| <BR> |
| Constant specifying to throw an exception when attempting to persist |
| null values in object fields.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#NULL_NONE">NULL_NONE</A></B></CODE> |
| |
| <BR> |
| Constant specifying to use a datastore null to persist null values |
| in object fields.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#NULL_UNSET">NULL_UNSET</A></B></CODE> |
| |
| <BR> |
| Constant specifying that no null-value was given.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="fields_inherited_from_class_org.apache.openjpa.meta.Extensions"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>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></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../org/apache/openjpa/meta/Extensions.html#OPENJPA">OPENJPA</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="fields_inherited_from_class_org.apache.openjpa.meta.ValueMetaData"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>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></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><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></TD> |
| </TR> |
| </TABLE> |
| <A NAME="fields_inherited_from_class_org.apache.openjpa.meta.MetaDataModes"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>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></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><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></TD> |
| </TR> |
| </TABLE> |
| <A NAME="fields_inherited_from_class_org.apache.openjpa.lib.xml.Commentable"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>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></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../org/apache/openjpa/lib/xml/Commentable.html#EMPTY_COMMENTS">EMPTY_COMMENTS</A></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| |
| <A NAME="constructor_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Constructor Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected </CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#FieldMetaData(java.lang.String, java.lang.Class, org.apache.openjpa.meta.ClassMetaData)">FieldMetaData</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> name, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" 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> |
| |
| <BR> |
| Constructor.</TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#addEmbeddedMetaData()">addEmbeddedMetaData</A></B>()</CODE> |
| |
| <BR> |
| Add embedded metadata for this value.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#addExtensionKeys(java.util.Collection)">addExtensionKeys</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> exts)</CODE> |
| |
| <BR> |
| 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.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#backingMember(java.lang.reflect.Member)">backingMember</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/reflect/Member.html" title="class or interface in java.lang.reflect">Member</A> member)</CODE> |
| |
| <BR> |
| Supply the backing member object; this allows us to utilize |
| parameterized type information if available.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#compareTo(java.lang.Object)">compareTo</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> other)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#copy(org.apache.openjpa.meta.FieldMetaData)">copy</A></B>(<A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</A> field)</CODE> |
| |
| <BR> |
| Copy state from the given field to this one.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#copy(org.apache.openjpa.meta.ValueMetaData)">copy</A></B>(<A HREF="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</A> vmd)</CODE> |
| |
| <BR> |
| Copy state from the given value to this one.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#equals(java.lang.Object)">equals</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> other)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/reflect/Member.html" title="class or interface in java.lang.reflect">Member</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getBackingMember()">getBackingMember</A></B>()</CODE> |
| |
| <BR> |
| 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>.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getCascadeAttach()">getCascadeAttach</A></B>()</CODE> |
| |
| <BR> |
| Cascade behavior for attach operation.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getCascadeDelete()">getCascadeDelete</A></B>()</CODE> |
| |
| <BR> |
| Cascade behavior for delete operation.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getCascadePersist()">getCascadePersist</A></B>()</CODE> |
| |
| <BR> |
| Cascade behavior for persist operation.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getCascadeRefresh()">getCascadeRefresh</A></B>()</CODE> |
| |
| <BR> |
| Cascade behavior for refresh operation.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getComments()">getComments</A></B>()</CODE> |
| |
| <BR> |
| Return comments, or empty array if none.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getCustomFetchGroups()">getCustomFetchGroups</A></B>()</CODE> |
| |
| <BR> |
| Gets the name of the custom fetch groups those are associated to this |
| receiver.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getDeclaredIndex()">getDeclaredIndex</A></B>()</CODE> |
| |
| <BR> |
| The relative index of this persistent/transactional field.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getDeclaredType()">getDeclaredType</A></B>()</CODE> |
| |
| <BR> |
| Return the declared class of the value.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getDeclaredTypeCode()">getDeclaredTypeCode</A></B>()</CODE> |
| |
| <BR> |
| Return the declared type code of the value.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getDeclaredTypeMetaData()">getDeclaredTypeMetaData</A></B>()</CODE> |
| |
| <BR> |
| Return metadata for the value's class, if the type is persistent.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getDeclaringMetaData()">getDeclaringMetaData</A></B>()</CODE> |
| |
| <BR> |
| The declaring class.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getDeclaringType()">getDeclaringType</A></B>()</CODE> |
| |
| <BR> |
| The declaring class.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getDefiningMetaData()">getDefiningMetaData</A></B>()</CODE> |
| |
| <BR> |
| The class that defines the metadata for this field.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getElement()">getElement</A></B>()</CODE> |
| |
| <BR> |
| Metadata about the element value.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getEmbeddedMetaData()">getEmbeddedMetaData</A></B>()</CODE> |
| |
| <BR> |
| The embedded class metadata for the value.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getExternalizer()">getExternalizer</A></B>()</CODE> |
| |
| <BR> |
| The name of this field's externalizer, or null if none.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/reflect/Method.html" title="class or interface in java.lang.reflect">Method</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getExternalizerMethod()">getExternalizerMethod</A></B>()</CODE> |
| |
| <BR> |
| The externalizer method.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getExternalValue(java.lang.Object, org.apache.openjpa.kernel.StoreContext)">getExternalValue</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" 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> |
| |
| <BR> |
| Convert the given field value to its external value through the |
| provided externalizer, or return the value as-is if no externalizer.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html" title="class or interface in java.util">Map</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getExternalValueMap()">getExternalValueMap</A></B>()</CODE> |
| |
| <BR> |
| Return the mapping of field values to external values.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getExternalValues()">getExternalValues</A></B>()</CODE> |
| |
| <BR> |
| Properties string mapping field values to external values.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getFactory()">getFactory</A></B>()</CODE> |
| |
| <BR> |
| The name of this field's factory, or null if none.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/reflect/Member.html" title="class or interface in java.lang.reflect">Member</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getFactoryMethod()">getFactoryMethod</A></B>()</CODE> |
| |
| <BR> |
| The factory method or constructor.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getFieldMetaData()">getFieldMetaData</A></B>()</CODE> |
| |
| <BR> |
| Return the owning field for this value.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getFieldValue(java.lang.Object, org.apache.openjpa.kernel.StoreContext)">getFieldValue</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" 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> |
| |
| <BR> |
| Return the result of passing the given external value through the |
| factory to get the field value.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html" title="class or interface in java.util">Map</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getFieldValueMap()">getFieldValueMap</A></B>()</CODE> |
| |
| <BR> |
| Return the mapping of external values to field values.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getFullName()">getFullName</A></B>()</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>Use getFullName(boolean) instead.</I></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getFullName(boolean)">getFullName</A></B>(boolean embedOwner)</CODE> |
| |
| <BR> |
| The field name, qualified by the owning class and optionally the |
| embedding owner's name (if any).</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getIndex()">getIndex</A></B>()</CODE> |
| |
| <BR> |
| The absolute index of this persistent/transactional field.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getInitializer()">getInitializer</A></B>()</CODE> |
| |
| <BR> |
| The initializer used by the field, or null if none.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getInverse()">getInverse</A></B>()</CODE> |
| |
| <BR> |
| Logical inverse field.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</A>[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getInverseMetaDatas()">getInverseMetaDatas</A></B>()</CODE> |
| |
| <BR> |
| Return all inverses of this field.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getKey()">getKey</A></B>()</CODE> |
| |
| <BR> |
| Metadata about the key value.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getListingIndex()">getListingIndex</A></B>()</CODE> |
| |
| <BR> |
| The index in which this field was listed in the metadata.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getLoadFetchGroup()">getLoadFetchGroup</A></B>()</CODE> |
| |
| <BR> |
| The fetch group that is to be loaded when this receiver is loaded, or |
| null if none set.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getManagement()">getManagement</A></B>()</CODE> |
| |
| <BR> |
| Return the management level for the field.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getMappedBy()">getMappedBy</A></B>()</CODE> |
| |
| <BR> |
| The field that this field shares a mapping with.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getMappedByMetaData()">getMappedByMetaData</A></B>()</CODE> |
| |
| <BR> |
| The field that this field shares a mapping with.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getName()">getName</A></B>()</CODE> |
| |
| <BR> |
| The field name.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getNullValue()">getNullValue</A></B>()</CODE> |
| |
| <BR> |
| 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>.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getObjectIdFieldType()">getObjectIdFieldType</A></B>()</CODE> |
| |
| <BR> |
| For a primary key field, return the type of the corresponding object id |
| class field.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getObjectIdFieldTypeCode()">getObjectIdFieldTypeCode</A></B>()</CODE> |
| |
| <BR> |
| For a primary key field, return the type of the corresponding object id |
| class field.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getOrderDeclaration()">getOrderDeclaration</A></B>()</CODE> |
| |
| <BR> |
| String declaring the orderings for this field to be applied on load, |
| or null.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/openjpa/meta/Order.html" title="interface in org.apache.openjpa.meta">Order</A>[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getOrders()">getOrders</A></B>()</CODE> |
| |
| <BR> |
| The orderings for this field to be applied on load, or empty array.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getPrimaryKeyIndex()">getPrimaryKeyIndex</A></B>()</CODE> |
| |
| <BR> |
| The absolute primary key index for this field, or -1 if not a primary |
| key.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getProxyType()">getProxyType</A></B>()</CODE> |
| |
| <BR> |
| The type this field was initialized with, and therefore the |
| type to use for proxies when loading data into this field.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/openjpa/meta/MetaDataRepository.html" title="class in org.apache.openjpa.meta">MetaDataRepository</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getRepository()">getRepository</A></B>()</CODE> |
| |
| <BR> |
| The metadata repository.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getResolve()">getResolve</A></B>()</CODE> |
| |
| <BR> |
| Resolve mode for this field.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getType()">getType</A></B>()</CODE> |
| |
| <BR> |
| The value class.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getTypeCode()">getTypeCode</A></B>()</CODE> |
| |
| <BR> |
| The type code of the value class.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getTypeMetaData()">getTypeMetaData</A></B>()</CODE> |
| |
| <BR> |
| The metadata for the value class, if the type is persistent.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getTypeOverride()">getTypeOverride</A></B>()</CODE> |
| |
| <BR> |
| User-supplied type overriding assumed type based on field.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getUpdateStrategy()">getUpdateStrategy</A></B>()</CODE> |
| |
| <BR> |
| The strategy to use when updating the field.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getValue()">getValue</A></B>()</CODE> |
| |
| <BR> |
| MetaData about the field value.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getValueMappedBy()">getValueMappedBy</A></B>()</CODE> |
| |
| <BR> |
| The field that this value shares a mapping with.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getValueMappedByMetaData()">getValueMappedByMetaData</A></B>()</CODE> |
| |
| <BR> |
| The field that this value shares a mapping with.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/openjpa/meta/SequenceMetaData.html" title="class in org.apache.openjpa.meta">SequenceMetaData</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getValueSequenceMetaData()">getValueSequenceMetaData</A></B>()</CODE> |
| |
| <BR> |
| Metadata for the value sequence.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getValueSequenceName()">getValueSequenceName</A></B>()</CODE> |
| |
| <BR> |
| The value sequence name, or null for none.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#getValueStrategy()">getValueStrategy</A></B>()</CODE> |
| |
| <BR> |
| The strategy to use for insert value generation.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#hashCode()">hashCode</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#isDeclaredTypePC()">isDeclaredTypePC</A></B>()</CODE> |
| |
| <BR> |
| Whether the type is a persistence capable instance.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#isDefaultFetchGroupExplicit()">isDefaultFetchGroupExplicit</A></B>()</CODE> |
| |
| <BR> |
| Whether the default fetch group setting is explicit.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#isEmbedded()">isEmbedded</A></B>()</CODE> |
| |
| <BR> |
| 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.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#isEmbeddedPC()">isEmbeddedPC</A></B>()</CODE> |
| |
| <BR> |
| Whether this is an embedded persistence capable value.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#isExplicit()">isExplicit</A></B>()</CODE> |
| |
| <BR> |
| Whether this field is explicitly declared in the metadata.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#isExternalized()">isExternalized</A></B>()</CODE> |
| |
| <BR> |
| Whether the field is externalized.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#isInDefaultFetchGroup()">isInDefaultFetchGroup</A></B>()</CODE> |
| |
| <BR> |
| Whether this field is in the default fetch group.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#isInFetchGroup(java.lang.String)">isInFetchGroup</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> fg)</CODE> |
| |
| <BR> |
| Whether this field is in the given fetch group.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#isLRS()">isLRS</A></B>()</CODE> |
| |
| <BR> |
| Whether this field is backed by a large result set.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#isMapped()">isMapped</A></B>()</CODE> |
| |
| <BR> |
| Return whether this field is mapped to the datastore.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#isPrimaryKey()">isPrimaryKey</A></B>()</CODE> |
| |
| <BR> |
| Whether this is a primary key field.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#isSerialized()">isSerialized</A></B>()</CODE> |
| |
| <BR> |
| Whether this value is serialized when stored.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#isStream()">isStream</A></B>()</CODE> |
| |
| <BR> |
| Whether this field is backed by a stream.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#isTransient()">isTransient</A></B>()</CODE> |
| |
| <BR> |
| Return whether this is a transient field.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#isTypePC()">isTypePC</A></B>()</CODE> |
| |
| <BR> |
| Whether the type is a persistence capable instance.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#isUsedInOrderBy()">isUsedInOrderBy</A></B>()</CODE> |
| |
| <BR> |
| Check if this field is used by other field as "order by" value.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#isValueGenerated()">isValueGenerated</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#isVersion()">isVersion</A></B>()</CODE> |
| |
| <BR> |
| Whether this field holds optimistic version information.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#order(java.lang.Object)">order</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> val)</CODE> |
| |
| <BR> |
| Order this field value when it is loaded.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#resolve(int)">resolve</A></B>(int mode)</CODE> |
| |
| <BR> |
| Resolve and validate metadata.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#setCascadeAttach(int)">setCascadeAttach</A></B>(int attach)</CODE> |
| |
| <BR> |
| Cascade behavior for attach operation.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#setCascadeDelete(int)">setCascadeDelete</A></B>(int delete)</CODE> |
| |
| <BR> |
| Cascade behavior for deletion.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#setCascadePersist(int)">setCascadePersist</A></B>(int persist)</CODE> |
| |
| <BR> |
| Cascade behavior for persist operation.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#setCascadeRefresh(int)">setCascadeRefresh</A></B>(int refresh)</CODE> |
| |
| <BR> |
| Cascade behavior for refresh operation.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#setComments(java.lang.String[])">setComments</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>[] comments)</CODE> |
| |
| <BR> |
| Set comments.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#setDeclaredIndex(int)">setDeclaredIndex</A></B>(int index)</CODE> |
| |
| <BR> |
| The relative index of this persistent/transactional field.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#setDeclaredType(java.lang.Class)">setDeclaredType</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A> type)</CODE> |
| |
| <BR> |
| Set the declared class of the value.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#setDeclaredTypeCode(int)">setDeclaredTypeCode</A></B>(int type)</CODE> |
| |
| <BR> |
| Set the type code for the value.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#setDeclaringType(java.lang.Class)">setDeclaringType</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A> cls)</CODE> |
| |
| <BR> |
| The declaring class.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#setDefaultFetchGroupExplicit(boolean)">setDefaultFetchGroupExplicit</A></B>(boolean explicit)</CODE> |
| |
| <BR> |
| Whether the default fetch group setting is explicit.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#setEmbedded(boolean)">setEmbedded</A></B>(boolean embedded)</CODE> |
| |
| <BR> |
| 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.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#setExplicit(boolean)">setExplicit</A></B>(boolean explicit)</CODE> |
| |
| <BR> |
| Whether this field is explicitly declared in the metadata.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#setExternalizer(java.lang.String)">setExternalizer</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> externalizer)</CODE> |
| |
| <BR> |
| The name of this field's externalizer, or null if none.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#setExternalValues(java.lang.String)">setExternalValues</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> values)</CODE> |
| |
| <BR> |
| Properties string mapping field values to external values.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#setFactory(java.lang.String)">setFactory</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> factory)</CODE> |
| |
| <BR> |
| The name of this field's factory, or null if none.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#setInDefaultFetchGroup(boolean)">setInDefaultFetchGroup</A></B>(boolean dfg)</CODE> |
| |
| <BR> |
| Whether this field is in the default fetch group.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#setIndex(int)">setIndex</A></B>(int index)</CODE> |
| |
| <BR> |
| The absolute index of this persistent/transactional field.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#setInFetchGroup(java.lang.String, boolean)">setInFetchGroup</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> fg, |
| boolean in)</CODE> |
| |
| <BR> |
| Set whether this field is in the given fetch group.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#setInitializer(java.lang.Object)">setInitializer</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> initializer)</CODE> |
| |
| <BR> |
| The initializer used by the field, or null if none.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#setInverse(java.lang.String)">setInverse</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> inverse)</CODE> |
| |
| <BR> |
| Logical inverse field.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#setListingIndex(int)">setListingIndex</A></B>(int index)</CODE> |
| |
| <BR> |
| The index in which this field was listed in the metadata.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#setLoadFetchGroup(java.lang.String)">setLoadFetchGroup</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> lfg)</CODE> |
| |
| <BR> |
| The fetch group that is to be loaded when this receiver is loaded, or |
| null if none set.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#setLRS(boolean)">setLRS</A></B>(boolean lrs)</CODE> |
| |
| <BR> |
| Whether this field is backed by a large result set.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#setManagement(int)">setManagement</A></B>(int manage)</CODE> |
| |
| <BR> |
| Return the management level for the field.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#setMappedBy(java.lang.String)">setMappedBy</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> mapped)</CODE> |
| |
| <BR> |
| The field that this field shares a mapping with.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#setNullValue(int)">setNullValue</A></B>(int nullValue)</CODE> |
| |
| <BR> |
| 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>.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#setOrderDeclaration(java.lang.String)">setOrderDeclaration</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> dec)</CODE> |
| |
| <BR> |
| String declaring the orderings for this field to be applied on load, |
| or null.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#setOrders(org.apache.openjpa.meta.Order[])">setOrders</A></B>(<A HREF="../../../../org/apache/openjpa/meta/Order.html" title="interface in org.apache.openjpa.meta">Order</A>[] orders)</CODE> |
| |
| <BR> |
| The orderings for this field to be applied on load.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#setPrimaryKey(boolean)">setPrimaryKey</A></B>(boolean primKey)</CODE> |
| |
| <BR> |
| Whether this is a primary key field.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#setPrimaryKeyIndex(int)">setPrimaryKeyIndex</A></B>(int index)</CODE> |
| |
| <BR> |
| The absolute primary key index for this field, or -1 if not a primary |
| key.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#setProxyType(java.lang.Class)">setProxyType</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A> type)</CODE> |
| |
| <BR> |
| The type this field was initialized with, and therefore the |
| type to use for proxies when loading data into this field.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#setResolve(int)">setResolve</A></B>(int mode)</CODE> |
| |
| <BR> |
| Resolve mode for this field.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#setResolve(int, boolean)">setResolve</A></B>(int mode, |
| boolean on)</CODE> |
| |
| <BR> |
| Resolve mode for this field.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#setSerialized(boolean)">setSerialized</A></B>(boolean serialized)</CODE> |
| |
| <BR> |
| Whether this value is serialized when stored.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#setStream(boolean)">setStream</A></B>(boolean stream)</CODE> |
| |
| <BR> |
| Whether this field is backed by a stream.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#setTransient(boolean)">setTransient</A></B>(boolean trans)</CODE> |
| |
| <BR> |
| Return whether this is a transient field.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#setType(java.lang.Class)">setType</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A> type)</CODE> |
| |
| <BR> |
| The value class.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#setTypeCode(int)">setTypeCode</A></B>(int code)</CODE> |
| |
| <BR> |
| The type code of the value class.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#setTypeOverride(java.lang.Class)">setTypeOverride</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A> type)</CODE> |
| |
| <BR> |
| User-supplied type overriding assumed type based on field.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#setUpdateStrategy(int)">setUpdateStrategy</A></B>(int strategy)</CODE> |
| |
| <BR> |
| Set the update strategy.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#setUsedInOrderBy(boolean)">setUsedInOrderBy</A></B>(boolean isUsed)</CODE> |
| |
| <BR> |
| Whether this field is used by other field as "order by" value .</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#setUsesImplData(java.lang.Boolean)">setUsesImplData</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Boolean.html" title="class or interface in java.lang">Boolean</A> implData)</CODE> |
| |
| <BR> |
| 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>.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#setUsesIntermediate(boolean)">setUsesIntermediate</A></B>(boolean intermediate)</CODE> |
| |
| <BR> |
| 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>.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#setValueGenerated(boolean)">setValueGenerated</A></B>(boolean generated)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#setValueMappedBy(java.lang.String)">setValueMappedBy</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> mapped)</CODE> |
| |
| <BR> |
| The field that this value shares a mapping with.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#setValueSequenceName(java.lang.String)">setValueSequenceName</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> seqName)</CODE> |
| |
| <BR> |
| The value sequence name, or null for none.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#setValueStrategy(int)">setValueStrategy</A></B>(int strategy)</CODE> |
| |
| <BR> |
| The strategy to use for insert value generation.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#setVersion(boolean)">setVersion</A></B>(boolean version)</CODE> |
| |
| <BR> |
| Whether this field holds optimistic version information.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#toString()">toString</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Boolean.html" title="class or interface in java.lang">Boolean</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#usesImplData()">usesImplData</A></B>()</CODE> |
| |
| <BR> |
| 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>.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#usesIntermediate()">usesIntermediate</A></B>()</CODE> |
| |
| <BR> |
| 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>.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.apache.openjpa.meta.Extensions"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>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></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../org/apache/openjpa/meta/Extensions.html#addExtension(java.lang.String, java.lang.Object)">addExtension</A>, <A HREF="../../../../org/apache/openjpa/meta/Extensions.html#addExtension(java.lang.String, java.lang.String, java.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, java.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, java.lang.String)">getDoubleExtension</A>, <A HREF="../../../../org/apache/openjpa/meta/Extensions.html#getEmbeddedExtensions(java.lang.String, boolean)">getEmbeddedExtensions</A>, <A HREF="../../../../org/apache/openjpa/meta/Extensions.html#getEmbeddedExtensions(java.lang.String, java.lang.String, boolean)">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, java.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, java.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, java.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, java.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, java.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, java.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></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ FIELD DETAIL =========== --> |
| |
| <A NAME="field_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Field Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="NULL_UNSET"><!-- --></A><H3> |
| NULL_UNSET</H3> |
| <PRE> |
| public static final int <B>NULL_UNSET</B></PRE> |
| <DL> |
| <DD>Constant specifying that no null-value was given. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.openjpa.meta.FieldMetaData.NULL_UNSET">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="NULL_NONE"><!-- --></A><H3> |
| NULL_NONE</H3> |
| <PRE> |
| public static final int <B>NULL_NONE</B></PRE> |
| <DL> |
| <DD>Constant specifying to use a datastore null to persist null values |
| in object fields. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.openjpa.meta.FieldMetaData.NULL_NONE">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="NULL_DEFAULT"><!-- --></A><H3> |
| NULL_DEFAULT</H3> |
| <PRE> |
| public static final int <B>NULL_DEFAULT</B></PRE> |
| <DL> |
| <DD>Constant specifying to use a datastore default value to persist null |
| values in object fields. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.openjpa.meta.FieldMetaData.NULL_DEFAULT">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="NULL_EXCEPTION"><!-- --></A><H3> |
| NULL_EXCEPTION</H3> |
| <PRE> |
| public static final int <B>NULL_EXCEPTION</B></PRE> |
| <DL> |
| <DD>Constant specifying to throw an exception when attempting to persist |
| null values in object fields. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.openjpa.meta.FieldMetaData.NULL_EXCEPTION">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="MANAGE_PERSISTENT"><!-- --></A><H3> |
| MANAGE_PERSISTENT</H3> |
| <PRE> |
| public static final int <B>MANAGE_PERSISTENT</B></PRE> |
| <DL> |
| <DD>Constant specifying the management level of a field. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.openjpa.meta.FieldMetaData.MANAGE_PERSISTENT">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="MANAGE_TRANSACTIONAL"><!-- --></A><H3> |
| MANAGE_TRANSACTIONAL</H3> |
| <PRE> |
| public static final int <B>MANAGE_TRANSACTIONAL</B></PRE> |
| <DL> |
| <DD>Constant specifying the management level of a field. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.openjpa.meta.FieldMetaData.MANAGE_TRANSACTIONAL">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="MANAGE_NONE"><!-- --></A><H3> |
| MANAGE_NONE</H3> |
| <PRE> |
| public static final int <B>MANAGE_NONE</B></PRE> |
| <DL> |
| <DD>Constant specifying the management level of a field. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.openjpa.meta.FieldMetaData.MANAGE_NONE">Constant Field Values</A></DL> |
| </DL> |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| <A NAME="constructor_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Constructor Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="FieldMetaData(java.lang.String, java.lang.Class, org.apache.openjpa.meta.ClassMetaData)"><!-- --></A><H3> |
| FieldMetaData</H3> |
| <PRE> |
| protected <B>FieldMetaData</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> name, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" 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> |
| <DL> |
| <DD>Constructor. |
| <P> |
| <DL> |
| <DT><B>Parameters:</B><DD><CODE>name</CODE> - the field name<DD><CODE>type</CODE> - the field type<DD><CODE>owner</CODE> - the owning class metadata</DL> |
| </DL> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="backingMember(java.lang.reflect.Member)"><!-- --></A><H3> |
| backingMember</H3> |
| <PRE> |
| public void <B>backingMember</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/reflect/Member.html" title="class or interface in java.lang.reflect">Member</A> member)</PRE> |
| <DL> |
| <DD>Supply the backing member object; this allows us to utilize |
| parameterized type information if available. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getBackingMember()"><!-- --></A><H3> |
| getBackingMember</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/reflect/Member.html" title="class or interface in java.lang.reflect">Member</A> <B>getBackingMember</B>()</PRE> |
| <DL> |
| <DD>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>. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getRepository()"><!-- --></A><H3> |
| getRepository</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/openjpa/meta/MetaDataRepository.html" title="class in org.apache.openjpa.meta">MetaDataRepository</A> <B>getRepository</B>()</PRE> |
| <DL> |
| <DD>The metadata repository. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><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><DT><B>Specified by:</B><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></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDefiningMetaData()"><!-- --></A><H3> |
| getDefiningMetaData</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</A> <B>getDefiningMetaData</B>()</PRE> |
| <DL> |
| <DD>The class that defines the metadata for this field. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDeclaringType()"><!-- --></A><H3> |
| getDeclaringType</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A> <B>getDeclaringType</B>()</PRE> |
| <DL> |
| <DD>The declaring class. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setDeclaringType(java.lang.Class)"><!-- --></A><H3> |
| setDeclaringType</H3> |
| <PRE> |
| public void <B>setDeclaringType</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A> cls)</PRE> |
| <DL> |
| <DD>The declaring class. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDeclaringMetaData()"><!-- --></A><H3> |
| getDeclaringMetaData</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</A> <B>getDeclaringMetaData</B>()</PRE> |
| <DL> |
| <DD>The declaring class. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getName()"><!-- --></A><H3> |
| getName</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getName</B>()</PRE> |
| <DL> |
| <DD>The field name. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getFullName()"><!-- --></A><H3> |
| getFullName</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getFullName</B>()</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>Use getFullName(boolean) instead.</I> |
| <P> |
| <DD>The field name, qualified by the owning class. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getFullName(boolean)"><!-- --></A><H3> |
| getFullName</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getFullName</B>(boolean embedOwner)</PRE> |
| <DL> |
| <DD>The field name, qualified by the owning class and optionally the |
| embedding owner's name (if any). |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getValue()"><!-- --></A><H3> |
| getValue</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</A> <B>getValue</B>()</PRE> |
| <DL> |
| <DD>MetaData about the field value. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getKey()"><!-- --></A><H3> |
| getKey</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</A> <B>getKey</B>()</PRE> |
| <DL> |
| <DD>Metadata about the key value. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getElement()"><!-- --></A><H3> |
| getElement</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</A> <B>getElement</B>()</PRE> |
| <DL> |
| <DD>Metadata about the element value. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isMapped()"><!-- --></A><H3> |
| isMapped</H3> |
| <PRE> |
| public boolean <B>isMapped</B>()</PRE> |
| <DL> |
| <DD>Return whether this field is mapped to the datastore. By default, |
| returns true for all persistent fields whose defining class is mapped. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getProxyType()"><!-- --></A><H3> |
| getProxyType</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A> <B>getProxyType</B>()</PRE> |
| <DL> |
| <DD>The type this field was initialized with, and therefore the |
| type to use for proxies when loading data into this field. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setProxyType(java.lang.Class)"><!-- --></A><H3> |
| setProxyType</H3> |
| <PRE> |
| public void <B>setProxyType</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A> type)</PRE> |
| <DL> |
| <DD>The type this field was initialized with, and therefore the |
| type to use for proxies when loading data into this field. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getInitializer()"><!-- --></A><H3> |
| getInitializer</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> <B>getInitializer</B>()</PRE> |
| <DL> |
| <DD>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://java.sun.com/j2se/1.5.0/docs/api/java/util/Comparator.html" title="class or interface in java.util"><CODE>Comparator</CODE></A> used by a <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Set.html" title="class or interface in java.util"><CODE>Set</CODE></A> or |
| a <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/TimeZone.html" title="class or interface in java.util"><CODE>TimeZone</CODE></A> used by a <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Calendar.html" title="class or interface in java.util"><CODE>Calendar</CODE></A>. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setInitializer(java.lang.Object)"><!-- --></A><H3> |
| setInitializer</H3> |
| <PRE> |
| public void <B>setInitializer</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> initializer)</PRE> |
| <DL> |
| <DD>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://java.sun.com/j2se/1.5.0/docs/api/java/util/Comparator.html" title="class or interface in java.util"><CODE>Comparator</CODE></A> used by a <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Set.html" title="class or interface in java.util"><CODE>Set</CODE></A> or |
| a <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/TimeZone.html" title="class or interface in java.util"><CODE>TimeZone</CODE></A> used by a <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Calendar.html" title="class or interface in java.util"><CODE>Calendar</CODE></A>. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isTransient()"><!-- --></A><H3> |
| isTransient</H3> |
| <PRE> |
| public boolean <B>isTransient</B>()</PRE> |
| <DL> |
| <DD>Return whether this is a transient field. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setTransient(boolean)"><!-- --></A><H3> |
| setTransient</H3> |
| <PRE> |
| public void <B>setTransient</B>(boolean trans)</PRE> |
| <DL> |
| <DD>Return whether this is a transient field. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getIndex()"><!-- --></A><H3> |
| getIndex</H3> |
| <PRE> |
| public int <B>getIndex</B>()</PRE> |
| <DL> |
| <DD>The absolute index of this persistent/transactional field. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setIndex(int)"><!-- --></A><H3> |
| setIndex</H3> |
| <PRE> |
| public void <B>setIndex</B>(int index)</PRE> |
| <DL> |
| <DD>The absolute index of this persistent/transactional field. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDeclaredIndex()"><!-- --></A><H3> |
| getDeclaredIndex</H3> |
| <PRE> |
| public int <B>getDeclaredIndex</B>()</PRE> |
| <DL> |
| <DD>The relative index of this persistent/transactional field. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setDeclaredIndex(int)"><!-- --></A><H3> |
| setDeclaredIndex</H3> |
| <PRE> |
| public void <B>setDeclaredIndex</B>(int index)</PRE> |
| <DL> |
| <DD>The relative index of this persistent/transactional field. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getListingIndex()"><!-- --></A><H3> |
| getListingIndex</H3> |
| <PRE> |
| public int <B>getListingIndex</B>()</PRE> |
| <DL> |
| <DD>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. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setListingIndex(int)"><!-- --></A><H3> |
| setListingIndex</H3> |
| <PRE> |
| public void <B>setListingIndex</B>(int index)</PRE> |
| <DL> |
| <DD>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. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getPrimaryKeyIndex()"><!-- --></A><H3> |
| getPrimaryKeyIndex</H3> |
| <PRE> |
| public int <B>getPrimaryKeyIndex</B>()</PRE> |
| <DL> |
| <DD>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. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setPrimaryKeyIndex(int)"><!-- --></A><H3> |
| setPrimaryKeyIndex</H3> |
| <PRE> |
| public void <B>setPrimaryKeyIndex</B>(int index)</PRE> |
| <DL> |
| <DD>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. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getManagement()"><!-- --></A><H3> |
| getManagement</H3> |
| <PRE> |
| public int <B>getManagement</B>()</PRE> |
| <DL> |
| <DD>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>. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setManagement(int)"><!-- --></A><H3> |
| setManagement</H3> |
| <PRE> |
| public void <B>setManagement</B>(int manage)</PRE> |
| <DL> |
| <DD>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>. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isPrimaryKey()"><!-- --></A><H3> |
| isPrimaryKey</H3> |
| <PRE> |
| public boolean <B>isPrimaryKey</B>()</PRE> |
| <DL> |
| <DD>Whether this is a primary key field. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setPrimaryKey(boolean)"><!-- --></A><H3> |
| setPrimaryKey</H3> |
| <PRE> |
| public void <B>setPrimaryKey</B>(boolean primKey)</PRE> |
| <DL> |
| <DD>Whether this is a primary key field. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getObjectIdFieldTypeCode()"><!-- --></A><H3> |
| getObjectIdFieldTypeCode</H3> |
| <PRE> |
| public int <B>getObjectIdFieldTypeCode</B>()</PRE> |
| <DL> |
| <DD>For a primary key field, return the type of the corresponding object id |
| class field. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getObjectIdFieldType()"><!-- --></A><H3> |
| getObjectIdFieldType</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A> <B>getObjectIdFieldType</B>()</PRE> |
| <DL> |
| <DD>For a primary key field, return the type of the corresponding object id |
| class field. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isVersion()"><!-- --></A><H3> |
| isVersion</H3> |
| <PRE> |
| public boolean <B>isVersion</B>()</PRE> |
| <DL> |
| <DD>Whether this field holds optimistic version information. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setVersion(boolean)"><!-- --></A><H3> |
| setVersion</H3> |
| <PRE> |
| public void <B>setVersion</B>(boolean version)</PRE> |
| <DL> |
| <DD>Whether this field holds optimistic version information. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isInDefaultFetchGroup()"><!-- --></A><H3> |
| isInDefaultFetchGroup</H3> |
| <PRE> |
| public boolean <B>isInDefaultFetchGroup</B>()</PRE> |
| <DL> |
| <DD>Whether this field is in the default fetch group. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setInDefaultFetchGroup(boolean)"><!-- --></A><H3> |
| setInDefaultFetchGroup</H3> |
| <PRE> |
| public void <B>setInDefaultFetchGroup</B>(boolean dfg)</PRE> |
| <DL> |
| <DD>Whether this field is in the default fetch group. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isDefaultFetchGroupExplicit()"><!-- --></A><H3> |
| isDefaultFetchGroupExplicit</H3> |
| <PRE> |
| public boolean <B>isDefaultFetchGroupExplicit</B>()</PRE> |
| <DL> |
| <DD>Whether the default fetch group setting is explicit. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setDefaultFetchGroupExplicit(boolean)"><!-- --></A><H3> |
| setDefaultFetchGroupExplicit</H3> |
| <PRE> |
| public void <B>setDefaultFetchGroupExplicit</B>(boolean explicit)</PRE> |
| <DL> |
| <DD>Whether the default fetch group setting is explicit. Allow setting |
| for testing. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getCustomFetchGroups()"><!-- --></A><H3> |
| getCustomFetchGroups</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>[] <B>getCustomFetchGroups</B>()</PRE> |
| <DL> |
| <DD>Gets the name of the custom fetch groups those are associated to this |
| receiver. This does not include the "default" and "all" fetch groups. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the set of fetch group names, not including the default and |
| all fetch groups.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getLoadFetchGroup()"><!-- --></A><H3> |
| getLoadFetchGroup</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getLoadFetchGroup</B>()</PRE> |
| <DL> |
| <DD>The fetch group that is to be loaded when this receiver is loaded, or |
| null if none set. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setLoadFetchGroup(java.lang.String)"><!-- --></A><H3> |
| setLoadFetchGroup</H3> |
| <PRE> |
| public void <B>setLoadFetchGroup</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> lfg)</PRE> |
| <DL> |
| <DD>The fetch group that is to be loaded when this receiver is loaded, or |
| null if none set. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isInFetchGroup(java.lang.String)"><!-- --></A><H3> |
| isInFetchGroup</H3> |
| <PRE> |
| public boolean <B>isInFetchGroup</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> fg)</PRE> |
| <DL> |
| <DD>Whether this field is in the given fetch group. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setInFetchGroup(java.lang.String, boolean)"><!-- --></A><H3> |
| setInFetchGroup</H3> |
| <PRE> |
| public void <B>setInFetchGroup</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> fg, |
| boolean in)</PRE> |
| <DL> |
| <DD>Set whether this field is in the given fetch group. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><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.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getNullValue()"><!-- --></A><H3> |
| getNullValue</H3> |
| <PRE> |
| public int <B>getNullValue</B>()</PRE> |
| <DL> |
| <DD>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>. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setNullValue(int)"><!-- --></A><H3> |
| setNullValue</H3> |
| <PRE> |
| public void <B>setNullValue</B>(int nullValue)</PRE> |
| <DL> |
| <DD>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>. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isExplicit()"><!-- --></A><H3> |
| isExplicit</H3> |
| <PRE> |
| public boolean <B>isExplicit</B>()</PRE> |
| <DL> |
| <DD>Whether this field is explicitly declared in the metadata. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setExplicit(boolean)"><!-- --></A><H3> |
| setExplicit</H3> |
| <PRE> |
| public void <B>setExplicit</B>(boolean explicit)</PRE> |
| <DL> |
| <DD>Whether this field is explicitly declared in the metadata. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getMappedBy()"><!-- --></A><H3> |
| getMappedBy</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getMappedBy</B>()</PRE> |
| <DL> |
| <DD>The field that this field shares a mapping with. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setMappedBy(java.lang.String)"><!-- --></A><H3> |
| setMappedBy</H3> |
| <PRE> |
| public void <B>setMappedBy</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> mapped)</PRE> |
| <DL> |
| <DD>The field that this field shares a mapping with. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getMappedByMetaData()"><!-- --></A><H3> |
| getMappedByMetaData</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</A> <B>getMappedByMetaData</B>()</PRE> |
| <DL> |
| <DD>The field that this field shares a mapping with. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getInverse()"><!-- --></A><H3> |
| getInverse</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getInverse</B>()</PRE> |
| <DL> |
| <DD>Logical inverse field. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setInverse(java.lang.String)"><!-- --></A><H3> |
| setInverse</H3> |
| <PRE> |
| public void <B>setInverse</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> inverse)</PRE> |
| <DL> |
| <DD>Logical inverse field. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getInverseMetaDatas()"><!-- --></A><H3> |
| getInverseMetaDatas</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</A>[] <B>getInverseMetaDatas</B>()</PRE> |
| <DL> |
| <DD>Return all inverses of this field. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getValueStrategy()"><!-- --></A><H3> |
| getValueStrategy</H3> |
| <PRE> |
| public int <B>getValueStrategy</B>()</PRE> |
| <DL> |
| <DD>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>. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setValueStrategy(int)"><!-- --></A><H3> |
| setValueStrategy</H3> |
| <PRE> |
| public void <B>setValueStrategy</B>(int strategy)</PRE> |
| <DL> |
| <DD>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>. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getValueSequenceName()"><!-- --></A><H3> |
| getValueSequenceName</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getValueSequenceName</B>()</PRE> |
| <DL> |
| <DD>The value sequence name, or null for none. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setValueSequenceName(java.lang.String)"><!-- --></A><H3> |
| setValueSequenceName</H3> |
| <PRE> |
| public void <B>setValueSequenceName</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> seqName)</PRE> |
| <DL> |
| <DD>The value sequence name, or null for none. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getValueSequenceMetaData()"><!-- --></A><H3> |
| getValueSequenceMetaData</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/openjpa/meta/SequenceMetaData.html" title="class in org.apache.openjpa.meta">SequenceMetaData</A> <B>getValueSequenceMetaData</B>()</PRE> |
| <DL> |
| <DD>Metadata for the value sequence. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getUpdateStrategy()"><!-- --></A><H3> |
| getUpdateStrategy</H3> |
| <PRE> |
| public int <B>getUpdateStrategy</B>()</PRE> |
| <DL> |
| <DD>The strategy to use when updating the field. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setUpdateStrategy(int)"><!-- --></A><H3> |
| setUpdateStrategy</H3> |
| <PRE> |
| public void <B>setUpdateStrategy</B>(int strategy)</PRE> |
| <DL> |
| <DD>Set the update strategy. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isLRS()"><!-- --></A><H3> |
| isLRS</H3> |
| <PRE> |
| public boolean <B>isLRS</B>()</PRE> |
| <DL> |
| <DD>Whether this field is backed by a large result set. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setLRS(boolean)"><!-- --></A><H3> |
| setLRS</H3> |
| <PRE> |
| public void <B>setLRS</B>(boolean lrs)</PRE> |
| <DL> |
| <DD>Whether this field is backed by a large result set. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isStream()"><!-- --></A><H3> |
| isStream</H3> |
| <PRE> |
| public boolean <B>isStream</B>()</PRE> |
| <DL> |
| <DD>Whether this field is backed by a stream. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.1.0</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setStream(boolean)"><!-- --></A><H3> |
| setStream</H3> |
| <PRE> |
| public void <B>setStream</B>(boolean stream)</PRE> |
| <DL> |
| <DD>Whether this field is backed by a stream. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.1.0</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="usesIntermediate()"><!-- --></A><H3> |
| usesIntermediate</H3> |
| <PRE> |
| public boolean <B>usesIntermediate</B>()</PRE> |
| <DL> |
| <DD>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. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#setIntermediate(int, java.lang.Object)"><CODE>OpenJPAStateManager.setIntermediate(int,Object)</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setUsesIntermediate(boolean)"><!-- --></A><H3> |
| setUsesIntermediate</H3> |
| <PRE> |
| public void <B>setUsesIntermediate</B>(boolean intermediate)</PRE> |
| <DL> |
| <DD>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. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#setIntermediate(int, java.lang.Object)"><CODE>OpenJPAStateManager.setIntermediate(int,Object)</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="usesImplData()"><!-- --></A><H3> |
| usesImplData</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Boolean.html" title="class or interface in java.lang">Boolean</A> <B>usesImplData</B>()</PRE> |
| <DL> |
| <DD>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://java.sun.com/j2se/1.5.0/docs/api/java/lang/Boolean.html#TRUE" title="class or interface in java.lang"><CODE>Boolean.TRUE</CODE></A> (non-cachable impl data). |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Boolean.html#FALSE" title="class or interface in java.lang"><CODE>Boolean.FALSE</CODE></A> if this field does not use impl data, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Boolean.html#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<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#setImplData(int, java.lang.Object)"><CODE>OpenJPAStateManager.setImplData(int,Object)</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setUsesImplData(java.lang.Boolean)"><!-- --></A><H3> |
| setUsesImplData</H3> |
| <PRE> |
| public void <B>setUsesImplData</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Boolean.html" title="class or interface in java.lang">Boolean</A> implData)</PRE> |
| <DL> |
| <DD>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>. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#setImplData(int, java.lang.Object)"><CODE>OpenJPAStateManager.setImplData(int,Object)</CODE></A>, |
| <A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html#usesImplData()"><CODE>usesImplData()</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getOrders()"><!-- --></A><H3> |
| getOrders</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/openjpa/meta/Order.html" title="interface in org.apache.openjpa.meta">Order</A>[] <B>getOrders</B>()</PRE> |
| <DL> |
| <DD>The orderings for this field to be applied on load, or empty array. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setOrders(org.apache.openjpa.meta.Order[])"><!-- --></A><H3> |
| setOrders</H3> |
| <PRE> |
| public void <B>setOrders</B>(<A HREF="../../../../org/apache/openjpa/meta/Order.html" title="interface in org.apache.openjpa.meta">Order</A>[] orders)</PRE> |
| <DL> |
| <DD>The orderings for this field to be applied on load. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getOrderDeclaration()"><!-- --></A><H3> |
| getOrderDeclaration</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getOrderDeclaration</B>()</PRE> |
| <DL> |
| <DD>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. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setOrderDeclaration(java.lang.String)"><!-- --></A><H3> |
| setOrderDeclaration</H3> |
| <PRE> |
| public void <B>setOrderDeclaration</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> dec)</PRE> |
| <DL> |
| <DD>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. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="order(java.lang.Object)"><!-- --></A><H3> |
| order</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> <B>order</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> val)</PRE> |
| <DL> |
| <DD>Order this field value when it is loaded. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isExternalized()"><!-- --></A><H3> |
| isExternalized</H3> |
| <PRE> |
| public boolean <B>isExternalized</B>()</PRE> |
| <DL> |
| <DD>Whether the field is externalized. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getExternalValue(java.lang.Object, org.apache.openjpa.kernel.StoreContext)"><!-- --></A><H3> |
| getExternalValue</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> <B>getExternalValue</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" 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> |
| <DL> |
| <DD>Convert the given field value to its external value through the |
| provided externalizer, or return the value as-is if no externalizer. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getFieldValue(java.lang.Object, org.apache.openjpa.kernel.StoreContext)"><!-- --></A><H3> |
| getFieldValue</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> <B>getFieldValue</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" 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> |
| <DL> |
| <DD>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. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getExternalizer()"><!-- --></A><H3> |
| getExternalizer</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getExternalizer</B>()</PRE> |
| <DL> |
| <DD>The name of this field's externalizer, or null if none. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setExternalizer(java.lang.String)"><!-- --></A><H3> |
| setExternalizer</H3> |
| <PRE> |
| public void <B>setExternalizer</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> externalizer)</PRE> |
| <DL> |
| <DD>The name of this field's externalizer, or null if none. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getFactory()"><!-- --></A><H3> |
| getFactory</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getFactory</B>()</PRE> |
| <DL> |
| <DD>The name of this field's factory, or null if none. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setFactory(java.lang.String)"><!-- --></A><H3> |
| setFactory</H3> |
| <PRE> |
| public void <B>setFactory</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> factory)</PRE> |
| <DL> |
| <DD>The name of this field's factory, or null if none. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getExternalValues()"><!-- --></A><H3> |
| getExternalValues</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getExternalValues</B>()</PRE> |
| <DL> |
| <DD>Properties string mapping field values to external values. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setExternalValues(java.lang.String)"><!-- --></A><H3> |
| setExternalValues</H3> |
| <PRE> |
| public void <B>setExternalValues</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> values)</PRE> |
| <DL> |
| <DD>Properties string mapping field values to external values. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getExternalValueMap()"><!-- --></A><H3> |
| getExternalValueMap</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html" title="class or interface in java.util">Map</A> <B>getExternalValueMap</B>()</PRE> |
| <DL> |
| <DD>Return the mapping of field values to external values. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getFieldValueMap()"><!-- --></A><H3> |
| getFieldValueMap</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html" title="class or interface in java.util">Map</A> <B>getFieldValueMap</B>()</PRE> |
| <DL> |
| <DD>Return the mapping of external values to field values. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getExternalizerMethod()"><!-- --></A><H3> |
| getExternalizerMethod</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/reflect/Method.html" title="class or interface in java.lang.reflect">Method</A> <B>getExternalizerMethod</B>()</PRE> |
| <DL> |
| <DD>The externalizer method. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getFactoryMethod()"><!-- --></A><H3> |
| getFactoryMethod</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/reflect/Member.html" title="class or interface in java.lang.reflect">Member</A> <B>getFactoryMethod</B>()</PRE> |
| <DL> |
| <DD>The factory method or constructor. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="equals(java.lang.Object)"><!-- --></A><H3> |
| equals</H3> |
| <PRE> |
| public boolean <B>equals</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> other)</PRE> |
| <DL> |
| <DD><DL> |
| <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="hashCode()"><!-- --></A><H3> |
| hashCode</H3> |
| <PRE> |
| public int <B>hashCode</B>()</PRE> |
| <DL> |
| <DD><DL> |
| <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="compareTo(java.lang.Object)"><!-- --></A><H3> |
| compareTo</H3> |
| <PRE> |
| public int <B>compareTo</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> other)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="toString()"><!-- --></A><H3> |
| toString</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>toString</B>()</PRE> |
| <DL> |
| <DD><DL> |
| <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang">toString</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getResolve()"><!-- --></A><H3> |
| getResolve</H3> |
| <PRE> |
| public int <B>getResolve</B>()</PRE> |
| <DL> |
| <DD>Resolve mode for this field. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><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></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setResolve(int)"><!-- --></A><H3> |
| setResolve</H3> |
| <PRE> |
| public void <B>setResolve</B>(int mode)</PRE> |
| <DL> |
| <DD>Resolve mode for this field. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><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></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setResolve(int, boolean)"><!-- --></A><H3> |
| setResolve</H3> |
| <PRE> |
| public void <B>setResolve</B>(int mode, |
| boolean on)</PRE> |
| <DL> |
| <DD>Resolve mode for this field. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/meta/ValueMetaData.html#setResolve(int, boolean)">setResolve</A></CODE> in interface <CODE><A HREF="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="resolve(int)"><!-- --></A><H3> |
| resolve</H3> |
| <PRE> |
| public boolean <B>resolve</B>(int mode)</PRE> |
| <DL> |
| <DD>Resolve and validate metadata. Return true if already resolved. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><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></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="copy(org.apache.openjpa.meta.FieldMetaData)"><!-- --></A><H3> |
| copy</H3> |
| <PRE> |
| public void <B>copy</B>(<A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</A> field)</PRE> |
| <DL> |
| <DD>Copy state from the given field to this one. Do not copy mapping |
| information. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addExtensionKeys(java.util.Collection)"><!-- --></A><H3> |
| addExtensionKeys</H3> |
| <PRE> |
| protected void <B>addExtensionKeys</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> exts)</PRE> |
| <DL> |
| <DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/openjpa/meta/Extensions.html#addExtensionKeys(java.util.Collection)">Extensions</A></CODE></B></DD> |
| <DD>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. |
| <P> |
| <DD><DL> |
| <DT><B>Overrides:</B><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></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getComments()"><!-- --></A><H3> |
| getComments</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>[] <B>getComments</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/lib/xml/Commentable.html#getComments()">Commentable</A></CODE></B></DD> |
| <DD>Return comments, or empty array if none. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><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></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setComments(java.lang.String[])"><!-- --></A><H3> |
| setComments</H3> |
| <PRE> |
| public void <B>setComments</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>[] comments)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/lib/xml/Commentable.html#setComments(java.lang.String[])">Commentable</A></CODE></B></DD> |
| <DD>Set comments. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><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></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getFieldMetaData()"><!-- --></A><H3> |
| getFieldMetaData</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</A> <B>getFieldMetaData</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/meta/ValueMetaData.html#getFieldMetaData()">ValueMetaData</A></CODE></B></DD> |
| <DD>Return the owning field for this value. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><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></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getType()"><!-- --></A><H3> |
| getType</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A> <B>getType</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/meta/ValueMetaData.html#getType()">ValueMetaData</A></CODE></B></DD> |
| <DD>The value class. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><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></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setType(java.lang.Class)"><!-- --></A><H3> |
| setType</H3> |
| <PRE> |
| public void <B>setType</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A> type)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/meta/ValueMetaData.html#setType(java.lang.Class)">ValueMetaData</A></CODE></B></DD> |
| <DD>The value class. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><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></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getTypeCode()"><!-- --></A><H3> |
| getTypeCode</H3> |
| <PRE> |
| public int <B>getTypeCode</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/meta/ValueMetaData.html#getTypeCode()">ValueMetaData</A></CODE></B></DD> |
| <DD>The type code of the value class. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><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></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setTypeCode(int)"><!-- --></A><H3> |
| setTypeCode</H3> |
| <PRE> |
| public void <B>setTypeCode</B>(int code)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/meta/ValueMetaData.html#setTypeCode(int)">ValueMetaData</A></CODE></B></DD> |
| <DD>The type code of the value class. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><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></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isTypePC()"><!-- --></A><H3> |
| isTypePC</H3> |
| <PRE> |
| public boolean <B>isTypePC</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/meta/ValueMetaData.html#isTypePC()">ValueMetaData</A></CODE></B></DD> |
| <DD>Whether the type is a persistence capable instance. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><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></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getTypeMetaData()"><!-- --></A><H3> |
| getTypeMetaData</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</A> <B>getTypeMetaData</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/meta/ValueMetaData.html#getTypeMetaData()">ValueMetaData</A></CODE></B></DD> |
| <DD>The metadata for the value class, if the type is persistent. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><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></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDeclaredType()"><!-- --></A><H3> |
| getDeclaredType</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A> <B>getDeclaredType</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/meta/ValueMetaData.html#getDeclaredType()">ValueMetaData</A></CODE></B></DD> |
| <DD>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. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><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></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setDeclaredType(java.lang.Class)"><!-- --></A><H3> |
| setDeclaredType</H3> |
| <PRE> |
| public void <B>setDeclaredType</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A> type)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/meta/ValueMetaData.html#setDeclaredType(java.lang.Class)">ValueMetaData</A></CODE></B></DD> |
| <DD>Set the declared class of the value. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><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></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDeclaredTypeCode()"><!-- --></A><H3> |
| getDeclaredTypeCode</H3> |
| <PRE> |
| public int <B>getDeclaredTypeCode</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/meta/ValueMetaData.html#getDeclaredTypeCode()">ValueMetaData</A></CODE></B></DD> |
| <DD>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. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><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></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setDeclaredTypeCode(int)"><!-- --></A><H3> |
| setDeclaredTypeCode</H3> |
| <PRE> |
| public void <B>setDeclaredTypeCode</B>(int type)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/meta/ValueMetaData.html#setDeclaredTypeCode(int)">ValueMetaData</A></CODE></B></DD> |
| <DD>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. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><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></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isDeclaredTypePC()"><!-- --></A><H3> |
| isDeclaredTypePC</H3> |
| <PRE> |
| public boolean <B>isDeclaredTypePC</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/meta/ValueMetaData.html#isDeclaredTypePC()">ValueMetaData</A></CODE></B></DD> |
| <DD>Whether the type is a persistence capable instance. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><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></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDeclaredTypeMetaData()"><!-- --></A><H3> |
| getDeclaredTypeMetaData</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</A> <B>getDeclaredTypeMetaData</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/meta/ValueMetaData.html#getDeclaredTypeMetaData()">ValueMetaData</A></CODE></B></DD> |
| <DD>Return metadata for the value's class, if the type is persistent. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><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></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isEmbedded()"><!-- --></A><H3> |
| isEmbedded</H3> |
| <PRE> |
| public boolean <B>isEmbedded</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/meta/ValueMetaData.html#isEmbedded()">ValueMetaData</A></CODE></B></DD> |
| <DD>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. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><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></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setEmbedded(boolean)"><!-- --></A><H3> |
| setEmbedded</H3> |
| <PRE> |
| public void <B>setEmbedded</B>(boolean embedded)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/meta/ValueMetaData.html#setEmbedded(boolean)">ValueMetaData</A></CODE></B></DD> |
| <DD>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. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><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></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isEmbeddedPC()"><!-- --></A><H3> |
| isEmbeddedPC</H3> |
| <PRE> |
| public boolean <B>isEmbeddedPC</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/meta/ValueMetaData.html#isEmbeddedPC()">ValueMetaData</A></CODE></B></DD> |
| <DD>Whether this is an embedded persistence capable value. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><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></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getEmbeddedMetaData()"><!-- --></A><H3> |
| getEmbeddedMetaData</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</A> <B>getEmbeddedMetaData</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/meta/ValueMetaData.html#getEmbeddedMetaData()">ValueMetaData</A></CODE></B></DD> |
| <DD>The embedded class metadata for the value. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><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></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addEmbeddedMetaData()"><!-- --></A><H3> |
| addEmbeddedMetaData</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/openjpa/meta/ClassMetaData.html" title="class in org.apache.openjpa.meta">ClassMetaData</A> <B>addEmbeddedMetaData</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/meta/ValueMetaData.html#addEmbeddedMetaData()">ValueMetaData</A></CODE></B></DD> |
| <DD>Add embedded metadata for this value. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><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></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getCascadeDelete()"><!-- --></A><H3> |
| getCascadeDelete</H3> |
| <PRE> |
| public int <B>getCascadeDelete</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/meta/ValueMetaData.html#getCascadeDelete()">ValueMetaData</A></CODE></B></DD> |
| <DD>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> |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><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></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setCascadeDelete(int)"><!-- --></A><H3> |
| setCascadeDelete</H3> |
| <PRE> |
| public void <B>setCascadeDelete</B>(int delete)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/meta/ValueMetaData.html#setCascadeDelete(int)">ValueMetaData</A></CODE></B></DD> |
| <DD>Cascade behavior for deletion. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><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></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../org/apache/openjpa/meta/ValueMetaData.html#getCascadeDelete()"><CODE>ValueMetaData.getCascadeDelete()</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getCascadePersist()"><!-- --></A><H3> |
| getCascadePersist</H3> |
| <PRE> |
| public int <B>getCascadePersist</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/meta/ValueMetaData.html#getCascadePersist()">ValueMetaData</A></CODE></B></DD> |
| <DD>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> |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><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></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setCascadePersist(int)"><!-- --></A><H3> |
| setCascadePersist</H3> |
| <PRE> |
| public void <B>setCascadePersist</B>(int persist)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/meta/ValueMetaData.html#setCascadePersist(int)">ValueMetaData</A></CODE></B></DD> |
| <DD>Cascade behavior for persist operation. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><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></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../org/apache/openjpa/meta/ValueMetaData.html#getCascadePersist()"><CODE>ValueMetaData.getCascadePersist()</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getCascadeAttach()"><!-- --></A><H3> |
| getCascadeAttach</H3> |
| <PRE> |
| public int <B>getCascadeAttach</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/meta/ValueMetaData.html#getCascadeAttach()">ValueMetaData</A></CODE></B></DD> |
| <DD>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> |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><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></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setCascadeAttach(int)"><!-- --></A><H3> |
| setCascadeAttach</H3> |
| <PRE> |
| public void <B>setCascadeAttach</B>(int attach)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/meta/ValueMetaData.html#setCascadeAttach(int)">ValueMetaData</A></CODE></B></DD> |
| <DD>Cascade behavior for attach operation. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><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></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../org/apache/openjpa/meta/ValueMetaData.html#getCascadeAttach()"><CODE>ValueMetaData.getCascadeAttach()</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getCascadeRefresh()"><!-- --></A><H3> |
| getCascadeRefresh</H3> |
| <PRE> |
| public int <B>getCascadeRefresh</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/meta/ValueMetaData.html#getCascadeRefresh()">ValueMetaData</A></CODE></B></DD> |
| <DD>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> |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><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></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setCascadeRefresh(int)"><!-- --></A><H3> |
| setCascadeRefresh</H3> |
| <PRE> |
| public void <B>setCascadeRefresh</B>(int refresh)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/meta/ValueMetaData.html#setCascadeRefresh(int)">ValueMetaData</A></CODE></B></DD> |
| <DD>Cascade behavior for refresh operation. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><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></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../org/apache/openjpa/meta/ValueMetaData.html#getCascadeRefresh()"><CODE>ValueMetaData.getCascadeRefresh()</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isSerialized()"><!-- --></A><H3> |
| isSerialized</H3> |
| <PRE> |
| public boolean <B>isSerialized</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/meta/ValueMetaData.html#isSerialized()">ValueMetaData</A></CODE></B></DD> |
| <DD>Whether this value is serialized when stored. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><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></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setSerialized(boolean)"><!-- --></A><H3> |
| setSerialized</H3> |
| <PRE> |
| public void <B>setSerialized</B>(boolean serialized)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/meta/ValueMetaData.html#setSerialized(boolean)">ValueMetaData</A></CODE></B></DD> |
| <DD>Whether this value is serialized when stored. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><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></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getValueMappedBy()"><!-- --></A><H3> |
| getValueMappedBy</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getValueMappedBy</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/meta/ValueMetaData.html#getValueMappedBy()">ValueMetaData</A></CODE></B></DD> |
| <DD>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. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><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></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setValueMappedBy(java.lang.String)"><!-- --></A><H3> |
| setValueMappedBy</H3> |
| <PRE> |
| public void <B>setValueMappedBy</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> mapped)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/meta/ValueMetaData.html#setValueMappedBy(java.lang.String)">ValueMetaData</A></CODE></B></DD> |
| <DD>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. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><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></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getValueMappedByMetaData()"><!-- --></A><H3> |
| getValueMappedByMetaData</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</A> <B>getValueMappedByMetaData</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/meta/ValueMetaData.html#getValueMappedByMetaData()">ValueMetaData</A></CODE></B></DD> |
| <DD>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. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><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></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getTypeOverride()"><!-- --></A><H3> |
| getTypeOverride</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A> <B>getTypeOverride</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/meta/ValueMetaData.html#getTypeOverride()">ValueMetaData</A></CODE></B></DD> |
| <DD>User-supplied type overriding assumed type based on field. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><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></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setTypeOverride(java.lang.Class)"><!-- --></A><H3> |
| setTypeOverride</H3> |
| <PRE> |
| public void <B>setTypeOverride</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A> type)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/meta/ValueMetaData.html#setTypeOverride(java.lang.Class)">ValueMetaData</A></CODE></B></DD> |
| <DD>User-supplied type overriding assumed type based on field. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><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></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="copy(org.apache.openjpa.meta.ValueMetaData)"><!-- --></A><H3> |
| copy</H3> |
| <PRE> |
| public void <B>copy</B>(<A HREF="../../../../org/apache/openjpa/meta/ValueMetaData.html" title="interface in org.apache.openjpa.meta">ValueMetaData</A> vmd)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/meta/ValueMetaData.html#copy(org.apache.openjpa.meta.ValueMetaData)">ValueMetaData</A></CODE></B></DD> |
| <DD>Copy state from the given value to this one. Do not copy mapping |
| information. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><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></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isUsedInOrderBy()"><!-- --></A><H3> |
| isUsedInOrderBy</H3> |
| <PRE> |
| public boolean <B>isUsedInOrderBy</B>()</PRE> |
| <DL> |
| <DD>Check if this field is used by other field as "order by" value. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.1.0</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setUsedInOrderBy(boolean)"><!-- --></A><H3> |
| setUsedInOrderBy</H3> |
| <PRE> |
| public void <B>setUsedInOrderBy</B>(boolean isUsed)</PRE> |
| <DL> |
| <DD>Whether this field is used by other field as "order by" value . |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.1.0</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isValueGenerated()"><!-- --></A><H3> |
| isValueGenerated</H3> |
| <PRE> |
| public boolean <B>isValueGenerated</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setValueGenerated(boolean)"><!-- --></A><H3> |
| setValueGenerated</H3> |
| <PRE> |
| public void <B>setValueGenerated</B>(boolean generated)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/FieldMetaData.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/apache/openjpa/meta/FetchGroup.html" title="class in org.apache.openjpa.meta"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.MemberProvider.html" title="class in org.apache.openjpa.meta"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/openjpa/meta/FieldMetaData.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="FieldMetaData.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| Copyright © 2006-2010 <a href="http://www.apache.org">Apache Software Foundation</a>. All Rights Reserved. |
| </BODY> |
| </HTML> |
