NameGenerator.html from iTicket at Krugle
Show NameGenerator.html syntax highlighted
<!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.4.2_05) on Tue Dec 06 20:33:29 CET 2005 -->
<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<TITLE>
NameGenerator (Torque generator 3.2 API)
</TITLE>
<META NAME="keywords" CONTENT="org.apache.torque.engine.database.model.NameGenerator interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="NameGenerator (Torque generator 3.2 API)";
}
</SCRIPT>
</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=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/NameGenerator.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../org/apache/torque/engine/database/model/IDMethod.html" title="interface in org.apache.torque.engine.database.model"><B>PREV CLASS</B></A>
NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../index.html" target="_top"><B>FRAMES</B></A>
<A HREF="NameGenerator.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> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.apache.torque.engine.database.model</FONT>
<BR>
Interface NameGenerator</H2>
<DL>
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../../org/apache/torque/engine/database/model/ConstraintNameGenerator.html" title="class in org.apache.torque.engine.database.model">ConstraintNameGenerator</A>, <A HREF="../../../../../../org/apache/torque/engine/database/model/JavaNameGenerator.html" title="class in org.apache.torque.engine.database.model">JavaNameGenerator</A></DD>
</DL>
<HR>
<DL>
<DT>public interface <B>NameGenerator</B></DL>
<P>
The generic interface to a name generation algorithm.
<P>
<P>
<DL>
<DT><B>Version:</B></DT>
<DD>$Id: NameGenerator.html,v 1.1 2006/04/19 20:02:28 ukistler Exp $</DD>
<DT><B>Author:</B></DT>
<DD><a href="mailto:dlr@finemaltcoding.com>Daniel Rall</a>, <a href="mailto:byron_foster@byron_foster@yahoo.com>Byron Foster</a></DD>
</DL>
<HR>
<P>
<!-- ======== NESTED CLASS SUMMARY ======== -->
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Field Summary</B></FONT></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/torque/engine/database/model/NameGenerator.html#CONV_METHOD_JAVANAME">CONV_METHOD_JAVANAME</A></B></CODE>
<BR>
Similar to <A HREF="../../../../../../org/apache/torque/engine/database/model/NameGenerator.html#CONV_METHOD_UNDERSCORE"><CODE>CONV_METHOD_UNDERSCORE</CODE></A> except nothing is
converted to lowercase.</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/torque/engine/database/model/NameGenerator.html#CONV_METHOD_NOCHANGE">CONV_METHOD_NOCHANGE</A></B></CODE>
<BR>
Specifies no modification when converting from a schema column
or table name to a java name.</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/torque/engine/database/model/NameGenerator.html#CONV_METHOD_UNDERSCORE">CONV_METHOD_UNDERSCORE</A></B></CODE>
<BR>
Traditional method for converting schema table and column names
to java names.</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/torque/engine/database/model/NameGenerator.html#CONV_METHOD_UNDERSCORE_OMIT_SCHEMA">CONV_METHOD_UNDERSCORE_OMIT_SCHEMA</A></B></CODE>
<BR>
Similar to <A HREF="../../../../../../org/apache/torque/engine/database/model/NameGenerator.html#CONV_METHOD_UNDERSCORE"><CODE>CONV_METHOD_UNDERSCORE</CODE></A> except a possible
schema name (preceding a dot (.) )is omitted</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static char</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/apache/torque/engine/database/model/NameGenerator.html#SCHEMA_SEPARATOR_CHAR">SCHEMA_SEPARATOR_CHAR</A></B></CODE>
<BR>
The character which separates the schema name from the table name</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static char</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/apache/torque/engine/database/model/NameGenerator.html#STD_SEPARATOR_CHAR">STD_SEPARATOR_CHAR</A></B></CODE>
<BR>
The character used by most implementations as the separator
between name elements.</TD>
</TR>
</TABLE>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Method Summary</B></FONT></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/torque/engine/database/model/NameGenerator.html#generateName(java.util.List)">generateName</A></B>(java.util.List inputs)</CODE>
<BR>
Given a list of <code>String</code> objects, implements an
algorithm which produces a name.</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">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Field Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="STD_SEPARATOR_CHAR"><!-- --></A><H3>
STD_SEPARATOR_CHAR</H3>
<PRE>
public static final char <B>STD_SEPARATOR_CHAR</B></PRE>
<DL>
<DD>The character used by most implementations as the separator
between name elements.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../../constant-values.html#org.apache.torque.engine.database.model.NameGenerator.STD_SEPARATOR_CHAR">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="SCHEMA_SEPARATOR_CHAR"><!-- --></A><H3>
SCHEMA_SEPARATOR_CHAR</H3>
<PRE>
public static final char <B>SCHEMA_SEPARATOR_CHAR</B></PRE>
<DL>
<DD>The character which separates the schema name from the table name
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../../constant-values.html#org.apache.torque.engine.database.model.NameGenerator.SCHEMA_SEPARATOR_CHAR">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="CONV_METHOD_UNDERSCORE"><!-- --></A><H3>
CONV_METHOD_UNDERSCORE</H3>
<PRE>
public static final java.lang.String <B>CONV_METHOD_UNDERSCORE</B></PRE>
<DL>
<DD>Traditional method for converting schema table and column names
to java names. The <code>CONV_METHOD_XXX</code> constants
define how names for columns and tables in the database schema
will be converted to java source names.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../../org/apache/torque/engine/database/model/JavaNameGenerator.html#underscoreMethod(java.lang.String)"><CODE>JavaNameGenerator.underscoreMethod(String)</CODE></A>,
<A HREF="../../../../../../constant-values.html#org.apache.torque.engine.database.model.NameGenerator.CONV_METHOD_UNDERSCORE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="CONV_METHOD_UNDERSCORE_OMIT_SCHEMA"><!-- --></A><H3>
CONV_METHOD_UNDERSCORE_OMIT_SCHEMA</H3>
<PRE>
public static final java.lang.String <B>CONV_METHOD_UNDERSCORE_OMIT_SCHEMA</B></PRE>
<DL>
<DD>Similar to <A HREF="../../../../../../org/apache/torque/engine/database/model/NameGenerator.html#CONV_METHOD_UNDERSCORE"><CODE>CONV_METHOD_UNDERSCORE</CODE></A> except a possible
schema name (preceding a dot (.) )is omitted
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../../org/apache/torque/engine/database/model/JavaNameGenerator.html#underscoreOmitSchemaMethod(java.lang.String)"><CODE>JavaNameGenerator.underscoreOmitSchemaMethod(String)</CODE></A>,
<A HREF="../../../../../../constant-values.html#org.apache.torque.engine.database.model.NameGenerator.CONV_METHOD_UNDERSCORE_OMIT_SCHEMA">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="CONV_METHOD_JAVANAME"><!-- --></A><H3>
CONV_METHOD_JAVANAME</H3>
<PRE>
public static final java.lang.String <B>CONV_METHOD_JAVANAME</B></PRE>
<DL>
<DD>Similar to <A HREF="../../../../../../org/apache/torque/engine/database/model/NameGenerator.html#CONV_METHOD_UNDERSCORE"><CODE>CONV_METHOD_UNDERSCORE</CODE></A> except nothing is
converted to lowercase.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../../org/apache/torque/engine/database/model/JavaNameGenerator.html#javanameMethod(java.lang.String)"><CODE>JavaNameGenerator.javanameMethod(String)</CODE></A>,
<A HREF="../../../../../../constant-values.html#org.apache.torque.engine.database.model.NameGenerator.CONV_METHOD_JAVANAME">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="CONV_METHOD_NOCHANGE"><!-- --></A><H3>
CONV_METHOD_NOCHANGE</H3>
<PRE>
public static final java.lang.String <B>CONV_METHOD_NOCHANGE</B></PRE>
<DL>
<DD>Specifies no modification when converting from a schema column
or table name to a java name.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../../constant-values.html#org.apache.torque.engine.database.model.NameGenerator.CONV_METHOD_NOCHANGE">Constant Field Values</A></DL>
</DL>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="generateName(java.util.List)"><!-- --></A><H3>
generateName</H3>
<PRE>
public java.lang.String <B>generateName</B>(java.util.List inputs)
throws <A HREF="../../../../../../org/apache/torque/engine/EngineException.html" title="class in org.apache.torque.engine">EngineException</A></PRE>
<DL>
<DD>Given a list of <code>String</code> objects, implements an
algorithm which produces a name.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>inputs</CODE> - Inputs used to generate a name.
<DT><B>Returns:</B><DD>The generated name.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../../org/apache/torque/engine/EngineException.html" title="class in org.apache.torque.engine">EngineException</A></CODE> - if the name could not be generated</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=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/NameGenerator.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../org/apache/torque/engine/database/model/IDMethod.html" title="interface in org.apache.torque.engine.database.model"><B>PREV CLASS</B></A>
NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../index.html" target="_top"><B>FRAMES</B></A>
<A HREF="NameGenerator.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> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright © 2000-2005 Apache Software Foundation. All Rights Reserved.
</BODY>
</HTML>
See more files for this project here