Project

General

Profile

metacat / docs / edu / ucsb / nceas / metacat / DBSAXDocument.html @ 107

1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
2
<!--NewPage-->
3
<HTML>
4
<HEAD>
5
<!-- Generated by javadoc on Sat May 20 14:25:41 AKDT 2000 -->
6
<TITLE>
7
: Class  DBSAXDocument
8
</TITLE>
9
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
10
</HEAD>
11
<BODY BGCOLOR="white">
12

    
13
<!-- ========== START OF NAVBAR ========== -->
14
<A NAME="navbar_top"><!-- --></A>
15
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
16
<TR>
17
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
18
<A NAME="navbar_top_firstrow"><!-- --></A>
19
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
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>&nbsp;</TD>
22
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
23
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
24
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT ID="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
25
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
26
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT ID="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
27
  </TR>
28
</TABLE>
29
</TD>
30
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
31
</EM>
32
</TD>
33
</TR>
34

    
35
<TR>
36
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
37
&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
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
40
  <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
41
&nbsp;<A HREF="DBSAXDocument.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
42
</TR>
43
<TR>
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>
46
<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
</TR>
49
</TABLE>
50
<!-- =========== END OF NAVBAR =========== -->
51

    
52
<HR>
53
<!-- ======== START OF CLASS DATA ======== -->
54
<H2>
55
<FONT SIZE="-1">
56
edu.ucsb.nceas.metacat</FONT>
57
<BR>
58
Class  DBSAXDocument</H2>
59
<PRE>
60
java.lang.Object
61
  |
62
  +--<B>edu.ucsb.nceas.metacat.DBSAXDocument</B>
63
</PRE>
64
<HR>
65
<DL>
66
<DT>public class <B>DBSAXDocument</B><DT>extends java.lang.Object</DL>
67

    
68
<P>
69
A Class that writes an XML document main data to a database connection
70
<P>
71
<HR>
72

    
73
<P>
74
<!-- ======== INNER CLASS SUMMARY ======== -->
75

    
76

    
77
<!-- =========== FIELD SUMMARY =========== -->
78

    
79

    
80
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
81

    
82
<A NAME="constructor_summary"><!-- --></A>
83
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
84
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
85
<TD COLSPAN=2><FONT SIZE="+2">
86
<B>Constructor Summary</B></FONT></TD>
87
</TR>
88
<TR BGCOLOR="white" CLASS="TableRowColor">
89
<TD><CODE><B><A HREF="../../../../edu/ucsb/nceas/metacat/DBSAXDocument.html#DBSAXDocument(java.sql.Connection, long, java.lang.String, java.lang.String)">DBSAXDocument</A></B>(java.sql.Connection&nbsp;conn,
90
              long&nbsp;rootnodeid,
91
              java.lang.String&nbsp;docname,
92
              java.lang.String&nbsp;doctype)</CODE>
93

    
94
<BR>
95
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Construct a new document instance</TD>
96
</TR>
97
</TABLE>
98
&nbsp;
99
<!-- ========== METHOD SUMMARY =========== -->
100

    
101
<A NAME="method_summary"><!-- --></A>
102
<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
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
136
<TD><B>Methods inherited from class java.lang.Object</B></TD>
137
</TR>
138
<TR BGCOLOR="white" CLASS="TableRowColor">
139
<TD><CODE>clone, 
140
equals, 
141
finalize, 
142
getClass, 
143
hashCode, 
144
notify, 
145
notifyAll, 
146
toString, 
147
wait, 
148
wait, 
149
wait</CODE></TD>
150
</TR>
151
</TABLE>
152
&nbsp;
153
<P>
154

    
155
<!-- ============ FIELD DETAIL =========== -->
156

    
157

    
158
<!-- ========= CONSTRUCTOR DETAIL ======== -->
159

    
160
<A NAME="constructor_detail"><!-- --></A>
161
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
162
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
163
<TD COLSPAN=1><FONT SIZE="+2">
164
<B>Constructor Detail</B></FONT></TD>
165
</TR>
166
</TABLE>
167

    
168
<A NAME="DBSAXDocument(java.sql.Connection, long, java.lang.String, java.lang.String)"><!-- --></A><H3>
169
DBSAXDocument</H3>
170
<PRE>
171
public <B>DBSAXDocument</B>(java.sql.Connection&nbsp;conn,
172
                     long&nbsp;rootnodeid,
173
                     java.lang.String&nbsp;docname,
174
                     java.lang.String&nbsp;doctype)</PRE>
175
<DL>
176
<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.
180
        (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>
184
</DD>
185
</DL>
186

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

    
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
<!-- ========= END OF CLASS DATA ========= -->
224
<HR>
225

    
226
<!-- ========== START OF NAVBAR ========== -->
227
<A NAME="navbar_bottom"><!-- --></A>
228
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
229
<TR>
230
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
231
<A NAME="navbar_bottom_firstrow"><!-- --></A>
232
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
233
  <TR ALIGN="center" VALIGN="top">
234
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT ID="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
235
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
236
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT ID="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
237
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT ID="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
238
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT ID="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
239
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT ID="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
240
  </TR>
241
</TABLE>
242
</TD>
243
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
244
</EM>
245
</TD>
246
</TR>
247

    
248
<TR>
249
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
250
&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>
252
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
253
  <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
254
&nbsp;<A HREF="DBSAXDocument.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
255
</TR>
256
<TR>
257
<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>
259
<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>
261
</TR>
262
</TABLE>
263
<!-- =========== END OF NAVBAR =========== -->
264

    
265
<HR>
266

    
267
</BODY>
268
</HTML>