Revision 515
Added by Matt Jones over 23 years ago
| AccessionNumber.html | ||
|---|---|---|
| 2 | 2 |
<!--NewPage--> |
| 3 | 3 |
<HTML> |
| 4 | 4 |
<HEAD> |
| 5 |
<!-- Generated by javadoc on Mon Jun 26 20:52:06 AKDT 2000 -->
|
|
| 5 |
<!-- Generated by javadoc on Tue Nov 07 20:14:05 PST 2000 -->
|
|
| 6 | 6 |
<TITLE> |
| 7 | 7 |
MetaCat API: Class AccessionNumber |
| 8 | 8 |
</TITLE> |
| ... | ... | |
| 18 | 18 |
<A NAME="navbar_top_firstrow"><!-- --></A> |
| 19 | 19 |
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> |
| 20 | 20 |
<TR ALIGN="center" VALIGN="top"> |
| 21 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT ID="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
|
| 21 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
|
| 22 | 22 |
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| 23 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/AccessionNumber.html"><FONT ID="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
|
| 24 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|
| 25 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT ID="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
|
| 26 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
| 27 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT ID="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
| 23 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/AccessionNumber.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
|
| 24 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|
| 25 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
|
| 26 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
| 27 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
| 28 | 28 |
</TR> |
| 29 | 29 |
</TABLE> |
| 30 | 30 |
</TD> |
| ... | ... | |
| 36 | 36 |
<TR> |
| 37 | 37 |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| 38 | 38 |
PREV CLASS |
| 39 |
<A HREF="../../../../edu/ucsb/nceas/metacat/BasicNode.html"><B>NEXT CLASS</B></A></FONT></TD>
|
|
| 39 |
<A HREF="../../../../edu/ucsb/nceas/metacat/AuthLdap.html"><B>NEXT CLASS</B></A></FONT></TD>
|
|
| 40 | 40 |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| 41 | 41 |
<A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A> |
| 42 | 42 |
<A HREF="AccessionNumber.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD> |
| ... | ... | |
| 67 | 67 |
<DT>public class <B>AccessionNumber</B><DT>extends java.lang.Object</DL> |
| 68 | 68 |
|
| 69 | 69 |
<P> |
| 70 |
A class that generates an Accession Number and will check a submitted |
|
| 71 |
accession number for uniqueness and register it into the db connection |
|
| 70 |
(on insert of XML document) |
|
| 71 |
Generates a unique Accession Number or if provided check it |
|
| 72 |
for uniqueness and register it into the db connection |
|
| 73 |
(on update or delete of XML document) |
|
| 74 |
Check for existance of provided Accession Number |
|
| 72 | 75 |
<P> |
| 73 | 76 |
<HR> |
| 74 | 77 |
|
| ... | ... | |
| 91 | 94 |
<TD><CODE><B><A HREF="../../../../edu/ucsb/nceas/metacat/AccessionNumber.html#AccessionNumber()">AccessionNumber</A></B>()</CODE> |
| 92 | 95 |
|
| 93 | 96 |
<BR> |
| 94 |
</TD>
|
|
| 97 |
Construct an AccessionNumber</TD>
|
|
| 95 | 98 |
</TR> |
| 99 |
<TR BGCOLOR="white" CLASS="TableRowColor"> |
|
| 100 |
<TD><CODE><B><A HREF="../../../../edu/ucsb/nceas/metacat/AccessionNumber.html#AccessionNumber(java.sql.Connection)">AccessionNumber</A></B>(java.sql.Connection conn)</CODE> |
|
| 101 |
|
|
| 102 |
<BR> |
|
| 103 |
Construct an AccessionNumber</TD> |
|
| 104 |
</TR> |
|
| 96 | 105 |
</TABLE> |
| 97 | 106 |
|
| 98 | 107 |
<!-- ========== METHOD SUMMARY =========== --> |
| ... | ... | |
| 105 | 114 |
</TR> |
| 106 | 115 |
<TR BGCOLOR="white" CLASS="TableRowColor"> |
| 107 | 116 |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| 108 |
<CODE>static java.lang.String</CODE></FONT></TD>
|
|
| 117 |
<CODE> java.lang.String</CODE></FONT></TD> |
|
| 109 | 118 |
<TD><CODE><B><A HREF="../../../../edu/ucsb/nceas/metacat/AccessionNumber.html#generate(java.lang.String, java.lang.String)">generate</A></B>(java.lang.String accNumber, |
| 110 | 119 |
java.lang.String action)</CODE> |
| 111 | 120 |
|
| 112 | 121 |
<BR> |
| 113 |
Get an accession number from the user, check it for uniqueness
|
|
| 114 |
and register it into new db connection.</TD>
|
|
| 122 |
Get an Accession Number, check it for uniqueness and
|
|
| 123 |
register it into db connection.</TD>
|
|
| 115 | 124 |
</TR> |
| 116 | 125 |
</TABLE> |
| 117 | 126 |
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| ... | ... | |
| 120 | 129 |
<TD><B>Methods inherited from class java.lang.Object</B></TD> |
| 121 | 130 |
</TR> |
| 122 | 131 |
<TR BGCOLOR="white" CLASS="TableRowColor"> |
| 123 |
<TD><CODE>clone, |
|
| 124 |
equals, |
|
| 125 |
finalize, |
|
| 126 |
getClass, |
|
| 127 |
hashCode, |
|
| 128 |
notify, |
|
| 129 |
notifyAll, |
|
| 130 |
toString, |
|
| 131 |
wait, |
|
| 132 |
wait, |
|
| 133 |
wait</CODE></TD> |
|
| 132 |
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> |
|
| 134 | 133 |
</TR> |
| 135 | 134 |
</TABLE> |
| 136 | 135 |
|
| ... | ... | |
| 152 | 151 |
<A NAME="AccessionNumber()"><!-- --></A><H3> |
| 153 | 152 |
AccessionNumber</H3> |
| 154 | 153 |
<PRE> |
| 155 |
public <B>AccessionNumber</B>()</PRE> |
|
| 154 |
public <B>AccessionNumber</B>() |
|
| 155 |
throws java.sql.SQLException, |
|
| 156 |
java.lang.ClassNotFoundException</PRE> |
|
| 156 | 157 |
<DL> |
| 158 |
<DD>Construct an AccessionNumber</DL> |
|
| 159 |
<HR> |
|
| 160 |
|
|
| 161 |
<A NAME="AccessionNumber(java.sql.Connection)"><!-- --></A><H3> |
|
| 162 |
AccessionNumber</H3> |
|
| 163 |
<PRE> |
|
| 164 |
public <B>AccessionNumber</B>(java.sql.Connection conn)</PRE> |
|
| 165 |
<DL> |
|
| 166 |
<DD>Construct an AccessionNumber<DD><DL> |
|
| 167 |
<DT><B>Parameters:</B><DD><CODE>conn</CODE> - the db connection to read from and write Accession# to</DL> |
|
| 168 |
</DD> |
|
| 157 | 169 |
</DL> |
| 158 | 170 |
|
| 159 | 171 |
<!-- ============ METHOD DETAIL ========== --> |
| ... | ... | |
| 169 | 181 |
<A NAME="generate(java.lang.String, java.lang.String)"><!-- --></A><H3> |
| 170 | 182 |
generate</H3> |
| 171 | 183 |
<PRE> |
| 172 |
public static java.lang.String <B>generate</B>(java.lang.String accNumber, |
|
| 173 |
java.lang.String action) |
|
| 174 |
throws <A HREF="../../../../edu/ucsb/nceas/metacat/AccessionNumberException.html">AccessionNumberException</A>, |
|
| 175 |
java.sql.SQLException, |
|
| 176 |
java.lang.ClassNotFoundException</PRE> |
|
| 184 |
public java.lang.String <B>generate</B>(java.lang.String accNumber, |
|
| 185 |
java.lang.String action) |
|
| 186 |
throws <A HREF="../../../../edu/ucsb/nceas/metacat/AccessionNumberException.html">AccessionNumberException</A>, |
|
| 187 |
java.sql.SQLException</PRE> |
|
| 177 | 188 |
<DL> |
| 178 |
<DD>Get an accession number from the user, check it for uniqueness
|
|
| 179 |
and register it into new db connection. If no accession number is
|
|
| 180 |
provided by the user, generate one from the database and return it.<DD><DL>
|
|
| 181 |
<DT><B>Parameters:</B><DD><CODE>accNumber</CODE> - - accession # if provided or null if not<DD><CODE>action</CODE> - - INSERT, UPDATE or DELETE.
|
|
| 182 |
When "INSERT" and accession # provided is not unique, get next one.
|
|
| 189 |
<DD>Get an Accession Number, check it for uniqueness and
|
|
| 190 |
register it into db connection. If no Accession Number is
|
|
| 191 |
provided, generate one from the database and return it.<DD><DL> |
|
| 192 |
<DT><B>Parameters:</B><DD><CODE>accNumber</CODE> - - Accession # if provided or null if not<DD><CODE>action</CODE> - - INSERT, UPDATE or DELETE.
|
|
| 193 |
When "INSERT" and accession # provided is not unique, get new one.
|
|
| 183 | 194 |
If it is unique, use it. |
| 184 | 195 |
When "INSERT" and accession # is null, get a new one. |
| 185 |
When "UPDATE", accession # is required.
|
|
| 186 |
When "DELETE", accession # is required.</DL> |
|
| 196 |
When "UPDATE", accession # is required and it is checked for existance.
|
|
| 197 |
When "DELETE", accession # is required and it is checked for existance.</DL>
|
|
| 187 | 198 |
</DD> |
| 188 | 199 |
</DL> |
| 189 | 200 |
<!-- ========= END OF CLASS DATA ========= --> |
| ... | ... | |
| 197 | 208 |
<A NAME="navbar_bottom_firstrow"><!-- --></A> |
| 198 | 209 |
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> |
| 199 | 210 |
<TR ALIGN="center" VALIGN="top"> |
| 200 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT ID="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
|
| 211 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
|
| 201 | 212 |
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| 202 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/AccessionNumber.html"><FONT ID="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
|
| 203 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|
| 204 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT ID="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
|
| 205 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
| 206 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT ID="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
| 213 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/AccessionNumber.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
|
| 214 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|
| 215 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
|
| 216 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
| 217 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
| 207 | 218 |
</TR> |
| 208 | 219 |
</TABLE> |
| 209 | 220 |
</TD> |
| ... | ... | |
| 215 | 226 |
<TR> |
| 216 | 227 |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| 217 | 228 |
PREV CLASS |
| 218 |
<A HREF="../../../../edu/ucsb/nceas/metacat/BasicNode.html"><B>NEXT CLASS</B></A></FONT></TD>
|
|
| 229 |
<A HREF="../../../../edu/ucsb/nceas/metacat/AuthLdap.html"><B>NEXT CLASS</B></A></FONT></TD>
|
|
| 219 | 230 |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| 220 | 231 |
<A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A> |
| 221 | 232 |
<A HREF="AccessionNumber.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD> |
Also available in: Unified diff
Updated the Javadoc documentation so that the current release can be provided
on the web site.