| <!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.6.0_18) on Mon Apr 19 13:38:28 EDT 2010 --> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <TITLE> |
| ReverseMappingTool (OpenJPA Parent POM 2.0.0 API) |
| </TITLE> |
| |
| <META NAME="date" CONTENT="2010-04-19"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="ReverseMappingTool (OpenJPA Parent POM 2.0.0 API)"; |
| } |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| <HR> |
| |
| |
| <!-- ========= 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/ReverseMappingTool.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/ReverseCustomizer.html" title="interface in org.apache.openjpa.jdbc.meta"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseMappingTool.Flags.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/ReverseMappingTool.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="ReverseMappingTool.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.jdbc.meta</FONT> |
| <BR> |
| Class ReverseMappingTool</H2> |
| <PRE> |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> |
| <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.openjpa.jdbc.meta.ReverseMappingTool</B> |
| </PRE> |
| <DL> |
| <DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</A>, <A HREF="../../../../../org/apache/openjpa/meta/MetaDataModes.html" title="interface in org.apache.openjpa.meta">MetaDataModes</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public class <B>ReverseMappingTool</B><DT>extends <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A><DT>implements <A HREF="../../../../../org/apache/openjpa/meta/MetaDataModes.html" title="interface in org.apache.openjpa.meta">MetaDataModes</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</A></DL> |
| </PRE> |
| |
| <P> |
| Reverse-maps a schema into class mappings and the associated java |
| code. Generates a Java code files for persistent classes and associated |
| identity classes and metadata. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Author:</B></DT> |
| <DD>Abe White</DD> |
| </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/jdbc/meta/ReverseMappingTool.Flags.html" title="class in org.apache.openjpa.jdbc.meta">ReverseMappingTool.Flags</A></B></CODE> |
| |
| <BR> |
| Holder for run flags.</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 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseMappingTool.html#ACCESS_TYPE_FIELD">ACCESS_TYPE_FIELD</A></B></CODE> |
| |
| <BR> |
| Access type for generated source, defaults to field-based access.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseMappingTool.html#ACCESS_TYPE_PROPERTY">ACCESS_TYPE_PROPERTY</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseMappingTool.html#LEVEL_CLASS">LEVEL_CLASS</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseMappingTool.html#LEVEL_NONE">LEVEL_NONE</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseMappingTool.html#LEVEL_PACKAGE">LEVEL_PACKAGE</A></B></CODE> |
| |
| <BR> |
| </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/jdbc/meta/ReverseMappingTool.html#TABLE_ASSOCIATION">TABLE_ASSOCIATION</A></B></CODE> |
| |
| <BR> |
| Association table.</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/jdbc/meta/ReverseMappingTool.html#TABLE_BASE">TABLE_BASE</A></B></CODE> |
| |
| <BR> |
| Primary table for a new base class.</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/jdbc/meta/ReverseMappingTool.html#TABLE_NONE">TABLE_NONE</A></B></CODE> |
| |
| <BR> |
| Unmapped table.</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/jdbc/meta/ReverseMappingTool.html#TABLE_SECONDARY">TABLE_SECONDARY</A></B></CODE> |
| |
| <BR> |
| Secondary table of an existing class.</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/jdbc/meta/ReverseMappingTool.html#TABLE_SECONDARY_OUTER">TABLE_SECONDARY_OUTER</A></B></CODE> |
| |
| <BR> |
| Secondary table of an existing class.</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/jdbc/meta/ReverseMappingTool.html#TABLE_SUBCLASS">TABLE_SUBCLASS</A></B></CODE> |
| |
| <BR> |
| Subclass table.</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> |
| |
| <!-- ======== 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><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseMappingTool.html#ReverseMappingTool(org.apache.openjpa.jdbc.conf.JDBCConfiguration)">ReverseMappingTool</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/conf/JDBCConfiguration.html" title="interface in org.apache.openjpa.jdbc.conf">JDBCConfiguration</A> conf)</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> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseMappingTool.html#addConstraints(org.apache.openjpa.jdbc.meta.ValueMapping)">addConstraints</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html" title="interface in org.apache.openjpa.jdbc.meta">ValueMapping</A> vm)</CODE> |
| |
| <BR> |
| Add existing unique constraints and indexes to the given 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/jdbc/meta/ReverseMappingTool.html#addJoinConstraints(org.apache.openjpa.jdbc.meta.FieldMapping)">addJoinConstraints</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/meta/FieldMapping.html" title="class in org.apache.openjpa.jdbc.meta">FieldMapping</A> field)</CODE> |
| |
| <BR> |
| Add existing unique constraints and indexes to the given field's join.</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/ReverseMappingTool.html#buildAnnotations()">buildAnnotations</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/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseMappingTool.html#clone()">clone</A></B>()</CODE> |
| |
| <BR> |
| Return a new tool with the same settings as this one.</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?is-external=true" title="class or interface in java.lang">Class</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseMappingTool.html#generateClass(java.lang.String, java.lang.Class)">generateClass</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" 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?is-external=true" title="class or interface in java.lang">Class</A> parent)</CODE> |
| |
| <BR> |
| Generate a new class with the given name.</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?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseMappingTool.html#getAccessType()">getAccessType</A></B>()</CODE> |
| |
| <BR> |
| Whether to use field or property-based access on generated 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/util/List.html?is-external=true" title="class or interface in java.util">List</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseMappingTool.html#getAnnotationsForMeta(java.lang.Object)">getAnnotationsForMeta</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> meta)</CODE> |
| |
| <BR> |
| Returns a list of stringified annotations for specified meta.</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/ReverseMappingTool.html#getBlobAsObject()">getBlobAsObject</A></B>()</CODE> |
| |
| <BR> |
| Whether to reverse-map blob columns as containing serialized Java |
| objects, rather than the default of using a byte[] field.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/apache/openjpa/jdbc/meta/ClassMapping.html" title="class in org.apache.openjpa.jdbc.meta">ClassMapping</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseMappingTool.html#getClassMapping(org.apache.openjpa.jdbc.schema.Table)">getClassMapping</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</A> table)</CODE> |
| |
| <BR> |
| Return the class mapping for the given table, or null if none.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/apache/openjpa/lib/util/CodeFormat.html" title="class in org.apache.openjpa.lib.util">CodeFormat</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseMappingTool.html#getCodeFormat()">getCodeFormat</A></B>()</CODE> |
| |
| <BR> |
| The code formatter for the generated Java code.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/apache/openjpa/jdbc/conf/JDBCConfiguration.html" title="interface in org.apache.openjpa.jdbc.conf">JDBCConfiguration</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseMappingTool.html#getConfiguration()">getConfiguration</A></B>()</CODE> |
| |
| <BR> |
| Return the configuration provided on construction.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseCustomizer.html" title="interface in org.apache.openjpa.jdbc.meta">ReverseCustomizer</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseMappingTool.html#getCustomizer()">getCustomizer</A></B>()</CODE> |
| |
| <BR> |
| Return the customizer in use, or null if none.</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/ReverseMappingTool.html#getDetachable()">getDetachable</A></B>()</CODE> |
| |
| <BR> |
| Whether to make generated classes detachable.</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/io/File.html?is-external=true" title="class or interface in java.io">File</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseMappingTool.html#getDirectory()">getDirectory</A></B>()</CODE> |
| |
| <BR> |
| The file to output the generated code to, or null for |
| the current directory.</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?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseMappingTool.html#getDiscriminatorStrategy()">getDiscriminatorStrategy</A></B>()</CODE> |
| |
| <BR> |
| Default discriminator strategy for base class mappings.</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?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseMappingTool.html#getFieldName(java.lang.String, org.apache.openjpa.jdbc.meta.ClassMapping)">getFieldName</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name, |
| <A HREF="../../../../../org/apache/openjpa/jdbc/meta/ClassMapping.html" title="class in org.apache.openjpa.jdbc.meta">ClassMapping</A> dec)</CODE> |
| |
| <BR> |
| Return a default Java identifier-formatted name for the given |
| column/table name.</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?is-external=true" title="class or interface in java.lang">Class</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseMappingTool.html#getFieldType(org.apache.openjpa.jdbc.schema.Column, boolean)">getFieldType</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A> col, |
| boolean forceObject)</CODE> |
| |
| <BR> |
| Return the default field type for the given column.</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/ReverseMappingTool.html#getGenerateAnnotations()">getGenerateAnnotations</A></B>()</CODE> |
| |
| <BR> |
| Whether to generate annotations along with generated 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?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseMappingTool.html#getIdentityClassSuffix()">getIdentityClassSuffix</A></B>()</CODE> |
| |
| <BR> |
| Suffix used to create application identity class name from a class name, |
| or in the case of inner identity classes, the inner class name.</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/ReverseMappingTool.html#getInnerIdentityClasses()">getInnerIdentityClasses</A></B>()</CODE> |
| |
| <BR> |
| Whether or not to generate inner classes when creating application |
| identity classes.</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/ReverseMappingTool.html#getInverseRelations()">getInverseRelations</A></B>()</CODE> |
| |
| <BR> |
| Whether to generate inverse 1-many/1-1 relations for all many-1/1-1 |
| relations.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/apache/openjpa/lib/log/Log.html" title="interface in org.apache.openjpa.lib.log">Log</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseMappingTool.html#getLog()">getLog</A></B>()</CODE> |
| |
| <BR> |
| Return the log to write to.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/apache/openjpa/jdbc/meta/ClassMapping.html" title="class in org.apache.openjpa.jdbc.meta">ClassMapping</A>[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseMappingTool.html#getMappings()">getMappings</A></B>()</CODE> |
| |
| <BR> |
| Return the generated mappings.</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/ReverseMappingTool.html#getNullableAsObject()">getNullableAsObject</A></B>()</CODE> |
| |
| <BR> |
| Return whether even nullable columns will be mapped to wrappers |
| rather than primitives.</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?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseMappingTool.html#getPackageName()">getPackageName</A></B>()</CODE> |
| |
| <BR> |
| Return the default package for the generated classes, or null if unset.</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/ReverseMappingTool.html#getPrimaryKeyOnJoin()">getPrimaryKeyOnJoin</A></B>()</CODE> |
| |
| <BR> |
| Return true if join tables are allowed to have primary keys, false |
| if all primary key tables will be mapped as persistent classes.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/apache/openjpa/jdbc/meta/MappingRepository.html" title="class in org.apache.openjpa.jdbc.meta">MappingRepository</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseMappingTool.html#getRepository()">getRepository</A></B>()</CODE> |
| |
| <BR> |
| Return the mapping repository used to hold generated mappings.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaGroup.html" title="class in org.apache.openjpa.jdbc.schema">SchemaGroup</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseMappingTool.html#getSchemaGroup()">getSchemaGroup</A></B>()</CODE> |
| |
| <BR> |
| Return the schema group to reverse map.</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/Properties.html?is-external=true" title="class or interface in java.util">Properties</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseMappingTool.html#getTypeMap()">getTypeMap</A></B>()</CODE> |
| |
| <BR> |
| Map of JDBC-name to Java-type-name entries that allows customization |
| of reverse mapping columns to field types.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html" title="class in org.apache.openjpa.jdbc.schema">ForeignKey</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseMappingTool.html#getUniqueForeignKey(org.apache.openjpa.jdbc.schema.Table)">getUniqueForeignKey</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</A> table)</CODE> |
| |
| <BR> |
| If the given table has a single unique foreign key or a foreign |
| key that matches the primary key, return it.</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/ReverseMappingTool.html#getUseBuiltinIdentityClass()">getUseBuiltinIdentityClass</A></B>()</CODE> |
| |
| <BR> |
| Whether to use built in identity classes when possible.</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/ReverseMappingTool.html#getUseDataStoreIdentity()">getUseDataStoreIdentity</A></B>()</CODE> |
| |
| <BR> |
| Whether to use datastore identity when possible.</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/ReverseMappingTool.html#getUseForeignKeyName()">getUseForeignKeyName</A></B>()</CODE> |
| |
| <BR> |
| Return whether the foreign key name will be used to generate |
| relation names.</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/ReverseMappingTool.html#getUseGenericCollections()">getUseGenericCollections</A></B>()</CODE> |
| |
| <BR> |
| Whether to use generic collections on one-to-many and many-to-many |
| relations instead of untyped collections.</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/ReverseMappingTool.html#getUseSchemaName()">getUseSchemaName</A></B>()</CODE> |
| |
| <BR> |
| Return true if the schema name will be included in the generated |
| class name for each 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?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseMappingTool.html#getVersionStrategy()">getVersionStrategy</A></B>()</CODE> |
| |
| <BR> |
| Default version strategy for base class mappings.</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/ReverseMappingTool.html#isBaseTable(org.apache.openjpa.jdbc.schema.Table)">isBaseTable</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</A> table)</CODE> |
| |
| <BR> |
| Return whether the given table is a base class table.</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/ReverseMappingTool.html#isUnique(org.apache.openjpa.jdbc.schema.ForeignKey)">isUnique</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html" title="class in org.apache.openjpa.jdbc.schema">ForeignKey</A> fk)</CODE> |
| |
| <BR> |
| Return whether the given foreign key is unique.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseMappingTool.html#main(java.lang.String[])">main</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[] args)</CODE> |
| |
| <BR> |
| Usage: java org.apache.openjpa.jdbc.meta.ReverseMappingTool |
| [option]* <.schema file or resource>* |
| Where the following options are recognized.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/apache/openjpa/jdbc/meta/ClassMapping.html" title="class in org.apache.openjpa.jdbc.meta">ClassMapping</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseMappingTool.html#newClassMapping(java.lang.Class, org.apache.openjpa.jdbc.schema.Table)">newClassMapping</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A> cls, |
| <A HREF="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</A> table)</CODE> |
| |
| <BR> |
| Create a new class to be mapped to a table.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/apache/openjpa/jdbc/meta/FieldMapping.html" title="class in org.apache.openjpa.jdbc.meta">FieldMapping</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseMappingTool.html#newFieldMapping(java.lang.String, java.lang.Class, org.apache.openjpa.jdbc.schema.Column, org.apache.openjpa.jdbc.schema.ForeignKey, org.apache.openjpa.jdbc.meta.ClassMapping)">newFieldMapping</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" 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?is-external=true" title="class or interface in java.lang">Class</A> type, |
| <A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A> col, |
| <A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html" title="class in org.apache.openjpa.jdbc.schema">ForeignKey</A> fk, |
| <A HREF="../../../../../org/apache/openjpa/jdbc/meta/ClassMapping.html" title="class in org.apache.openjpa.jdbc.meta">ClassMapping</A> dec)</CODE> |
| |
| <BR> |
| Create a field mapping for the given info, or return null if |
| customizer rejects.</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/List.html?is-external=true" title="class or interface in java.util">List</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseMappingTool.html#recordCode()">recordCode</A></B>()</CODE> |
| |
| <BR> |
| Uses <A HREF="../../../../../org/apache/openjpa/enhance/CodeGenerator.html" title="class in org.apache.openjpa.enhance"><CODE>CodeGenerator</CODE></A>s to write the Java code for the generated |
| mappings to the proper packages.</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/List.html?is-external=true" title="class or interface in java.util">List</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseMappingTool.html#recordCode(java.util.Map)">recordCode</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A> output)</CODE> |
| |
| <BR> |
| Write the code for the 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/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseMappingTool.html#recordMetaData(boolean)">recordMetaData</A></B>(boolean perClass)</CODE> |
| |
| <BR> |
| Write the generated metadata to the proper packages.</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/Collection.html?is-external=true" title="class or interface in java.util">Collection</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseMappingTool.html#recordMetaData(boolean, java.util.Map)">recordMetaData</A></B>(boolean perClass, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A> output)</CODE> |
| |
| <BR> |
| Write the code for the 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/ReverseMappingTool.html#run()">run</A></B>()</CODE> |
| |
| <BR> |
| Generate mappings and class code for the current schema group.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseMappingTool.html#run(org.apache.openjpa.jdbc.conf.JDBCConfiguration, java.lang.String[], org.apache.openjpa.lib.util.Options)">run</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/conf/JDBCConfiguration.html" title="interface in org.apache.openjpa.jdbc.conf">JDBCConfiguration</A> conf, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[] args, |
| <A HREF="../../../../../org/apache/openjpa/lib/util/Options.html" title="class in org.apache.openjpa.lib.util">Options</A> opts)</CODE> |
| |
| <BR> |
| Run the tool.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseMappingTool.html#run(org.apache.openjpa.jdbc.conf.JDBCConfiguration, java.lang.String[], org.apache.openjpa.jdbc.meta.ReverseMappingTool.Flags, java.lang.ClassLoader)">run</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/conf/JDBCConfiguration.html" title="interface in org.apache.openjpa.jdbc.conf">JDBCConfiguration</A> conf, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[] args, |
| <A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseMappingTool.Flags.html" title="class in org.apache.openjpa.jdbc.meta">ReverseMappingTool.Flags</A> flags, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</A> loader)</CODE> |
| |
| <BR> |
| Run the 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/ReverseMappingTool.html#setAccessType(java.lang.String)">setAccessType</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> accessType)</CODE> |
| |
| <BR> |
| Whether to use field or property-based access on generated code.</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/ReverseMappingTool.html#setBlobAsObject(boolean)">setBlobAsObject</A></B>(boolean blobAsObj)</CODE> |
| |
| <BR> |
| Whether to reverse-map blob columns as containing serialized Java |
| objects, rather than the default of using a byte[] 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/jdbc/meta/ReverseMappingTool.html#setCodeFormat(org.apache.openjpa.lib.util.CodeFormat)">setCodeFormat</A></B>(<A HREF="../../../../../org/apache/openjpa/lib/util/CodeFormat.html" title="class in org.apache.openjpa.lib.util">CodeFormat</A> format)</CODE> |
| |
| <BR> |
| Set the code formatter for the generated Java code.</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/ReverseMappingTool.html#setCustomizer(org.apache.openjpa.jdbc.meta.ReverseCustomizer)">setCustomizer</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseCustomizer.html" title="interface in org.apache.openjpa.jdbc.meta">ReverseCustomizer</A> customizer)</CODE> |
| |
| <BR> |
| Set the customizer.</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/ReverseMappingTool.html#setDetachable(boolean)">setDetachable</A></B>(boolean detachable)</CODE> |
| |
| <BR> |
| Whether to make generated classes detachable.</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/ReverseMappingTool.html#setDirectory(java.io.File)">setDirectory</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> dir)</CODE> |
| |
| <BR> |
| The file to output the generated code to, or null for |
| the current directory.</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/ReverseMappingTool.html#setDiscriminatorStrategy(java.lang.String)">setDiscriminatorStrategy</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> discStrat)</CODE> |
| |
| <BR> |
| Default discriminator strategy for base class mappings.</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/ReverseMappingTool.html#setGenerateAnnotations(boolean)">setGenerateAnnotations</A></B>(boolean genAnnotations)</CODE> |
| |
| <BR> |
| Whether to generate annotations along with generated code.</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/ReverseMappingTool.html#setIdentityClassSuffix(java.lang.String)">setIdentityClassSuffix</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> suffix)</CODE> |
| |
| <BR> |
| Suffix used to create application identity class name from a class name, |
| or in the case of inner identity classes, the inner class name.</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/ReverseMappingTool.html#setInnerIdentityClasses(boolean)">setInnerIdentityClasses</A></B>(boolean inner)</CODE> |
| |
| <BR> |
| Whether or not to generate inner classes when creating application |
| identity classes.</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/ReverseMappingTool.html#setInverseRelations(boolean)">setInverseRelations</A></B>(boolean inverse)</CODE> |
| |
| <BR> |
| Whether to generate inverse 1-many/1-1 relations for all many-1/1-1 |
| relations.</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/ReverseMappingTool.html#setNullableAsObject(boolean)">setNullableAsObject</A></B>(boolean nullAsObj)</CODE> |
| |
| <BR> |
| Set whether even nullable columns will be mapped to wrappers |
| rather than primitives.</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/ReverseMappingTool.html#setPackageName(java.lang.String)">setPackageName</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> packageName)</CODE> |
| |
| <BR> |
| Set the default package for the generated classes; use null to |
| indicate no package.</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/ReverseMappingTool.html#setPrimaryKeyOnJoin(boolean)">setPrimaryKeyOnJoin</A></B>(boolean pkOnJoin)</CODE> |
| |
| <BR> |
| Set to true if join tables are allowed to have primary keys, false |
| if all primary key tables will be mapped as persistent classes.</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/ReverseMappingTool.html#setRepository(org.apache.openjpa.jdbc.meta.MappingRepository)">setRepository</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/meta/MappingRepository.html" title="class in org.apache.openjpa.jdbc.meta">MappingRepository</A> repos)</CODE> |
| |
| <BR> |
| Set the repository to use.</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/ReverseMappingTool.html#setSchemaGroup(org.apache.openjpa.jdbc.schema.SchemaGroup)">setSchemaGroup</A></B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaGroup.html" title="class in org.apache.openjpa.jdbc.schema">SchemaGroup</A> schema)</CODE> |
| |
| <BR> |
| Set the schema to reverse map.</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/ReverseMappingTool.html#setTypeMap(java.util.Properties)">setTypeMap</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</A> typeMap)</CODE> |
| |
| <BR> |
| Map of JDBC-name to Java-type-name entries that allows customization |
| of reverse mapping columns to field types.</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/ReverseMappingTool.html#setUseBuiltinIdentityClass(boolean)">setUseBuiltinIdentityClass</A></B>(boolean builtin)</CODE> |
| |
| <BR> |
| Whether to use built in identity classes when possible.</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/ReverseMappingTool.html#setUseDataStoreIdentity(boolean)">setUseDataStoreIdentity</A></B>(boolean datastore)</CODE> |
| |
| <BR> |
| Whether to use datastore identity when possible.</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/ReverseMappingTool.html#setUseForeignKeyName(boolean)">setUseForeignKeyName</A></B>(boolean useFK)</CODE> |
| |
| <BR> |
| Set whether the foreign key name will be used to generate |
| relation names.</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/ReverseMappingTool.html#setUseGenericCollections(boolean)">setUseGenericCollections</A></B>(boolean useGenericCollections)</CODE> |
| |
| <BR> |
| Whether to use generic collections on one-to-many and many-to-many |
| relations instead of untyped collections.</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/ReverseMappingTool.html#setUseSchemaName(boolean)">setUseSchemaName</A></B>(boolean useSchema)</CODE> |
| |
| <BR> |
| Set whether the schema name will be included in the generated |
| class name for each table.</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/ReverseMappingTool.html#setVersionStrategy(java.lang.String)">setVersionStrategy</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> versionStrat)</CODE> |
| |
| <BR> |
| Default version strategy for base class mappings.</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?is-external=true" 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?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#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?is-external=true#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?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#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?is-external=true#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?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#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?is-external=true#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?is-external=true#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="TABLE_NONE"><!-- --></A><H3> |
| TABLE_NONE</H3> |
| <PRE> |
| public static final int <B>TABLE_NONE</B></PRE> |
| <DL> |
| <DD>Unmapped table. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.openjpa.jdbc.meta.ReverseMappingTool.TABLE_NONE">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="TABLE_BASE"><!-- --></A><H3> |
| TABLE_BASE</H3> |
| <PRE> |
| public static final int <B>TABLE_BASE</B></PRE> |
| <DL> |
| <DD>Primary table for a new base class. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.openjpa.jdbc.meta.ReverseMappingTool.TABLE_BASE">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="TABLE_SECONDARY"><!-- --></A><H3> |
| TABLE_SECONDARY</H3> |
| <PRE> |
| public static final int <B>TABLE_SECONDARY</B></PRE> |
| <DL> |
| <DD>Secondary table of an existing class. There is exactly one row in |
| this table for each row in the primary table. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.openjpa.jdbc.meta.ReverseMappingTool.TABLE_SECONDARY">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="TABLE_SECONDARY_OUTER"><!-- --></A><H3> |
| TABLE_SECONDARY_OUTER</H3> |
| <PRE> |
| public static final int <B>TABLE_SECONDARY_OUTER</B></PRE> |
| <DL> |
| <DD>Secondary table of an existing class. There is zero or one row in |
| this table for each row in the primary table. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.openjpa.jdbc.meta.ReverseMappingTool.TABLE_SECONDARY_OUTER">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="TABLE_ASSOCIATION"><!-- --></A><H3> |
| TABLE_ASSOCIATION</H3> |
| <PRE> |
| public static final int <B>TABLE_ASSOCIATION</B></PRE> |
| <DL> |
| <DD>Association table. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.openjpa.jdbc.meta.ReverseMappingTool.TABLE_ASSOCIATION">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="TABLE_SUBCLASS"><!-- --></A><H3> |
| TABLE_SUBCLASS</H3> |
| <PRE> |
| public static final int <B>TABLE_SUBCLASS</B></PRE> |
| <DL> |
| <DD>Subclass table. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.openjpa.jdbc.meta.ReverseMappingTool.TABLE_SUBCLASS">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="LEVEL_NONE"><!-- --></A><H3> |
| LEVEL_NONE</H3> |
| <PRE> |
| public static final <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>LEVEL_NONE</B></PRE> |
| <DL> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.openjpa.jdbc.meta.ReverseMappingTool.LEVEL_NONE">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="LEVEL_PACKAGE"><!-- --></A><H3> |
| LEVEL_PACKAGE</H3> |
| <PRE> |
| public static final <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>LEVEL_PACKAGE</B></PRE> |
| <DL> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.openjpa.jdbc.meta.ReverseMappingTool.LEVEL_PACKAGE">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="LEVEL_CLASS"><!-- --></A><H3> |
| LEVEL_CLASS</H3> |
| <PRE> |
| public static final <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>LEVEL_CLASS</B></PRE> |
| <DL> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.openjpa.jdbc.meta.ReverseMappingTool.LEVEL_CLASS">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="ACCESS_TYPE_FIELD"><!-- --></A><H3> |
| ACCESS_TYPE_FIELD</H3> |
| <PRE> |
| public static final <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>ACCESS_TYPE_FIELD</B></PRE> |
| <DL> |
| <DD>Access type for generated source, defaults to field-based access. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.openjpa.jdbc.meta.ReverseMappingTool.ACCESS_TYPE_FIELD">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="ACCESS_TYPE_PROPERTY"><!-- --></A><H3> |
| ACCESS_TYPE_PROPERTY</H3> |
| <PRE> |
| public static final <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>ACCESS_TYPE_PROPERTY</B></PRE> |
| <DL> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.openjpa.jdbc.meta.ReverseMappingTool.ACCESS_TYPE_PROPERTY">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="ReverseMappingTool(org.apache.openjpa.jdbc.conf.JDBCConfiguration)"><!-- --></A><H3> |
| ReverseMappingTool</H3> |
| <PRE> |
| public <B>ReverseMappingTool</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/conf/JDBCConfiguration.html" title="interface in org.apache.openjpa.jdbc.conf">JDBCConfiguration</A> conf)</PRE> |
| <DL> |
| <DD>Constructor. Supply configuration. |
| <P> |
| </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="getConfiguration()"><!-- --></A><H3> |
| getConfiguration</H3> |
| <PRE> |
| public <A HREF="../../../../../org/apache/openjpa/jdbc/conf/JDBCConfiguration.html" title="interface in org.apache.openjpa.jdbc.conf">JDBCConfiguration</A> <B>getConfiguration</B>()</PRE> |
| <DL> |
| <DD>Return the configuration provided on construction. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getLog()"><!-- --></A><H3> |
| getLog</H3> |
| <PRE> |
| public <A HREF="../../../../../org/apache/openjpa/lib/log/Log.html" title="interface in org.apache.openjpa.lib.log">Log</A> <B>getLog</B>()</PRE> |
| <DL> |
| <DD>Return the log to write to. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getPackageName()"><!-- --></A><H3> |
| getPackageName</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getPackageName</B>()</PRE> |
| <DL> |
| <DD>Return the default package for the generated classes, or null if unset. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setPackageName(java.lang.String)"><!-- --></A><H3> |
| setPackageName</H3> |
| <PRE> |
| public void <B>setPackageName</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> packageName)</PRE> |
| <DL> |
| <DD>Set the default package for the generated classes; use null to |
| indicate no package. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDirectory()"><!-- --></A><H3> |
| getDirectory</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> <B>getDirectory</B>()</PRE> |
| <DL> |
| <DD>The file to output the generated code to, or null for |
| the current directory. If the directory matches the package, it will |
| be used. Otherwise, the package structure will be created under |
| this directory. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setDirectory(java.io.File)"><!-- --></A><H3> |
| setDirectory</H3> |
| <PRE> |
| public void <B>setDirectory</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> dir)</PRE> |
| <DL> |
| <DD>The file to output the generated code to, or null for |
| the current directory. If the directory matches the package, it will |
| be used. Otherwise, the package structure will be created under |
| this directory. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getUseSchemaName()"><!-- --></A><H3> |
| getUseSchemaName</H3> |
| <PRE> |
| public boolean <B>getUseSchemaName</B>()</PRE> |
| <DL> |
| <DD>Return true if the schema name will be included in the generated |
| class name for each table. Defaults to false. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setUseSchemaName(boolean)"><!-- --></A><H3> |
| setUseSchemaName</H3> |
| <PRE> |
| public void <B>setUseSchemaName</B>(boolean useSchema)</PRE> |
| <DL> |
| <DD>Set whether the schema name will be included in the generated |
| class name for each table. Defaults to false. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getUseForeignKeyName()"><!-- --></A><H3> |
| getUseForeignKeyName</H3> |
| <PRE> |
| public boolean <B>getUseForeignKeyName</B>()</PRE> |
| <DL> |
| <DD>Return whether the foreign key name will be used to generate |
| relation names. Defaults to false. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setUseForeignKeyName(boolean)"><!-- --></A><H3> |
| setUseForeignKeyName</H3> |
| <PRE> |
| public void <B>setUseForeignKeyName</B>(boolean useFK)</PRE> |
| <DL> |
| <DD>Set whether the foreign key name will be used to generate |
| relation names. Defaults to false. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getNullableAsObject()"><!-- --></A><H3> |
| getNullableAsObject</H3> |
| <PRE> |
| public boolean <B>getNullableAsObject</B>()</PRE> |
| <DL> |
| <DD>Return whether even nullable columns will be mapped to wrappers |
| rather than primitives. Defaults to false. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setNullableAsObject(boolean)"><!-- --></A><H3> |
| setNullableAsObject</H3> |
| <PRE> |
| public void <B>setNullableAsObject</B>(boolean nullAsObj)</PRE> |
| <DL> |
| <DD>Set whether even nullable columns will be mapped to wrappers |
| rather than primitives. Defaults to false. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getBlobAsObject()"><!-- --></A><H3> |
| getBlobAsObject</H3> |
| <PRE> |
| public boolean <B>getBlobAsObject</B>()</PRE> |
| <DL> |
| <DD>Whether to reverse-map blob columns as containing serialized Java |
| objects, rather than the default of using a byte[] field. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setBlobAsObject(boolean)"><!-- --></A><H3> |
| setBlobAsObject</H3> |
| <PRE> |
| public void <B>setBlobAsObject</B>(boolean blobAsObj)</PRE> |
| <DL> |
| <DD>Whether to reverse-map blob columns as containing serialized Java |
| objects, rather than the default of using a byte[] field. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getUseGenericCollections()"><!-- --></A><H3> |
| getUseGenericCollections</H3> |
| <PRE> |
| public boolean <B>getUseGenericCollections</B>()</PRE> |
| <DL> |
| <DD>Whether to use generic collections on one-to-many and many-to-many |
| relations instead of untyped collections. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setUseGenericCollections(boolean)"><!-- --></A><H3> |
| setUseGenericCollections</H3> |
| <PRE> |
| public void <B>setUseGenericCollections</B>(boolean useGenericCollections)</PRE> |
| <DL> |
| <DD>Whether to use generic collections on one-to-many and many-to-many |
| relations instead of untyped collections. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getTypeMap()"><!-- --></A><H3> |
| getTypeMap</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</A> <B>getTypeMap</B>()</PRE> |
| <DL> |
| <DD>Map of JDBC-name to Java-type-name entries that allows customization |
| of reverse mapping columns to field types. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setTypeMap(java.util.Properties)"><!-- --></A><H3> |
| setTypeMap</H3> |
| <PRE> |
| public void <B>setTypeMap</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</A> typeMap)</PRE> |
| <DL> |
| <DD>Map of JDBC-name to Java-type-name entries that allows customization |
| of reverse mapping columns to field types. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getPrimaryKeyOnJoin()"><!-- --></A><H3> |
| getPrimaryKeyOnJoin</H3> |
| <PRE> |
| public boolean <B>getPrimaryKeyOnJoin</B>()</PRE> |
| <DL> |
| <DD>Return true if join tables are allowed to have primary keys, false |
| if all primary key tables will be mapped as persistent classes. |
| Defaults to false. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setPrimaryKeyOnJoin(boolean)"><!-- --></A><H3> |
| setPrimaryKeyOnJoin</H3> |
| <PRE> |
| public void <B>setPrimaryKeyOnJoin</B>(boolean pkOnJoin)</PRE> |
| <DL> |
| <DD>Set to true if join tables are allowed to have primary keys, false |
| if all primary key tables will be mapped as persistent classes. |
| Defaults to false. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getUseDataStoreIdentity()"><!-- --></A><H3> |
| getUseDataStoreIdentity</H3> |
| <PRE> |
| public boolean <B>getUseDataStoreIdentity</B>()</PRE> |
| <DL> |
| <DD>Whether to use datastore identity when possible. Defaults to false. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setUseDataStoreIdentity(boolean)"><!-- --></A><H3> |
| setUseDataStoreIdentity</H3> |
| <PRE> |
| public void <B>setUseDataStoreIdentity</B>(boolean datastore)</PRE> |
| <DL> |
| <DD>Whether to use datastore identity when possible. Defaults to false. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getUseBuiltinIdentityClass()"><!-- --></A><H3> |
| getUseBuiltinIdentityClass</H3> |
| <PRE> |
| public boolean <B>getUseBuiltinIdentityClass</B>()</PRE> |
| <DL> |
| <DD>Whether to use built in identity classes when possible. Defaults to true. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setUseBuiltinIdentityClass(boolean)"><!-- --></A><H3> |
| setUseBuiltinIdentityClass</H3> |
| <PRE> |
| public void <B>setUseBuiltinIdentityClass</B>(boolean builtin)</PRE> |
| <DL> |
| <DD>Whether to use built in identity classes when possible. Defaults to true. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getInnerIdentityClasses()"><!-- --></A><H3> |
| getInnerIdentityClasses</H3> |
| <PRE> |
| public boolean <B>getInnerIdentityClasses</B>()</PRE> |
| <DL> |
| <DD>Whether or not to generate inner classes when creating application |
| identity classes. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setInnerIdentityClasses(boolean)"><!-- --></A><H3> |
| setInnerIdentityClasses</H3> |
| <PRE> |
| public void <B>setInnerIdentityClasses</B>(boolean inner)</PRE> |
| <DL> |
| <DD>Whether or not to generate inner classes when creating application |
| identity classes. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getIdentityClassSuffix()"><!-- --></A><H3> |
| getIdentityClassSuffix</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getIdentityClassSuffix</B>()</PRE> |
| <DL> |
| <DD>Suffix used to create application identity class name from a class name, |
| or in the case of inner identity classes, the inner class name. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setIdentityClassSuffix(java.lang.String)"><!-- --></A><H3> |
| setIdentityClassSuffix</H3> |
| <PRE> |
| public void <B>setIdentityClassSuffix</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> suffix)</PRE> |
| <DL> |
| <DD>Suffix used to create application identity class name from a class name, |
| or in the case of inner identity classes, the inner class name. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getInverseRelations()"><!-- --></A><H3> |
| getInverseRelations</H3> |
| <PRE> |
| public boolean <B>getInverseRelations</B>()</PRE> |
| <DL> |
| <DD>Whether to generate inverse 1-many/1-1 relations for all many-1/1-1 |
| relations. Defaults to true. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setInverseRelations(boolean)"><!-- --></A><H3> |
| setInverseRelations</H3> |
| <PRE> |
| public void <B>setInverseRelations</B>(boolean inverse)</PRE> |
| <DL> |
| <DD>Whether to generate inverse 1-many/1-1 relations for all many-1/1-1 |
| relations. Defaults to true. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDetachable()"><!-- --></A><H3> |
| getDetachable</H3> |
| <PRE> |
| public boolean <B>getDetachable</B>()</PRE> |
| <DL> |
| <DD>Whether to make generated classes detachable. Defaults to false. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setDetachable(boolean)"><!-- --></A><H3> |
| setDetachable</H3> |
| <PRE> |
| public void <B>setDetachable</B>(boolean detachable)</PRE> |
| <DL> |
| <DD>Whether to make generated classes detachable. Defaults to false. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDiscriminatorStrategy()"><!-- --></A><H3> |
| getDiscriminatorStrategy</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getDiscriminatorStrategy</B>()</PRE> |
| <DL> |
| <DD>Default discriminator strategy for base class mappings. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setDiscriminatorStrategy(java.lang.String)"><!-- --></A><H3> |
| setDiscriminatorStrategy</H3> |
| <PRE> |
| public void <B>setDiscriminatorStrategy</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> discStrat)</PRE> |
| <DL> |
| <DD>Default discriminator strategy for base class mappings. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getVersionStrategy()"><!-- --></A><H3> |
| getVersionStrategy</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getVersionStrategy</B>()</PRE> |
| <DL> |
| <DD>Default version strategy for base class mappings. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setVersionStrategy(java.lang.String)"><!-- --></A><H3> |
| setVersionStrategy</H3> |
| <PRE> |
| public void <B>setVersionStrategy</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> versionStrat)</PRE> |
| <DL> |
| <DD>Default version strategy for base class mappings. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getGenerateAnnotations()"><!-- --></A><H3> |
| getGenerateAnnotations</H3> |
| <PRE> |
| public boolean <B>getGenerateAnnotations</B>()</PRE> |
| <DL> |
| <DD>Whether to generate annotations along with generated code. Defaults |
| to false. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setGenerateAnnotations(boolean)"><!-- --></A><H3> |
| setGenerateAnnotations</H3> |
| <PRE> |
| public void <B>setGenerateAnnotations</B>(boolean genAnnotations)</PRE> |
| <DL> |
| <DD>Whether to generate annotations along with generated code. Defaults |
| to false. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getAccessType()"><!-- --></A><H3> |
| getAccessType</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getAccessType</B>()</PRE> |
| <DL> |
| <DD>Whether to use field or property-based access on generated code. |
| Defaults to field-based access. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setAccessType(java.lang.String)"><!-- --></A><H3> |
| setAccessType</H3> |
| <PRE> |
| public void <B>setAccessType</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> accessType)</PRE> |
| <DL> |
| <DD>Whether to use field or property-based access on generated code. |
| Defaults to field-based access. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getCodeFormat()"><!-- --></A><H3> |
| getCodeFormat</H3> |
| <PRE> |
| public <A HREF="../../../../../org/apache/openjpa/lib/util/CodeFormat.html" title="class in org.apache.openjpa.lib.util">CodeFormat</A> <B>getCodeFormat</B>()</PRE> |
| <DL> |
| <DD>The code formatter for the generated Java code. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setCodeFormat(org.apache.openjpa.lib.util.CodeFormat)"><!-- --></A><H3> |
| setCodeFormat</H3> |
| <PRE> |
| public void <B>setCodeFormat</B>(<A HREF="../../../../../org/apache/openjpa/lib/util/CodeFormat.html" title="class in org.apache.openjpa.lib.util">CodeFormat</A> format)</PRE> |
| <DL> |
| <DD>Set the code formatter for the generated Java code. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getCustomizer()"><!-- --></A><H3> |
| getCustomizer</H3> |
| <PRE> |
| public <A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseCustomizer.html" title="interface in org.apache.openjpa.jdbc.meta">ReverseCustomizer</A> <B>getCustomizer</B>()</PRE> |
| <DL> |
| <DD>Return the customizer in use, or null if none. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setCustomizer(org.apache.openjpa.jdbc.meta.ReverseCustomizer)"><!-- --></A><H3> |
| setCustomizer</H3> |
| <PRE> |
| public void <B>setCustomizer</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseCustomizer.html" title="interface in org.apache.openjpa.jdbc.meta">ReverseCustomizer</A> customizer)</PRE> |
| <DL> |
| <DD>Set the customizer. The configuration on the customizer, if any, |
| should already be set. |
| <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/jdbc/meta/MappingRepository.html" title="class in org.apache.openjpa.jdbc.meta">MappingRepository</A> <B>getRepository</B>()</PRE> |
| <DL> |
| <DD>Return the mapping repository used to hold generated mappings. You |
| can also use the repository to seed the schema group to generate |
| classes from. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setRepository(org.apache.openjpa.jdbc.meta.MappingRepository)"><!-- --></A><H3> |
| setRepository</H3> |
| <PRE> |
| public void <B>setRepository</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/meta/MappingRepository.html" title="class in org.apache.openjpa.jdbc.meta">MappingRepository</A> repos)</PRE> |
| <DL> |
| <DD>Set the repository to use. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getSchemaGroup()"><!-- --></A><H3> |
| getSchemaGroup</H3> |
| <PRE> |
| public <A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaGroup.html" title="class in org.apache.openjpa.jdbc.schema">SchemaGroup</A> <B>getSchemaGroup</B>()</PRE> |
| <DL> |
| <DD>Return the schema group to reverse map. If none has been set, the |
| schema will be generated from the database. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setSchemaGroup(org.apache.openjpa.jdbc.schema.SchemaGroup)"><!-- --></A><H3> |
| setSchemaGroup</H3> |
| <PRE> |
| public void <B>setSchemaGroup</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/SchemaGroup.html" title="class in org.apache.openjpa.jdbc.schema">SchemaGroup</A> schema)</PRE> |
| <DL> |
| <DD>Set the schema to reverse map. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getMappings()"><!-- --></A><H3> |
| getMappings</H3> |
| <PRE> |
| public <A HREF="../../../../../org/apache/openjpa/jdbc/meta/ClassMapping.html" title="class in org.apache.openjpa.jdbc.meta">ClassMapping</A>[] <B>getMappings</B>()</PRE> |
| <DL> |
| <DD>Return the generated mappings. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="run()"><!-- --></A><H3> |
| run</H3> |
| <PRE> |
| public void <B>run</B>()</PRE> |
| <DL> |
| <DD>Generate mappings and class code for the current schema group. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="recordCode()"><!-- --></A><H3> |
| recordCode</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A> <B>recordCode</B>() |
| throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> |
| <DL> |
| <DD>Uses <A HREF="../../../../../org/apache/openjpa/enhance/CodeGenerator.html" title="class in org.apache.openjpa.enhance"><CODE>CodeGenerator</CODE></A>s to write the Java code for the generated |
| mappings to the proper packages. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>a list of <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io"><CODE>File</CODE></A> instances that were written |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="recordCode(java.util.Map)"><!-- --></A><H3> |
| recordCode</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A> <B>recordCode</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A> output) |
| throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> |
| <DL> |
| <DD>Write the code for the tool. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>output</CODE> - if null, then perform the write directly |
| to the filesystem; otherwise, populate the |
| specified map with keys as the generated |
| <A HREF="../../../../../org/apache/openjpa/jdbc/meta/ClassMapping.html" title="class in org.apache.openjpa.jdbc.meta"><CODE>ClassMapping</CODE></A> and values as a |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang"><CODE>String</CODE></A> that contains the generated code |
| <DT><B>Returns:</B><DD>a list of <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io"><CODE>File</CODE></A> instances that were written |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="recordMetaData(boolean)"><!-- --></A><H3> |
| recordMetaData</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A> <B>recordMetaData</B>(boolean perClass) |
| throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> |
| <DL> |
| <DD>Write the generated metadata to the proper packages. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the set of metadata <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io"><CODE>File</CODE></A>s that were written |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="recordMetaData(boolean, java.util.Map)"><!-- --></A><H3> |
| recordMetaData</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A> <B>recordMetaData</B>(boolean perClass, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A> output) |
| throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> |
| <DL> |
| <DD>Write the code for the tool. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>output</CODE> - if null, then perform the write directly |
| to the filesystem; otherwise, populate the |
| specified map with keys as the generated |
| <A HREF="../../../../../org/apache/openjpa/jdbc/meta/ClassMapping.html" title="class in org.apache.openjpa.jdbc.meta"><CODE>ClassMapping</CODE></A> and values as a |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang"><CODE>String</CODE></A> that contains the generated code |
| <DT><B>Returns:</B><DD>the set of metadata <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io"><CODE>File</CODE></A>s that were written |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="buildAnnotations()"><!-- --></A><H3> |
| buildAnnotations</H3> |
| <PRE> |
| public void <B>buildAnnotations</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getAnnotationsForMeta(java.lang.Object)"><!-- --></A><H3> |
| getAnnotationsForMeta</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A> <B>getAnnotationsForMeta</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> meta)</PRE> |
| <DL> |
| <DD>Returns a list of stringified annotations for specified meta. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getClassMapping(org.apache.openjpa.jdbc.schema.Table)"><!-- --></A><H3> |
| getClassMapping</H3> |
| <PRE> |
| public <A HREF="../../../../../org/apache/openjpa/jdbc/meta/ClassMapping.html" title="class in org.apache.openjpa.jdbc.meta">ClassMapping</A> <B>getClassMapping</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</A> table)</PRE> |
| <DL> |
| <DD>Return the class mapping for the given table, or null if none. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="newClassMapping(java.lang.Class, org.apache.openjpa.jdbc.schema.Table)"><!-- --></A><H3> |
| newClassMapping</H3> |
| <PRE> |
| public <A HREF="../../../../../org/apache/openjpa/jdbc/meta/ClassMapping.html" title="class in org.apache.openjpa.jdbc.meta">ClassMapping</A> <B>newClassMapping</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A> cls, |
| <A HREF="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</A> table)</PRE> |
| <DL> |
| <DD>Create a new class to be mapped to a table. The class will start out |
| with a default application identity class set. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="generateClass(java.lang.String, java.lang.Class)"><!-- --></A><H3> |
| generateClass</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A> <B>generateClass</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" 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?is-external=true" title="class or interface in java.lang">Class</A> parent)</PRE> |
| <DL> |
| <DD>Generate a new class with the given name. If a non-null parent class |
| is given, it will be set as the superclass. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isUnique(org.apache.openjpa.jdbc.schema.ForeignKey)"><!-- --></A><H3> |
| isUnique</H3> |
| <PRE> |
| public boolean <B>isUnique</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html" title="class in org.apache.openjpa.jdbc.schema">ForeignKey</A> fk)</PRE> |
| <DL> |
| <DD>Return whether the given foreign key is unique. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getUniqueForeignKey(org.apache.openjpa.jdbc.schema.Table)"><!-- --></A><H3> |
| getUniqueForeignKey</H3> |
| <PRE> |
| public <A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html" title="class in org.apache.openjpa.jdbc.schema">ForeignKey</A> <B>getUniqueForeignKey</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</A> table)</PRE> |
| <DL> |
| <DD>If the given table has a single unique foreign key or a foreign |
| key that matches the primary key, return it. Else return null. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addJoinConstraints(org.apache.openjpa.jdbc.meta.FieldMapping)"><!-- --></A><H3> |
| addJoinConstraints</H3> |
| <PRE> |
| public void <B>addJoinConstraints</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/meta/FieldMapping.html" title="class in org.apache.openjpa.jdbc.meta">FieldMapping</A> field)</PRE> |
| <DL> |
| <DD>Add existing unique constraints and indexes to the given field's join. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addConstraints(org.apache.openjpa.jdbc.meta.ValueMapping)"><!-- --></A><H3> |
| addConstraints</H3> |
| <PRE> |
| public void <B>addConstraints</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/meta/ValueMapping.html" title="interface in org.apache.openjpa.jdbc.meta">ValueMapping</A> vm)</PRE> |
| <DL> |
| <DD>Add existing unique constraints and indexes to the given value. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isBaseTable(org.apache.openjpa.jdbc.schema.Table)"><!-- --></A><H3> |
| isBaseTable</H3> |
| <PRE> |
| public boolean <B>isBaseTable</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Table.html" title="class in org.apache.openjpa.jdbc.schema">Table</A> table)</PRE> |
| <DL> |
| <DD>Return whether the given table is a base class table. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="newFieldMapping(java.lang.String, java.lang.Class, org.apache.openjpa.jdbc.schema.Column, org.apache.openjpa.jdbc.schema.ForeignKey, org.apache.openjpa.jdbc.meta.ClassMapping)"><!-- --></A><H3> |
| newFieldMapping</H3> |
| <PRE> |
| public <A HREF="../../../../../org/apache/openjpa/jdbc/meta/FieldMapping.html" title="class in org.apache.openjpa.jdbc.meta">FieldMapping</A> <B>newFieldMapping</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" 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?is-external=true" title="class or interface in java.lang">Class</A> type, |
| <A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A> col, |
| <A HREF="../../../../../org/apache/openjpa/jdbc/schema/ForeignKey.html" title="class in org.apache.openjpa.jdbc.schema">ForeignKey</A> fk, |
| <A HREF="../../../../../org/apache/openjpa/jdbc/meta/ClassMapping.html" title="class in org.apache.openjpa.jdbc.meta">ClassMapping</A> dec)</PRE> |
| <DL> |
| <DD>Create a field mapping for the given info, or return null if |
| customizer rejects. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getFieldName(java.lang.String, org.apache.openjpa.jdbc.meta.ClassMapping)"><!-- --></A><H3> |
| getFieldName</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getFieldName</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name, |
| <A HREF="../../../../../org/apache/openjpa/jdbc/meta/ClassMapping.html" title="class in org.apache.openjpa.jdbc.meta">ClassMapping</A> dec)</PRE> |
| <DL> |
| <DD>Return a default Java identifier-formatted name for the given |
| column/table name. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getFieldType(org.apache.openjpa.jdbc.schema.Column, boolean)"><!-- --></A><H3> |
| getFieldType</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A> <B>getFieldType</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/schema/Column.html" title="class in org.apache.openjpa.jdbc.schema">Column</A> col, |
| boolean forceObject)</PRE> |
| <DL> |
| <DD>Return the default field type for the given column. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="clone()"><!-- --></A><H3> |
| clone</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> <B>clone</B>()</PRE> |
| <DL> |
| <DD>Return a new tool with the same settings as this one. Used in workbench. |
| <P> |
| <DD><DL> |
| <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="main(java.lang.String[])"><!-- --></A><H3> |
| main</H3> |
| <PRE> |
| public static void <B>main</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[] args) |
| throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A>, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></PRE> |
| <DL> |
| <DD>Usage: java org.apache.openjpa.jdbc.meta.ReverseMappingTool |
| [option]* <.schema file or resource>* |
| Where the following options are recognized. |
| <ul> |
| <li><i>-properties/-p <properties file or resource></i>: The |
| path or resource name of a OpenJPA properties file containing |
| information such as the license key data as outlined in |
| <A HREF="../../../../../org/apache/openjpa/conf/OpenJPAConfiguration.html" title="interface in org.apache.openjpa.conf"><CODE>OpenJPAConfiguration</CODE></A>. Optional.</li> |
| <li><i>-<property name> <property value></i>: All bean |
| properties of the OpenJPA <A HREF="../../../../../org/apache/openjpa/jdbc/conf/JDBCConfiguration.html" title="interface in org.apache.openjpa.jdbc.conf"><CODE>JDBCConfiguration</CODE></A> can be set by |
| using their names and supplying a value. For example: |
| <code>-licenseKey adslfja83r3lkadf</code></li> |
| <li><i>-schemas/-s <schemas and tables></i>: Comma-separated |
| list of schemas and tables to reverse-map.</li> |
| <li><i>-package/-pkg <package name></i>: The name of the package |
| for all generated classes. Defaults to no package.</li> |
| <li><i>-directory/-d <output directory></i>: The directory where |
| all generated code should be placed. Defaults to the current |
| directory.</li> |
| <li><i>-useSchemaName/-sn <true/t | false/f></i>: Set this flag to |
| true to include the schema name as part of the generated class name |
| for each table.</li> |
| <li><i>-useForeignKeyName/-fkn <true/t | false/f></i>: Set this |
| flag to true to use the foreign key name to generate fields |
| representing relations between classes.</li> |
| <li><i>-nullableAsObject/-no <true/t | false/f></i>: Set to true |
| to make all nullable columns map to object types; columns that would |
| normally map to a primitive will map to the appropriate wrapper |
| type instead.</li> |
| <li><i>-blobAsObject/-bo <true/t | false/f></i>: Set to true |
| to make all binary columns map to Object rather than byte[].</li> |
| <li><i>-useGenericCollections/-gc <true/t | false/f></i>: Set to |
| true to use generic collections on OneToMany and ManyToMany relations |
| (requires JDK 1.5 or higher).</li> |
| <li><i>-typeMap/-typ <types></i>: Default mapping of SQL type |
| names to Java classes.</li> |
| <li><i>-primaryKeyOnJoin/-pkj <true/t | false/f></i>: Set to true |
| to allow primary keys on join tables.</li> |
| <li><i>-useDatastoreIdentity/-ds <true/t | false/f></i>: Set to |
| true to use datastore identity where possible.</li> |
| <li><i>-useBuiltinIdentityClass/-bic <true/t | false/f></i>: Set |
| to false to never use OpenJPA's builtin application identity |
| classes.</li> |
| <li><i>-innerIdentityClasses/-inn <true/t | false/f></i>: Set to |
| true to generate the application identity classes as inner classes.</li> |
| <li><i>-identityClassSuffix/-is <suffix></i>: Suffix to append |
| to class names to create identity class name, or for inner identity |
| classes, the inner class name.</li> |
| <li><i>-inverseRelations/-ir <true/t | false/f></i>: Set to |
| false to prevent the creation of inverse 1-many/1-1 relations for |
| each encountered many-1/1-1 relation.</li> |
| <li><i>-detachable/-det <true/t | false/f></i>: Set to |
| true to make generated classes detachable.</li> |
| <li><i>-discriminatorStrategy/-ds <strategy></i>: The default |
| discriminator strategy to place on base classes.</li> |
| <li><i>-versionStrategy/-vs <strategy></i>: The default |
| version strategy to place on base classes.</li> |
| <li><i>-metadata/-md <class | package | none></i>: Specify the |
| level the metadata should be generated at. Defaults to generating a |
| single package-level metadata file.</li> |
| <li><i>-annotations/-ann <true/t | false/f></i>: Set to true to |
| generate JPA annotations in generated code.</li> |
| <li><i>-accessType/-access <field | property></i>: Change access |
| type for generated annotations. Defaults to field access.</li> |
| <li><i>-customizerClass/-cc <class name></i>: The full class |
| name of a <A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseCustomizer.html" title="interface in org.apache.openjpa.jdbc.meta"><CODE>ReverseCustomizer</CODE></A> implementation to use to |
| customize the reverse mapping process. Optional.</li> |
| <li><i>-customizerProperties/-cp <properties file or resource></i> |
| : The path or resource name of a properties file that will be |
| passed to the reverse customizer on initialization. Optional.</li> |
| <li><i>-customizer/-c.<property name> < property value></i> |
| : Arguments like this will be used to configure the bean |
| properties of the <A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseCustomizer.html" title="interface in org.apache.openjpa.jdbc.meta"><CODE>ReverseCustomizer</CODE></A>.</li> |
| <li><i>-codeFormat/-cf.<property name> < property value></i> |
| : Arguments like this will be used to configure the bean |
| properties of the internal <A HREF="../../../../../org/apache/openjpa/lib/util/CodeFormat.html" title="class in org.apache.openjpa.lib.util"><CODE>CodeFormat</CODE></A>.</li> |
| </ul> |
| Each schema given as an argument will be reverse-mapped into |
| persistent classes and associated metadata. If no arguments are given, |
| the database schemas defined by the system configuration will be |
| reverse-mapped. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> |
| <DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="run(org.apache.openjpa.jdbc.conf.JDBCConfiguration, java.lang.String[], org.apache.openjpa.lib.util.Options)"><!-- --></A><H3> |
| run</H3> |
| <PRE> |
| public static boolean <B>run</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/conf/JDBCConfiguration.html" title="interface in org.apache.openjpa.jdbc.conf">JDBCConfiguration</A> conf, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[] args, |
| <A HREF="../../../../../org/apache/openjpa/lib/util/Options.html" title="class in org.apache.openjpa.lib.util">Options</A> opts) |
| throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A>, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></PRE> |
| <DL> |
| <DD>Run the tool. Returns false if invalid options were given. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> |
| <DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></CODE><DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseMappingTool.html#main(java.lang.String[])"><CODE>main(java.lang.String[])</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="run(org.apache.openjpa.jdbc.conf.JDBCConfiguration, java.lang.String[], org.apache.openjpa.jdbc.meta.ReverseMappingTool.Flags, java.lang.ClassLoader)"><!-- --></A><H3> |
| run</H3> |
| <PRE> |
| public static void <B>run</B>(<A HREF="../../../../../org/apache/openjpa/jdbc/conf/JDBCConfiguration.html" title="interface in org.apache.openjpa.jdbc.conf">JDBCConfiguration</A> conf, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[] args, |
| <A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseMappingTool.Flags.html" title="class in org.apache.openjpa.jdbc.meta">ReverseMappingTool.Flags</A> flags, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</A> loader) |
| throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A>, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></PRE> |
| <DL> |
| <DD>Run the tool. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> |
| <DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></CODE></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/ReverseMappingTool.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/ReverseCustomizer.html" title="interface in org.apache.openjpa.jdbc.meta"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../org/apache/openjpa/jdbc/meta/ReverseMappingTool.Flags.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/ReverseMappingTool.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="ReverseMappingTool.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> |