Project

General

Profile

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 Tue Nov 07 20:14:05 PST 2000 -->
6
<TITLE>
7
MetaCat API: Class  DBValidate
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 CLASS="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="class-use/DBValidate.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
24
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
25
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
26
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
27
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
28
  </TR>
29
</TABLE>
30
</TD>
31
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
32
</EM>
33
</TD>
34
</TR>
35

    
36
<TR>
37
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
38
&nbsp;<A HREF="../../../../edu/ucsb/nceas/metacat/DBUtil.html"><B>PREV CLASS</B></A>&nbsp;
39
&nbsp;<A HREF="../../../../edu/ucsb/nceas/metacat/DocumentImpl.html"><B>NEXT CLASS</B></A></FONT></TD>
40
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
41
  <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
42
&nbsp;<A HREF="DBValidate.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
43
</TR>
44
<TR>
45
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
46
  SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
47
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
48
DETAIL: &nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
49
</TR>
50
</TABLE>
51
<!-- =========== END OF NAVBAR =========== -->
52

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

    
69
<P>
70
Name: DBValidate.java
71
       Purpose: A Class that validates XML documents
72
 			   This class is designed to be parser independent
73
    			   i.e. it uses only org.xml.sax classes
74
 			   It is tied to SAX 2.0 methods
75
     Copyright: 2000 Regents of the University of California and the
76
                National Center for Ecological Analysis and Synthesis
77
                April 28, 2000
78
    Authors: Dan Higgins, Matt Jones
79
<P>
80
<HR>
81

    
82
<P>
83
<!-- ======== INNER CLASS SUMMARY ======== -->
84

    
85

    
86
<!-- =========== FIELD SUMMARY =========== -->
87

    
88

    
89
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
90

    
91
<A NAME="constructor_summary"><!-- --></A>
92
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
93
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
94
<TD COLSPAN=2><FONT SIZE="+2">
95
<B>Constructor Summary</B></FONT></TD>
96
</TR>
97
<TR BGCOLOR="white" CLASS="TableRowColor">
98
<TD><CODE><B><A HREF="../../../../edu/ucsb/nceas/metacat/DBValidate.html#DBValidate(java.lang.String)">DBValidate</A></B>(java.lang.String&nbsp;parserName)</CODE>
99

    
100
<BR>
101
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Construct a new validation object</TD>
102
</TR>
103
<TR BGCOLOR="white" CLASS="TableRowColor">
104
<TD><CODE><B><A HREF="../../../../edu/ucsb/nceas/metacat/DBValidate.html#DBValidate(java.lang.String, java.sql.Connection)">DBValidate</A></B>(java.lang.String&nbsp;parserName,
105
           java.sql.Connection&nbsp;conn)</CODE>
106

    
107
<BR>
108
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Construct a new validation object using a database entity resolver</TD>
109
</TR>
110
<TR BGCOLOR="white" CLASS="TableRowColor">
111
<TD><CODE><B><A HREF="../../../../edu/ucsb/nceas/metacat/DBValidate.html#DBValidate(java.lang.String, java.lang.String)">DBValidate</A></B>(java.lang.String&nbsp;parserName,
112
           java.lang.String&nbsp;xmlcatalogfile)</CODE>
113

    
114
<BR>
115
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Construct a new validation object using an OASIS catalog file</TD>
116
</TR>
117
</TABLE>
118
&nbsp;
119
<!-- ========== METHOD SUMMARY =========== -->
120

    
121
<A NAME="method_summary"><!-- --></A>
122
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
123
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
124
<TD COLSPAN=2><FONT SIZE="+2">
125
<B>Method Summary</B></FONT></TD>
126
</TR>
127
<TR BGCOLOR="white" CLASS="TableRowColor">
128
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
129
<CODE>static&nbsp;void</CODE></FONT></TD>
130
<TD><CODE><B><A HREF="../../../../edu/ucsb/nceas/metacat/DBValidate.html#main(java.lang.String[])">main</A></B>(java.lang.String[]&nbsp;args)</CODE>
131

    
132
<BR>
133
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;main method for testing 
134
 </TD>
135
</TR>
136
<TR BGCOLOR="white" CLASS="TableRowColor">
137
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
138
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
139
<TD><CODE><B><A HREF="../../../../edu/ucsb/nceas/metacat/DBValidate.html#returnErrors()">returnErrors</A></B>()</CODE>
140

    
141
<BR>
142
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;provide a list of errors from the validation process</TD>
143
</TR>
144
<TR BGCOLOR="white" CLASS="TableRowColor">
145
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
146
<CODE>&nbsp;boolean</CODE></FONT></TD>
147
<TD><CODE><B><A HREF="../../../../edu/ucsb/nceas/metacat/DBValidate.html#validate(java.lang.String)">validate</A></B>(java.lang.String&nbsp;doc)</CODE>
148

    
149
<BR>
150
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;validate an xml document against its DTD</TD>
151
</TR>
152
<TR BGCOLOR="white" CLASS="TableRowColor">
153
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
154
<CODE>&nbsp;boolean</CODE></FONT></TD>
155
<TD><CODE><B><A HREF="../../../../edu/ucsb/nceas/metacat/DBValidate.html#validateString(java.lang.String)">validateString</A></B>(java.lang.String&nbsp;xmldoc)</CODE>
156

    
157
<BR>
158
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;validate an xml document against its DTD</TD>
159
</TR>
160
</TABLE>
161
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
162
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
163
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
164
<TD><B>Methods inherited from class java.lang.Object</B></TD>
165
</TR>
166
<TR BGCOLOR="white" CLASS="TableRowColor">
167
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
168
</TR>
169
</TABLE>
170
&nbsp;
171
<P>
172

    
173
<!-- ============ FIELD DETAIL =========== -->
174

    
175

    
176
<!-- ========= CONSTRUCTOR DETAIL ======== -->
177

    
178
<A NAME="constructor_detail"><!-- --></A>
179
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
180
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
181
<TD COLSPAN=1><FONT SIZE="+2">
182
<B>Constructor Detail</B></FONT></TD>
183
</TR>
184
</TABLE>
185

    
186
<A NAME="DBValidate(java.lang.String)"><!-- --></A><H3>
187
DBValidate</H3>
188
<PRE>
189
public <B>DBValidate</B>(java.lang.String&nbsp;parserName)</PRE>
190
<DL>
191
<DD>Construct a new validation object</DL>
192
<HR>
193

    
194
<A NAME="DBValidate(java.lang.String, java.lang.String)"><!-- --></A><H3>
195
DBValidate</H3>
196
<PRE>
197
public <B>DBValidate</B>(java.lang.String&nbsp;parserName,
198
                  java.lang.String&nbsp;xmlcatalogfile)</PRE>
199
<DL>
200
<DD>Construct a new validation object using an OASIS catalog file</DL>
201
<HR>
202

    
203
<A NAME="DBValidate(java.lang.String, java.sql.Connection)"><!-- --></A><H3>
204
DBValidate</H3>
205
<PRE>
206
public <B>DBValidate</B>(java.lang.String&nbsp;parserName,
207
                  java.sql.Connection&nbsp;conn)</PRE>
208
<DL>
209
<DD>Construct a new validation object using a database entity resolver</DL>
210

    
211
<!-- ============ METHOD DETAIL ========== -->
212

    
213
<A NAME="method_detail"><!-- --></A>
214
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
215
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
216
<TD COLSPAN=1><FONT SIZE="+2">
217
<B>Method Detail</B></FONT></TD>
218
</TR>
219
</TABLE>
220

    
221
<A NAME="validate(java.lang.String)"><!-- --></A><H3>
222
validate</H3>
223
<PRE>
224
public boolean <B>validate</B>(java.lang.String&nbsp;doc)</PRE>
225
<DL>
226
<DD>validate an xml document against its DTD<DD><DL>
227
<DT><B>Parameters:</B><DD><CODE>doc</CODE> - the filename of the document to validate</DL>
228
</DD>
229
</DL>
230
<HR>
231

    
232
<A NAME="validateString(java.lang.String)"><!-- --></A><H3>
233
validateString</H3>
234
<PRE>
235
public boolean <B>validateString</B>(java.lang.String&nbsp;xmldoc)</PRE>
236
<DL>
237
<DD>validate an xml document against its DTD<DD><DL>
238
<DT><B>Parameters:</B><DD><CODE>xmldoc</CODE> - the String containing the xml document to validate</DL>
239
</DD>
240
</DL>
241
<HR>
242

    
243
<A NAME="returnErrors()"><!-- --></A><H3>
244
returnErrors</H3>
245
<PRE>
246
public java.lang.String <B>returnErrors</B>()</PRE>
247
<DL>
248
<DD>provide a list of errors from the validation process</DL>
249
<HR>
250

    
251
<A NAME="main(java.lang.String[])"><!-- --></A><H3>
252
main</H3>
253
<PRE>
254
public static void <B>main</B>(java.lang.String[]&nbsp;args)</PRE>
255
<DL>
256
<DD>main method for testing 
257
 <p>
258
 Usage: java DBValidate <xmlfile or URL></DL>
259
<!-- ========= END OF CLASS DATA ========= -->
260
<HR>
261

    
262
<!-- ========== START OF NAVBAR ========== -->
263
<A NAME="navbar_bottom"><!-- --></A>
264
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
265
<TR>
266
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
267
<A NAME="navbar_bottom_firstrow"><!-- --></A>
268
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
269
  <TR ALIGN="center" VALIGN="top">
270
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
271
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
272
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/DBValidate.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
273
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
274
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
275
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
276
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
277
  </TR>
278
</TABLE>
279
</TD>
280
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
281
</EM>
282
</TD>
283
</TR>
284

    
285
<TR>
286
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
287
&nbsp;<A HREF="../../../../edu/ucsb/nceas/metacat/DBUtil.html"><B>PREV CLASS</B></A>&nbsp;
288
&nbsp;<A HREF="../../../../edu/ucsb/nceas/metacat/DocumentImpl.html"><B>NEXT CLASS</B></A></FONT></TD>
289
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
290
  <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
291
&nbsp;<A HREF="DBValidate.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
292
</TR>
293
<TR>
294
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
295
  SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
296
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
297
DETAIL: &nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
298
</TR>
299
</TABLE>
300
<!-- =========== END OF NAVBAR =========== -->
301

    
302
<HR>
303
<i>Copyright ? 2000 National Center for Ecological Analysis and Synthesis. All Rights Reserved.</i>
304
</BODY>
305
</HTML>
(21-21/40)