| <!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 Fri May 21 07:02:01 BST 2010 --> |
| <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> |
| <TITLE> |
| Column (JDO API 3.0) |
| </TITLE> |
| |
| <META NAME="date" CONTENT="2010-05-21"> |
| |
| <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 (JDO API 3.0)"; |
| } |
| } |
| </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="class-use/Column.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="../../../javax/jdo/annotations/Cacheable.html" title="annotation in javax.jdo.annotations"><B>PREV CLASS</B></A> |
| <A HREF="../../../javax/jdo/annotations/Columns.html" title="annotation in javax.jdo.annotations"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../index.html?javax/jdo/annotations/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: REQUIRED | <A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| javax.jdo.annotations</FONT> |
| <BR> |
| Annotation Type Column</H2> |
| <HR> |
| <DL> |
| <DT><PRE><FONT SIZE="-1">@Target(value={FIELD,METHOD}) |
| @Retention(value=RUNTIME) |
| </FONT>public @interface <B>Column</B></DL> |
| </PRE> |
| |
| <P> |
| Annotation for a column in the database. |
| Corresponds to the xml element "column". |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>2.1</DD> |
| <DT><B>Version:</B></DT> |
| <DD>2.1</DD> |
| </DL> |
| <HR> |
| |
| <P> |
| <!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> |
| |
| <A NAME="annotation_type_optional_element_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>Optional Element Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/jdo/annotations/Column.html#allowsNull()">allowsNull</A></B></CODE> |
| |
| <BR> |
| Whether the column allows null values to be inserted.</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="../../../javax/jdo/annotations/Column.html#defaultValue()">defaultValue</A></B></CODE> |
| |
| <BR> |
| Default value for this column.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../javax/jdo/annotations/Extension.html" title="annotation in javax.jdo.annotations">Extension</A>[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/jdo/annotations/Column.html#extensions()">extensions</A></B></CODE> |
| |
| <BR> |
| Vendor extensions.</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="../../../javax/jdo/annotations/Column.html#insertValue()">insertValue</A></B></CODE> |
| |
| <BR> |
| Value to be inserted when this is an "unmapped" column</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="../../../javax/jdo/annotations/Column.html#jdbcType()">jdbcType</A></B></CODE> |
| |
| <BR> |
| JDBC Type for this column.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/jdo/annotations/Column.html#length()">length</A></B></CODE> |
| |
| <BR> |
| Maximum length of data stored in this column.</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="../../../javax/jdo/annotations/Column.html#name()">name</A></B></CODE> |
| |
| <BR> |
| Name of the column.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../javax/jdo/annotations/Column.html#scale()">scale</A></B></CODE> |
| |
| <BR> |
| Scale for the column when handling floating point values.</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="../../../javax/jdo/annotations/Column.html#sqlType()">sqlType</A></B></CODE> |
| |
| <BR> |
| SQL Type for this column.</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="../../../javax/jdo/annotations/Column.html#target()">target</A></B></CODE> |
| |
| <BR> |
| Target column for this column in the other table when part of a |
| foreign key relation.</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="../../../javax/jdo/annotations/Column.html#targetMember()">targetMember</A></B></CODE> |
| |
| <BR> |
| Target member in the other class or interface for this column |
| when part of a bidirectional relation.</TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| <A NAME="name()"><!-- --></A><H3> |
| name</H3> |
| <PRE> |
| public abstract java.lang.String <B>name</B></PRE> |
| <DL> |
| <DD>Name of the column. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the name of the column</DL> |
| <DL> |
| <DT><B>Default:</B><DD>""</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="target()"><!-- --></A><H3> |
| target</H3> |
| <PRE> |
| public abstract java.lang.String <B>target</B></PRE> |
| <DL> |
| <DD>Target column for this column in the other table when part of a |
| foreign key relation. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the target column in the other table for this column |
| when part of a foreign key relation.</DL> |
| <DL> |
| <DT><B>Default:</B><DD>""</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="targetMember()"><!-- --></A><H3> |
| targetMember</H3> |
| <PRE> |
| public abstract java.lang.String <B>targetMember</B></PRE> |
| <DL> |
| <DD>Target member in the other class or interface for this column |
| when part of a bidirectional relation. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the target member for this column when part of |
| a bidirectional relation.</DL> |
| <DL> |
| <DT><B>Default:</B><DD>""</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="jdbcType()"><!-- --></A><H3> |
| jdbcType</H3> |
| <PRE> |
| public abstract java.lang.String <B>jdbcType</B></PRE> |
| <DL> |
| <DD>JDBC Type for this column. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>JDBC type for this column</DL> |
| <DL> |
| <DT><B>Default:</B><DD>""</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="sqlType()"><!-- --></A><H3> |
| sqlType</H3> |
| <PRE> |
| public abstract java.lang.String <B>sqlType</B></PRE> |
| <DL> |
| <DD>SQL Type for this column. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>SQL type for this column</DL> |
| <DL> |
| <DT><B>Default:</B><DD>""</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="length()"><!-- --></A><H3> |
| length</H3> |
| <PRE> |
| public abstract int <B>length</B></PRE> |
| <DL> |
| <DD>Maximum length of data stored in this column. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the maximum length of data stored in this column</DL> |
| <DL> |
| <DT><B>Default:</B><DD>-1</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="scale()"><!-- --></A><H3> |
| scale</H3> |
| <PRE> |
| public abstract int <B>scale</B></PRE> |
| <DL> |
| <DD>Scale for the column when handling floating point values. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the scale for the column when handling floating point values</DL> |
| <DL> |
| <DT><B>Default:</B><DD>-1</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="allowsNull()"><!-- --></A><H3> |
| allowsNull</H3> |
| <PRE> |
| public abstract java.lang.String <B>allowsNull</B></PRE> |
| <DL> |
| <DD>Whether the column allows null values to be inserted. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>whether the column allows null values to be inserted</DL> |
| <DL> |
| <DT><B>Default:</B><DD>""</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="defaultValue()"><!-- --></A><H3> |
| defaultValue</H3> |
| <PRE> |
| public abstract java.lang.String <B>defaultValue</B></PRE> |
| <DL> |
| <DD>Default value for this column. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the default value for this column</DL> |
| <DL> |
| <DT><B>Default:</B><DD>""</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="insertValue()"><!-- --></A><H3> |
| insertValue</H3> |
| <PRE> |
| public abstract java.lang.String <B>insertValue</B></PRE> |
| <DL> |
| <DD>Value to be inserted when this is an "unmapped" column |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the value to be inserted when this is an "unmapped" column</DL> |
| <DL> |
| <DT><B>Default:</B><DD>""</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="extensions()"><!-- --></A><H3> |
| extensions</H3> |
| <PRE> |
| public abstract <A HREF="../../../javax/jdo/annotations/Extension.html" title="annotation in javax.jdo.annotations">Extension</A>[] <B>extensions</B></PRE> |
| <DL> |
| <DD>Vendor extensions. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the vendor extensions</DL> |
| <DL> |
| <DT><B>Default:</B><DD>{}</DD> |
| </DL> |
| </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="class-use/Column.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="../../../javax/jdo/annotations/Cacheable.html" title="annotation in javax.jdo.annotations"><B>PREV CLASS</B></A> |
| <A HREF="../../../javax/jdo/annotations/Columns.html" title="annotation in javax.jdo.annotations"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../index.html?javax/jdo/annotations/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: REQUIRED | <A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| Copyright © 2005-2010 Apache Software Foundation. All Rights Reserved. |
| </BODY> |
| </HTML> |