Project

General

Profile

Revision 138

updated javadoc documentation

View differences:

DBSAXDocument.html
2 2
<!--NewPage-->
3 3
<HTML>
4 4
<HEAD>
5
<!-- Generated by javadoc on Sat May 20 14:25:41 AKDT 2000 -->
5
<!-- Generated by javadoc on Wed Jun 07 16:35:58 AKDT 2000 -->
6 6
<TITLE>
7
: Class  DBSAXDocument
7
MetaCat API: Class  DBSAXDocument
8 8
</TITLE>
9 9
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
10 10
</HEAD>
......
20 20
  <TR ALIGN="center" VALIGN="top">
21 21
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT ID="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
22 22
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
23
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/DBSAXDocument.html"><FONT ID="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
23 24
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
24 25
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT ID="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
25 26
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
......
35 36
<TR>
36 37
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
37 38
&nbsp;<A HREF="../../../../edu/ucsb/nceas/metacat/DBReader.DoctypeInfo.html"><B>PREV CLASS</B></A>&nbsp;
38
&nbsp;<A HREF="../../../../edu/ucsb/nceas/metacat/DBSAXElement.html"><B>NEXT CLASS</B></A></FONT></TD>
39
&nbsp;<A HREF="../../../../edu/ucsb/nceas/metacat/DBSAXHandler.html"><B>NEXT CLASS</B></A></FONT></TD>
39 40
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
40 41
  <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
41 42
&nbsp;<A HREF="DBSAXDocument.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
42 43
</TR>
43 44
<TR>
44 45
<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>
46
  SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#methods_inherited_from_class_java.lang.Object">METHOD</A></FONT></TD>
46 47
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
47
DETAIL: &nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
48
DETAIL: &nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;METHOD</FONT></TD>
48 49
</TR>
49 50
</TABLE>
50 51
<!-- =========== END OF NAVBAR =========== -->
......
98 99
&nbsp;
99 100
<!-- ========== METHOD SUMMARY =========== -->
100 101

  
101
<A NAME="method_summary"><!-- --></A>
102
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
102 103
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
103
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
104
<TD COLSPAN=2><FONT SIZE="+2">
105
<B>Method Summary</B></FONT></TD>
106
</TR>
107
<TR BGCOLOR="white" CLASS="TableRowColor">
108
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
109
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
110
<TD><CODE><B><A HREF="../../../../edu/ucsb/nceas/metacat/DBSAXDocument.html#getTitle()">getTitle</A></B>()</CODE>
111

  
112
<BR>
113
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the document title</TD>
114
</TR>
115
<TR BGCOLOR="white" CLASS="TableRowColor">
116
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
117
<CODE>&nbsp;void</CODE></FONT></TD>
118
<TD><CODE><B><A HREF="../../../../edu/ucsb/nceas/metacat/DBSAXDocument.html#setTitle(java.lang.String)">setTitle</A></B>(java.lang.String&nbsp;title)</CODE>
119

  
120
<BR>
121
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the document title</TD>
122
</TR>
123
<TR BGCOLOR="white" CLASS="TableRowColor">
124
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
125
<CODE>&nbsp;void</CODE></FONT></TD>
126
<TD><CODE><B><A HREF="../../../../edu/ucsb/nceas/metacat/DBSAXDocument.html#setTitleFromChildElement()">setTitleFromChildElement</A></B>()</CODE>
127

  
128
<BR>
129
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Look up the title of the first child element named "title"
130
 and record it as the document title</TD>
131
</TR>
132
</TABLE>
133
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
134
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
135 104
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
136 105
<TD><B>Methods inherited from class java.lang.Object</B></TD>
137 106
</TR>
......
174 143
                     java.lang.String&nbsp;doctype)</PRE>
175 144
<DL>
176 145
<DD>Construct a new document instance<DD><DL>
177
<DT><B>Parameters:</B><DD><CODE>conn</CODE> - the JDBC Connection to which all information is written<DD><CODE>rootnodeid</CODE> - - sequence id of the root node in the document<DD><CODE>docname</CODE> - - the name of DTD, 
178
        i.e. the name immediately following the DOCTYPE keyword - 
179
        should be the root element name.
146
<DT><B>Parameters:</B><DD><CODE>conn</CODE> - the JDBC Connection to which all information is written<DD><CODE>rootnodeid</CODE> - - sequence id of the root node in the document<DD><CODE>docname</CODE> - - the name of DTD, i.e. the name immediately following 
147
        the DOCTYPE keyword - should be the root element name.
180 148
        (Oracle's and IBM parsers are not aware if it is not the 
181
        root element name)<DD><CODE>doctype</CODE> - - Public ID of the DTD, 
182
        i.e. the name immediately following the PUBLIC keyword in 
183
        DOCTYPE declaration.<DD><CODE>doctitle</CODE> - - document title from first child element named "title"</DL>
149
        root element name)<DD><CODE>doctype</CODE> - - Public ID of the DTD, i.e. the name immediately 
150
                  following the PUBLIC keyword in DOCTYPE declaration.</DL>
184 151
</DD>
185 152
</DL>
186 153

  
187 154
<!-- ============ METHOD DETAIL ========== -->
188 155

  
189
<A NAME="method_detail"><!-- --></A>
190
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
191
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
192
<TD COLSPAN=1><FONT SIZE="+2">
193
<B>Method Detail</B></FONT></TD>
194
</TR>
195
</TABLE>
196

  
197
<A NAME="getTitle()"><!-- --></A><H3>
198
getTitle</H3>
199
<PRE>
200
public java.lang.String <B>getTitle</B>()</PRE>
201
<DL>
202
<DD>Get the document title</DL>
203
<HR>
204

  
205
<A NAME="setTitle(java.lang.String)"><!-- --></A><H3>
206
setTitle</H3>
207
<PRE>
208
public void <B>setTitle</B>(java.lang.String&nbsp;title)</PRE>
209
<DL>
210
<DD>Set the document title<DD><DL>
211
<DT><B>Parameters:</B><DD><CODE>title</CODE> - the new title for the document</DL>
212
</DD>
213
</DL>
214
<HR>
215

  
216
<A NAME="setTitleFromChildElement()"><!-- --></A><H3>
217
setTitleFromChildElement</H3>
218
<PRE>
219
public void <B>setTitleFromChildElement</B>()</PRE>
220
<DL>
221
<DD>Look up the title of the first child element named "title"
222
 and record it as the document title</DL>
223 156
<!-- ========= END OF CLASS DATA ========= -->
224 157
<HR>
225 158

  
......
233 166
  <TR ALIGN="center" VALIGN="top">
234 167
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT ID="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
235 168
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
169
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/DBSAXDocument.html"><FONT ID="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
236 170
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
237 171
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT ID="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
238 172
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
......
248 182
<TR>
249 183
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
250 184
&nbsp;<A HREF="../../../../edu/ucsb/nceas/metacat/DBReader.DoctypeInfo.html"><B>PREV CLASS</B></A>&nbsp;
251
&nbsp;<A HREF="../../../../edu/ucsb/nceas/metacat/DBSAXElement.html"><B>NEXT CLASS</B></A></FONT></TD>
185
&nbsp;<A HREF="../../../../edu/ucsb/nceas/metacat/DBSAXHandler.html"><B>NEXT CLASS</B></A></FONT></TD>
252 186
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
253 187
  <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
254 188
&nbsp;<A HREF="DBSAXDocument.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
255 189
</TR>
256 190
<TR>
257 191
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
258
  SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
192
  SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#methods_inherited_from_class_java.lang.Object">METHOD</A></FONT></TD>
259 193
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
260
DETAIL: &nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
194
DETAIL: &nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;METHOD</FONT></TD>
261 195
</TR>
262 196
</TABLE>
263 197
<!-- =========== END OF NAVBAR =========== -->
264 198

  
265 199
<HR>
266

  
200
<i>Copyright ? 2000 National Center for Ecological Analysis and Synthesis. All Rights Reserved.</i>
267 201
</BODY>
268 202
</HTML>

Also available in: Unified diff