Project

General

Profile

« Previous | Next » 

Revision 516

Added by Matt Jones about 24 years ago

Changed target of the javadoc builds to the build/docs/apiDocs directory
so that we no loger version track the javadoc html files -- they changes
too much between each of the times we would generate them. Also, removed
the old javadoc documentation that was found in the "docs" subdirectory.

View differences:

docs/index.html
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd>
2
<!--NewPage-->
3
<HTML>
4
<HEAD>
5
<!-- Generated by javadoc on Tue Nov 07 20:14:04 PST 2000-->
6
<TITLE>
7
MetaCat API
8
</TITLE>
9
</HEAD>
10
<FRAMESET cols="20%,80%">
11
<FRAME src="allclasses-frame.html" name="packageFrame">
12
<FRAME src="edu/ucsb/nceas/metacat/package-summary.html" name="classFrame">
13
</FRAMESET>
14
<NOFRAMES>
15
<H2>
16
Frame Alert</H2>
17

  
18
<P>
19
This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client.
20
<BR>
21
Link to <A HREF="edu/ucsb/nceas/metacat/package-summary.html">Non-frame version.</A></NOFRAMES>
22
</HTML>
23 0

  
docs/deprecated-list.html
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:04 PST 2000 -->
6
<TITLE>
7
MetaCat API: Deprecated List
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">    <FONT CLASS="NavBarFont1">Package</FONT>&nbsp;</TD>
22
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
23
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Use</FONT>&nbsp;</TD>
24
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="edu/ucsb/nceas/metacat/package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
25
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Deprecated</B></FONT>&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;PREV&nbsp;
39
&nbsp;NEXT</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="deprecated-list.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
43
</TR>
44
</TABLE>
45
<!-- =========== END OF NAVBAR =========== -->
46

  
47
<HR>
48
<CENTER>
49
<H2>
50
<B>Deprecated API</B></H2>
51
</CENTER>
52
<HR>
53

  
54
<!-- ========== START OF NAVBAR ========== -->
55
<A NAME="navbar_bottom"><!-- --></A>
56
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
57
<TR>
58
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
59
<A NAME="navbar_bottom_firstrow"><!-- --></A>
60
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
61
  <TR ALIGN="center" VALIGN="top">
62
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Package</FONT>&nbsp;</TD>
63
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
64
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Use</FONT>&nbsp;</TD>
65
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="edu/ucsb/nceas/metacat/package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
66
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Deprecated</B></FONT>&nbsp;</TD>
67
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
68
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
69
  </TR>
70
</TABLE>
71
</TD>
72
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
73
</EM>
74
</TD>
75
</TR>
76

  
77
<TR>
78
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
79
&nbsp;PREV&nbsp;
80
&nbsp;NEXT</FONT></TD>
81
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
82
  <A HREF="index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
83
&nbsp;<A HREF="deprecated-list.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
84
</TR>
85
</TABLE>
86
<!-- =========== END OF NAVBAR =========== -->
87

  
88
<HR>
89
<i>Copyright ? 2000 National Center for Ecological Analysis and Synthesis. All Rights Reserved.</i>
90
</BODY>
91
</HTML>
92 0

  
docs/edu/ucsb/nceas/metacat/DBSimpleQuery.html
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  DBSimpleQuery
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/DBSimpleQuery.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/DBSAXNode.html"><B>PREV CLASS</B></A>&nbsp;
39
&nbsp;<A HREF="../../../../edu/ucsb/nceas/metacat/DBTransform.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="DBSimpleQuery.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  DBSimpleQuery</H2>
60
<PRE>
61
java.lang.Object
62
  |
63
  +--<B>edu.ucsb.nceas.metacat.DBSimpleQuery</B>
64
</PRE>
65
<HR>
66
<DL>
67
<DT>public class <B>DBSimpleQuery</B><DT>extends java.lang.Object</DL>
68

  
69
<P>
70
A Class that searches a relational DB for elements and attributes that
71
 have free text matches to the query string.  It returns a result set 
72
 consisting of the root nodeid for each document that satisfies the query
73
<P>
74
<HR>
75

  
76
<P>
77
<!-- ======== INNER CLASS SUMMARY ======== -->
78

  
79

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

  
82

  
83
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
84

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

  
94
<BR>
95
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;construct an instance of the DBSimpleQuery class 
96

  
97
 </TD>
98
</TR>
99
</TABLE>
100
&nbsp;
101
<!-- ========== METHOD SUMMARY =========== -->
102

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

  
114
<BR>
115
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;routine to search the elements and attributes looking to match query</TD>
116
</TR>
117
<TR BGCOLOR="white" CLASS="TableRowColor">
118
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
119
<CODE>&nbsp;java.util.Hashtable</CODE></FONT></TD>
120
<TD><CODE><B><A HREF="../../../../edu/ucsb/nceas/metacat/DBSimpleQuery.html#findDocuments(java.lang.String, java.lang.String)">findDocuments</A></B>(java.lang.String&nbsp;query,
121
              java.lang.String&nbsp;requestedDoctype)</CODE>
122

  
123
<BR>
124
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;routine to search the elements and attributes looking to match query</TD>
125
</TR>
126
<TR BGCOLOR="white" CLASS="TableRowColor">
127
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
128
<CODE>static&nbsp;void</CODE></FONT></TD>
129
<TD><CODE><B><A HREF="../../../../edu/ucsb/nceas/metacat/DBSimpleQuery.html#main(java.lang.String[])">main</A></B>(java.lang.String[]&nbsp;args)</CODE>
130

  
131
<BR>
132
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;the main routine used to test the DBSimpleQuery utility.</TD>
133
</TR>
134
</TABLE>
135
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
136
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
137
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
138
<TD><B>Methods inherited from class java.lang.Object</B></TD>
139
</TR>
140
<TR BGCOLOR="white" CLASS="TableRowColor">
141
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
142
</TR>
143
</TABLE>
144
&nbsp;
145
<P>
146

  
147
<!-- ============ FIELD DETAIL =========== -->
148

  
149

  
150
<!-- ========= CONSTRUCTOR DETAIL ======== -->
151

  
152
<A NAME="constructor_detail"><!-- --></A>
153
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
154
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
155
<TD COLSPAN=1><FONT SIZE="+2">
156
<B>Constructor Detail</B></FONT></TD>
157
</TR>
158
</TABLE>
159

  
160
<A NAME="DBSimpleQuery(java.sql.Connection)"><!-- --></A><H3>
161
DBSimpleQuery</H3>
162
<PRE>
163
public <B>DBSimpleQuery</B>(java.sql.Connection&nbsp;conn)
164
              throws java.io.IOException,
165
                     java.sql.SQLException,
166
                     java.lang.ClassNotFoundException</PRE>
167
<DL>
168
<DD>construct an instance of the DBSimpleQuery class 
169

  
170
 <p>Generally, one would call the findDocuments() routine after creating 
171
 an instance to specify the search query</p><DD><DL>
172
<DT><B>Parameters:</B><DD><CODE>conn</CODE> - the JDBC connection that we use for the query</DL>
173
</DD>
174
</DL>
175

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

  
178
<A NAME="method_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>Method Detail</B></FONT></TD>
183
</TR>
184
</TABLE>
185

  
186
<A NAME="main(java.lang.String[])"><!-- --></A><H3>
187
main</H3>
188
<PRE>
189
public static void <B>main</B>(java.lang.String[]&nbsp;args)</PRE>
190
<DL>
191
<DD>the main routine used to test the DBSimpleQuery utility.
192
 <p>
193
 Usage: java DBSimpleQuery <query><DD><DL>
194
<DT><B>Parameters:</B><DD><CODE>query</CODE> - the text to search for in the element and attribute content</DL>
195
</DD>
196
</DL>
197
<HR>
198

  
199
<A NAME="findDocuments(java.lang.String)"><!-- --></A><H3>
200
findDocuments</H3>
201
<PRE>
202
public java.util.Hashtable <B>findDocuments</B>(java.lang.String&nbsp;query)</PRE>
203
<DL>
204
<DD>routine to search the elements and attributes looking to match query<DD><DL>
205
<DT><B>Parameters:</B><DD><CODE>query</CODE> - the text to search for</DL>
206
</DD>
207
</DL>
208
<HR>
209

  
210
<A NAME="findDocuments(java.lang.String, java.lang.String)"><!-- --></A><H3>
211
findDocuments</H3>
212
<PRE>
213
public java.util.Hashtable <B>findDocuments</B>(java.lang.String&nbsp;query,
214
                                         java.lang.String&nbsp;requestedDoctype)</PRE>
215
<DL>
216
<DD>routine to search the elements and attributes looking to match query<DD><DL>
217
<DT><B>Parameters:</B><DD><CODE>query</CODE> - the text to search for<DD><CODE>requestedDoctype</CODE> - the type of documents to return from the query</DL>
218
</DD>
219
</DL>
220
<!-- ========= END OF CLASS DATA ========= -->
221
<HR>
222

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

  
246
<TR>
247
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
248
&nbsp;<A HREF="../../../../edu/ucsb/nceas/metacat/DBSAXNode.html"><B>PREV CLASS</B></A>&nbsp;
249
&nbsp;<A HREF="../../../../edu/ucsb/nceas/metacat/DBTransform.html"><B>NEXT CLASS</B></A></FONT></TD>
250
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
251
  <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
252
&nbsp;<A HREF="DBSimpleQuery.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
253
</TR>
254
<TR>
255
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
256
  SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
257
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
258
DETAIL: &nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
259
</TR>
260
</TABLE>
261
<!-- =========== END OF NAVBAR =========== -->
262

  
263
<HR>
264
<i>Copyright ? 2000 National Center for Ecological Analysis and Synthesis. All Rights Reserved.</i>
265
</BODY>
266
</HTML>
267 0

  
docs/edu/ucsb/nceas/metacat/package-use.html
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:04 PST 2000 -->
6
<TITLE>
7
MetaCat API: Uses of Package edu.ucsb.nceas.metacat
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="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
23
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Use</B></FONT>&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;PREV&nbsp;
39
&nbsp;NEXT</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="package-use.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
43
</TR>
44
</TABLE>
45
<!-- =========== END OF NAVBAR =========== -->
46

  
47
<HR>
48
<CENTER>
49
<H2>
50
<B>Uses of Package<br>edu.ucsb.nceas.metacat</B></H2>
51
</CENTER>
52
<A NAME="edu.ucsb.nceas.metacat"><!-- --></A>
53
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
54
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
55
<TD COLSPAN=2><FONT SIZE="+2">
56
Classes in <A HREF="../../../../edu/ucsb/nceas/metacat/package-summary.html">edu.ucsb.nceas.metacat</A> used by <A HREF="../../../../edu/ucsb/nceas/metacat/package-summary.html">edu.ucsb.nceas.metacat</A><TR BGCOLOR="white" CLASS="TableRowColor">
57
<TD><B><A HREF="../../../../edu/ucsb/nceas/metacat/class-use/AccessionNumberException.html#edu.ucsb.nceas.metacat"><B>AccessionNumberException</B></A></B>
58

  
59
<BR>
60
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Exception thrown when an error occurs because an AccessionNumber was 
61
 invalid or used incorrectly.</TD>
62
</TR>
63
<TR BGCOLOR="white" CLASS="TableRowColor">
64
<TD><B><A HREF="../../../../edu/ucsb/nceas/metacat/class-use/AuthInterface.html#edu.ucsb.nceas.metacat"><B>AuthInterface</B></A></B>
65

  
66
<BR>
67
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;An interface representing the methods that should be 
68
 implemented by an authentication service.</TD>
69
</TR>
70
<TR BGCOLOR="white" CLASS="TableRowColor">
71
<TD><B><A HREF="../../../../edu/ucsb/nceas/metacat/class-use/BasicNode.html#edu.ucsb.nceas.metacat"><B>BasicNode</B></A></B>
72

  
73
<BR>
74
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A Class that represents an XML node and its contents</TD>
75
</TR>
76
<TR BGCOLOR="white" CLASS="TableRowColor">
77
<TD><B><A HREF="../../../../edu/ucsb/nceas/metacat/class-use/DBSAXHandler.html#edu.ucsb.nceas.metacat"><B>DBSAXHandler</B></A></B>
78

  
79
<BR>
80
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A database aware Class implementing callback bethods for the SAX parser to
81
 call when processing the XML stream and generating events</TD>
82
</TR>
83
<TR BGCOLOR="white" CLASS="TableRowColor">
84
<TD><B><A HREF="../../../../edu/ucsb/nceas/metacat/class-use/DBSAXNode.html#edu.ucsb.nceas.metacat"><B>DBSAXNode</B></A></B>
85

  
86
<BR>
87
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A Class that represents an XML node and its contents and
88
 can write its own representation to a database connection</TD>
89
</TR>
90
<TR BGCOLOR="white" CLASS="TableRowColor">
91
<TD><B><A HREF="../../../../edu/ucsb/nceas/metacat/class-use/DocumentImpl.html#edu.ucsb.nceas.metacat"><B>DocumentImpl</B></A></B>
92

  
93
<BR>
94
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A class that represents an XML document.</TD>
95
</TR>
96
<TR BGCOLOR="white" CLASS="TableRowColor">
97
<TD><B><A HREF="../../../../edu/ucsb/nceas/metacat/class-use/McdbException.html#edu.ucsb.nceas.metacat"><B>McdbException</B></A></B>
98

  
99
<BR>
100
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Exception thrown when an error occurs because a problem occurred in
101
 the metacat database.</TD>
102
</TR>
103
<TR BGCOLOR="white" CLASS="TableRowColor">
104
<TD><B><A HREF="../../../../edu/ucsb/nceas/metacat/class-use/NodeRecord.html#edu.ucsb.nceas.metacat"><B>NodeRecord</B></A></B>
105

  
106
<BR>
107
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A utility class that encapsulates a node and its data</TD>
108
</TR>
109
</FONT></TD>
110
</TR>
111
</TABLE>
112
&nbsp;
113
<P>
114
<HR>
115

  
116
<!-- ========== START OF NAVBAR ========== -->
117
<A NAME="navbar_bottom"><!-- --></A>
118
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
119
<TR>
120
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
121
<A NAME="navbar_bottom_firstrow"><!-- --></A>
122
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
123
  <TR ALIGN="center" VALIGN="top">
124
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
125
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
126
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Use</B></FONT>&nbsp;</TD>
127
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
128
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
129
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
130
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
131
  </TR>
132
</TABLE>
133
</TD>
134
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
135
</EM>
136
</TD>
137
</TR>
138

  
139
<TR>
140
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
141
&nbsp;PREV&nbsp;
142
&nbsp;NEXT</FONT></TD>
143
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
144
  <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
145
&nbsp;<A HREF="package-use.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
146
</TR>
147
</TABLE>
148
<!-- =========== END OF NAVBAR =========== -->
149

  
150
<HR>
151
<i>Copyright ? 2000 National Center for Ecological Analysis and Synthesis. All Rights Reserved.</i>
152
</BODY>
153
</HTML>
154 0

  
docs/edu/ucsb/nceas/metacat/package-summary.html
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:04 PST 2000 -->
6
<TITLE>
7
MetaCat API: Package edu.ucsb.nceas.metacat
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="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
22
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
23
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-use.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;PREV PACKAGE&nbsp;
39
&nbsp;NEXT PACKAGE</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="package-summary.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
43
</TR>
44
</TABLE>
45
<!-- =========== END OF NAVBAR =========== -->
46

  
47
<HR>
48
<H2>
49
Package edu.ucsb.nceas.metacat
50
</H2>
51

  
52
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
53
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
54
<TD COLSPAN=2><FONT SIZE="+2">
55
<B>Interface Summary</B></FONT></TD>
56
</TR>
57
<TR BGCOLOR="white" CLASS="TableRowColor">
58
<TD WIDTH="15%"><B><A HREF="AuthInterface.html"><I>AuthInterface</I></A></B></TD>
59
<TD>An interface representing the methods that should be 
60
 implemented by an authentication service.</TD>
61
</TR>
62
</TABLE>
63
&nbsp;
64

  
65
<P>
66

  
67
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
68
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
69
<TD COLSPAN=2><FONT SIZE="+2">
70
<B>Class Summary</B></FONT></TD>
71
</TR>
72
<TR BGCOLOR="white" CLASS="TableRowColor">
73
<TD WIDTH="15%"><B><A HREF="AccessionNumber.html">AccessionNumber</A></B></TD>
74
<TD>(on insert of XML document)
75
 Generates a unique Accession Number or if provided check it 
76
 for uniqueness and register it into the db connection 
77
 (on update or delete of XML document)
78
 Check for existance of provided Accession Number</TD>
79
</TR>
80
<TR BGCOLOR="white" CLASS="TableRowColor">
81
<TD WIDTH="15%"><B><A HREF="AuthLdap.html">AuthLdap</A></B></TD>
82
<TD>An implementation of the AuthInterface interface that
83
 allows Metacat to use the LDAP protocol for directory services.</TD>
84
</TR>
85
<TR BGCOLOR="white" CLASS="TableRowColor">
86
<TD WIDTH="15%"><B><A HREF="AuthMcat.html">AuthMcat</A></B></TD>
87
<TD>An implementation of the AuthInterface interface that
88
 allows Metacat to use the SRB/MCAT for authentication.</TD>
89
</TR>
90
<TR BGCOLOR="white" CLASS="TableRowColor">
91
<TD WIDTH="15%"><B><A HREF="AuthSession.html">AuthSession</A></B></TD>
92
<TD>A Class that implements session tracking for MetaCatServlet users.</TD>
93
</TR>
94
<TR BGCOLOR="white" CLASS="TableRowColor">
95
<TD WIDTH="15%"><B><A HREF="BasicNode.html">BasicNode</A></B></TD>
96
<TD>A Class that represents an XML node and its contents</TD>
97
</TR>
98
<TR BGCOLOR="white" CLASS="TableRowColor">
99
<TD WIDTH="15%"><B><A HREF="CommentNode.html">CommentNode</A></B></TD>
100
<TD>A Class that represents an XML Comment node and its contents,</TD>
101
</TR>
102
<TR BGCOLOR="white" CLASS="TableRowColor">
103
<TD WIDTH="15%"><B><A HREF="DBDTDHandler.html">DBDTDHandler</A></B></TD>
104
<TD>A database aware Class implementing DTDHandler interface for the SAX 
105
 parser to call when processing the XML stream and intercepting notations 
106
 and unparsed entities</TD>
107
</TR>
108
<TR BGCOLOR="white" CLASS="TableRowColor">
109
<TD WIDTH="15%"><B><A HREF="DBEntityResolver.html">DBEntityResolver</A></B></TD>
110
<TD>A database aware Class implementing EntityResolver interface for the SAX 
111
 parser to call when processing the XML stream and intercepting any 
112
 external entities (including the external DTD subset and external 
113
 parameter entities, if any) before including them.</TD>
114
</TR>
115
<TR BGCOLOR="white" CLASS="TableRowColor">
116
<TD WIDTH="15%"><B><A HREF="DBQuery.html">DBQuery</A></B></TD>
117
<TD>A Class that searches a relational DB for elements and 
118
 attributes that have free text matches a query string,
119
 or structured query matches to a path specified node in the 
120
 XML hierarchy.</TD>
121
</TR>
122
<TR BGCOLOR="white" CLASS="TableRowColor">
123
<TD WIDTH="15%"><B><A HREF="DBSAXHandler.html">DBSAXHandler</A></B></TD>
124
<TD>A database aware Class implementing callback bethods for the SAX parser to
125
 call when processing the XML stream and generating events</TD>
126
</TR>
127
<TR BGCOLOR="white" CLASS="TableRowColor">
128
<TD WIDTH="15%"><B><A HREF="DBSAXNode.html">DBSAXNode</A></B></TD>
129
<TD>A Class that represents an XML node and its contents and
130
 can write its own representation to a database connection</TD>
131
</TR>
132
<TR BGCOLOR="white" CLASS="TableRowColor">
133
<TD WIDTH="15%"><B><A HREF="DBSimpleQuery.html">DBSimpleQuery</A></B></TD>
134
<TD>A Class that searches a relational DB for elements and attributes that
135
 have free text matches to the query string.</TD>
136
</TR>
137
<TR BGCOLOR="white" CLASS="TableRowColor">
138
<TD WIDTH="15%"><B><A HREF="DBTransform.html">DBTransform</A></B></TD>
139
<TD>A Class that transforms XML documents utitlizing XSL style sheets</TD>
140
</TR>
141
<TR BGCOLOR="white" CLASS="TableRowColor">
142
<TD WIDTH="15%"><B><A HREF="DBUtil.html">DBUtil</A></B></TD>
143
<TD>A suite of utility classes for quering DB</TD>
144
</TR>
145
<TR BGCOLOR="white" CLASS="TableRowColor">
146
<TD WIDTH="15%"><B><A HREF="DBValidate.html">DBValidate</A></B></TD>
147
<TD>Name: DBValidate.java
148
       Purpose: A Class that validates XML documents
149
 			   This class is designed to be parser independent
150
    			   i.e.</TD>
151
</TR>
152
<TR BGCOLOR="white" CLASS="TableRowColor">
153
<TD WIDTH="15%"><B><A HREF="DocumentImpl.html">DocumentImpl</A></B></TD>
154
<TD>A class that represents an XML document.</TD>
155
</TR>
156
<TR BGCOLOR="white" CLASS="TableRowColor">
157
<TD WIDTH="15%"><B><A HREF="ElementNode.html">ElementNode</A></B></TD>
158
<TD>A Class that represents an XML element and its contents,
159
 and can build itself from a database connection</TD>
160
</TR>
161
<TR BGCOLOR="white" CLASS="TableRowColor">
162
<TD WIDTH="15%"><B><A HREF="MetaCatServlet.html">MetaCatServlet</A></B></TD>
163
<TD>A metadata catalog server implemented as a Java Servlet
164

  
165
 </TD>
166
</TR>
167
<TR BGCOLOR="white" CLASS="TableRowColor">
168
<TD WIDTH="15%"><B><A HREF="MetaCatSession.html">MetaCatSession</A></B></TD>
169
<TD>A Class that implements session tracking for MetaCatServlet users.</TD>
170
</TR>
171
<TR BGCOLOR="white" CLASS="TableRowColor">
172
<TD WIDTH="15%"><B><A HREF="metacatURL.html">metacatURL</A></B></TD>
173
<TD>&nbsp;</TD>
174
</TR>
175
<TR BGCOLOR="white" CLASS="TableRowColor">
176
<TD WIDTH="15%"><B><A HREF="MetaCatUtil.html">MetaCatUtil</A></B></TD>
177
<TD>A suite of utility classes for the metadata catalog server</TD>
178
</TR>
179
<TR BGCOLOR="white" CLASS="TableRowColor">
180
<TD WIDTH="15%"><B><A HREF="NodeComparator.html">NodeComparator</A></B></TD>
181
<TD>A utility class that sorts two node records.</TD>
182
</TR>
183
<TR BGCOLOR="white" CLASS="TableRowColor">
184
<TD WIDTH="15%"><B><A HREF="NodeRecord.html">NodeRecord</A></B></TD>
185
<TD>A utility class that encapsulates a node and its data</TD>
186
</TR>
187
<TR BGCOLOR="white" CLASS="TableRowColor">
188
<TD WIDTH="15%"><B><A HREF="PINode.html">PINode</A></B></TD>
189
<TD>A Class that represents an XML PI node and its contents,</TD>
190
</TR>
191
<TR BGCOLOR="white" CLASS="TableRowColor">
192
<TD WIDTH="15%"><B><A HREF="QuerySpecification.html">QuerySpecification</A></B></TD>
193
<TD>A Class that represents a structured query, and can be 
194
 constructed from an XML serialization conforming to @see pathquery.dtd.</TD>
195
</TR>
196
<TR BGCOLOR="white" CLASS="TableRowColor">
197
<TD WIDTH="15%"><B><A HREF="relationHandler.html">relationHandler</A></B></TD>
198
<TD>&nbsp;</TD>
199
</TR>
200
<TR BGCOLOR="white" CLASS="TableRowColor">
201
<TD WIDTH="15%"><B><A HREF="TextNode.html">TextNode</A></B></TD>
202
<TD>A Class that represents an XML Text node and its contents,</TD>
203
</TR>
204
</TABLE>
205
&nbsp;
206

  
207
<P>
208

  
209
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
210
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
211
<TD COLSPAN=2><FONT SIZE="+2">
212
<B>Exception Summary</B></FONT></TD>
213
</TR>
214
<TR BGCOLOR="white" CLASS="TableRowColor">
215
<TD WIDTH="15%"><B><A HREF="AccessionNumberException.html">AccessionNumberException</A></B></TD>
216
<TD>Exception thrown when an error occurs because an AccessionNumber was 
217
 invalid or used incorrectly.</TD>
218
</TR>
219
<TR BGCOLOR="white" CLASS="TableRowColor">
220
<TD WIDTH="15%"><B><A HREF="AccessionNumberGeneratedException.html">AccessionNumberGeneratedException</A></B></TD>
221
<TD>Exception thrown when a new accession number is generated
222
 either because none was provided or it was not unique.</TD>
223
</TR>
224
<TR BGCOLOR="white" CLASS="TableRowColor">
225
<TD WIDTH="15%"><B><A HREF="McdbDocNotFoundException.html">McdbDocNotFoundException</A></B></TD>
226
<TD>Exception thrown when an error occurs because a document with a
227
 given ID could not be found in the metacat database.</TD>
228
</TR>
229
<TR BGCOLOR="white" CLASS="TableRowColor">
230
<TD WIDTH="15%"><B><A HREF="McdbException.html">McdbException</A></B></TD>
231
<TD>Exception thrown when an error occurs because a problem occurred in
232
 the metacat database.</TD>
233
</TR>
234
</TABLE>
235
&nbsp;
236

  
237
<P>
238
<HR>
239

  
240
<!-- ========== START OF NAVBAR ========== -->
241
<A NAME="navbar_bottom"><!-- --></A>
242
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
243
<TR>
244
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
245
<A NAME="navbar_bottom_firstrow"><!-- --></A>
246
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
247
  <TR ALIGN="center" VALIGN="top">
248
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
249
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
250
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
251
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
252
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
253
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
254
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
255
  </TR>
256
</TABLE>
257
</TD>
258
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
259
</EM>
260
</TD>
261
</TR>
262

  
263
<TR>
264
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
265
&nbsp;PREV PACKAGE&nbsp;
266
&nbsp;NEXT PACKAGE</FONT></TD>
267
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
268
  <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
269
&nbsp;<A HREF="package-summary.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
270
</TR>
271
</TABLE>
272
<!-- =========== END OF NAVBAR =========== -->
273

  
274
<HR>
275
<i>Copyright ? 2000 National Center for Ecological Analysis and Synthesis. All Rights Reserved.</i>
276
</BODY>
277
</HTML>
278 0

  
docs/edu/ucsb/nceas/metacat/BasicNode.html
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  BasicNode
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/BasicNode.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/AuthSession.html"><B>PREV CLASS</B></A>&nbsp;
39
&nbsp;<A HREF="../../../../edu/ucsb/nceas/metacat/CommentNode.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="BasicNode.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  BasicNode</H2>
60
<PRE>
61
java.lang.Object
62
  |
63
  +--<B>edu.ucsb.nceas.metacat.BasicNode</B>
64
</PRE>
65
<DL>
66
<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../edu/ucsb/nceas/metacat/CommentNode.html">CommentNode</A>, <A HREF="../../../../edu/ucsb/nceas/metacat/DBSAXNode.html">DBSAXNode</A>, <A HREF="../../../../edu/ucsb/nceas/metacat/ElementNode.html">ElementNode</A>, <A HREF="../../../../edu/ucsb/nceas/metacat/PINode.html">PINode</A>, <A HREF="../../../../edu/ucsb/nceas/metacat/TextNode.html">TextNode</A></DD>
67
</DL>
68
<HR>
69
<DL>
70
<DT>public class <B>BasicNode</B><DT>extends java.lang.Object</DL>
71

  
72
<P>
73
A Class that represents an XML node and its contents
74
<P>
75
<HR>
76

  
77
<P>
78
<!-- ======== INNER CLASS SUMMARY ======== -->
79

  
80

  
81
<!-- =========== FIELD SUMMARY =========== -->
82

  
83

  
84
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
85

  
86
<A NAME="constructor_summary"><!-- --></A>
87
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
88
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
89
<TD COLSPAN=2><FONT SIZE="+2">
90
<B>Constructor Summary</B></FONT></TD>
91
</TR>
92
<TR BGCOLOR="white" CLASS="TableRowColor">
93
<TD><CODE><B><A HREF="../../../../edu/ucsb/nceas/metacat/BasicNode.html#BasicNode()">BasicNode</A></B>()</CODE>
94

  
95
<BR>
96
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Construct a Basic Node</TD>
97
</TR>
98
<TR BGCOLOR="white" CLASS="TableRowColor">
99
<TD><CODE><B><A HREF="../../../../edu/ucsb/nceas/metacat/BasicNode.html#BasicNode(long, java.lang.String, long, int)">BasicNode</A></B>(long&nbsp;node_id,
100
          java.lang.String&nbsp;tagname,
101
          long&nbsp;parent_id,
102
          int&nbsp;nodeIndex)</CODE>
103

  
104
<BR>
105
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Construct a Basic Node</TD>
106
</TR>
107
<TR BGCOLOR="white" CLASS="TableRowColor">
108
<TD><CODE><B><A HREF="../../../../edu/ucsb/nceas/metacat/BasicNode.html#BasicNode(java.lang.String)">BasicNode</A></B>(java.lang.String&nbsp;tagname)</CODE>
109

  
110
<BR>
111
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Construct a Basic Node</TD>
112
</TR>
113
<TR BGCOLOR="white" CLASS="TableRowColor">
114
<TD><CODE><B><A HREF="../../../../edu/ucsb/nceas/metacat/BasicNode.html#BasicNode(java.lang.String, long, int)">BasicNode</A></B>(java.lang.String&nbsp;tagname,
115
          long&nbsp;parent_id,
116
          int&nbsp;nodeIndex)</CODE>
117

  
118
<BR>
119
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Construct a Basic Node</TD>
120
</TR>
121
</TABLE>
122
&nbsp;
123
<!-- ========== METHOD SUMMARY =========== -->
124

  
125
<A NAME="method_summary"><!-- --></A>
126
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
127
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
128
<TD COLSPAN=2><FONT SIZE="+2">
129
<B>Method Summary</B></FONT></TD>
130
</TR>
131
<TR BGCOLOR="white" CLASS="TableRowColor">
132
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
133
<CODE>&nbsp;void</CODE></FONT></TD>
134
<TD><CODE><B><A HREF="../../../../edu/ucsb/nceas/metacat/BasicNode.html#addChildNode(edu.ucsb.nceas.metacat.BasicNode)">addChildNode</A></B>(<A HREF="../../../../edu/ucsb/nceas/metacat/BasicNode.html">BasicNode</A>&nbsp;child)</CODE>
135

  
136
<BR>
137
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add a child node to this node</TD>
138
</TR>
139
<TR BGCOLOR="white" CLASS="TableRowColor">
140
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
141
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
142
<TD><CODE><B><A HREF="../../../../edu/ucsb/nceas/metacat/BasicNode.html#getAttribute(java.lang.String)">getAttribute</A></B>(java.lang.String&nbsp;attName)</CODE>
143

  
144
<BR>
145
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get an attribute value by name</TD>
146
</TR>
147
<TR BGCOLOR="white" CLASS="TableRowColor">
148
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
149
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
150
<TD><CODE><B><A HREF="../../../../edu/ucsb/nceas/metacat/BasicNode.html#getAttributes()">getAttributes</A></B>()</CODE>
151

  
152
<BR>
153
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the attributes as a string</TD>
154
</TR>
155
<TR BGCOLOR="white" CLASS="TableRowColor">
156
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
157
<CODE>&nbsp;java.util.Enumeration</CODE></FONT></TD>
158
<TD><CODE><B><A HREF="../../../../edu/ucsb/nceas/metacat/BasicNode.html#getChildren()">getChildren</A></B>()</CODE>
159

  
160
<BR>
161
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the an enumeration of the children of this node</TD>
162
</TR>
163
<TR BGCOLOR="white" CLASS="TableRowColor">
164
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
165
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
166
<TD><CODE><B><A HREF="../../../../edu/ucsb/nceas/metacat/BasicNode.html#getDocID()">getDocID</A></B>()</CODE>
167

  
168
<BR>
169
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the doc id of this node</TD>
170
</TR>
171
<TR BGCOLOR="white" CLASS="TableRowColor">
172
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
173
<CODE>&nbsp;long</CODE></FONT></TD>
174
<TD><CODE><B><A HREF="../../../../edu/ucsb/nceas/metacat/BasicNode.html#getNodeID()">getNodeID</A></B>()</CODE>
175

  
176
<BR>
177
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the id of this node</TD>
178
</TR>
179
<TR BGCOLOR="white" CLASS="TableRowColor">
180
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
181
<CODE>&nbsp;int</CODE></FONT></TD>
182
<TD><CODE><B><A HREF="../../../../edu/ucsb/nceas/metacat/BasicNode.html#getNodeIndex()">getNodeIndex</A></B>()</CODE>
183

  
184
<BR>
185
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get nodeIndex of the node</TD>
186
</TR>
187
<TR BGCOLOR="white" CLASS="TableRowColor">
188
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
189
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
190
<TD><CODE><B><A HREF="../../../../edu/ucsb/nceas/metacat/BasicNode.html#getNodeType()">getNodeType</A></B>()</CODE>
191

  
192
<BR>
193
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the type of this node</TD>
194
</TR>
195
<TR BGCOLOR="white" CLASS="TableRowColor">
196
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
197
<CODE>&nbsp;long</CODE></FONT></TD>
198
<TD><CODE><B><A HREF="../../../../edu/ucsb/nceas/metacat/BasicNode.html#getParentID()">getParentID</A></B>()</CODE>
199

  
200
<BR>
201
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the parent id of this node</TD>
202
</TR>
203
<TR BGCOLOR="white" CLASS="TableRowColor">
204
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
205
<CODE>&nbsp;long</CODE></FONT></TD>
206
<TD><CODE><B><A HREF="../../../../edu/ucsb/nceas/metacat/BasicNode.html#getRootNodeID()">getRootNodeID</A></B>()</CODE>
207

  
208
<BR>
209
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the root node id of this node</TD>
210
</TR>
211
<TR BGCOLOR="white" CLASS="TableRowColor">
212
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
213
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
214
<TD><CODE><B><A HREF="../../../../edu/ucsb/nceas/metacat/BasicNode.html#getTagName()">getTagName</A></B>()</CODE>
215

  
216
<BR>
217
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the name of this node</TD>
218
</TR>
219
<TR BGCOLOR="white" CLASS="TableRowColor">
220
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
221
<CODE>&nbsp;int</CODE></FONT></TD>
222
<TD><CODE><B><A HREF="../../../../edu/ucsb/nceas/metacat/BasicNode.html#incChildNum()">incChildNum</A></B>()</CODE>
223

  
224
<BR>
225
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;increase childNum when new child for the node is created</TD>
226
</TR>
227
<TR BGCOLOR="white" CLASS="TableRowColor">
228
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
229
<CODE>&nbsp;void</CODE></FONT></TD>
230
<TD><CODE><B><A HREF="../../../../edu/ucsb/nceas/metacat/BasicNode.html#setAttribute(java.lang.String, java.lang.String)">setAttribute</A></B>(java.lang.String&nbsp;attName,
231
             java.lang.String&nbsp;attValue)</CODE>
232

  
233
<BR>
234
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add a new attribute to this node, or set its value</TD>
235
</TR>
236
<TR BGCOLOR="white" CLASS="TableRowColor">
237
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
238
<CODE>&nbsp;void</CODE></FONT></TD>
239
<TD><CODE><B><A HREF="../../../../edu/ucsb/nceas/metacat/BasicNode.html#setDocID(java.lang.String)">setDocID</A></B>(java.lang.String&nbsp;doc_id)</CODE>
240

  
241
<BR>
242
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the doc id of this node</TD>
243
</TR>
244
<TR BGCOLOR="white" CLASS="TableRowColor">
245
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
246
<CODE>&nbsp;void</CODE></FONT></TD>
247
<TD><CODE><B><A HREF="../../../../edu/ucsb/nceas/metacat/BasicNode.html#setNodeID(long)">setNodeID</A></B>(long&nbsp;node_id)</CODE>
248

  
249
<BR>
250
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the id of this node</TD>
251
</TR>
252
<TR BGCOLOR="white" CLASS="TableRowColor">
253
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
254
<CODE>&nbsp;void</CODE></FONT></TD>
255
<TD><CODE><B><A HREF="../../../../edu/ucsb/nceas/metacat/BasicNode.html#setNodeIndex(int)">setNodeIndex</A></B>(int&nbsp;nodeIndex)</CODE>
256

  
257
<BR>
258
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the node index of this node</TD>
259
</TR>
260
<TR BGCOLOR="white" CLASS="TableRowColor">
261
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
262
<CODE>&nbsp;void</CODE></FONT></TD>
263
<TD><CODE><B><A HREF="../../../../edu/ucsb/nceas/metacat/BasicNode.html#setNodeType(java.lang.String)">setNodeType</A></B>(java.lang.String&nbsp;type)</CODE>
264

  
265
<BR>
266
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the type of this node</TD>
267
</TR>
268
<TR BGCOLOR="white" CLASS="TableRowColor">
269
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
270
<CODE>&nbsp;void</CODE></FONT></TD>
271
<TD><CODE><B><A HREF="../../../../edu/ucsb/nceas/metacat/BasicNode.html#setParentID(long)">setParentID</A></B>(long&nbsp;parent_id)</CODE>
272

  
273
<BR>
274
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the parent id of this node</TD>
275
</TR>
276
<TR BGCOLOR="white" CLASS="TableRowColor">
277
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
278
<CODE>&nbsp;void</CODE></FONT></TD>
279
<TD><CODE><B><A HREF="../../../../edu/ucsb/nceas/metacat/BasicNode.html#setRootNodeID(long)">setRootNodeID</A></B>(long&nbsp;rootnode_id)</CODE>
280

  
281
<BR>
282
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the root node id of this node</TD>
283
</TR>
284
<TR BGCOLOR="white" CLASS="TableRowColor">
285
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
286
<CODE>&nbsp;void</CODE></FONT></TD>
287
<TD><CODE><B><A HREF="../../../../edu/ucsb/nceas/metacat/BasicNode.html#setTagName(java.lang.String)">setTagName</A></B>(java.lang.String&nbsp;tagname)</CODE>
288

  
289
<BR>
290
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the name of this node</TD>
291
</TR>
292
</TABLE>
293
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
294
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
295
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
296
<TD><B>Methods inherited from class java.lang.Object</B></TD>
297
</TR>
298
<TR BGCOLOR="white" CLASS="TableRowColor">
299
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
300
</TR>
301
</TABLE>
302
&nbsp;
303
<P>
304

  
305
<!-- ============ FIELD DETAIL =========== -->
306

  
307

  
308
<!-- ========= CONSTRUCTOR DETAIL ======== -->
309

  
310
<A NAME="constructor_detail"><!-- --></A>
311
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
312
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
313
<TD COLSPAN=1><FONT SIZE="+2">
314
<B>Constructor Detail</B></FONT></TD>
315
</TR>
316
</TABLE>
317

  
318
<A NAME="BasicNode()"><!-- --></A><H3>
319
BasicNode</H3>
320
<PRE>
321
public <B>BasicNode</B>()</PRE>
322
<DL>
323
<DD>Construct a Basic Node</DL>
324
<HR>
325

  
326
<A NAME="BasicNode(java.lang.String)"><!-- --></A><H3>
327
BasicNode</H3>
328
<PRE>
329
public <B>BasicNode</B>(java.lang.String&nbsp;tagname)</PRE>
330
<DL>
331
<DD>Construct a Basic Node<DD><DL>
332
<DT><B>Parameters:</B><DD><CODE>tagname</CODE> - the name of the node</DL>
333
</DD>
334
</DL>
335
<HR>
336

  
337
<A NAME="BasicNode(java.lang.String, long, int)"><!-- --></A><H3>
338
BasicNode</H3>
339
<PRE>
340
public <B>BasicNode</B>(java.lang.String&nbsp;tagname,
341
                 long&nbsp;parent_id,
342
                 int&nbsp;nodeIndex)</PRE>
343
<DL>
344
<DD>Construct a Basic Node<DD><DL>
345
<DT><B>Parameters:</B><DD><CODE>tagname</CODE> - the name of the node<DD><CODE>parent_id</CODE> - the id number of the parent node<DD><CODE>nodeIndex</CODE> - - index of node among siblings in parent node
346
                    Every node initializes childNum to 0 when 
347
                    created and has interface incChildNum
348
                    when new child is created</DL>
349
</DD>
350
</DL>
351
<HR>
352

  
353
<A NAME="BasicNode(long, java.lang.String, long, int)"><!-- --></A><H3>
354
BasicNode</H3>
355
<PRE>
356
public <B>BasicNode</B>(long&nbsp;node_id,
357
                 java.lang.String&nbsp;tagname,
358
                 long&nbsp;parent_id,
359
                 int&nbsp;nodeIndex)</PRE>
360
<DL>
361
<DD>Construct a Basic Node<DD><DL>
362
<DT><B>Parameters:</B><DD><CODE>node_id</CODE> - the id number of the node<DD><CODE>tagname</CODE> - the name of the node<DD><CODE>parent_id</CODE> - the id number of the parent node</DL>
363
</DD>
364
</DL>
365

  
366
<!-- ============ METHOD DETAIL ========== -->
367

  
368
<A NAME="method_detail"><!-- --></A>
369
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
370
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
371
<TD COLSPAN=1><FONT SIZE="+2">
372
<B>Method Detail</B></FONT></TD>
373
</TR>
374
</TABLE>
375

  
376
<A NAME="getNodeID()"><!-- --></A><H3>
377
getNodeID</H3>
378
<PRE>
379
public long <B>getNodeID</B>()</PRE>
380
<DL>
381
<DD>Get the id of this node</DL>
382
<HR>
383

  
384
<A NAME="setNodeID(long)"><!-- --></A><H3>
385
setNodeID</H3>
386
<PRE>
387
public void <B>setNodeID</B>(long&nbsp;node_id)</PRE>
388
<DL>
389
<DD>Set the id of this node</DL>
390
<HR>
391

  
392
<A NAME="getParentID()"><!-- --></A><H3>
393
getParentID</H3>
394
<PRE>
395
public long <B>getParentID</B>()</PRE>
396
<DL>
397
<DD>Get the parent id of this node</DL>
398
<HR>
399

  
400
<A NAME="setParentID(long)"><!-- --></A><H3>
401
setParentID</H3>
402
<PRE>
403
public void <B>setParentID</B>(long&nbsp;parent_id)</PRE>
404
<DL>
405
<DD>Set the parent id of this node</DL>
406
<HR>
407

  
408
<A NAME="getRootNodeID()"><!-- --></A><H3>
409
getRootNodeID</H3>
410
<PRE>
411
public long <B>getRootNodeID</B>()</PRE>
412
<DL>
413
<DD>Get the root node id of this node</DL>
414
<HR>
415

  
416
<A NAME="setRootNodeID(long)"><!-- --></A><H3>
417
setRootNodeID</H3>
418
<PRE>
419
public void <B>setRootNodeID</B>(long&nbsp;rootnode_id)</PRE>
420
<DL>
421
<DD>Set the root node id of this node</DL>
422
<HR>
423

  
424
<A NAME="getDocID()"><!-- --></A><H3>
425
getDocID</H3>
426
<PRE>
427
public java.lang.String <B>getDocID</B>()</PRE>
428
<DL>
429
<DD>Get the doc id of this node</DL>
430
<HR>
431

  
432
<A NAME="setDocID(java.lang.String)"><!-- --></A><H3>
433
setDocID</H3>
434
<PRE>
435
public void <B>setDocID</B>(java.lang.String&nbsp;doc_id)</PRE>
436
<DL>
437
<DD>Set the doc id of this node</DL>
438
<HR>
439

  
440
<A NAME="getTagName()"><!-- --></A><H3>
441
getTagName</H3>
442
<PRE>
443
public java.lang.String <B>getTagName</B>()</PRE>
444
<DL>
445
<DD>Get the name of this node</DL>
446
<HR>
447

  
448
<A NAME="setTagName(java.lang.String)"><!-- --></A><H3>
449
setTagName</H3>
450
<PRE>
451
public void <B>setTagName</B>(java.lang.String&nbsp;tagname)</PRE>
452
<DL>
453
<DD>Set the name of this node</DL>
454
<HR>
455

  
456
<A NAME="getAttributes()"><!-- --></A><H3>
457
getAttributes</H3>
458
<PRE>
459
public java.lang.String <B>getAttributes</B>()</PRE>
460
<DL>
461
<DD>Get the attributes as a string</DL>
462
<HR>
463

  
464
<A NAME="setAttribute(java.lang.String, java.lang.String)"><!-- --></A><H3>
465
setAttribute</H3>
466
<PRE>
467
public void <B>setAttribute</B>(java.lang.String&nbsp;attName,
468
                         java.lang.String&nbsp;attValue)</PRE>
469
<DL>
470
<DD>Add a new attribute to this node, or set its value</DL>
471
<HR>
472

  
473
<A NAME="getAttribute(java.lang.String)"><!-- --></A><H3>
474
getAttribute</H3>
475
<PRE>
476
public java.lang.String <B>getAttribute</B>(java.lang.String&nbsp;attName)</PRE>
477
<DL>
478
<DD>Get an attribute value by name</DL>
479
<HR>
480

  
481
<A NAME="getNodeIndex()"><!-- --></A><H3>
482
getNodeIndex</H3>
483
<PRE>
484
public int <B>getNodeIndex</B>()</PRE>
485
<DL>
486
<DD>Get nodeIndex of the node</DL>
487
<HR>
488

  
489
<A NAME="setNodeIndex(int)"><!-- --></A><H3>
490
setNodeIndex</H3>
491
<PRE>
492
public void <B>setNodeIndex</B>(int&nbsp;nodeIndex)</PRE>
493
<DL>
494
<DD>Set the node index of this node</DL>
495
<HR>
496

  
497
<A NAME="getNodeType()"><!-- --></A><H3>
498
getNodeType</H3>
499
<PRE>
500
public java.lang.String <B>getNodeType</B>()</PRE>
501
<DL>
502
<DD>Get the type of this node</DL>
503
<HR>
504

  
505
<A NAME="setNodeType(java.lang.String)"><!-- --></A><H3>
506
setNodeType</H3>
507
<PRE>
508
public void <B>setNodeType</B>(java.lang.String&nbsp;type)</PRE>
509
<DL>
510
<DD>Set the type of this node</DL>
511
<HR>
512

  
513
<A NAME="addChildNode(edu.ucsb.nceas.metacat.BasicNode)"><!-- --></A><H3>
514
addChildNode</H3>
515
<PRE>
516
public void <B>addChildNode</B>(<A HREF="../../../../edu/ucsb/nceas/metacat/BasicNode.html">BasicNode</A>&nbsp;child)</PRE>
517
<DL>
518
<DD>Add a child node to this node</DL>
519
<HR>
520

  
521
<A NAME="getChildren()"><!-- --></A><H3>
522
getChildren</H3>
523
<PRE>
524
public java.util.Enumeration <B>getChildren</B>()</PRE>
525
<DL>
526
<DD>Get the an enumeration of the children of this node</DL>
527
<HR>
528

  
529
<A NAME="incChildNum()"><!-- --></A><H3>
530
incChildNum</H3>
531
<PRE>
532
public int <B>incChildNum</B>()</PRE>
533
<DL>
534
<DD>increase childNum when new child for the node is created</DL>
535
<!-- ========= END OF CLASS DATA ========= -->
536
<HR>
537

  
538
<!-- ========== START OF NAVBAR ========== -->
539
<A NAME="navbar_bottom"><!-- --></A>
540
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
541
<TR>
542
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
543
<A NAME="navbar_bottom_firstrow"><!-- --></A>
544
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
545
  <TR ALIGN="center" VALIGN="top">
546
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
547
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
548
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/BasicNode.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
549
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
550
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
551
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
552
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
553
  </TR>
554
</TABLE>
555
</TD>
556
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
557
</EM>
558
</TD>
559
</TR>
560

  
561
<TR>
562
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
563
&nbsp;<A HREF="../../../../edu/ucsb/nceas/metacat/AuthSession.html"><B>PREV CLASS</B></A>&nbsp;
564
&nbsp;<A HREF="../../../../edu/ucsb/nceas/metacat/CommentNode.html"><B>NEXT CLASS</B></A></FONT></TD>
565
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
566
  <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
567
&nbsp;<A HREF="BasicNode.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
568
</TR>
569
<TR>
570
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
571
  SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
572
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
573
DETAIL: &nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
574
</TR>
575
</TABLE>
576
<!-- =========== END OF NAVBAR =========== -->
577

  
578
<HR>
579
<i>Copyright ? 2000 National Center for Ecological Analysis and Synthesis. All Rights Reserved.</i>
580
</BODY>
581
</HTML>
582 0

  
... This diff was truncated because it exceeds the maximum size that can be displayed.

Also available in: Unified diff