Project

General

Profile

Revision 107

updated javadoc documentation

View differences:

DBReader.html
2 2
<!--NewPage-->
3 3
<HTML>
4 4
<HEAD>
5
<!-- Generated by javadoc on Tue Apr 18 13:19:07 AKDT 2000 -->
5
<!-- Generated by javadoc on Sat May 20 14:25:41 AKDT 2000 -->
6 6
<TITLE>
7 7
: Class  DBReader
8 8
</TITLE>
......
34 34

  
35 35
<TR>
36 36
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
37
&nbsp;<A HREF="../../../../edu/ucsb/nceas/metacat/BasicElement.html"><B>PREV CLASS</B></A>&nbsp;
38
&nbsp;<A HREF="../../../../edu/ucsb/nceas/metacat/DBSAXElement.html"><B>NEXT CLASS</B></A></FONT></TD>
37
&nbsp;<A HREF="../../../../edu/ucsb/nceas/metacat/DBEntityResolver.html"><B>PREV CLASS</B></A>&nbsp;
38
&nbsp;<A HREF="../../../../edu/ucsb/nceas/metacat/DBReader.DoctypeInfo.html"><B>NEXT CLASS</B></A></FONT></TD>
39 39
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
40 40
  <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
41 41
&nbsp;<A HREF="DBReader.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
42 42
</TR>
43 43
<TR>
44 44
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
45
  SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
45
  SUMMARY: &nbsp;<A HREF="#inner_class_summary">INNER</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
46 46
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
47 47
DETAIL: &nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
48 48
</TR>
......
74 74
<P>
75 75
<!-- ======== INNER CLASS SUMMARY ======== -->
76 76

  
77
<A NAME="inner_class_summary"><!-- --></A>
78
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
79
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
80
<TD COLSPAN=2><FONT SIZE="+2">
81
<B>Inner Class Summary</B></FONT></TD>
82
</TR>
83
<TR BGCOLOR="white" CLASS="TableRowColor">
84
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
85
<CODE>&nbsp;class</CODE></FONT></TD>
86
<TD><CODE><B><A HREF="../../../../edu/ucsb/nceas/metacat/DBReader.DoctypeInfo.html">DBReader.DoctypeInfo</A></B></CODE>
77 87

  
88
<BR>
89
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A utility class that encapsulates document type information</TD>
90
</TR>
91
</TABLE>
92
&nbsp;
78 93
<!-- =========== FIELD SUMMARY =========== -->
79 94

  
80 95

  
......
104 119
</TR>
105 120
<TR BGCOLOR="white" CLASS="TableRowColor">
106 121
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
122
<CODE>&nbsp;<A HREF="../../../../edu/ucsb/nceas/metacat/DBReader.DoctypeInfo.html">DBReader.DoctypeInfo</A></CODE></FONT></TD>
123
<TD><CODE><B><A HREF="../../../../edu/ucsb/nceas/metacat/DBReader.html#getDoctypeInfo(long)">getDoctypeInfo</A></B>(long&nbsp;docid)</CODE>
124

  
125
<BR>
126
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Look up the document type information from the database</TD>
127
</TR>
128
<TR BGCOLOR="white" CLASS="TableRowColor">
129
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
130
<CODE>&nbsp;long</CODE></FONT></TD>
131
<TD><CODE><B><A HREF="../../../../edu/ucsb/nceas/metacat/DBReader.html#getRootNode(long)">getRootNode</A></B>(long&nbsp;docid)</CODE>
132

  
133
<BR>
134
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the root node id for an XML document given a document id</TD>
135
</TR>
136
<TR BGCOLOR="white" CLASS="TableRowColor">
137
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
107 138
<CODE>static&nbsp;void</CODE></FONT></TD>
108 139
<TD><CODE><B><A HREF="../../../../edu/ucsb/nceas/metacat/DBReader.html#main(java.lang.String[])">main</A></B>(java.lang.String[]&nbsp;args)</CODE>
109 140

  
......
113 144
<TR BGCOLOR="white" CLASS="TableRowColor">
114 145
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
115 146
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
116
<TD><CODE><B><A HREF="../../../../edu/ucsb/nceas/metacat/DBReader.html#readXMLDocument(long)">readXMLDocument</A></B>(long&nbsp;nodeid)</CODE>
147
<TD><CODE><B><A HREF="../../../../edu/ucsb/nceas/metacat/DBReader.html#readXMLDocument(long)">readXMLDocument</A></B>(long&nbsp;docid)</CODE>
117 148

  
118 149
<BR>
119 150
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create an XML document from the database starting with the element 
......
193 224
</DL>
194 225
<HR>
195 226

  
227
<A NAME="getRootNode(long)"><!-- --></A><H3>
228
getRootNode</H3>
229
<PRE>
230
public long <B>getRootNode</B>(long&nbsp;docid)</PRE>
231
<DL>
232
<DD>Get the root node id for an XML document given a document id<DD><DL>
233
<DT><B>Parameters:</B><DD><CODE>docid</CODE> - the document node contains the root of the document</DL>
234
</DD>
235
</DL>
236
<HR>
237

  
196 238
<A NAME="readXMLDocument(long)"><!-- --></A><H3>
197 239
readXMLDocument</H3>
198 240
<PRE>
199
public java.lang.String <B>readXMLDocument</B>(long&nbsp;nodeid)</PRE>
241
public java.lang.String <B>readXMLDocument</B>(long&nbsp;docid)</PRE>
200 242
<DL>
201 243
<DD>Create an XML document from the database starting with the element 
202 244
 having element_id nodeid<DD><DL>
203
<DT><B>Parameters:</B><DD><CODE>nodeid</CODE> - the node that will represent the root of the document</DL>
245
<DT><B>Parameters:</B><DD><CODE>docid</CODE> - the document that we want retrieved</DL>
204 246
</DD>
205 247
</DL>
248
<HR>
249

  
250
<A NAME="getDoctypeInfo(long)"><!-- --></A><H3>
251
getDoctypeInfo</H3>
252
<PRE>
253
public <A HREF="../../../../edu/ucsb/nceas/metacat/DBReader.DoctypeInfo.html">DBReader.DoctypeInfo</A> <B>getDoctypeInfo</B>(long&nbsp;docid)</PRE>
254
<DL>
255
<DD>Look up the document type information from the database<DD><DL>
256
<DT><B>Parameters:</B><DD><CODE>docid</CODE> - the id of the document to look up</DL>
257
</DD>
258
</DL>
206 259
<!-- ========= END OF CLASS DATA ========= -->
207 260
<HR>
208 261

  
......
230 283

  
231 284
<TR>
232 285
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
233
&nbsp;<A HREF="../../../../edu/ucsb/nceas/metacat/BasicElement.html"><B>PREV CLASS</B></A>&nbsp;
234
&nbsp;<A HREF="../../../../edu/ucsb/nceas/metacat/DBSAXElement.html"><B>NEXT CLASS</B></A></FONT></TD>
286
&nbsp;<A HREF="../../../../edu/ucsb/nceas/metacat/DBEntityResolver.html"><B>PREV CLASS</B></A>&nbsp;
287
&nbsp;<A HREF="../../../../edu/ucsb/nceas/metacat/DBReader.DoctypeInfo.html"><B>NEXT CLASS</B></A></FONT></TD>
235 288
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
236 289
  <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
237 290
&nbsp;<A HREF="DBReader.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
238 291
</TR>
239 292
<TR>
240 293
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
241
  SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
294
  SUMMARY: &nbsp;<A HREF="#inner_class_summary">INNER</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
242 295
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
243 296
DETAIL: &nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
244 297
</TR>

Also available in: Unified diff