| <!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> |
| ClassGenerationInfo (Apache Cayenne API Documentation - v.2.0-incubating-SNAPSHOT) |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.apache.cayenne.gen.ClassGenerationInfo class"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../apache-javadoc.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="ClassGenerationInfo (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/AntClassGenerator.html" title="class in org.apache.cayenne.gen"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/cayenne/gen/ClassGenerator.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/ClassGenerationInfo.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="ClassGenerationInfo.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 ClassGenerationInfo</H2> |
| <PRE> |
| java.lang.Object |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.cayenne.gen.ClassGenerationInfo</B> |
| </PRE> |
| <HR> |
| <DL> |
| <DT><PRE>public class <B>ClassGenerationInfo</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>Since:</B></DT> |
| <DD>1.2</DD> |
| <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 java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/gen/ClassGenerationInfo.html#className">className</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/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/gen/ClassGenerationInfo.html#entity">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.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/gen/ClassGenerationInfo.html#packageName">packageName</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/ClassGenerationInfo.html#prop">prop</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/ClassGenerationInfo.html#superClassName">superClassName</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/ClassGenerationInfo.html#superPackageName">superPackageName</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/ClassGenerationInfo.html#superPrefix">superPrefix</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/ClassGenerationInfo.html#ClassGenerationInfo()">ClassGenerationInfo</A></B>()</CODE> |
| |
| <BR> |
| </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> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/gen/ClassGenerationInfo.html#capitalized(java.lang.String)">capitalized</A></B>(java.lang.String name)</CODE> |
| |
| <BR> |
| Capitalizes the first letter of the property name.</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/ClassGenerationInfo.html#capitalizedAsConstant(java.lang.String)">capitalizedAsConstant</A></B>(java.lang.String name)</CODE> |
| |
| <BR> |
| Converts property name to Java constants naming convention.</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/ClassGenerationInfo.html#formatJavaType(java.lang.String)">formatJavaType</A></B>(java.lang.String type)</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/ClassGenerationInfo.html#formatVariableName(java.lang.String)">formatVariableName</A></B>(java.lang.String variableName)</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/ClassGenerationInfo.html#getCappedProp()">getCappedProp</A></B>()</CODE> |
| |
| <BR> |
| Returns current property name with capitalized first letter</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/ClassGenerationInfo.html#getClassName()">getClassName</A></B>()</CODE> |
| |
| <BR> |
| Returns class name (without a package) of the class associated with this |
| generator.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/cayenne/map/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/gen/ClassGenerationInfo.html#getEntity()">getEntity</A></B>()</CODE> |
| |
| <BR> |
| Returns entity for the class associated with this generator.</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/ClassGenerationInfo.html#getPackageName()">getPackageName</A></B>()</CODE> |
| |
| <BR> |
| Returns Java package name of the class associated with this generator.</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/ClassGenerationInfo.html#getProp()">getProp</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/ClassGenerationInfo.html#getPropAsConstantName()">getPropAsConstantName</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/ClassGenerationInfo.html#getSuperClassName()">getSuperClassName</A></B>()</CODE> |
| |
| <BR> |
| Returns the fully qualified super class of the data object class |
| associated with this generator</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/ClassGenerationInfo.html#getSuperPackageName()">getSuperPackageName</A></B>()</CODE> |
| |
| <BR> |
| Returns <code>superPackageName</code> property that defines a |
| superclass's package name.</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/ClassGenerationInfo.html#getSuperPrefix()">getSuperPrefix</A></B>()</CODE> |
| |
| <BR> |
| Returns prefix used to distinguish between superclass and subclass when |
| generating classes in pairs.</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/ClassGenerationInfo.html#isContainingDeclaredListProperties()">isContainingDeclaredListProperties</A></B>()</CODE> |
| |
| <BR> |
| Returns true if current entity contains at least one Declared List property.</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/ClassGenerationInfo.html#isContainingListProperties()">isContainingListProperties</A></B>()</CODE> |
| |
| <BR> |
| Returns true if current entity contains at least one List property.</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/ClassGenerationInfo.html#isUsingPackage()">isUsingPackage</A></B>()</CODE> |
| |
| <BR> |
| Returns <code>true</code> if a class associated with this generator is |
| located in a package.</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/ClassGenerationInfo.html#isUsingSuperPackage()">isUsingSuperPackage</A></B>()</CODE> |
| |
| <BR> |
| Returns <code>true</code> if a superclass class associated with this |
| generator is located in a package.</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/ClassGenerationInfo.html#setClassName(java.lang.String)">setClassName</A></B>(java.lang.String className)</CODE> |
| |
| <BR> |
| Sets class name of the class associated with this |
| generator.</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/ClassGenerationInfo.html#setObjEntity(org.apache.cayenne.map.ObjEntity)">setObjEntity</A></B>(<A HREF="../../../../org/apache/cayenne/map/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</A> entity)</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/ClassGenerationInfo.html#setPackageName(java.lang.String)">setPackageName</A></B>(java.lang.String packageName)</CODE> |
| |
| <BR> |
| Sets Java package name of the class associated with this generator.</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/ClassGenerationInfo.html#setProp(java.lang.String)">setProp</A></B>(java.lang.String prop)</CODE> |
| |
| <BR> |
| Sets current class property name.</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/ClassGenerationInfo.html#setSuperClassName(java.lang.String)">setSuperClassName</A></B>(java.lang.String value)</CODE> |
| |
| <BR> |
| Sets the fully qualified super class of the data object class associated |
| with this generator</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/ClassGenerationInfo.html#setSuperPackageName(java.lang.String)">setSuperPackageName</A></B>(java.lang.String superPackageName)</CODE> |
| |
| <BR> |
| Sets <code>superPackageName</code> property that defines a superclass's |
| package name.</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/ClassGenerationInfo.html#setSuperPrefix(java.lang.String)">setSuperPrefix</A></B>(java.lang.String superPrefix)</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="entity"><!-- --></A><H3> |
| entity</H3> |
| <PRE> |
| protected <A HREF="../../../../org/apache/cayenne/map/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</A> <B>entity</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="packageName"><!-- --></A><H3> |
| packageName</H3> |
| <PRE> |
| protected java.lang.String <B>packageName</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="className"><!-- --></A><H3> |
| className</H3> |
| <PRE> |
| protected java.lang.String <B>className</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="superPrefix"><!-- --></A><H3> |
| superPrefix</H3> |
| <PRE> |
| protected java.lang.String <B>superPrefix</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="prop"><!-- --></A><H3> |
| prop</H3> |
| <PRE> |
| protected java.lang.String <B>prop</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="superPackageName"><!-- --></A><H3> |
| superPackageName</H3> |
| <PRE> |
| protected java.lang.String <B>superPackageName</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="superClassName"><!-- --></A><H3> |
| superClassName</H3> |
| <PRE> |
| protected java.lang.String <B>superClassName</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="ClassGenerationInfo()"><!-- --></A><H3> |
| ClassGenerationInfo</H3> |
| <PRE> |
| public <B>ClassGenerationInfo</B>()</PRE> |
| <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="getPackageName()"><!-- --></A><H3> |
| getPackageName</H3> |
| <PRE> |
| public java.lang.String <B>getPackageName</B>()</PRE> |
| <DL> |
| <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> |
| protected void <B>setPackageName</B>(java.lang.String packageName)</PRE> |
| <DL> |
| <DD>Sets Java package name of the class associated with this generator. |
| <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>Returns <code>superPackageName</code> property that defines a |
| superclass's package name. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setSuperPackageName(java.lang.String)"><!-- --></A><H3> |
| setSuperPackageName</H3> |
| <PRE> |
| protected void <B>setSuperPackageName</B>(java.lang.String superPackageName)</PRE> |
| <DL> |
| <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>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> |
| protected void <B>setClassName</B>(java.lang.String className)</PRE> |
| <DL> |
| <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="setSuperPrefix(java.lang.String)"><!-- --></A><H3> |
| setSuperPrefix</H3> |
| <PRE> |
| protected void <B>setSuperPrefix</B>(java.lang.String superPrefix)</PRE> |
| <DL> |
| <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 type)</PRE> |
| <DL> |
| <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 variableName)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getSuperPrefix()"><!-- --></A><H3> |
| getSuperPrefix</H3> |
| <PRE> |
| public java.lang.String <B>getSuperPrefix</B>()</PRE> |
| <DL> |
| <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 prop)</PRE> |
| <DL> |
| <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><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 name)</PRE> |
| <DL> |
| <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 name)</PRE> |
| <DL> |
| <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>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><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="isContainingDeclaredListProperties()"><!-- --></A><H3> |
| isContainingDeclaredListProperties</H3> |
| <PRE> |
| public boolean <B>isContainingDeclaredListProperties</B>()</PRE> |
| <DL> |
| <DD>Returns true if current entity contains at least one Declared List property. |
| <P> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isContainingListProperties()"><!-- --></A><H3> |
| isContainingListProperties</H3> |
| <PRE> |
| public boolean <B>isContainingListProperties</B>()</PRE> |
| <DL> |
| <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>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>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/apache/cayenne/map/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</A> <B>getEntity</B>()</PRE> |
| <DL> |
| <DD>Returns entity for the class associated with this generator. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setObjEntity(org.apache.cayenne.map.ObjEntity)"><!-- --></A><H3> |
| setObjEntity</H3> |
| <PRE> |
| protected void <B>setObjEntity</B>(<A HREF="../../../../org/apache/cayenne/map/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</A> entity)</PRE> |
| <DL> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>entity</CODE> - The entity to set.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getSuperClassName()"><!-- --></A><H3> |
| getSuperClassName</H3> |
| <PRE> |
| public java.lang.String <B>getSuperClassName</B>()</PRE> |
| <DL> |
| <DD>Returns the fully qualified super class of the data object class |
| associated with this generator |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setSuperClassName(java.lang.String)"><!-- --></A><H3> |
| setSuperClassName</H3> |
| <PRE> |
| protected void <B>setSuperClassName</B>(java.lang.String value)</PRE> |
| <DL> |
| <DD>Sets 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> </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/AntClassGenerator.html" title="class in org.apache.cayenne.gen"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/cayenne/gen/ClassGenerator.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/ClassGenerationInfo.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="ClassGenerationInfo.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> |
