blob: a52a2bf90bde909aa247a0fb996e1238e3ae1470 [file] [log] [blame]
<!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:42:48 EDT 2006 -->
<TITLE>
ClassGenerator (Cayenne API Documentation - v.1.2)
</TITLE>
<META NAME="keywords" CONTENT="org.objectstyle.cayenne.gen.ClassGenerator class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../objectstyle-javadoc.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="ClassGenerator (Cayenne API Documentation - v.1.2)";
}
</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>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../org/objectstyle/cayenne/gen/ClassGenerationInfo.html" title="class in org.objectstyle.cayenne.gen"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/objectstyle/cayenne/gen/ClassGeneratorResourceLoader.html" title="class in org.objectstyle.cayenne.gen"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/objectstyle/cayenne/gen/ClassGenerator.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="ClassGenerator.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<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.objectstyle.cayenne.gen</FONT>
<BR>
Class ClassGenerator</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.objectstyle.cayenne.gen.ClassGenerator</B>
</PRE>
<HR>
<DL>
<DT><PRE>public class <B>ClassGenerator</B><DT>extends java.lang.Object</DL>
</PRE>
<P>
Class generation engine for ObjEntities based on <a
href="http://jakarta.apache.org/velocity/" target="_blank">Velocity templates </a>.
Instance of ClassGenerationInfo is available inside Velocity template under the key
"classGen".
<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 &nbsp;<A HREF="../../../../org/objectstyle/cayenne/gen/ClassGenerationInfo.html" title="class in org.objectstyle.cayenne.gen">ClassGenerationInfo</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/gen/ClassGenerator.html#classGenerationInfo">classGenerationInfo</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;org.apache.velocity.Template</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/gen/ClassGenerator.html#classTemplate">classTemplate</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;org.apache.velocity.context.Context</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/gen/ClassGenerator.html#velCtxt">velCtxt</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/gen/ClassGenerator.html#VERSION_1_1">VERSION_1_1</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/gen/ClassGenerator.html#VERSION_1_2">VERSION_1_2</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/gen/ClassGenerator.html#versionString">versionString</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<!-- ======== 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/objectstyle/cayenne/gen/ClassGenerator.html#ClassGenerator(java.lang.String)">ClassGenerator</A></B>(java.lang.String&nbsp;template)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>Since 1.2 use ClassGenerator(String template, String versionString)
instead.</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/gen/ClassGenerator.html#ClassGenerator(java.lang.String, java.lang.String)">ClassGenerator</A></B>(java.lang.String&nbsp;template,
java.lang.String&nbsp;versionString)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a new ClassGenerationInfo that uses a specified Velocity template.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/gen/ClassGenerator.html#ClassGenerator(java.lang.String, java.lang.String, foundrylogic.vpp.VPPConfig)">ClassGenerator</A></B>(java.lang.String&nbsp;template,
java.lang.String&nbsp;versionString,
foundrylogic.vpp.VPPConfig&nbsp;vppConfig)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a new ClassGenerationInfo that uses a specified Velocity template.</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== 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>static&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/gen/ClassGenerator.html#bootstrapVelocity(java.lang.Class)">bootstrapVelocity</A></B>(java.lang.Class&nbsp;cl)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>since 1.2, as now Cayenne uses thread ClassLoader.</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/gen/ClassGenerator.html#capitalized(java.lang.String)">capitalized</A></B>(java.lang.String&nbsp;name)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>Since 1.2 use getClassGenerationInfo().capitalized(String)</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/gen/ClassGenerator.html#capitalizedAsConstant(java.lang.String)">capitalizedAsConstant</A></B>(java.lang.String&nbsp;name)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>Since 1.2 use getClassGenerationInfo().capitalizedAsConstant(String)</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/gen/ClassGenerator.html#formatJavaType(java.lang.String)">formatJavaType</A></B>(java.lang.String&nbsp;type)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>use getClassGenerationInfo().formatJavaType(String)</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/gen/ClassGenerator.html#formatVariableName(java.lang.String)">formatVariableName</A></B>(java.lang.String&nbsp;variableName)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>Since 1.2 use getClassGenerationInfo().formatVariableName(String)</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/gen/ClassGenerator.html#generateClass(java.io.Writer, org.objectstyle.cayenne.map.DataMap, org.objectstyle.cayenne.map.ObjEntity, java.lang.String, java.lang.String, java.lang.String)">generateClass</A></B>(java.io.Writer&nbsp;out,
<A HREF="../../../../org/objectstyle/cayenne/map/DataMap.html" title="class in org.objectstyle.cayenne.map">DataMap</A>&nbsp;dataMap,
<A HREF="../../../../org/objectstyle/cayenne/map/ObjEntity.html" title="class in org.objectstyle.cayenne.map">ObjEntity</A>&nbsp;entity,
java.lang.String&nbsp;fqnBaseClass,
java.lang.String&nbsp;fqnSuperClass,
java.lang.String&nbsp;fqnSubClass)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Generates Java code for the ObjEntity.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/gen/ClassGenerator.html#generateClass(java.io.Writer, org.objectstyle.cayenne.map.ObjEntity)">generateClass</A></B>(java.io.Writer&nbsp;out,
<A HREF="../../../../org/objectstyle/cayenne/map/ObjEntity.html" title="class in org.objectstyle.cayenne.map">ObjEntity</A>&nbsp;entity)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Generates Java code for the ObjEntity.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/gen/ClassGenerator.html#getCappedProp()">getCappedProp</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>Since 1.2 use getClassGenerationInfo().getCappedProp()</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../org/objectstyle/cayenne/gen/ClassGenerationInfo.html" title="class in org.objectstyle.cayenne.gen">ClassGenerationInfo</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/gen/ClassGenerator.html#getClassGenerationInfo()">getClassGenerationInfo</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/gen/ClassGenerator.html#getClassName()">getClassName</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>Since 1.2 use getClassGenerationInfo().getClassName()</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../org/objectstyle/cayenne/map/ObjEntity.html" title="class in org.objectstyle.cayenne.map">ObjEntity</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/gen/ClassGenerator.html#getEntity()">getEntity</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>Since 1.2 use getClassGenerationInfo().getEntity()</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/gen/ClassGenerator.html#getPackageName()">getPackageName</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>Since 1.2 use getClassGenerationInfo().getPackageName()</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/gen/ClassGenerator.html#getProp()">getProp</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>Since 1.2 use getClassGenerationInfo().getProp()</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/gen/ClassGenerator.html#getPropAsConstantName()">getPropAsConstantName</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>Since 1.2 use getClassGenerationInfo().getPropAsConstantName()</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/gen/ClassGenerator.html#getSuperClassName()">getSuperClassName</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>Since 1.2 use getClassGenerationInfo().getSuperClassName()</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/gen/ClassGenerator.html#getSuperPackageName()">getSuperPackageName</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>Since 1.2 use getClassGenerationInfo().getSuperPackageName()</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/gen/ClassGenerator.html#getSuperPrefix()">getSuperPrefix</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>Since 1.2 use getClassGenerationInfo().getSuperPrefix()</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/gen/ClassGenerator.html#isContainingListProperties()">isContainingListProperties</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>Since 1.2 use getClassGenerationInfo().isContainingListProperties()</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/gen/ClassGenerator.html#isUsingPackage()">isUsingPackage</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>Since 1.2 use getClassGenerationInfo().isUsingPackage()</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/gen/ClassGenerator.html#isUsingSuperPackage()">isUsingSuperPackage</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>Since 1.2 use getClassGenerationInfo().isUsingSuperPackage()</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/gen/ClassGenerator.html#setClassName(java.lang.String)">setClassName</A></B>(java.lang.String&nbsp;className)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>Since 1.2 use getClassGenerationInfo().setClassName()</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/gen/ClassGenerator.html#setPackageName(java.lang.String)">setPackageName</A></B>(java.lang.String&nbsp;packageName)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>Since 1.2 use getClassGenerationInfo().setPackageName()</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/gen/ClassGenerator.html#setProp(java.lang.String)">setProp</A></B>(java.lang.String&nbsp;prop)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>Since 1.2 use getClassGenerationInfo().setProp(String)</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/gen/ClassGenerator.html#setSuperClassName(java.lang.String)">setSuperClassName</A></B>(java.lang.String&nbsp;value)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>Since 1.2 use getClassGenerationInfo().setSuperClassName()</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/gen/ClassGenerator.html#setSuperPackageName(java.lang.String)">setSuperPackageName</A></B>(java.lang.String&nbsp;superPackageName)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>Since 1.2 use getClassGenerationInfo().setSuperPackageName()</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/gen/ClassGenerator.html#setSuperPrefix(java.lang.String)">setSuperPrefix</A></B>(java.lang.String&nbsp;superPrefix)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>Since 1.2 use getClassGenerationInfo().setSuperPrefix()</I></TD>
</TR>
</TABLE>
&nbsp;<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>
&nbsp;
<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="VERSION_1_1"><!-- --></A><H3>
VERSION_1_1</H3>
<PRE>
public 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.objectstyle.cayenne.gen.ClassGenerator.VERSION_1_1">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="VERSION_1_2"><!-- --></A><H3>
VERSION_1_2</H3>
<PRE>
public 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.objectstyle.cayenne.gen.ClassGenerator.VERSION_1_2">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="classTemplate"><!-- --></A><H3>
classTemplate</H3>
<PRE>
protected org.apache.velocity.Template <B>classTemplate</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="velCtxt"><!-- --></A><H3>
velCtxt</H3>
<PRE>
protected org.apache.velocity.context.Context <B>velCtxt</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="classGenerationInfo"><!-- --></A><H3>
classGenerationInfo</H3>
<PRE>
protected <A HREF="../../../../org/objectstyle/cayenne/gen/ClassGenerationInfo.html" title="class in org.objectstyle.cayenne.gen">ClassGenerationInfo</A> <B>classGenerationInfo</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="ClassGenerator(java.lang.String)"><!-- --></A><H3>
ClassGenerator</H3>
<PRE>
public <B>ClassGenerator</B>(java.lang.String&nbsp;template)
throws java.lang.Exception</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>Since 1.2 use ClassGenerator(String template, String versionString)
instead.</I>
<P>
<DD>Creates a new ClassGenerationInfo that uses a specified Velocity template.
<P>
<DL>
<DT><B>Throws:</B>
<DD><CODE>java.lang.Exception</CODE></DL>
</DL>
<HR>
<A NAME="ClassGenerator(java.lang.String, java.lang.String)"><!-- --></A><H3>
ClassGenerator</H3>
<PRE>
public <B>ClassGenerator</B>(java.lang.String&nbsp;template,
java.lang.String&nbsp;versionString)
throws java.lang.Exception</PRE>
<DL>
<DD>Creates a new ClassGenerationInfo that uses a specified Velocity template.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>template</CODE> - to use<DD><CODE>versionString</CODE> - of cgen
<DT><B>Throws:</B>
<DD><CODE>java.lang.Exception</CODE><DT><B>Since:</B></DT>
<DD>1.2</DD>
</DL>
</DL>
<HR>
<A NAME="ClassGenerator(java.lang.String, java.lang.String, foundrylogic.vpp.VPPConfig)"><!-- --></A><H3>
ClassGenerator</H3>
<PRE>
public <B>ClassGenerator</B>(java.lang.String&nbsp;template,
java.lang.String&nbsp;versionString,
foundrylogic.vpp.VPPConfig&nbsp;vppConfig)
throws java.lang.Exception</PRE>
<DL>
<DD>Creates a new ClassGenerationInfo that uses a specified Velocity template.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>template</CODE> - to use<DD><CODE>versionString</CODE> - of cgen<DD><CODE>vppConfig</CODE> - for configuring VelocityEngine and VelocityContext
<DT><B>Throws:</B>
<DD><CODE>java.lang.Exception</CODE><DT><B>Since:</B></DT>
<DD>1.2</DD>
</DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="bootstrapVelocity(java.lang.Class)"><!-- --></A><H3>
bootstrapVelocity</H3>
<PRE>
public static final void <B>bootstrapVelocity</B>(java.lang.Class&nbsp;cl)</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>since 1.2, as now Cayenne uses thread ClassLoader.</I>
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="generateClass(java.io.Writer, org.objectstyle.cayenne.map.ObjEntity)"><!-- --></A><H3>
generateClass</H3>
<PRE>
public void <B>generateClass</B>(java.io.Writer&nbsp;out,
<A HREF="../../../../org/objectstyle/cayenne/map/ObjEntity.html" title="class in org.objectstyle.cayenne.map">ObjEntity</A>&nbsp;entity)
throws java.lang.Exception</PRE>
<DL>
<DD>Generates Java code for the ObjEntity. Output is written to the provided Writer.
<P>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE>java.lang.Exception</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="generateClass(java.io.Writer, org.objectstyle.cayenne.map.DataMap, org.objectstyle.cayenne.map.ObjEntity, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
generateClass</H3>
<PRE>
public void <B>generateClass</B>(java.io.Writer&nbsp;out,
<A HREF="../../../../org/objectstyle/cayenne/map/DataMap.html" title="class in org.objectstyle.cayenne.map">DataMap</A>&nbsp;dataMap,
<A HREF="../../../../org/objectstyle/cayenne/map/ObjEntity.html" title="class in org.objectstyle.cayenne.map">ObjEntity</A>&nbsp;entity,
java.lang.String&nbsp;fqnBaseClass,
java.lang.String&nbsp;fqnSuperClass,
java.lang.String&nbsp;fqnSubClass)
throws java.lang.Exception</PRE>
<DL>
<DD>Generates Java code for the ObjEntity. Output is written to the provided Writer.
<P>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE>java.lang.Exception</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="getClassGenerationInfo()"><!-- --></A><H3>
getClassGenerationInfo</H3>
<PRE>
public <A HREF="../../../../org/objectstyle/cayenne/gen/ClassGenerationInfo.html" title="class in org.objectstyle.cayenne.gen">ClassGenerationInfo</A> <B>getClassGenerationInfo</B>()</PRE>
<DL>
<DD><DL>
<DT><B>Returns:</B><DD>Returns the classGenerationInfo in template.</DL>
</DD>
</DL>
<HR>
<A NAME="getPackageName()"><!-- --></A><H3>
getPackageName</H3>
<PRE>
public java.lang.String <B>getPackageName</B>()</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>Since 1.2 use getClassGenerationInfo().getPackageName()</I>
<P>
<DD>Returns Java package name of the class associated with this generator.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setPackageName(java.lang.String)"><!-- --></A><H3>
setPackageName</H3>
<PRE>
public void <B>setPackageName</B>(java.lang.String&nbsp;packageName)</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>Since 1.2 use getClassGenerationInfo().setPackageName()</I>
<P>
<DD>Sets Java package name of the class associated with this generator.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setSuperPackageName(java.lang.String)"><!-- --></A><H3>
setSuperPackageName</H3>
<PRE>
public void <B>setSuperPackageName</B>(java.lang.String&nbsp;superPackageName)</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>Since 1.2 use getClassGenerationInfo().setSuperPackageName()</I>
<P>
<DD>Sets <code>superPackageName</code> property that defines a superclass's package
name.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getClassName()"><!-- --></A><H3>
getClassName</H3>
<PRE>
public java.lang.String <B>getClassName</B>()</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>Since 1.2 use getClassGenerationInfo().getClassName()</I>
<P>
<DD>Returns class name (without a package) of the class associated with this generator.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setClassName(java.lang.String)"><!-- --></A><H3>
setClassName</H3>
<PRE>
public void <B>setClassName</B>(java.lang.String&nbsp;className)</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>Since 1.2 use getClassGenerationInfo().setClassName()</I>
<P>
<DD>Sets class name of the class associated with this generator. Class name must not
include a package.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setSuperClassName(java.lang.String)"><!-- --></A><H3>
setSuperClassName</H3>
<PRE>
public void <B>setSuperClassName</B>(java.lang.String&nbsp;value)</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>Since 1.2 use getClassGenerationInfo().setSuperClassName()</I>
<P>
<DD>Sets the fully qualified super class of the data object class associated with this
generator
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setSuperPrefix(java.lang.String)"><!-- --></A><H3>
setSuperPrefix</H3>
<PRE>
public void <B>setSuperPrefix</B>(java.lang.String&nbsp;superPrefix)</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>Since 1.2 use getClassGenerationInfo().setSuperPrefix()</I>
<P>
<DD>Returns prefix used to distinguish between superclass and subclass when generating
classes in pairs.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getSuperPackageName()"><!-- --></A><H3>
getSuperPackageName</H3>
<PRE>
public java.lang.String <B>getSuperPackageName</B>()</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>Since 1.2 use getClassGenerationInfo().getSuperPackageName()</I>
<P>
<DD>Returns <code>superPackageName</code> property that defines a superclass's
package name.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="formatJavaType(java.lang.String)"><!-- --></A><H3>
formatJavaType</H3>
<PRE>
public java.lang.String <B>formatJavaType</B>(java.lang.String&nbsp;type)</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>use getClassGenerationInfo().formatJavaType(String)</I>
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="formatVariableName(java.lang.String)"><!-- --></A><H3>
formatVariableName</H3>
<PRE>
public java.lang.String <B>formatVariableName</B>(java.lang.String&nbsp;variableName)</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>Since 1.2 use getClassGenerationInfo().formatVariableName(String)</I>
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getSuperPrefix()"><!-- --></A><H3>
getSuperPrefix</H3>
<PRE>
public java.lang.String <B>getSuperPrefix</B>()</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>Since 1.2 use getClassGenerationInfo().getSuperPrefix()</I>
<P>
<DD>Returns prefix used to distinguish between superclass and subclass when generating
classes in pairs.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setProp(java.lang.String)"><!-- --></A><H3>
setProp</H3>
<PRE>
public void <B>setProp</B>(java.lang.String&nbsp;prop)</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>Since 1.2 use getClassGenerationInfo().setProp(String)</I>
<P>
<DD>Sets current class property name. This method is called during template parsing for
each of the class properties.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getProp()"><!-- --></A><H3>
getProp</H3>
<PRE>
public java.lang.String <B>getProp</B>()</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>Since 1.2 use getClassGenerationInfo().getProp()</I>
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="capitalized(java.lang.String)"><!-- --></A><H3>
capitalized</H3>
<PRE>
public java.lang.String <B>capitalized</B>(java.lang.String&nbsp;name)</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>Since 1.2 use getClassGenerationInfo().capitalized(String)</I>
<P>
<DD>Capitalizes the first letter of the property name.
<P>
<DD><DL>
<DT><B>Since:</B></DT>
<DD>1.1</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="capitalizedAsConstant(java.lang.String)"><!-- --></A><H3>
capitalizedAsConstant</H3>
<PRE>
public java.lang.String <B>capitalizedAsConstant</B>(java.lang.String&nbsp;name)</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>Since 1.2 use getClassGenerationInfo().capitalizedAsConstant(String)</I>
<P>
<DD>Converts property name to Java constants naming convention.
<P>
<DD><DL>
<DT><B>Since:</B></DT>
<DD>1.1</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="getCappedProp()"><!-- --></A><H3>
getCappedProp</H3>
<PRE>
public java.lang.String <B>getCappedProp</B>()</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>Since 1.2 use getClassGenerationInfo().getCappedProp()</I>
<P>
<DD>Returns current property name with capitalized first letter
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getPropAsConstantName()"><!-- --></A><H3>
getPropAsConstantName</H3>
<PRE>
public java.lang.String <B>getPropAsConstantName</B>()</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>Since 1.2 use getClassGenerationInfo().getPropAsConstantName()</I>
<P>
<DD><DL>
<DT><B>Returns:</B><DD>a current property name converted to a format used by java static final
variables - all capitalized with underscores.<DT><B>Since:</B></DT>
<DD>1.0.3</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="isContainingListProperties()"><!-- --></A><H3>
isContainingListProperties</H3>
<PRE>
public boolean <B>isContainingListProperties</B>()</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>Since 1.2 use getClassGenerationInfo().isContainingListProperties()</I>
<P>
<DD>Returns true if current entity contains at least one List property.
<P>
<DD><DL>
<DT><B>Since:</B></DT>
<DD>1.1</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="isUsingPackage()"><!-- --></A><H3>
isUsingPackage</H3>
<PRE>
public boolean <B>isUsingPackage</B>()</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>Since 1.2 use getClassGenerationInfo().isUsingPackage()</I>
<P>
<DD>Returns <code>true</code> if a class associated with this generator is located in
a package.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="isUsingSuperPackage()"><!-- --></A><H3>
isUsingSuperPackage</H3>
<PRE>
public boolean <B>isUsingSuperPackage</B>()</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>Since 1.2 use getClassGenerationInfo().isUsingSuperPackage()</I>
<P>
<DD>Returns <code>true</code> if a superclass class associated with this generator is
located in a package.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getEntity()"><!-- --></A><H3>
getEntity</H3>
<PRE>
public <A HREF="../../../../org/objectstyle/cayenne/map/ObjEntity.html" title="class in org.objectstyle.cayenne.map">ObjEntity</A> <B>getEntity</B>()</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>Since 1.2 use getClassGenerationInfo().getEntity()</I>
<P>
<DD>Returns entity for the class associated with this generator.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getSuperClassName()"><!-- --></A><H3>
getSuperClassName</H3>
<PRE>
public java.lang.String <B>getSuperClassName</B>()</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>Since 1.2 use getClassGenerationInfo().getSuperClassName()</I>
<P>
<DD>Returns the fully qualified super class of the data object class associated with
this generator
<P>
<DD><DL>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../org/objectstyle/cayenne/gen/ClassGenerationInfo.html" title="class in org.objectstyle.cayenne.gen"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/objectstyle/cayenne/gen/ClassGeneratorResourceLoader.html" title="class in org.objectstyle.cayenne.gen"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/objectstyle/cayenne/gen/ClassGenerator.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="ClassGenerator.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<!--@SFLOGO@--> &nbsp; <i>Copyright &#169; 2001-2006 <a href=
"http://objectstyle.org" target="_top">ObjectStyle.org</a> All Rights Reserved.</i>
</BODY>
</HTML>