| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc (build 1.5.0_06) on Wed Jul 19 14:45:50 EDT 2006 --> |
| <TITLE> |
| MapClassGenerator (Apache Cayenne API Documentation - v.2.0-incubating-SNAPSHOT) |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.apache.cayenne.gen.MapClassGenerator class"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../apache-javadoc.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="MapClassGenerator (Apache Cayenne API Documentation - v.2.0-incubating-SNAPSHOT)"; |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <A NAME="navbar_top"><!-- --></A> |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="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-files/index-1.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/cayenne/gen/ImportUtils.html" title="class in org.apache.cayenne.gen"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/cayenne/gen/StringUtils.html" title="class in org.apache.cayenne.gen"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/cayenne/gen/MapClassGenerator.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="MapClassGenerator.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | <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.cayenne.gen</FONT> |
| <BR> |
| Class MapClassGenerator</H2> |
| <PRE> |
| java.lang.Object |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.cayenne.gen.MapClassGenerator</B> |
| </PRE> |
| <DL> |
| <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/apache/cayenne/gen/DefaultClassGenerator.html" title="class in org.apache.cayenne.gen">DefaultClassGenerator</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public abstract class <B>MapClassGenerator</B><DT>extends java.lang.Object</DL> |
| </PRE> |
| |
| <P> |
| Generates Java source code for ObjEntities in the DataMap. This class is abstract and |
| does not deal with filesystem issues directly. Concrete subclasses should provide ways |
| to store generated files by implementing <A HREF="../../../../org/apache/cayenne/gen/MapClassGenerator.html#openWriter(org.apache.cayenne.map.ObjEntity, java.lang.String, java.lang.String)"><CODE>openWriter(ObjEntity, String, String)</CODE></A> |
| and <A HREF="../../../../org/apache/cayenne/gen/MapClassGenerator.html#closeWriter(java.io.Writer)"><CODE>closeWriter(Writer)</CODE></A>methods. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Author:</B></DT> |
| <DD>Andrei Adamchik</DD> |
| </DL> |
| <HR> |
| |
| <P> |
| <!-- =========== 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>protected boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/gen/MapClassGenerator.html#client">client</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/gen/MapClassGenerator.html#CLIENT_SUBCLASS_TEMPLATE_1_2">CLIENT_SUBCLASS_TEMPLATE_1_2</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/gen/MapClassGenerator.html#CLIENT_SUPERCLASS_TEMPLATE_1_2">CLIENT_SUPERCLASS_TEMPLATE_1_2</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected <A HREF="../../../../org/apache/cayenne/map/DataMap.html" title="class in org.apache.cayenne.map">DataMap</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/gen/MapClassGenerator.html#dataMap">dataMap</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected static java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/gen/MapClassGenerator.html#DEFAULT_VERSION">DEFAULT_VERSION</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/gen/MapClassGenerator.html#mode">mode</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected static java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/gen/MapClassGenerator.html#MODE_DATAMAP">MODE_DATAMAP</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected static java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/gen/MapClassGenerator.html#MODE_ENTITY">MODE_ENTITY</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.util.List</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/gen/MapClassGenerator.html#objEntities">objEntities</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/gen/MapClassGenerator.html#SINGLE_CLASS_TEMPLATE">SINGLE_CLASS_TEMPLATE</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/gen/MapClassGenerator.html#SINGLE_CLASS_TEMPLATE_1_1">SINGLE_CLASS_TEMPLATE_1_1</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/gen/MapClassGenerator.html#SINGLE_CLASS_TEMPLATE_1_2">SINGLE_CLASS_TEMPLATE_1_2</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/gen/MapClassGenerator.html#SUBCLASS_TEMPLATE">SUBCLASS_TEMPLATE</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/gen/MapClassGenerator.html#SUBCLASS_TEMPLATE_1_1">SUBCLASS_TEMPLATE_1_1</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/gen/MapClassGenerator.html#SUBCLASS_TEMPLATE_1_2">SUBCLASS_TEMPLATE_1_2</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/gen/MapClassGenerator.html#SUPERCLASS_PREFIX">SUPERCLASS_PREFIX</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/gen/MapClassGenerator.html#SUPERCLASS_TEMPLATE">SUPERCLASS_TEMPLATE</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/gen/MapClassGenerator.html#SUPERCLASS_TEMPLATE_1_1">SUPERCLASS_TEMPLATE_1_1</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/gen/MapClassGenerator.html#SUPERCLASS_TEMPLATE_1_2">SUPERCLASS_TEMPLATE_1_2</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/gen/MapClassGenerator.html#superPkg">superPkg</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected static java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/gen/MapClassGenerator.html#VERSION_1_1">VERSION_1_1</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected static java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/gen/MapClassGenerator.html#VERSION_1_2">VERSION_1_2</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/gen/MapClassGenerator.html#versionString">versionString</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected foundrylogic.vpp.VPPConfig</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/gen/MapClassGenerator.html#vppConfig">vppConfig</A></B></CODE> |
| |
| <BR> |
| </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/cayenne/gen/MapClassGenerator.html#MapClassGenerator()">MapClassGenerator</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/gen/MapClassGenerator.html#MapClassGenerator(org.apache.cayenne.map.DataMap)">MapClassGenerator</A></B>(<A HREF="../../../../org/apache/cayenne/map/DataMap.html" title="class in org.apache.cayenne.map">DataMap</A> dataMap)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/gen/MapClassGenerator.html#MapClassGenerator(org.apache.cayenne.map.DataMap, java.util.List)">MapClassGenerator</A></B>(<A HREF="../../../../org/apache/cayenne/map/DataMap.html" title="class in org.apache.cayenne.map">DataMap</A> dataMap, |
| java.util.List objEntities)</CODE> |
| |
| <BR> |
| Creates a new MapClassGenerator.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/gen/MapClassGenerator.html#MapClassGenerator(java.util.List)">MapClassGenerator</A></B>(java.util.List objEntities)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>Since 1.2 use MapClassGenerator(DataMap, List) to provide support for |
| v1.2 templates.</I></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>abstract void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/gen/MapClassGenerator.html#closeWriter(java.io.Writer)">closeWriter</A></B>(java.io.Writer out)</CODE> |
| |
| <BR> |
| Closes writer after class code has been successfully written by |
| ClassGenerationInfo.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/gen/MapClassGenerator.html#defaultSingleClassTemplate()">defaultSingleClassTemplate</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/gen/MapClassGenerator.html#defaultSubclassTemplate()">defaultSubclassTemplate</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/gen/MapClassGenerator.html#defaultSuperclassTemplate()">defaultSuperclassTemplate</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/gen/MapClassGenerator.html#generateClassPairs()">generateClassPairs</A></B>()</CODE> |
| |
| <BR> |
| Runs class generation.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/gen/MapClassGenerator.html#generateClassPairs(java.lang.String, java.lang.String, java.lang.String)">generateClassPairs</A></B>(java.lang.String classTemplate, |
| java.lang.String superTemplate, |
| java.lang.String superPrefix)</CODE> |
| |
| <BR> |
| Runs class generation.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/gen/MapClassGenerator.html#generateSingleClasses()">generateSingleClasses</A></B>()</CODE> |
| |
| <BR> |
| Runs class generation.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/gen/MapClassGenerator.html#generateSingleClasses(java.lang.String)">generateSingleClasses</A></B>(java.lang.String classTemplate)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>Use generateSingleClasses(String classTemplate, String superPrefix) |
| instead.</I></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/cayenne/gen/MapClassGenerator.html#generateSingleClasses(java.lang.String, java.lang.String)">generateSingleClasses</A></B>(java.lang.String classTemplate, |
| java.lang.String superPrefix)</CODE> |
| |
| <BR> |
| Runs class generation.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/cayenne/map/DataMap.html" title="class in org.apache.cayenne.map">DataMap</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/gen/MapClassGenerator.html#getDataMap()">getDataMap</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.util.List</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/gen/MapClassGenerator.html#getObjEntities()">getObjEntities</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/gen/MapClassGenerator.html#getSuperPkg()">getSuperPkg</A></B>()</CODE> |
| |
| <BR> |
| Returns "superPkg" property value - a name of a superclass package that should be |
| used for all generated superclasses.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/gen/MapClassGenerator.html#getVersionString()">getVersionString</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> foundrylogic.vpp.VPPConfig</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/gen/MapClassGenerator.html#getVppConfig()">getVppConfig</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/gen/MapClassGenerator.html#initClassGenerator_1_1(org.apache.cayenne.gen.ClassGenerationInfo, org.apache.cayenne.map.ObjEntity, boolean)">initClassGenerator_1_1</A></B>(<A HREF="../../../../org/apache/cayenne/gen/ClassGenerationInfo.html" title="class in org.apache.cayenne.gen">ClassGenerationInfo</A> gen, |
| <A HREF="../../../../org/apache/cayenne/map/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</A> entity, |
| boolean superclass)</CODE> |
| |
| <BR> |
| Initializes ClassGenerationInfo with class name and package of a generated class.</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/cayenne/gen/MapClassGenerator.html#isClient()">isClient</A></B>()</CODE> |
| |
| <BR> |
| Returns whether a default client object template will be used.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>abstract java.io.Writer</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/gen/MapClassGenerator.html#openWriter(org.apache.cayenne.map.ObjEntity, java.lang.String, java.lang.String)">openWriter</A></B>(<A HREF="../../../../org/apache/cayenne/map/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</A> entity, |
| java.lang.String pkgName, |
| java.lang.String className)</CODE> |
| |
| <BR> |
| Creates a Writer to output source code for a given ObjEntity and Java class.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/gen/MapClassGenerator.html#setClient(boolean)">setClient</A></B>(boolean client)</CODE> |
| |
| <BR> |
| Sets whether a default client object template should be used.</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/cayenne/gen/MapClassGenerator.html#setDataMap(org.apache.cayenne.map.DataMap)">setDataMap</A></B>(<A HREF="../../../../org/apache/cayenne/map/DataMap.html" title="class in org.apache.cayenne.map">DataMap</A> dataMap)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/gen/MapClassGenerator.html#setMode(java.lang.String)">setMode</A></B>(java.lang.String mode)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/gen/MapClassGenerator.html#setObjEntities(java.util.List)">setObjEntities</A></B>(java.util.List objEntities)</CODE> |
| |
| <BR> |
| Initializes internal ObjEntities list.</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/cayenne/gen/MapClassGenerator.html#setSuperPkg(java.lang.String)">setSuperPkg</A></B>(java.lang.String superPkg)</CODE> |
| |
| <BR> |
| Sets "superPkg" property 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/cayenne/gen/MapClassGenerator.html#setVersionString(java.lang.String)">setVersionString</A></B>(java.lang.String versionString)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/gen/MapClassGenerator.html#setVppConfig(foundrylogic.vpp.VPPConfig)">setVppConfig</A></B>(foundrylogic.vpp.VPPConfig vppConfig)</CODE> |
| |
| <BR> |
| </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.Object</B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</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="SINGLE_CLASS_TEMPLATE_1_1"><!-- --></A><H3> |
| SINGLE_CLASS_TEMPLATE_1_1</H3> |
| <PRE> |
| public static final java.lang.String <B>SINGLE_CLASS_TEMPLATE_1_1</B></PRE> |
| <DL> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.cayenne.gen.MapClassGenerator.SINGLE_CLASS_TEMPLATE_1_1">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="SUBCLASS_TEMPLATE_1_1"><!-- --></A><H3> |
| SUBCLASS_TEMPLATE_1_1</H3> |
| <PRE> |
| public static final java.lang.String <B>SUBCLASS_TEMPLATE_1_1</B></PRE> |
| <DL> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.cayenne.gen.MapClassGenerator.SUBCLASS_TEMPLATE_1_1">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="SUPERCLASS_TEMPLATE_1_1"><!-- --></A><H3> |
| SUPERCLASS_TEMPLATE_1_1</H3> |
| <PRE> |
| public static final java.lang.String <B>SUPERCLASS_TEMPLATE_1_1</B></PRE> |
| <DL> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.cayenne.gen.MapClassGenerator.SUPERCLASS_TEMPLATE_1_1">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="SINGLE_CLASS_TEMPLATE_1_2"><!-- --></A><H3> |
| SINGLE_CLASS_TEMPLATE_1_2</H3> |
| <PRE> |
| public static final java.lang.String <B>SINGLE_CLASS_TEMPLATE_1_2</B></PRE> |
| <DL> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.cayenne.gen.MapClassGenerator.SINGLE_CLASS_TEMPLATE_1_2">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="SUBCLASS_TEMPLATE_1_2"><!-- --></A><H3> |
| SUBCLASS_TEMPLATE_1_2</H3> |
| <PRE> |
| public static final java.lang.String <B>SUBCLASS_TEMPLATE_1_2</B></PRE> |
| <DL> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.cayenne.gen.MapClassGenerator.SUBCLASS_TEMPLATE_1_2">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="SUPERCLASS_TEMPLATE_1_2"><!-- --></A><H3> |
| SUPERCLASS_TEMPLATE_1_2</H3> |
| <PRE> |
| public static final java.lang.String <B>SUPERCLASS_TEMPLATE_1_2</B></PRE> |
| <DL> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.cayenne.gen.MapClassGenerator.SUPERCLASS_TEMPLATE_1_2">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="CLIENT_SUBCLASS_TEMPLATE_1_2"><!-- --></A><H3> |
| CLIENT_SUBCLASS_TEMPLATE_1_2</H3> |
| <PRE> |
| public static final java.lang.String <B>CLIENT_SUBCLASS_TEMPLATE_1_2</B></PRE> |
| <DL> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.cayenne.gen.MapClassGenerator.CLIENT_SUBCLASS_TEMPLATE_1_2">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="CLIENT_SUPERCLASS_TEMPLATE_1_2"><!-- --></A><H3> |
| CLIENT_SUPERCLASS_TEMPLATE_1_2</H3> |
| <PRE> |
| public static final java.lang.String <B>CLIENT_SUPERCLASS_TEMPLATE_1_2</B></PRE> |
| <DL> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.cayenne.gen.MapClassGenerator.CLIENT_SUPERCLASS_TEMPLATE_1_2">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="SINGLE_CLASS_TEMPLATE"><!-- --></A><H3> |
| SINGLE_CLASS_TEMPLATE</H3> |
| <PRE> |
| public static final java.lang.String <B>SINGLE_CLASS_TEMPLATE</B></PRE> |
| <DL> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.cayenne.gen.MapClassGenerator.SINGLE_CLASS_TEMPLATE">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="SUBCLASS_TEMPLATE"><!-- --></A><H3> |
| SUBCLASS_TEMPLATE</H3> |
| <PRE> |
| public static final java.lang.String <B>SUBCLASS_TEMPLATE</B></PRE> |
| <DL> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.cayenne.gen.MapClassGenerator.SUBCLASS_TEMPLATE">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="SUPERCLASS_TEMPLATE"><!-- --></A><H3> |
| SUPERCLASS_TEMPLATE</H3> |
| <PRE> |
| public static final java.lang.String <B>SUPERCLASS_TEMPLATE</B></PRE> |
| <DL> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.cayenne.gen.MapClassGenerator.SUPERCLASS_TEMPLATE">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="SUPERCLASS_PREFIX"><!-- --></A><H3> |
| SUPERCLASS_PREFIX</H3> |
| <PRE> |
| public static final java.lang.String <B>SUPERCLASS_PREFIX</B></PRE> |
| <DL> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.cayenne.gen.MapClassGenerator.SUPERCLASS_PREFIX">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="VERSION_1_1"><!-- --></A><H3> |
| VERSION_1_1</H3> |
| <PRE> |
| protected static final java.lang.String <B>VERSION_1_1</B></PRE> |
| <DL> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.cayenne.gen.MapClassGenerator.VERSION_1_1">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="VERSION_1_2"><!-- --></A><H3> |
| VERSION_1_2</H3> |
| <PRE> |
| protected static final java.lang.String <B>VERSION_1_2</B></PRE> |
| <DL> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.cayenne.gen.MapClassGenerator.VERSION_1_2">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="DEFAULT_VERSION"><!-- --></A><H3> |
| DEFAULT_VERSION</H3> |
| <PRE> |
| protected static final java.lang.String <B>DEFAULT_VERSION</B></PRE> |
| <DL> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.cayenne.gen.MapClassGenerator.DEFAULT_VERSION">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="MODE_DATAMAP"><!-- --></A><H3> |
| MODE_DATAMAP</H3> |
| <PRE> |
| protected static final java.lang.String <B>MODE_DATAMAP</B></PRE> |
| <DL> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.cayenne.gen.MapClassGenerator.MODE_DATAMAP">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="MODE_ENTITY"><!-- --></A><H3> |
| MODE_ENTITY</H3> |
| <PRE> |
| protected static final java.lang.String <B>MODE_ENTITY</B></PRE> |
| <DL> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.cayenne.gen.MapClassGenerator.MODE_ENTITY">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="versionString"><!-- --></A><H3> |
| versionString</H3> |
| <PRE> |
| protected java.lang.String <B>versionString</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="objEntities"><!-- --></A><H3> |
| objEntities</H3> |
| <PRE> |
| protected java.util.List <B>objEntities</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="superPkg"><!-- --></A><H3> |
| superPkg</H3> |
| <PRE> |
| protected java.lang.String <B>superPkg</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="dataMap"><!-- --></A><H3> |
| dataMap</H3> |
| <PRE> |
| protected <A HREF="../../../../org/apache/cayenne/map/DataMap.html" title="class in org.apache.cayenne.map">DataMap</A> <B>dataMap</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="vppConfig"><!-- --></A><H3> |
| vppConfig</H3> |
| <PRE> |
| protected foundrylogic.vpp.VPPConfig <B>vppConfig</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="mode"><!-- --></A><H3> |
| mode</H3> |
| <PRE> |
| protected java.lang.String <B>mode</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="client"><!-- --></A><H3> |
| client</H3> |
| <PRE> |
| protected boolean <B>client</B></PRE> |
| <DL> |
| <DL> |
| </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="MapClassGenerator()"><!-- --></A><H3> |
| MapClassGenerator</H3> |
| <PRE> |
| public <B>MapClassGenerator</B>()</PRE> |
| <DL> |
| </DL> |
| <HR> |
| |
| <A NAME="MapClassGenerator(org.apache.cayenne.map.DataMap)"><!-- --></A><H3> |
| MapClassGenerator</H3> |
| <PRE> |
| public <B>MapClassGenerator</B>(<A HREF="../../../../org/apache/cayenne/map/DataMap.html" title="class in org.apache.cayenne.map">DataMap</A> dataMap)</PRE> |
| <DL> |
| </DL> |
| <HR> |
| |
| <A NAME="MapClassGenerator(org.apache.cayenne.map.DataMap, java.util.List)"><!-- --></A><H3> |
| MapClassGenerator</H3> |
| <PRE> |
| public <B>MapClassGenerator</B>(<A HREF="../../../../org/apache/cayenne/map/DataMap.html" title="class in org.apache.cayenne.map">DataMap</A> dataMap, |
| java.util.List objEntities)</PRE> |
| <DL> |
| <DD>Creates a new MapClassGenerator. |
| <P> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="MapClassGenerator(java.util.List)"><!-- --></A><H3> |
| MapClassGenerator</H3> |
| <PRE> |
| public <B>MapClassGenerator</B>(java.util.List objEntities)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>Since 1.2 use MapClassGenerator(DataMap, List) to provide support for |
| v1.2 templates.</I> |
| <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="defaultSingleClassTemplate()"><!-- --></A><H3> |
| defaultSingleClassTemplate</H3> |
| <PRE> |
| protected java.lang.String <B>defaultSingleClassTemplate</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="defaultSubclassTemplate()"><!-- --></A><H3> |
| defaultSubclassTemplate</H3> |
| <PRE> |
| protected java.lang.String <B>defaultSubclassTemplate</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="defaultSuperclassTemplate()"><!-- --></A><H3> |
| defaultSuperclassTemplate</H3> |
| <PRE> |
| protected java.lang.String <B>defaultSuperclassTemplate</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="openWriter(org.apache.cayenne.map.ObjEntity, java.lang.String, java.lang.String)"><!-- --></A><H3> |
| openWriter</H3> |
| <PRE> |
| public abstract java.io.Writer <B>openWriter</B>(<A HREF="../../../../org/apache/cayenne/map/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</A> entity, |
| java.lang.String pkgName, |
| java.lang.String className) |
| throws java.lang.Exception</PRE> |
| <DL> |
| <DD>Creates a Writer to output source code for a given ObjEntity and Java class. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>Writer to store generated class source code or null if this class |
| generation should be skipped. |
| <DT><B>Throws:</B> |
| <DD><CODE>java.lang.Exception</CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="closeWriter(java.io.Writer)"><!-- --></A><H3> |
| closeWriter</H3> |
| <PRE> |
| public abstract void <B>closeWriter</B>(java.io.Writer out) |
| throws java.lang.Exception</PRE> |
| <DL> |
| <DD>Closes writer after class code has been successfully written by |
| ClassGenerationInfo. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE>java.lang.Exception</CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="generateClassPairs()"><!-- --></A><H3> |
| generateClassPairs</H3> |
| <PRE> |
| public void <B>generateClassPairs</B>() |
| throws java.lang.Exception</PRE> |
| <DL> |
| <DD>Runs class generation. Produces a pair of Java classes for each ObjEntity in the |
| map. Uses default Cayenne templates for classes. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE>java.lang.Exception</CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="generateClassPairs(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3> |
| generateClassPairs</H3> |
| <PRE> |
| public void <B>generateClassPairs</B>(java.lang.String classTemplate, |
| java.lang.String superTemplate, |
| java.lang.String superPrefix) |
| throws java.lang.Exception</PRE> |
| <DL> |
| <DD>Runs class generation. Produces a pair of Java classes for each ObjEntity in the |
| map. This allows developers to use generated <b>subclass </b> for their custom |
| code, while generated <b>superclass </b> will contain Cayenne code. Superclass will |
| be generated in the same package, its class name will be derived from the class |
| name by adding a <code>superPrefix</code>. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE>java.lang.Exception</CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="generateSingleClasses()"><!-- --></A><H3> |
| generateSingleClasses</H3> |
| <PRE> |
| public void <B>generateSingleClasses</B>() |
| throws java.lang.Exception</PRE> |
| <DL> |
| <DD>Runs class generation. Produces a single Java class for each ObjEntity in the map. |
| Uses default Cayenne templates for classes. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE>java.lang.Exception</CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="generateSingleClasses(java.lang.String)"><!-- --></A><H3> |
| generateSingleClasses</H3> |
| <PRE> |
| public void <B>generateSingleClasses</B>(java.lang.String classTemplate) |
| throws java.lang.Exception</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>Use generateSingleClasses(String classTemplate, String superPrefix) |
| instead.</I> |
| <P> |
| <DD>Runs class generation. Produces a single Java class for each ObjEntity in the map. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE>java.lang.Exception</CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="generateSingleClasses(java.lang.String, java.lang.String)"><!-- --></A><H3> |
| generateSingleClasses</H3> |
| <PRE> |
| public void <B>generateSingleClasses</B>(java.lang.String classTemplate, |
| java.lang.String superPrefix) |
| throws java.lang.Exception</PRE> |
| <DL> |
| <DD>Runs class generation. Produces a single Java class for each ObjEntity in the map. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE>java.lang.Exception</CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="initClassGenerator_1_1(org.apache.cayenne.gen.ClassGenerationInfo, org.apache.cayenne.map.ObjEntity, boolean)"><!-- --></A><H3> |
| initClassGenerator_1_1</H3> |
| <PRE> |
| protected void <B>initClassGenerator_1_1</B>(<A HREF="../../../../org/apache/cayenne/gen/ClassGenerationInfo.html" title="class in org.apache.cayenne.gen">ClassGenerationInfo</A> gen, |
| <A HREF="../../../../org/apache/cayenne/map/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</A> entity, |
| boolean superclass)</PRE> |
| <DL> |
| <DD>Initializes ClassGenerationInfo with class name and package of a generated class. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getSuperPkg()"><!-- --></A><H3> |
| getSuperPkg</H3> |
| <PRE> |
| public java.lang.String <B>getSuperPkg</B>()</PRE> |
| <DL> |
| <DD>Returns "superPkg" property value - a name of a superclass package that should be |
| used for all generated superclasses. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setSuperPkg(java.lang.String)"><!-- --></A><H3> |
| setSuperPkg</H3> |
| <PRE> |
| public void <B>setSuperPkg</B>(java.lang.String superPkg)</PRE> |
| <DL> |
| <DD>Sets "superPkg" property value. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isClient()"><!-- --></A><H3> |
| isClient</H3> |
| <PRE> |
| public boolean <B>isClient</B>()</PRE> |
| <DL> |
| <DD>Returns whether a default client object template will be used. |
| <P> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setClient(boolean)"><!-- --></A><H3> |
| setClient</H3> |
| <PRE> |
| public void <B>setClient</B>(boolean client)</PRE> |
| <DL> |
| <DD>Sets whether a default client object template should be used. |
| <P> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDataMap()"><!-- --></A><H3> |
| getDataMap</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/cayenne/map/DataMap.html" title="class in org.apache.cayenne.map">DataMap</A> <B>getDataMap</B>()</PRE> |
| <DL> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>Returns the dataMap.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setDataMap(org.apache.cayenne.map.DataMap)"><!-- --></A><H3> |
| setDataMap</H3> |
| <PRE> |
| public void <B>setDataMap</B>(<A HREF="../../../../org/apache/cayenne/map/DataMap.html" title="class in org.apache.cayenne.map">DataMap</A> dataMap)</PRE> |
| <DL> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>dataMap</CODE> - The dataMap to set.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getObjEntities()"><!-- --></A><H3> |
| getObjEntities</H3> |
| <PRE> |
| public java.util.List <B>getObjEntities</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setObjEntities(java.util.List)"><!-- --></A><H3> |
| setObjEntities</H3> |
| <PRE> |
| public void <B>setObjEntities</B>(java.util.List objEntities)</PRE> |
| <DL> |
| <DD>Initializes internal ObjEntities list. This method creates a copy of the provided |
| list to allow its indepdendent modification and also filters out entities that do |
| not require class generation. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getVersionString()"><!-- --></A><H3> |
| getVersionString</H3> |
| <PRE> |
| public java.lang.String <B>getVersionString</B>()</PRE> |
| <DL> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>Returns the versionString.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setVersionString(java.lang.String)"><!-- --></A><H3> |
| setVersionString</H3> |
| <PRE> |
| public void <B>setVersionString</B>(java.lang.String versionString)</PRE> |
| <DL> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>versionString</CODE> - The versionString to set.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getVppConfig()"><!-- --></A><H3> |
| getVppConfig</H3> |
| <PRE> |
| public foundrylogic.vpp.VPPConfig <B>getVppConfig</B>()</PRE> |
| <DL> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>Returns the vppConfig.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setVppConfig(foundrylogic.vpp.VPPConfig)"><!-- --></A><H3> |
| setVppConfig</H3> |
| <PRE> |
| public void <B>setVppConfig</B>(foundrylogic.vpp.VPPConfig vppConfig)</PRE> |
| <DL> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>vppConfig</CODE> - The vppConfig to set.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setMode(java.lang.String)"><!-- --></A><H3> |
| setMode</H3> |
| <PRE> |
| public void <B>setMode</B>(java.lang.String mode)</PRE> |
| <DL> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>mode</CODE> - use "entity" for per-entity generation and "datamap" for per-datamap |
| generation.</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="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-files/index-1.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/cayenne/gen/ImportUtils.html" title="class in org.apache.cayenne.gen"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/cayenne/gen/StringUtils.html" title="class in org.apache.cayenne.gen"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/cayenne/gen/MapClassGenerator.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="MapClassGenerator.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | <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> |
| |
| <i>Copyright © 2001-2006 <a href= |
| "http://apache.org" target="_top">Apache.org</a> All Rights Reserved.</i> |
| |
| </BODY> |
| </HTML> |
