<!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.6.0_18) on Sat Dec 04 05:26:45 UTC 2010 --> <TITLE> Column </TITLE> <META NAME="date" CONTENT="2010-12-04"> <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> <SCRIPT type="text/javascript"> function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { parent.document.title="Column"; } } </SCRIPT> <NOSCRIPT> </NOSCRIPT> </HEAD> <BODY BGCOLOR="white" onload="windowTitle();"> <HR> <!-- ========= 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-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/ws/jaxme/sqls/Case.When.html" title="interface in org.apache.ws.jaxme.sqls"><B>PREV CLASS</B></A> <A HREF="../../../../../org/apache/ws/jaxme/sqls/Column.Name.html" title="interface in org.apache.ws.jaxme.sqls"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../../index.html?org/apache/ws/jaxme/sqls/Column.html" target="_top"><B>FRAMES</B></A> <A HREF="Column.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: <A HREF="#nested_class_summary">NESTED</A> | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | 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.ws.jaxme.sqls</FONT> <BR> Interface Column</H2> <DL> <DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../../../org/apache/ws/jaxme/sqls/BinaryColumn.html" title="interface in org.apache.ws.jaxme.sqls">BinaryColumn</A>, <A HREF="../../../../../org/apache/ws/jaxme/sqls/db2/DB2Column.html" title="interface in org.apache.ws.jaxme.sqls.db2">DB2Column</A>, <A HREF="../../../../../org/apache/ws/jaxme/sqls/hsqldb/HsqlDbColumn.html" title="interface in org.apache.ws.jaxme.sqls.hsqldb">HsqlDbColumn</A>, <A HREF="../../../../../org/apache/ws/jaxme/sqls/StringColumn.html" title="interface in org.apache.ws.jaxme.sqls">StringColumn</A></DD> </DL> <DL> <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../org/apache/ws/jaxme/sqls/impl/AbstractColumn.html" title="class in org.apache.ws.jaxme.sqls.impl">AbstractColumn</A>, <A HREF="../../../../../org/apache/ws/jaxme/sqls/impl/ColumnImpl.html" title="class in org.apache.ws.jaxme.sqls.impl">ColumnImpl</A>, <A HREF="../../../../../org/apache/ws/jaxme/sqls/db2/DB2ColumnImpl.html" title="class in org.apache.ws.jaxme.sqls.db2">DB2ColumnImpl</A>, <A HREF="../../../../../org/apache/ws/jaxme/sqls/hsqldb/HsqlDbColumnImpl.html" title="class in org.apache.ws.jaxme.sqls.hsqldb">HsqlDbColumnImpl</A>, <A HREF="../../../../../org/apache/ws/jaxme/sqls/impl/VirtualColumn.html" title="class in org.apache.ws.jaxme.sqls.impl">VirtualColumn</A></DD> </DL> <HR> <DL> <DT><PRE>public interface <B>Column</B></DL> </PRE> <P> <DL> <DT><B>Author:</B></DT> <DD><a href="mailto:joe@ispsoft.de">Jochen Wiedmann</a></DD> </DL> <HR> <P> <!-- ======== NESTED CLASS SUMMARY ======== --> <A NAME="nested_class_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>Nested Class Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static interface</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../org/apache/ws/jaxme/sqls/Column.Name.html" title="interface in org.apache.ws.jaxme.sqls">Column.Name</A></B></CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static interface</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../org/apache/ws/jaxme/sqls/Column.Type.html" title="interface in org.apache.ws.jaxme.sqls">Column.Type</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.Object</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../org/apache/ws/jaxme/sqls/Column.html#getCustomData()">getCustomData</A></B>()</CODE> <BR> Allows the user to retrieve application specific data, which has previously been attached to the column.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../../org/apache/ws/jaxme/sqls/Column.Name.html" title="interface in org.apache.ws.jaxme.sqls">Column.Name</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../org/apache/ws/jaxme/sqls/Column.html#getName()">getName</A></B>()</CODE> <BR> Returns the columns 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/ws/jaxme/sqls/Column.html#getQName()">getQName</A></B>()</CODE> <BR> Returns the columns fully qualified name, which is <code>getTable().getQName() + "." + getName()</code>.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../../org/apache/ws/jaxme/sqls/Table.html" title="interface in org.apache.ws.jaxme.sqls">Table</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../org/apache/ws/jaxme/sqls/Column.html#getTable()">getTable</A></B>()</CODE> <BR> Returns the columns table.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../../org/apache/ws/jaxme/sqls/Column.Type.html" title="interface in org.apache.ws.jaxme.sqls">Column.Type</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../org/apache/ws/jaxme/sqls/Column.html#getType()">getType</A></B>()</CODE> <BR> Returns the columns type.</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/ws/jaxme/sqls/Column.html#isBinaryColumn()">isBinaryColumn</A></B>()</CODE> <BR> Returns whether this Column may be casted to a <A HREF="../../../../../org/apache/ws/jaxme/sqls/BinaryColumn.html" title="interface in org.apache.ws.jaxme.sqls"><CODE>BinaryColumn</CODE></A>.</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/ws/jaxme/sqls/Column.html#isNullable()">isNullable</A></B>()</CODE> <BR> Returns whether the column is nullable.</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/ws/jaxme/sqls/Column.html#isPrimaryKeyPart()">isPrimaryKeyPart</A></B>()</CODE> <BR> Returns whether this column is part of the primary key.</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/ws/jaxme/sqls/Column.html#isStringColumn()">isStringColumn</A></B>()</CODE> <BR> Returns whether this Column may be casted to a <A HREF="../../../../../org/apache/ws/jaxme/sqls/StringColumn.html" title="interface in org.apache.ws.jaxme.sqls"><CODE>StringColumn</CODE></A>.</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/ws/jaxme/sqls/Column.html#isVirtual()">isVirtual</A></B>()</CODE> <BR> Returns whether this column is a true column or a virtual column.</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/ws/jaxme/sqls/Column.html#setCustomData(java.lang.Object)">setCustomData</A></B>(java.lang.Object pData)</CODE> <BR> Allows the user to attach application specific data to the column.</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/ws/jaxme/sqls/Column.html#setNullable(boolean)">setNullable</A></B>(boolean pNullable)</CODE> <BR> Sets whether the column is nullable.</TD> </TR> </TABLE> <P> <!-- ============ 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="getTable()"><!-- --></A><H3> getTable</H3> <PRE> <A HREF="../../../../../org/apache/ws/jaxme/sqls/Table.html" title="interface in org.apache.ws.jaxme.sqls">Table</A> <B>getTable</B>()</PRE> <DL> <DD><p>Returns the columns table.</p> <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="getName()"><!-- --></A><H3> getName</H3> <PRE> <A HREF="../../../../../org/apache/ws/jaxme/sqls/Column.Name.html" title="interface in org.apache.ws.jaxme.sqls">Column.Name</A> <B>getName</B>()</PRE> <DL> <DD><p>Returns the columns name.</p> <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="getQName()"><!-- --></A><H3> getQName</H3> <PRE> java.lang.String <B>getQName</B>()</PRE> <DL> <DD><p>Returns the columns fully qualified name, which is <code>getTable().getQName() + "." + getName()</code>.</p> <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="getType()"><!-- --></A><H3> getType</H3> <PRE> <A HREF="../../../../../org/apache/ws/jaxme/sqls/Column.Type.html" title="interface in org.apache.ws.jaxme.sqls">Column.Type</A> <B>getType</B>()</PRE> <DL> <DD><p>Returns the columns type.</p> <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="isPrimaryKeyPart()"><!-- --></A><H3> isPrimaryKeyPart</H3> <PRE> boolean <B>isPrimaryKeyPart</B>()</PRE> <DL> <DD><p>Returns whether this column is part of the primary key.</p> <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="setNullable(boolean)"><!-- --></A><H3> setNullable</H3> <PRE> void <B>setNullable</B>(boolean pNullable)</PRE> <DL> <DD><p>Sets whether the column is nullable. By default columns are not nullable.</p> <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="isNullable()"><!-- --></A><H3> isNullable</H3> <PRE> boolean <B>isNullable</B>()</PRE> <DL> <DD><p>Returns whether the column is nullable. By default columns are not nullable.</p> <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="isStringColumn()"><!-- --></A><H3> isStringColumn</H3> <PRE> boolean <B>isStringColumn</B>()</PRE> <DL> <DD><p>Returns whether this Column may be casted to a <A HREF="../../../../../org/apache/ws/jaxme/sqls/StringColumn.html" title="interface in org.apache.ws.jaxme.sqls"><CODE>StringColumn</CODE></A>.</p> <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="isBinaryColumn()"><!-- --></A><H3> isBinaryColumn</H3> <PRE> boolean <B>isBinaryColumn</B>()</PRE> <DL> <DD><p>Returns whether this Column may be casted to a <A HREF="../../../../../org/apache/ws/jaxme/sqls/BinaryColumn.html" title="interface in org.apache.ws.jaxme.sqls"><CODE>BinaryColumn</CODE></A>.</p> <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="setCustomData(java.lang.Object)"><!-- --></A><H3> setCustomData</H3> <PRE> void <B>setCustomData</B>(java.lang.Object pData)</PRE> <DL> <DD><p>Allows the user to attach application specific data to the column.</p> <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="getCustomData()"><!-- --></A><H3> getCustomData</H3> <PRE> java.lang.Object <B>getCustomData</B>()</PRE> <DL> <DD><p>Allows the user to retrieve application specific data, which has previously been attached to the column.</p> <P> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="isVirtual()"><!-- --></A><H3> isVirtual</H3> <PRE> boolean <B>isVirtual</B>()</PRE> <DL> <DD><p>Returns whether this column is a true column or a virtual column.</p> <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-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/ws/jaxme/sqls/Case.When.html" title="interface in org.apache.ws.jaxme.sqls"><B>PREV CLASS</B></A> <A HREF="../../../../../org/apache/ws/jaxme/sqls/Column.Name.html" title="interface in org.apache.ws.jaxme.sqls"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../../index.html?org/apache/ws/jaxme/sqls/Column.html" target="_top"><B>FRAMES</B></A> <A HREF="Column.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: <A HREF="#nested_class_summary">NESTED</A> | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_bottom"></A> <!-- ======== END OF BOTTOM NAVBAR ======= --> <HR> </BODY> </HTML>