Code Search for Developers
 
 
  

Column.html from iTicket at Krugle


Show Column.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>
Column (Torque generator 3.2 API)
</TITLE>

<META NAME="keywords" CONTENT="org.apache.torque.engine.database.model.Column class">

<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style">

<SCRIPT type="text/javascript">
function windowTitle()
{
    parent.document.title="Column (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>&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="class-use/Column.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&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-all.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;PREV CLASS&nbsp;
&nbsp;<A HREF="../../../../../../org/apache/torque/engine/database/model/ConstraintNameGenerator.html" title="class in org.apache.torque.engine.database.model"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="Column.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;FIELD&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;FIELD&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.apache.torque.engine.database.model</FONT>
<BR>
Class Column</H2>
<PRE>
java.lang.Object
  <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.torque.engine.database.model.Column</B>
</PRE>
<HR>
<DL>
<DT>public class <B>Column</B><DT>extends java.lang.Object</DL>

<P>
A Class for holding data about a column used in an Application.
<P>

<P>
<DL>
<DT><B>Version:</B></DT>
  <DD>$Id: Column.html,v 1.1 2006/04/19 20:02:28 ukistler Exp $</DD>
<DT><B>Author:</B></DT>
  <DD><a href="mailto:leon@opticode.co.za">Leon Messerschmidt</a>, <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a>, <a href="mailto:jon@latchkey.com">Jon S. Stevens</a>, <a href="mailto:dlr@finemaltcoding.com">Daniel Rall</a>, <a href="mailto:byron_foster@byron_foster@yahoo.com>Byron Foster</a>, <a href="mailto:mpoeschl@marmot.at>Martin Poeschl</a></DD>
</DL>
<HR>

<P>
<!-- ======== NESTED CLASS SUMMARY ======== -->


<!-- =========== FIELD SUMMARY =========== -->


<!-- ======== CONSTRUCTOR SUMMARY ======== -->

<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../../../org/apache/torque/engine/database/model/Column.html#Column()">Column</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a new instance with a <code>null</code> name.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../../../org/apache/torque/engine/database/model/Column.html#Column(java.lang.String)">Column</A></B>(java.lang.String&nbsp;name)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a new column and set the name</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">
<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>&nbsp;<A HREF="../../../../../../org/apache/torque/engine/database/model/Inheritance.html" title="class in org.apache.torque.engine.database.model">Inheritance</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/apache/torque/engine/database/model/Column.html#addInheritance(org.xml.sax.Attributes)">addInheritance</A></B>(org.xml.sax.Attributes&nbsp;attrib)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A utility function to create a new column
 from attrib and add it to this table.</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/apache/torque/engine/database/model/Column.html#addInheritance(org.apache.torque.engine.database.model.Inheritance)">addInheritance</A></B>(<A HREF="../../../../../../org/apache/torque/engine/database/model/Inheritance.html" title="class in org.apache.torque.engine.database.model">Inheritance</A>&nbsp;inh)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds a new inheritance definition to the inheritance list and set the
 parent column of the inheritance to the current column</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/apache/torque/engine/database/model/Column.html#addReferrer(org.apache.torque.engine.database.model.ForeignKey)">addReferrer</A></B>(<A HREF="../../../../../../org/apache/torque/engine/database/model/ForeignKey.html" title="class in org.apache.torque.engine.database.model">ForeignKey</A>&nbsp;fk)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds the foreign key from another table that refers to this column.</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/apache/torque/engine/database/model/Column.html#getAutoIncrementString()">getAutoIncrementString</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.util.List</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/apache/torque/engine/database/model/Column.html#getChildren()">getChildren</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the inheritance definitions.</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/apache/torque/engine/database/model/Column.html#getDefaultSetting()">getDefaultSetting</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I></I>&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/apache/torque/engine/database/model/Column.html#getDefaultValue()">getDefaultValue</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get a string that will give this column a default value.</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/apache/torque/engine/database/model/Column.html#getDescription()">getDescription</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the description for the Table</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../../org/apache/torque/engine/database/model/Domain.html" title="class in org.apache.torque.engine.database.model">Domain</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/apache/torque/engine/database/model/Column.html#getDomain()">getDomain</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;<A HREF="../../../../../../org/apache/torque/engine/database/model/ForeignKey.html" title="class in org.apache.torque.engine.database.model">ForeignKey</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/apache/torque/engine/database/model/Column.html#getForeignKey()">getForeignKey</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;get the foreign key object for this column
 if it is a foreign key or part of a foreign key</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/apache/torque/engine/database/model/Column.html#getFullyQualifiedName()">getFullyQualifiedName</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns table.column</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/apache/torque/engine/database/model/Column.html#getGetterName()">getGetterName</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the name for the getter method to retrieve the value of this
 column</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/apache/torque/engine/database/model/Column.html#getInputValidator()">getInputValidator</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the class name to do input validation</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/apache/torque/engine/database/model/Column.html#getJavaName()">getJavaName</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get name to use in Java sources to build method names.</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/apache/torque/engine/database/model/Column.html#getJavaNative()">getJavaNative</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return a string representation of the native java type which corresponds
 to the JDBC type of this column.</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/apache/torque/engine/database/model/Column.html#getJavaObject()">getJavaObject</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return a string representation of the
 Java object which corresponds to the JDBC
 type of this column.</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/apache/torque/engine/database/model/Column.html#getJavaPrimitive()">getJavaPrimitive</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return a string representation of the primitive java type which
 corresponds to the JDBC type of this column.</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/apache/torque/engine/database/model/Column.html#getJavaType()">getJavaType</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get type to use in Java sources</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/apache/torque/engine/database/model/Column.html#getName()">getName</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the name of the column</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/apache/torque/engine/database/model/Column.html#getNotNullString()">getNotNullString</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return NOT NULL String for this column</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/apache/torque/engine/database/model/Column.html#getParameterParserMethod()">getParameterParserMethod</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return ParameterParser getX() method which
 corresponds to the JDBC type which represents this column.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/apache/torque/engine/database/model/Column.html#getPosition()">getPosition</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the location of this column within the table (one-based).</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/apache/torque/engine/database/model/Column.html#getPrecision()">getPrecision</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Try to determine the precision of the field from the size attribute.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.util.List</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/apache/torque/engine/database/model/Column.html#getReferrers()">getReferrers</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get list of references to this column.</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/apache/torque/engine/database/model/Column.html#getRelatedColumnName()">getRelatedColumnName</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Utility method to get the related column of this local column if this
 column is a foreign key or part of a foreign key.</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/apache/torque/engine/database/model/Column.html#getRelatedTableName()">getRelatedTableName</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Utility method to get the related table of this column if it is a foreign
 key or part of a foreign key</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/apache/torque/engine/database/model/Column.html#getScale()">getScale</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Try to determine the scale of the field from the scale and size 
 attribute.</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/apache/torque/engine/database/model/Column.html#getSetterName()">getSetterName</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the name for the setter method to set the value of this
 column</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/apache/torque/engine/database/model/Column.html#getSize()">getSize</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the size of the column</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/apache/torque/engine/database/model/Column.html#getSqlString()">getSqlString</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;<A HREF="../../../../../../org/apache/torque/engine/database/model/Table.html" title="class in org.apache.torque.engine.database.model">Table</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/apache/torque/engine/database/model/Column.html#getTable()">getTable</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the parent Table of the column</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/apache/torque/engine/database/model/Column.html#getTableName()">getTableName</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the Name of the table the column is in</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/apache/torque/engine/database/model/Column.html#getTorqueType()">getTorqueType</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the column type as given in the schema as an object</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/apache/torque/engine/database/model/Column.html#getType()">getType</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>the type conversion is handled by the platform package
             (since torque 3.2)</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/apache/torque/engine/database/model/Column.html#getUncapitalisedJavaName()">getUncapitalisedJavaName</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get variable name to use in Java sources (= uncapitalised java name)</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/apache/torque/engine/database/model/Column.html#getVillageMethod()">getVillageMethod</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return Village asX() method which corresponds to the JDBC type
 which represents this column.</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/apache/torque/engine/database/model/Column.html#isAutoIncrement()">isAutoIncrement</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return auto increment/sequence string for the target database.</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/apache/torque/engine/database/model/Column.html#isBit()">isBit</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if the column type is boolean in the
 java object and a Bit ("1" or "0") in the db.</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/apache/torque/engine/database/model/Column.html#isBooleanChar()">isBooleanChar</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if the column type is boolean in the
 java object and a String ("Y" or "N") in the db.</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/apache/torque/engine/database/model/Column.html#isBooleanInt()">isBooleanInt</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if the column type is boolean in the
 java object and a numeric (1 or 0) in the db.</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/apache/torque/engine/database/model/Column.html#isCorrectGetters()">isCorrectGetters</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the correctGetters property of the column</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/apache/torque/engine/database/model/Column.html#isEnumeratedClasses()">isEnumeratedClasses</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Determine if possible classes have been enumerated in the xml file.</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/apache/torque/engine/database/model/Column.html#isForeignKey()">isForeignKey</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Utility method to determine if this column is a foreign key.</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/apache/torque/engine/database/model/Column.html#isInheritance()">isInheritance</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Determine if this column is a normal property or specifies a
 the classes that are represented in the table containing this column.</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/apache/torque/engine/database/model/Column.html#isMultipleFK()">isMultipleFK</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Determine if this column is a foreign key that refers to the
 same table as another foreign key column in this table.</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/apache/torque/engine/database/model/Column.html#isNotNull()">isNotNull</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the isNotNull property of the column</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/apache/torque/engine/database/model/Column.html#isPrimaryKey()">isPrimaryKey</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return true if the column is a primary key</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/apache/torque/engine/database/model/Column.html#isPrimitive()">isPrimitive</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;returns true, if the columns java native type is an
 boolean, byte, short, int, long, float, double, char</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/apache/torque/engine/database/model/Column.html#isProtected()">isProtected</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the isProtected property of the column</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/apache/torque/engine/database/model/Column.html#isString()">isString</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>will be removed after the 3.2 release</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/apache/torque/engine/database/model/Column.html#isUnique()">isUnique</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the UNIQUE property</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/apache/torque/engine/database/model/Column.html#isUsePrimitive()">isUsePrimitive</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;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/apache/torque/engine/database/model/Column.html#loadFromXML(org.xml.sax.Attributes)">loadFromXML</A></B>(org.xml.sax.Attributes&nbsp;attrib)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Imports a column from an XML specification</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/apache/torque/engine/database/model/Column.html#makeList(java.util.List)">makeList</A></B>(java.util.List&nbsp;columns)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return a comma delimited string listing the specified columns.</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/apache/torque/engine/database/model/Column.html#needEscapedValue()">needEscapedValue</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Utility method to return the value as an element to be usable
 in an SQL insert statement.</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/apache/torque/engine/database/model/Column.html#printSize()">printSize</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the size and scale in brackets for use in an sql schema.</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/apache/torque/engine/database/model/Column.html#requiresTransactionInPostgres()">requiresTransactionInPostgres</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return true if the column requires a transaction in Postgres</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/apache/torque/engine/database/model/Column.html#setAutoIncrement(boolean)">setAutoIncrement</A></B>(boolean&nbsp;value)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the auto increment value.</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/apache/torque/engine/database/model/Column.html#setCorrectGetters(boolean)">setCorrectGetters</A></B>(boolean&nbsp;correctGetters)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the correctGetters property of the column.</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/apache/torque/engine/database/model/Column.html#setDefaultValue(java.lang.String)">setDefaultValue</A></B>(java.lang.String&nbsp;def)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set a string that will give this column a default value.</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/apache/torque/engine/database/model/Column.html#setDescription(java.lang.String)">setDescription</A></B>(java.lang.String&nbsp;newDescription)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the description for the Table</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/apache/torque/engine/database/model/Column.html#setDomain(org.apache.torque.engine.database.model.Domain)">setDomain</A></B>(<A HREF="../../../../../../org/apache/torque/engine/database/model/Domain.html" title="class in org.apache.torque.engine.database.model">Domain</A>&nbsp;domain)</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;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/apache/torque/engine/database/model/Column.html#setJavaName(java.lang.String)">setJavaName</A></B>(java.lang.String&nbsp;javaName)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set name to use in Java sources</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/apache/torque/engine/database/model/Column.html#setName(java.lang.String)">setName</A></B>(java.lang.String&nbsp;newName)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the name of the column</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/apache/torque/engine/database/model/Column.html#setNotNull(boolean)">setNotNull</A></B>(boolean&nbsp;status)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the isNotNull property of the column</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/apache/torque/engine/database/model/Column.html#setPosition(int)">setPosition</A></B>(int&nbsp;v)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the location of this column within the table (one-based).</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/apache/torque/engine/database/model/Column.html#setPrimaryKey(boolean)">setPrimaryKey</A></B>(boolean&nbsp;pk)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set if the column is a primary key or not</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/apache/torque/engine/database/model/Column.html#setProtected(boolean)">setProtected</A></B>(boolean&nbsp;prot)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the isProtected property of the Column</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/apache/torque/engine/database/model/Column.html#setScale(java.lang.String)">setScale</A></B>(java.lang.String&nbsp;newScale)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the scale of the column</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/apache/torque/engine/database/model/Column.html#setSize(java.lang.String)">setSize</A></B>(java.lang.String&nbsp;newSize)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the size of the column</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/apache/torque/engine/database/model/Column.html#setTable(org.apache.torque.engine.database.model.Table)">setTable</A></B>(<A HREF="../../../../../../org/apache/torque/engine/database/model/Table.html" title="class in org.apache.torque.engine.database.model">Table</A>&nbsp;parent)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the parent Table of the column</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/apache/torque/engine/database/model/Column.html#setType(org.apache.torque.engine.database.model.SchemaType)">setType</A></B>(<A HREF="../../../../../../org/apache/torque/engine/database/model/SchemaType.html" title="class in org.apache.torque.engine.database.model">SchemaType</A>&nbsp;torqueType)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the colunm type</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/apache/torque/engine/database/model/Column.html#setType(java.lang.String)">setType</A></B>(java.lang.String&nbsp;torqueType)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the colunm type</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/apache/torque/engine/database/model/Column.html#setTypeFromString(java.lang.String, java.lang.String)">setTypeFromString</A></B>(java.lang.String&nbsp;typeName,
                  java.lang.String&nbsp;size)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the column type from a string property
 (normally a string from an sql input file)</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/apache/torque/engine/database/model/Column.html#setUnique(boolean)">setUnique</A></B>(boolean&nbsp;u)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set true if the column is UNIQUE</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/apache/torque/engine/database/model/Column.html#toString()">toString</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;String representation of the column.</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">
<TD><B>Methods inherited from class java.lang.Object</B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>

<!-- ============ FIELD DETAIL =========== -->


<!-- ========= CONSTRUCTOR DETAIL ======== -->

<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="Column()"><!-- --></A><H3>
Column</H3>
<PRE>
public <B>Column</B>()</PRE>
<DL>
<DD>Creates a new instance with a <code>null</code> name.
<P>
</DL>
<HR>

<A NAME="Column(java.lang.String)"><!-- --></A><H3>
Column</H3>
<PRE>
public <B>Column</B>(java.lang.String&nbsp;name)</PRE>
<DL>
<DD>Creates a new column and set the name
<P>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - column name</DL>

<!-- ============ 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="makeList(java.util.List)"><!-- --></A><H3>
makeList</H3>
<PRE>
public static java.lang.String <B>makeList</B>(java.util.List&nbsp;columns)</PRE>
<DL>
<DD>Return a comma delimited string listing the specified columns.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>columns</CODE> - Either a list of <code>Column</code> objects, or
 a list of <code>String</code> objects with column names.</DL>
</DD>
</DL>
<HR>

<A NAME="loadFromXML(org.xml.sax.Attributes)"><!-- --></A><H3>
loadFromXML</H3>
<PRE>
public void <B>loadFromXML</B>(org.xml.sax.Attributes&nbsp;attrib)</PRE>
<DL>
<DD>Imports a column from an XML specification
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getFullyQualifiedName()"><!-- --></A><H3>
getFullyQualifiedName</H3>
<PRE>
public java.lang.String <B>getFullyQualifiedName</B>()</PRE>
<DL>
<DD>Returns table.column
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getName()"><!-- --></A><H3>
getName</H3>
<PRE>
public java.lang.String <B>getName</B>()</PRE>
<DL>
<DD>Get the name of the column
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="setName(java.lang.String)"><!-- --></A><H3>
setName</H3>
<PRE>
public void <B>setName</B>(java.lang.String&nbsp;newName)</PRE>
<DL>
<DD>Set the name of the column
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getDescription()"><!-- --></A><H3>
getDescription</H3>
<PRE>
public java.lang.String <B>getDescription</B>()</PRE>
<DL>
<DD>Get the description for the Table
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="setDescription(java.lang.String)"><!-- --></A><H3>
setDescription</H3>
<PRE>
public void <B>setDescription</B>(java.lang.String&nbsp;newDescription)</PRE>
<DL>
<DD>Set the description for the Table
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>newDescription</CODE> - description for the Table</DL>
</DD>
</DL>
<HR>

<A NAME="getJavaName()"><!-- --></A><H3>
getJavaName</H3>
<PRE>
public java.lang.String <B>getJavaName</B>()</PRE>
<DL>
<DD>Get name to use in Java sources to build method names.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the capitalised javaName</DL>
</DD>
</DL>
<HR>

<A NAME="getGetterName()"><!-- --></A><H3>
getGetterName</H3>
<PRE>
public java.lang.String <B>getGetterName</B>()</PRE>
<DL>
<DD>Returns the name for the getter method to retrieve the value of this
 column
<P>
<DD><DL>

<DT><B>Returns:</B><DD>A getter method name for this column.<DT><B>Since:</B></DT>
  <DD>3.2</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="getSetterName()"><!-- --></A><H3>
getSetterName</H3>
<PRE>
public java.lang.String <B>getSetterName</B>()</PRE>
<DL>
<DD>Returns the name for the setter method to set the value of this
 column
<P>
<DD><DL>

<DT><B>Returns:</B><DD>A setter method name for this column.<DT><B>Since:</B></DT>
  <DD>3.2</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="getUncapitalisedJavaName()"><!-- --></A><H3>
getUncapitalisedJavaName</H3>
<PRE>
public java.lang.String <B>getUncapitalisedJavaName</B>()</PRE>
<DL>
<DD>Get variable name to use in Java sources (= uncapitalised java name)
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="setJavaName(java.lang.String)"><!-- --></A><H3>
setJavaName</H3>
<PRE>
public void <B>setJavaName</B>(java.lang.String&nbsp;javaName)</PRE>
<DL>
<DD>Set name to use in Java sources
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getJavaType()"><!-- --></A><H3>
getJavaType</H3>
<PRE>
public java.lang.String <B>getJavaType</B>()</PRE>
<DL>
<DD>Get type to use in Java sources
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getPosition()"><!-- --></A><H3>
getPosition</H3>
<PRE>
public int <B>getPosition</B>()</PRE>
<DL>
<DD>Get the location of this column within the table (one-based).
<P>
<DD><DL>

<DT><B>Returns:</B><DD>value of position.</DL>
</DD>
</DL>
<HR>

<A NAME="setPosition(int)"><!-- --></A><H3>
setPosition</H3>
<PRE>
public void <B>setPosition</B>(int&nbsp;v)</PRE>
<DL>
<DD>Get the location of this column within the table (one-based).
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>v</CODE> - Value to assign to position.</DL>
</DD>
</DL>
<HR>

<A NAME="setTable(org.apache.torque.engine.database.model.Table)"><!-- --></A><H3>
setTable</H3>
<PRE>
public void <B>setTable</B>(<A HREF="../../../../../../org/apache/torque/engine/database/model/Table.html" title="class in org.apache.torque.engine.database.model">Table</A>&nbsp;parent)</PRE>
<DL>
<DD>Set the parent Table of the column
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getTable()"><!-- --></A><H3>
getTable</H3>
<PRE>
public <A HREF="../../../../../../org/apache/torque/engine/database/model/Table.html" title="class in org.apache.torque.engine.database.model">Table</A> <B>getTable</B>()</PRE>
<DL>
<DD>Get the parent Table of the column
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getTableName()"><!-- --></A><H3>
getTableName</H3>
<PRE>
public java.lang.String <B>getTableName</B>()</PRE>
<DL>
<DD>Returns the Name of the table the column is in
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="addInheritance(org.xml.sax.Attributes)"><!-- --></A><H3>
addInheritance</H3>
<PRE>
public <A HREF="../../../../../../org/apache/torque/engine/database/model/Inheritance.html" title="class in org.apache.torque.engine.database.model">Inheritance</A> <B>addInheritance</B>(org.xml.sax.Attributes&nbsp;attrib)</PRE>
<DL>
<DD>A utility function to create a new column
 from attrib and add it to this table.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="addInheritance(org.apache.torque.engine.database.model.Inheritance)"><!-- --></A><H3>
addInheritance</H3>
<PRE>
public void <B>addInheritance</B>(<A HREF="../../../../../../org/apache/torque/engine/database/model/Inheritance.html" title="class in org.apache.torque.engine.database.model">Inheritance</A>&nbsp;inh)</PRE>
<DL>
<DD>Adds a new inheritance definition to the inheritance list and set the
 parent column of the inheritance to the current column
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getChildren()"><!-- --></A><H3>
getChildren</H3>
<PRE>
public java.util.List <B>getChildren</B>()</PRE>
<DL>
<DD>Get the inheritance definitions.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="isInheritance()"><!-- --></A><H3>
isInheritance</H3>
<PRE>
public boolean <B>isInheritance</B>()</PRE>
<DL>
<DD>Determine if this column is a normal property or specifies a
 the classes that are represented in the table containing this column.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="isEnumeratedClasses()"><!-- --></A><H3>
isEnumeratedClasses</H3>
<PRE>
public boolean <B>isEnumeratedClasses</B>()</PRE>
<DL>
<DD>Determine if possible classes have been enumerated in the xml file.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="isNotNull()"><!-- --></A><H3>
isNotNull</H3>
<PRE>
public boolean <B>isNotNull</B>()</PRE>
<DL>
<DD>Return the isNotNull property of the column
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="setNotNull(boolean)"><!-- --></A><H3>
setNotNull</H3>
<PRE>
public void <B>setNotNull</B>(boolean&nbsp;status)</PRE>
<DL>
<DD>Set the isNotNull property of the column
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getNotNullString()"><!-- --></A><H3>
getNotNullString</H3>
<PRE>
public java.lang.String <B>getNotNullString</B>()</PRE>
<DL>
<DD>Return NOT NULL String for this column
<P>
<DD><DL>

<DT><B>Returns:</B><DD>"NOT NULL" if null values are not allowed or an empty String.</DL>
</DD>
</DL>
<HR>

<A NAME="isProtected()"><!-- --></A><H3>
isProtected</H3>
<PRE>
public boolean <B>isProtected</B>()</PRE>
<DL>
<DD>Return the isProtected property of the column
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="setProtected(boolean)"><!-- --></A><H3>
setProtected</H3>
<PRE>
public void <B>setProtected</B>(boolean&nbsp;prot)</PRE>
<DL>
<DD>Set the isProtected property of the Column
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="setPrimaryKey(boolean)"><!-- --></A><H3>
setPrimaryKey</H3>
<PRE>
public void <B>setPrimaryKey</B>(boolean&nbsp;pk)</PRE>
<DL>
<DD>Set if the column is a primary key or not
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="isPrimaryKey()"><!-- --></A><H3>
isPrimaryKey</H3>
<PRE>
public boolean <B>isPrimaryKey</B>()</PRE>
<DL>
<DD>Return true if the column is a primary key
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="setUnique(boolean)"><!-- --></A><H3>
setUnique</H3>
<PRE>
public void <B>setUnique</B>(boolean&nbsp;u)</PRE>
<DL>
<DD>Set true if the column is UNIQUE
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="isUnique()"><!-- --></A><H3>
isUnique</H3>
<PRE>
public boolean <B>isUnique</B>()</PRE>
<DL>
<DD>Get the UNIQUE property
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="requiresTransactionInPostgres()"><!-- --></A><H3>
requiresTransactionInPostgres</H3>
<PRE>
public boolean <B>requiresTransactionInPostgres</B>()</PRE>
<DL>
<DD>Return true if the column requires a transaction in Postgres
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="isForeignKey()"><!-- --></A><H3>
isForeignKey</H3>
<PRE>
public boolean <B>isForeignKey</B>()</PRE>
<DL>
<DD>Utility method to determine if this column is a foreign key.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="isMultipleFK()"><!-- --></A><H3>
isMultipleFK</H3>
<PRE>
public boolean <B>isMultipleFK</B>()</PRE>
<DL>
<DD>Determine if this column is a foreign key that refers to the
 same table as another foreign key column in this table.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getForeignKey()"><!-- --></A><H3>
getForeignKey</H3>
<PRE>
public <A HREF="../../../../../../org/apache/torque/engine/database/model/ForeignKey.html" title="class in org.apache.torque.engine.database.model">ForeignKey</A> <B>getForeignKey</B>()</PRE>
<DL>
<DD>get the foreign key object for this column
 if it is a foreign key or part of a foreign key
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getRelatedTableName()"><!-- --></A><H3>
getRelatedTableName</H3>
<PRE>
public java.lang.String <B>getRelatedTableName</B>()</PRE>
<DL>
<DD>Utility method to get the related table of this column if it is a foreign
 key or part of a foreign key
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getRelatedColumnName()"><!-- --></A><H3>
getRelatedColumnName</H3>
<PRE>
public java.lang.String <B>getRelatedColumnName</B>()</PRE>
<DL>
<DD>Utility method to get the related column of this local column if this
 column is a foreign key or part of a foreign key.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="addReferrer(org.apache.torque.engine.database.model.ForeignKey)"><!-- --></A><H3>
addReferrer</H3>
<PRE>
public void <B>addReferrer</B>(<A HREF="../../../../../../org/apache/torque/engine/database/model/ForeignKey.html" title="class in org.apache.torque.engine.database.model">ForeignKey</A>&nbsp;fk)</PRE>
<DL>
<DD>Adds the foreign key from another table that refers to this column.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getReferrers()"><!-- --></A><H3>
getReferrers</H3>
<PRE>
public java.util.List <B>getReferrers</B>()</PRE>
<DL>
<DD>Get list of references to this column.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="setType(java.lang.String)"><!-- --></A><H3>
setType</H3>
<PRE>
public void <B>setType</B>(java.lang.String&nbsp;torqueType)</PRE>
<DL>
<DD>Sets the colunm type
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="setType(org.apache.torque.engine.database.model.SchemaType)"><!-- --></A><H3>
setType</H3>
<PRE>
public void <B>setType</B>(<A HREF="../../../../../../org/apache/torque/engine/database/model/SchemaType.html" title="class in org.apache.torque.engine.database.model">SchemaType</A>&nbsp;torqueType)</PRE>
<DL>
<DD>Sets the colunm type
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getType()"><!-- --></A><H3>
getType</H3>
<PRE>
public java.lang.Object <B>getType</B>()</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>the type conversion is handled by the platform package
             (since torque 3.2)</I>
<P>
<DD>Returns the column jdbc type as an object
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getTorqueType()"><!-- --></A><H3>
getTorqueType</H3>
<PRE>
public java.lang.Object <B>getTorqueType</B>()</PRE>
<DL>
<DD>Returns the column type as given in the schema as an object
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="isString()"><!-- --></A><H3>
isString</H3>
<PRE>
public boolean <B>isString</B>()</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>will be removed after the 3.2 release</I>
<P>
<DD>Utility method to see if the column is a string
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="needEscapedValue()"><!-- --></A><H3>
needEscapedValue</H3>
<PRE>
public boolean <B>needEscapedValue</B>()</PRE>
<DL>
<DD>Utility method to return the value as an element to be usable
 in an SQL insert statement. This is used from the SQL loader task
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="toString()"><!-- --></A><H3>
toString</H3>
<PRE>
public java.lang.String <B>toString</B>()</PRE>
<DL>
<DD>String representation of the column. This is an xml representation.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>string representation in xml</DL>
</DD>
</DL>
<HR>

<A NAME="getSize()"><!-- --></A><H3>
getSize</H3>
<PRE>
public java.lang.String <B>getSize</B>()</PRE>
<DL>
<DD>Returns the size of the column
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="setSize(java.lang.String)"><!-- --></A><H3>
setSize</H3>
<PRE>
public void <B>setSize</B>(java.lang.String&nbsp;newSize)</PRE>
<DL>
<DD>Set the size of the column
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getPrecision()"><!-- --></A><H3>
getPrecision</H3>
<PRE>
public java.lang.String <B>getPrecision</B>()</PRE>
<DL>
<DD>Try to determine the precision of the field from the size attribute.
 If size attribute is an integer number, it will be returned.
 If size attribute is of the format "Precision,Scale", then Precision
 will be returned.
 If size is null or the size value is not an valid integer, 
 null is returned.
 <p>
 Note: Unparseable values will be logged as a warning.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>The precision portion of the size attribute.</DL>
</DD>
</DL>
<HR>

<A NAME="getScale()"><!-- --></A><H3>
getScale</H3>
<PRE>
public java.lang.String <B>getScale</B>()</PRE>
<DL>
<DD>Try to determine the scale of the field from the scale and size 
 attribute.
 If scale attribute is an integer number, it will be returned.
 If size attribute is of the format "Precision,Scale", then Scale
 will be returned.
 If scale and size attributes are null or the scale value found 
 is not an valid integer, a null value is returned.
 <p>
 Note: Unparseable values will be logged as a warning.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>The precision portion of the size attribute.</DL>
</DD>
</DL>
<HR>

<A NAME="setScale(java.lang.String)"><!-- --></A><H3>
setScale</H3>
<PRE>
public void <B>setScale</B>(java.lang.String&nbsp;newScale)</PRE>
<DL>
<DD>Set the scale of the column
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="printSize()"><!-- --></A><H3>
printSize</H3>
<PRE>
public java.lang.String <B>printSize</B>()</PRE>
<DL>
<DD>Return the size and scale in brackets for use in an sql schema.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>size and scale or an empty String if there are no values
         available.</DL>
</DD>
</DL>
<HR>

<A NAME="getDefaultSetting()"><!-- --></A><H3>
getDefaultSetting</H3>
<PRE>
public java.lang.String <B>getDefaultSetting</B>()</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I></I>&nbsp;
<P>
<DD>Return a string that will give this column a default value.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="setDefaultValue(java.lang.String)"><!-- --></A><H3>
setDefaultValue</H3>
<PRE>
public void <B>setDefaultValue</B>(java.lang.String&nbsp;def)</PRE>
<DL>
<DD>Set a string that will give this column a default value.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getDefaultValue()"><!-- --></A><H3>
getDefaultValue</H3>
<PRE>
public java.lang.String <B>getDefaultValue</B>()</PRE>
<DL>
<DD>Get a string that will give this column a default value.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getInputValidator()"><!-- --></A><H3>
getInputValidator</H3>
<PRE>
public java.lang.String <B>getInputValidator</B>()</PRE>
<DL>
<DD>Returns the class name to do input validation
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="isAutoIncrement()"><!-- --></A><H3>
isAutoIncrement</H3>
<PRE>
public boolean <B>isAutoIncrement</B>()</PRE>
<DL>
<DD>Return auto increment/sequence string for the target database. We need to
 pass in the props for the target database!
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="setAutoIncrement(boolean)"><!-- --></A><H3>
setAutoIncrement</H3>
<PRE>
public void <B>setAutoIncrement</B>(boolean&nbsp;value)</PRE>
<DL>
<DD>Set the auto increment value.
 Use isAutoIncrement() to find out if it is set or not.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getAutoIncrementString()"><!-- --></A><H3>
getAutoIncrementString</H3>
<PRE>
public java.lang.String <B>getAutoIncrementString</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="setTypeFromString(java.lang.String, java.lang.String)"><!-- --></A><H3>
setTypeFromString</H3>
<PRE>
public void <B>setTypeFromString</B>(java.lang.String&nbsp;typeName,
                              java.lang.String&nbsp;size)</PRE>
<DL>
<DD>Set the column type from a string property
 (normally a string from an sql input file)
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getJavaObject()"><!-- --></A><H3>
getJavaObject</H3>
<PRE>
public java.lang.String <B>getJavaObject</B>()</PRE>
<DL>
<DD>Return a string representation of the
 Java object which corresponds to the JDBC
 type of this column. Use in the generation
 of MapBuilders.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getJavaPrimitive()"><!-- --></A><H3>
getJavaPrimitive</H3>
<PRE>
public java.lang.String <B>getJavaPrimitive</B>()</PRE>
<DL>
<DD>Return a string representation of the primitive java type which
 corresponds to the JDBC type of this column.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>string representation of the primitive java type</DL>
</DD>
</DL>
<HR>

<A NAME="getJavaNative()"><!-- --></A><H3>
getJavaNative</H3>
<PRE>
public java.lang.String <B>getJavaNative</B>()</PRE>
<DL>
<DD>Return a string representation of the native java type which corresponds
 to the JDBC type of this column. Use in the generation of Base objects.
 This method is used by torque, so it returns Key types for primaryKey and
 foreignKey columns
<P>
<DD><DL>

<DT><B>Returns:</B><DD>java datatype used by torque</DL>
</DD>
</DL>
<HR>

<A NAME="getVillageMethod()"><!-- --></A><H3>
getVillageMethod</H3>
<PRE>
public java.lang.String <B>getVillageMethod</B>()</PRE>
<DL>
<DD>Return Village asX() method which corresponds to the JDBC type
 which represents this column.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getParameterParserMethod()"><!-- --></A><H3>
getParameterParserMethod</H3>
<PRE>
public java.lang.String <B>getParameterParserMethod</B>()</PRE>
<DL>
<DD>Return ParameterParser getX() method which
 corresponds to the JDBC type which represents this column.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="isBooleanInt()"><!-- --></A><H3>
isBooleanInt</H3>
<PRE>
public boolean <B>isBooleanInt</B>()</PRE>
<DL>
<DD>Returns true if the column type is boolean in the
 java object and a numeric (1 or 0) in the db.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="isBooleanChar()"><!-- --></A><H3>
isBooleanChar</H3>
<PRE>
public boolean <B>isBooleanChar</B>()</PRE>
<DL>
<DD>Returns true if the column type is boolean in the
 java object and a String ("Y" or "N") in the db.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="isBit()"><!-- --></A><H3>
isBit</H3>
<PRE>
public boolean <B>isBit</B>()</PRE>
<DL>
<DD>Returns true if the column type is boolean in the
 java object and a Bit ("1" or "0") in the db.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="isPrimitive()"><!-- --></A><H3>
isPrimitive</H3>
<PRE>
public boolean <B>isPrimitive</B>()</PRE>
<DL>
<DD>returns true, if the columns java native type is an
 boolean, byte, short, int, long, float, double, char
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="isUsePrimitive()"><!-- --></A><H3>
isUsePrimitive</H3>
<PRE>
public boolean <B>isUsePrimitive</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getDomain()"><!-- --></A><H3>
getDomain</H3>
<PRE>
public <A HREF="../../../../../../org/apache/torque/engine/database/model/Domain.html" title="class in org.apache.torque.engine.database.model">Domain</A> <B>getDomain</B>()</PRE>
<DL>
<DD><DL>

<DT><B>Returns:</B><DD>Returns the domain.</DL>
</DD>
</DL>
<HR>

<A NAME="setDomain(org.apache.torque.engine.database.model.Domain)"><!-- --></A><H3>
setDomain</H3>
<PRE>
public void <B>setDomain</B>(<A HREF="../../../../../../org/apache/torque/engine/database/model/Domain.html" title="class in org.apache.torque.engine.database.model">Domain</A>&nbsp;domain)</PRE>
<DL>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>domain</CODE> - The domain to set.</DL>
</DD>
</DL>
<HR>

<A NAME="getSqlString()"><!-- --></A><H3>
getSqlString</H3>
<PRE>
public java.lang.String <B>getSqlString</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="isCorrectGetters()"><!-- --></A><H3>
isCorrectGetters</H3>
<PRE>
public boolean <B>isCorrectGetters</B>()</PRE>
<DL>
<DD>Return the correctGetters property of the column
<P>
<DD><DL>

<DT><B>Returns:</B><DD>The currentValue of the correctGetters property.<DT><B>Since:</B></DT>
  <DD>3.2</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="setCorrectGetters(boolean)"><!-- --></A><H3>
setCorrectGetters</H3>
<PRE>
public void <B>setCorrectGetters</B>(boolean&nbsp;correctGetters)</PRE>
<DL>
<DD>Set the correctGetters property of the column. If set to true, the
 column returns is&lt;xxx&gt; as the getter name which is correct for the
 Bean Specs but incompatible to pre-3.2 releases.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>correctGetters</CODE> - The new value of the correctGetters property.<DT><B>Since:</B></DT>
  <DD>3.2</DD>
</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>&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="class-use/Column.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&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-all.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;PREV CLASS&nbsp;
&nbsp;<A HREF="../../../../../../org/apache/torque/engine/database/model/ConstraintNameGenerator.html" title="class in org.apache.torque.engine.database.model"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="Column.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;FIELD&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;FIELD&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>
Copyright &copy; 2000-2005 Apache Software Foundation. All Rights Reserved.
</BODY>
</HTML>




See more files for this project here

iTicket

iTicket is an application for booking specific flights. On a quick-check-in terminal the passenger could easily withdraw the ticket.

Project homepage: http://sourceforge.net/projects/iticket
Programming language(s): Java,JSP,XML
License: lgpl21

  class-use/
    Column.html
    ConstraintNameGenerator.html
    Database.html
    Domain.html
    ForeignKey.html
    IDMethod.html
    IdMethodParameter.html
    Index.html
    Inheritance.html
    JavaNameGenerator.html
    NameFactory.html
    NameGenerator.html
    SchemaType.html
    Table.html
    TypeMap.html
    Unique.html
  Column.html
  ConstraintNameGenerator.html
  Database.html
  Domain.html
  ForeignKey.html
  IDMethod.html
  IdMethodParameter.html
  Index.html
  Inheritance.html
  JavaNameGenerator.html
  NameFactory.html
  NameGenerator.html
  SchemaType.html
  Table.html
  TypeMap.html
  Unique.html
  package-frame.html
  package-summary.html
  package-tree.html
  package-use.html