| <!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_06) on Sat Oct 14 18:42:03 PDT 2006 --> |
| <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> |
| <TITLE> |
| ReverseCustomizer (OpenJPA 0.9.0-incubating API) |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.apache.openjpa.jdbc.meta.ReverseCustomizer interface"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="ReverseCustomizer (OpenJPA 0.9.0-incubating 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/ReverseCustomizer.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/jdbc/meta/RelationId.html" title="interface in org.apache.openjpa.jdbc.meta"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseMappingTool.html" title="class in org.apache.openjpa.jdbc.meta"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../index.html?org/apache/openjpa/jdbc/meta/ReverseCustomizer.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="ReverseCustomizer.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: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <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.jdbc.meta</FONT> |
| <BR> |
| Interface ReverseCustomizer</H2> |
| <DL> |
| <DT><B>All Superinterfaces:</B> <DD><A HREF="../../../../../org/apache/openjpa/lib/util/Closeable.html" title="interface in org.apache.openjpa.lib.util">Closeable</A></DD> |
| </DL> |
| <DL> |
| <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../org/apache/openjpa/jdbc/meta/PropertiesReverseCustomizer.html" title="class in org.apache.openjpa.jdbc.meta">PropertiesReverseCustomizer</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public interface <B>ReverseCustomizer</B><DT>extends <A HREF="../../../../../org/apache/openjpa/lib/util/Closeable.html" title="interface in org.apache.openjpa.lib.util">Closeable</A></DL> |
| </PRE> |
| |
| <P> |
| Plugin in interface to customize the output of the |
| <A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseMappingTool.html" title="class in org.apache.openjpa.jdbc.meta"><CODE>ReverseMappingTool</CODE></A>. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Author:</B></DT> |
| <DD>Abe White</DD> |
| </DL> |
| <HR> |
| |
| <P> |
| |
| <!-- ========== 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> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseCustomizer.html#close()">close</A></B>()</CODE> |
| |
| <BR> |
| Invoked when the customizer is no longer needed.</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/jdbc/meta/ReverseCustomizer.html#customize(org.apache.openjpa.jdbc.meta.ClassMapping)">customize</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/meta/ClassMapping.html" title="class in org.apache.openjpa.jdbc.meta">ClassMapping</A> cls)</CODE> |
| |
| <BR> |
| Customize the given class information produced by the reverse mapping |
| tool.</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/jdbc/meta/ReverseCustomizer.html#customize(org.apache.openjpa.jdbc.meta.FieldMapping)">customize</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/meta/FieldMapping.html" title="class in org.apache.openjpa.jdbc.meta">FieldMapping</A> field)</CODE> |
| |
| <BR> |
| Customize the given field information produced by the reverse mapping |
| tool.</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/jdbc/meta/ReverseCustomizer.html#getClassCode(org.apache.openjpa.jdbc.meta.ClassMapping)">getClassCode</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/meta/ClassMapping.html" title="class in org.apache.openjpa.jdbc.meta">ClassMapping</A> mapping)</CODE> |
| |
| <BR> |
| Return a code template for the given class, or null to use the standard |
| system-generated Java code.</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/jdbc/meta/ReverseCustomizer.html#getClassName(org.apache.openjpa.jdbc.schema.Table, java.lang.String)">getClassName</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</A> table, |
| <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> defaultName)</CODE> |
| |
| <BR> |
| Return the fully-qualified class name to generate for the given table.</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/jdbc/meta/ReverseCustomizer.html#getDeclaration(org.apache.openjpa.jdbc.meta.FieldMapping)">getDeclaration</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/meta/FieldMapping.html" title="class in org.apache.openjpa.jdbc.meta">FieldMapping</A> field)</CODE> |
| |
| <BR> |
| Return a code template for the declaration of the given field, or null |
| to use the system-generated default Java code.</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/jdbc/meta/ReverseCustomizer.html#getFieldCode(org.apache.openjpa.jdbc.meta.FieldMapping)">getFieldCode</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/meta/FieldMapping.html" title="class in org.apache.openjpa.jdbc.meta">FieldMapping</A> field)</CODE> |
| |
| <BR> |
| Return a code template for the get/set methods of the given field, or |
| null to use the system-generated default Java code.</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/jdbc/meta/ReverseCustomizer.html#getFieldName(org.apache.openjpa.jdbc.meta.ClassMapping, org.apache.openjpa.jdbc.schema.Column[], org.apache.openjpa.jdbc.schema.ForeignKey, java.lang.String)">getFieldName</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/meta/ClassMapping.html" title="class in org.apache.openjpa.jdbc.meta">ClassMapping</A> dec, |
| <A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A>[] cols, |
| <A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html" title="class in org.apache.openjpa.jdbc.schema">ForeignKey</A> fk, |
| <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> defaultName)</CODE> |
| |
| <BR> |
| Return the field name used to map the given columns, or null to prevent |
| the columns from being mapped.</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/jdbc/meta/ReverseCustomizer.html#getInitialValue(org.apache.openjpa.jdbc.meta.FieldMapping)">getInitialValue</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/meta/FieldMapping.html" title="class in org.apache.openjpa.jdbc.meta">FieldMapping</A> field)</CODE> |
| |
| <BR> |
| Return code for the initial value for the given field, or null to use |
| the default generated by the system.</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/jdbc/meta/ReverseCustomizer.html#getTableType(org.apache.openjpa.jdbc.schema.Table, int)">getTableType</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</A> table, |
| int defaultType)</CODE> |
| |
| <BR> |
| Return the type of the given table, or the given default type.</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/jdbc/meta/ReverseCustomizer.html#setConfiguration(java.util.Properties)">setConfiguration</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Properties.html" title="class or interface in java.util">Properties</A> props)</CODE> |
| |
| <BR> |
| Set configuration properties given by the user.</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/jdbc/meta/ReverseCustomizer.html#setTool(org.apache.openjpa.jdbc.meta.ReverseMappingTool)">setTool</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseMappingTool.html" title="class in org.apache.openjpa.jdbc.meta">ReverseMappingTool</A> tool)</CODE> |
| |
| <BR> |
| Set the reverse mapping tool using this customizer.</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/jdbc/meta/ReverseCustomizer.html#unmappedTable(org.apache.openjpa.jdbc.schema.Table)">unmappedTable</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</A> table)</CODE> |
| |
| <BR> |
| Notification that a table has gone unmapped.</TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ 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="setConfiguration(java.util.Properties)"><!-- --></A><H3> |
| setConfiguration</H3> |
| <PRE> |
| void <B>setConfiguration</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Properties.html" title="class or interface in java.util">Properties</A> props)</PRE> |
| <DL> |
| <DD>Set configuration properties given by the user. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setTool(org.apache.openjpa.jdbc.meta.ReverseMappingTool)"><!-- --></A><H3> |
| setTool</H3> |
| <PRE> |
| void <B>setTool</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseMappingTool.html" title="class in org.apache.openjpa.jdbc.meta">ReverseMappingTool</A> tool)</PRE> |
| <DL> |
| <DD>Set the reverse mapping tool using this customizer. You can use |
| the tool to see how it is configured, or to use utility methods the |
| tool provides. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getTableType(org.apache.openjpa.jdbc.schema.Table, int)"><!-- --></A><H3> |
| getTableType</H3> |
| <PRE> |
| int <B>getTableType</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</A> table, |
| int defaultType)</PRE> |
| <DL> |
| <DD>Return the type of the given table, or the given default type. |
| See the TABLE_XXX constants in <A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseMappingTool.html" title="class in org.apache.openjpa.jdbc.meta"><CODE>ReverseMappingTool</CODE></A>. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getClassName(org.apache.openjpa.jdbc.schema.Table, java.lang.String)"><!-- --></A><H3> |
| getClassName</H3> |
| <PRE> |
| <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>getClassName</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</A> table, |
| <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> defaultName)</PRE> |
| <DL> |
| <DD>Return the fully-qualified class name to generate for the given table. |
| Return null to prevent the table from being mapped. Return the given |
| default name if it is acceptable. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="customize(org.apache.openjpa.jdbc.meta.ClassMapping)"><!-- --></A><H3> |
| customize</H3> |
| <PRE> |
| void <B>customize</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/meta/ClassMapping.html" title="class in org.apache.openjpa.jdbc.meta">ClassMapping</A> cls)</PRE> |
| <DL> |
| <DD>Customize the given class information produced by the reverse mapping |
| tool. To change the application identity class, use |
| <A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseMappingTool.html#generateClass(java.lang.String, java.lang.Class)"><CODE>ReverseMappingTool.generateClass(java.lang.String, java.lang.Class)</CODE></A> to creat the new class object. |
| The class will not have any fields at the time of this call. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getClassCode(org.apache.openjpa.jdbc.meta.ClassMapping)"><!-- --></A><H3> |
| getClassCode</H3> |
| <PRE> |
| <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>getClassCode</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/meta/ClassMapping.html" title="class in org.apache.openjpa.jdbc.meta">ClassMapping</A> mapping)</PRE> |
| <DL> |
| <DD>Return a code template for the given class, or null to use the standard |
| system-generated Java code. To facilitate template reuse, the |
| following parameters can appear in your template; the proper values |
| will be subtituted by the system: |
| <ul> |
| <li>${packageDec}: The package declaration, in the form |
| "package <package name >;", or empty string if no package.</li> |
| <li>${imports}: Imports for the packages used by the declared |
| field types.</li> |
| <li>${className}: The name of the class, without package.</li> |
| <li>${extendsDec}: Extends declaration, in the form |
| "extends <superclass>", or empty string if no superclass.</li> |
| <li>${constructor}: A constructor that takes in all primary key fields |
| of the class, or empty string if the class uses datastore identity.</li> |
| <li>${fieldDecs}: Declarations of all the generated fields.</li> |
| <li>${fieldCode}: Get/set methods for all the generated fields.</li> |
| </ul> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getFieldName(org.apache.openjpa.jdbc.meta.ClassMapping, org.apache.openjpa.jdbc.schema.Column[], org.apache.openjpa.jdbc.schema.ForeignKey, java.lang.String)"><!-- --></A><H3> |
| getFieldName</H3> |
| <PRE> |
| <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>getFieldName</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/meta/ClassMapping.html" title="class in org.apache.openjpa.jdbc.meta">ClassMapping</A> dec, |
| <A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A>[] cols, |
| <A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html" title="class in org.apache.openjpa.jdbc.schema">ForeignKey</A> fk, |
| <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> defaultName)</PRE> |
| <DL> |
| <DD>Return the field name used to map the given columns, or null to prevent |
| the columns from being mapped. Return the given default if it is |
| acceptable. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>dec</CODE> - the class that will declare this field<DD><CODE>cols</CODE> - the column(s) this field will represent<DD><CODE>fk</CODE> - for relation fields, the foreign key to the related type</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="customize(org.apache.openjpa.jdbc.meta.FieldMapping)"><!-- --></A><H3> |
| customize</H3> |
| <PRE> |
| void <B>customize</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/meta/FieldMapping.html" title="class in org.apache.openjpa.jdbc.meta">FieldMapping</A> field)</PRE> |
| <DL> |
| <DD>Customize the given field information produced by the reverse mapping |
| tool. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getInitialValue(org.apache.openjpa.jdbc.meta.FieldMapping)"><!-- --></A><H3> |
| getInitialValue</H3> |
| <PRE> |
| <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>getInitialValue</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/meta/FieldMapping.html" title="class in org.apache.openjpa.jdbc.meta">FieldMapping</A> field)</PRE> |
| <DL> |
| <DD>Return code for the initial value for the given field, or null to use |
| the default generated by the system. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDeclaration(org.apache.openjpa.jdbc.meta.FieldMapping)"><!-- --></A><H3> |
| getDeclaration</H3> |
| <PRE> |
| <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>getDeclaration</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/meta/FieldMapping.html" title="class in org.apache.openjpa.jdbc.meta">FieldMapping</A> field)</PRE> |
| <DL> |
| <DD>Return a code template for the declaration of the given field, or null |
| to use the system-generated default Java code. |
| To facilitate template reuse, the following parameters can appear in |
| your template; the proper values will be subtituted by the system: |
| <ul> |
| <li>${fieldName}: The name of the field.</li> |
| <li>${capFieldName}: The capitalized field name.</li> |
| <li>${propertyName}: The field name without leading '_', if any.</li> |
| <li>${fieldType}: The field's type name.</li> |
| <li>${fieldValue}: The field's initial value, in the form |
| " = <value>", or empty string if none.</li> |
| </ul> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getFieldCode(org.apache.openjpa.jdbc.meta.FieldMapping)"><!-- --></A><H3> |
| getFieldCode</H3> |
| <PRE> |
| <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>getFieldCode</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/meta/FieldMapping.html" title="class in org.apache.openjpa.jdbc.meta">FieldMapping</A> field)</PRE> |
| <DL> |
| <DD>Return a code template for the get/set methods of the given field, or |
| null to use the system-generated default Java code. |
| To facilitate template reuse, the following parameters can appear in |
| your template; the proper values will be subtituted by the system: |
| <ul> |
| <li>${fieldName}: The name of the field.</li> |
| <li>${capFieldName}: The capitalized field name.</li> |
| <li>${propertyName}: The field name without leading '_', if any.</li> |
| <li>${fieldType}: The field's type name.</li> |
| <li>${fieldValue}: The field's initial value, in the form |
| "= <value>", or empty string if none.</li> |
| </ul> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="unmappedTable(org.apache.openjpa.jdbc.schema.Table)"><!-- --></A><H3> |
| unmappedTable</H3> |
| <PRE> |
| boolean <B>unmappedTable</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</A> table)</PRE> |
| <DL> |
| <DD>Notification that a table has gone unmapped. You can map the table |
| yourself using this method. When mapping, use |
| <A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseMappingTool.html#generateClass(java.lang.String, java.lang.Class)"><CODE>ReverseMappingTool.generateClass(java.lang.String, java.lang.Class)</CODE></A> to create the class, |
| <A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseMappingTool.html#newClassMapping(java.lang.Class, org.apache.openjpa.jdbc.schema.Table)"><CODE>ReverseMappingTool.newClassMapping(java.lang.Class, org.apache.openjpa.jdbc.schema.Table)</CODE></A> to create the class metadata, |
| and then <A HREF="../../../../../org/apache/openjpa/jdbc/meta/ClassMapping.html#addDeclaredFieldMapping(java.lang.String, java.lang.Class)"><CODE>ClassMapping.addDeclaredFieldMapping(java.lang.String, java.lang.Class)</CODE></A> to add field |
| metadata. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>true if you map the table, false otherwise</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="close()"><!-- --></A><H3> |
| close</H3> |
| <PRE> |
| void <B>close</B>()</PRE> |
| <DL> |
| <DD>Invoked when the customizer is no longer needed. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/openjpa/lib/util/Closeable.html#close()">close</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/openjpa/lib/util/Closeable.html" title="interface in org.apache.openjpa.lib.util">Closeable</A></CODE></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/ReverseCustomizer.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/jdbc/meta/RelationId.html" title="interface in org.apache.openjpa.jdbc.meta"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseMappingTool.html" title="class in org.apache.openjpa.jdbc.meta"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../index.html?org/apache/openjpa/jdbc/meta/ReverseCustomizer.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="ReverseCustomizer.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: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| Copyright © 2006 Apache Software Foundation. All Rights Reserved. |
| </BODY> |
| </HTML> |