Project

General

Profile

« Previous | Next » 

Revision 60

Added by Matt Jones over 24 years ago

updated javadoc documentation for changes

View differences:

src/edu/ucsb/nceas/metacat/MetaCatServlet.java
47 47 
   * qformat=html -- display resultset from query in HTML<br>
48 48 
   * action=getdocument -- display an XML document in XML or HTML<br>
49 49 
   * docid=34 -- display the document with the document ID number 34<br>
50 
   * action=putdocument -- load an XML document into the database store<br>
51 
   * doctext -- XML text ofthe document to load into the database<br>
50 52 
 */
51 53 
public class MetaCatServlet extends HttpServlet {
52 54 

  		












  

    
      docs/serialized-form.html
    
  





  2
  2
  
    
<!--NewPage-->


  		




  3
  3
  
    
<HTML>


  		




  4
  4
  
    
<HEAD>


  		




  5
  
  
    
<!-- Generated by javadoc on Mon Apr 17 15:35:35 AKDT 2000 -->


  		




  
  5
  
    
<!-- Generated by javadoc on Tue Apr 18 13:19:08 AKDT 2000 -->


  		




  6
  6
  
    
<TITLE>


  		




  7
  7
  
    
Serialized Form


  		




  8
  8
  
    
</TITLE>


  		




  ......




  84
  84
  
    
<HR>


  		




  85
  85
  
    

  		




  86
  86
  
    
<H3>


  		




  
  87
  
    
conn</H3>


  		




  
  88
  
    
<PRE>


  		




  
  89
  
    
java.sql.Connection <B>conn</B></PRE>


  		




  
  90
  
    
<DL>


  		




  
  91
  
    
</DL>


  		




  
  92
  
    
<HR>


  		




  
  93
  
    

  		




  
  94
  
    
<H3>


  		




  87
  95
  
    
context</H3>


  		




  88
  96
  
    
<PRE>


  		




  89
  97
  
    
javax.servlet.ServletContext <B>context</B></PRE>


  		












  

    
      docs/index-all.html
    
  





  2
  2
  
    
<!--NewPage-->


  		




  3
  3
  
    
<HTML>


  		




  4
  4
  
    
<HEAD>


  		




  5
  
  
    
<!-- Generated by javadoc on Mon Apr 17 15:35:34 AKDT 2000 -->


  		




  
  5
  
    
<!-- Generated by javadoc on Tue Apr 18 13:19:07 AKDT 2000 -->


  		




  6
  6
  
    
<TITLE>


  		




  7
  7
  
    
: Index


  		




  8
  8
  
    
</TITLE>


  		




  ......




  93
  93
  
    
Constructor for class edu.ucsb.nceas.metacat.<A HREF="edu/ucsb/nceas/metacat/DBSAXHandler.html">DBSAXHandler</A>


  		




  94
  94
  
    
<DD>Construct an instance of the handler class


  		




  95
  95
  
    
<DT><A HREF="edu/ucsb/nceas/metacat/DBSAXWriter.html"><B>DBSAXWriter</B></A> - class edu.ucsb.nceas.metacat.<A HREF="edu/ucsb/nceas/metacat/DBSAXWriter.html">DBSAXWriter</A>.<DD>A Class that reads in an XML text document and


  		




  96
  
  
    
 write its contents to a database connection using SAX<DT><A HREF="edu/ucsb/nceas/metacat/DBSAXWriter.html#DBSAXWriter(java.lang.String, java.sql.Connection)"><B>DBSAXWriter(String, Connection)</B></A> - 


  		




  
  96
  
    
 write its contents to a database connection using SAX<DT><A HREF="edu/ucsb/nceas/metacat/DBSAXWriter.html#DBSAXWriter(java.io.Reader, java.sql.Connection)"><B>DBSAXWriter(Reader, Connection)</B></A> - 


  		




  97
  97
  
    
Constructor for class edu.ucsb.nceas.metacat.<A HREF="edu/ucsb/nceas/metacat/DBSAXWriter.html">DBSAXWriter</A>


  		




  98
  98
  
    
<DD>construct a new instance of the class to write an XML file to the database


  		




  
  99
  
    
<DT><A HREF="edu/ucsb/nceas/metacat/DBSAXWriter.html#DBSAXWriter(java.lang.String, java.sql.Connection)"><B>DBSAXWriter(String, Connection)</B></A> - 


  		




  
  100
  
    
Constructor for class edu.ucsb.nceas.metacat.<A HREF="edu/ucsb/nceas/metacat/DBSAXWriter.html">DBSAXWriter</A>


  		




  
  101
  
    
<DD>&nbsp;


  		




  99
  102
  
    
<DT><A HREF="edu/ucsb/nceas/metacat/DBSimpleQuery.html"><B>DBSimpleQuery</B></A> - class edu.ucsb.nceas.metacat.<A HREF="edu/ucsb/nceas/metacat/DBSimpleQuery.html">DBSimpleQuery</A>.<DD>A Class that searches a relational DB for elements and attributes that


  		




  100
  103
  
    
 have free text matches to the query string.<DT><A HREF="edu/ucsb/nceas/metacat/DBSimpleQuery.html#DBSimpleQuery(java.sql.Connection)"><B>DBSimpleQuery(Connection)</B></A> - 


  		




  101
  104
  
    
Constructor for class edu.ucsb.nceas.metacat.<A HREF="edu/ucsb/nceas/metacat/DBSimpleQuery.html">DBSimpleQuery</A>


  		












  

    
      docs/allclasses-frame.html
    
  





  2
  2
  
    
<!--NewPage-->


  		




  3
  3
  
    
<HTML>


  		




  4
  4
  
    
<HEAD>


  		




  5
  
  
    
<!-- Generated by javadoc on Mon Apr 17 15:35:34 AKDT 2000 -->


  		




  
  5
  
    
<!-- Generated by javadoc on Tue Apr 18 13:19:07 AKDT 2000 -->


  		




  6
  6
  
    
<TITLE>


  		




  7
  7
  
    
All Classes


  		




  8
  8
  
    
</TITLE>


  		












  

    
      docs/packages.html
    
  





  2
  2
  
    
<!--NewPage-->


  		




  3
  3
  
    
<HTML>


  		




  4
  4
  
    
<HEAD>


  		




  5
  
  
    
<!-- Generated by javadoc on Mon Apr 17 15:35:34 AKDT 2000 -->


  		




  
  5
  
    
<!-- Generated by javadoc on Tue Apr 18 13:19:07 AKDT 2000 -->


  		




  6
  6
  
    
<TITLE>


  		




  7
  7
  
    

  		




  8
  8
  
    
</TITLE>


  		












  

    
      docs/overview-tree.html
    
  





  2
  2
  
    
<!--NewPage-->


  		




  3
  3
  
    
<HTML>


  		




  4
  4
  
    
<HEAD>


  		




  5
  
  
    
<!-- Generated by javadoc on Mon Apr 17 15:35:34 AKDT 2000 -->


  		




  
  5
  
    
<!-- Generated by javadoc on Tue Apr 18 13:19:07 AKDT 2000 -->


  		




  6
  6
  
    
<TITLE>


  		




  7
  7
  
    
: Class Hierarchy


  		




  8
  8
  
    
</TITLE>


  		












  

    
      docs/index.html
    
  





  2
  2
  
    
<!--NewPage-->


  		




  3
  3
  
    
<HTML>


  		




  4
  4
  
    
<HEAD>


  		




  5
  
  
    
<!-- Generated by javadoc on Mon Apr 17 15:35:34 AKDT 2000-->


  		




  
  5
  
    
<!-- Generated by javadoc on Tue Apr 18 13:19:07 AKDT 2000-->


  		




  6
  6
  
    
<TITLE>


  		




  7
  7
  
    
Generated Documentation (Untitled)


  		




  8
  8
  
    
</TITLE>


  		












  

    
      docs/deprecated-list.html
    
  





  2
  2
  
    
<!--NewPage-->


  		




  3
  3
  
    
<HTML>


  		




  4
  4
  
    
<HEAD>


  		




  5
  
  
    
<!-- Generated by javadoc on Mon Apr 17 15:35:34 AKDT 2000 -->


  		




  
  5
  
    
<!-- Generated by javadoc on Tue Apr 18 13:19:07 AKDT 2000 -->


  		




  6
  6
  
    
<TITLE>


  		




  7
  7
  
    
: Deprecated List


  		




  8
  8
  
    
</TITLE>


  		












  

    
      docs/edu/ucsb/nceas/metacat/MetaCatUtil.html
    
  





  2
  2
  
    
<!--NewPage-->


  		




  3
  3
  
    
<HTML>


  		




  4
  4
  
    
<HEAD>


  		




  5
  
  
    
<!-- Generated by javadoc on Mon Apr 17 15:35:35 AKDT 2000 -->


  		




  
  5
  
    
<!-- Generated by javadoc on Tue Apr 18 13:19:07 AKDT 2000 -->


  		




  6
  6
  
    
<TITLE>


  		




  7
  7
  
    
: Class  MetaCatUtil


  		




  8
  8
  
    
</TITLE>


  		












  

    
      docs/edu/ucsb/nceas/metacat/ReaderElement.html
    
  





  2
  2
  
    
<!--NewPage-->


  		




  3
  3
  
    
<HTML>


  		




  4
  4
  
    
<HEAD>


  		




  5
  
  
    
<!-- Generated by javadoc on Mon Apr 17 15:35:35 AKDT 2000 -->


  		




  
  5
  
    
<!-- Generated by javadoc on Tue Apr 18 13:19:08 AKDT 2000 -->


  		




  6
  6
  
    
<TITLE>


  		




  7
  7
  
    
: Class  ReaderElement


  		




  8
  8
  
    
</TITLE>


  		












  

    
      docs/edu/ucsb/nceas/metacat/DBSAXWriter.html
    
  





  2
  2
  
    
<!--NewPage-->


  		




  3
  3
  
    
<HTML>


  		




  4
  4
  
    
<HEAD>


  		




  5
  
  
    
<!-- Generated by javadoc on Mon Apr 17 15:35:35 AKDT 2000 -->


  		




  
  5
  
    
<!-- Generated by javadoc on Tue Apr 18 13:19:07 AKDT 2000 -->


  		




  6
  6
  
    
<TITLE>


  		




  7
  7
  
    
: Class  DBSAXWriter


  		




  8
  8
  
    
</TITLE>


  		




  ......




  87
  87
  
    
<B>Constructor Summary</B></FONT></TD>


  		




  88
  88
  
    
</TR>


  		




  89
  89
  
    
<TR BGCOLOR="white" CLASS="TableRowColor">


  		




  90
  
  
    
<TD><CODE><B><A HREF="../../../../edu/ucsb/nceas/metacat/DBSAXWriter.html#DBSAXWriter(java.lang.String, java.sql.Connection)">DBSAXWriter</A></B>(java.lang.String&nbsp;filename,


  		




  
  90
  
    
<TD><CODE><B><A HREF="../../../../edu/ucsb/nceas/metacat/DBSAXWriter.html#DBSAXWriter(java.io.Reader, java.sql.Connection)">DBSAXWriter</A></B>(java.io.Reader&nbsp;xml,


  		




  91
  91
  
    
            java.sql.Connection&nbsp;conn)</CODE>


  		




  92
  92
  
    

  		




  93
  93
  
    
<BR>


  		




  94
  94
  
    
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;construct a new instance of the class to write an XML file to the database</TD>


  		




  95
  95
  
    
</TR>


  		




  
  96
  
    
<TR BGCOLOR="white" CLASS="TableRowColor">


  		




  
  97
  
    
<TD><CODE><B><A HREF="../../../../edu/ucsb/nceas/metacat/DBSAXWriter.html#DBSAXWriter(java.lang.String, java.sql.Connection)">DBSAXWriter</A></B>(java.lang.String&nbsp;filename,


  		




  
  98
  
    
            java.sql.Connection&nbsp;conn)</CODE>


  		




  
  99
  
    

  		




  
  100
  
    
<BR>


  		




  
  101
  
    
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>


  		




  
  102
  
    
</TR>


  		




  96
  103
  
    
</TABLE>


  		




  97
  104
  
    
&nbsp;


  		




  98
  105
  
    
<!-- ========== METHOD SUMMARY =========== -->


  		




  ......




  155
  162
  
    
</TR>


  		




  156
  163
  
    
</TABLE>


  		




  157
  164
  
    

  		




  158
  
  
    
<A NAME="DBSAXWriter(java.lang.String, java.sql.Connection)"><!-- --></A><H3>


  		




  
  165
  
    
<A NAME="DBSAXWriter(java.io.Reader, java.sql.Connection)"><!-- --></A><H3>


  		




  159
  166
  
    
DBSAXWriter</H3>


  		




  160
  167
  
    
<PRE>


  		




  161
  
  
    
public <B>DBSAXWriter</B>(java.lang.String&nbsp;filename,


  		




  
  168
  
    
public <B>DBSAXWriter</B>(java.io.Reader&nbsp;xml,


  		




  162
  169
  
    
                   java.sql.Connection&nbsp;conn)


  		




  163
  170
  
    
            throws java.io.IOException,


  		




  164
  171
  
    
                   java.sql.SQLException,


  		




  ......




  168
  175
  
    
<DT><B>Parameters:</B><DD><CODE>filename</CODE> - the filename to be loaded into the database<DD><CODE>conn</CODE> - the database connection to which to write the XML file</DL>


  		




  169
  176
  
    
</DD>


  		




  170
  177
  
    
</DL>


  		




  
  178
  
    
<HR>


  		




  171
  179
  
    

  		




  
  180
  
    
<A NAME="DBSAXWriter(java.lang.String, java.sql.Connection)"><!-- --></A><H3>


  		




  
  181
  
    
DBSAXWriter</H3>


  		




  
  182
  
    
<PRE>


  		




  
  183
  
    
public <B>DBSAXWriter</B>(java.lang.String&nbsp;filename,


  		




  
  184
  
    
                   java.sql.Connection&nbsp;conn)


  		




  
  185
  
    
            throws java.io.IOException,


  		




  
  186
  
    
                   java.sql.SQLException,


  		




  
  187
  
    
                   java.lang.ClassNotFoundException</PRE>


  		




  
  188
  
    
<DL>


  		




  
  189
  
    
</DL>


  		




  
  190
  
    

  		




  172
  191
  
    
<!-- ============ METHOD DETAIL ========== -->


  		




  173
  192
  
    

  		




  174
  193
  
    
<A NAME="method_detail"><!-- --></A>


  		












  

    
      docs/edu/ucsb/nceas/metacat/DBSAXHandler.html
    
  





  2
  2
  
    
<!--NewPage-->


  		




  3
  3
  
    
<HTML>


  		




  4
  4
  
    
<HEAD>


  		




  5
  
  
    
<!-- Generated by javadoc on Mon Apr 17 15:35:35 AKDT 2000 -->


  		




  
  5
  
    
<!-- Generated by javadoc on Tue Apr 18 13:19:07 AKDT 2000 -->


  		




  6
  6
  
    
<TITLE>


  		




  7
  7
  
    
: Class  DBSAXHandler


  		




  8
  8
  
    
</TITLE>


  		












  

    
      docs/edu/ucsb/nceas/metacat/MetaCatServlet.html
    
  





  2
  2
  
    
<!--NewPage-->


  		




  3
  3
  
    
<HTML>


  		




  4
  4
  
    
<HEAD>


  		




  5
  
  
    
<!-- Generated by javadoc on Mon Apr 17 15:35:35 AKDT 2000 -->


  		




  
  5
  
    
<!-- Generated by javadoc on Tue Apr 18 13:19:07 AKDT 2000 -->


  		




  6
  6
  
    
<TITLE>


  		




  7
  7
  
    
: Class  MetaCatServlet


  		




  8
  8
  
    
</TITLE>


  		




  ......




  80
  80
  
    
 qformat=html -- display resultset from query in HTML<br>


  		




  81
  81
  
    
 action=getdocument -- display an XML document in XML or HTML<br>


  		




  82
  82
  
    
 docid=34 -- display the document with the document ID number 34<br>


  		




  
  83
  
    
 action=putdocument -- load an XML document into the database store<br>


  		




  
  84
  
    
 doctext -- XML text ofthe document to load into the database<br>


  		




  83
  85
  
    
<P>


  		




  84
  86
  
    
<DL>


  		




  85
  87
  
    
<DT><B>See Also: </B><DD><A HREF="../../../../serialized-form.html#edu.ucsb.nceas.metacat.MetaCatServlet">Serialized Form</A></DL>


  		












  

    
      docs/edu/ucsb/nceas/metacat/package-frame.html
    
  





  2
  2
  
    
<!--NewPage-->


  		




  3
  3
  
    
<HTML>


  		




  4
  4
  
    
<HEAD>


  		




  5
  
  
    
<!-- Generated by javadoc on Mon Apr 17 15:35:34 AKDT 2000 -->


  		




  
  5
  
    
<!-- Generated by javadoc on Tue Apr 18 13:19:07 AKDT 2000 -->


  		




  6
  6
  
    
<TITLE>


  		




  7
  7
  
    
: Package edu.ucsb.nceas.metacat


  		




  8
  8
  
    
</TITLE>


  		












  

    
      docs/edu/ucsb/nceas/metacat/DBSimpleQuery.html
    
  





  2
  2
  
    
<!--NewPage-->


  		




  3
  3
  
    
<HTML>


  		




  4
  4
  
    
<HEAD>


  		




  5
  
  
    
<!-- Generated by javadoc on Mon Apr 17 15:35:35 AKDT 2000 -->


  		




  
  5
  
    
<!-- Generated by javadoc on Tue Apr 18 13:19:07 AKDT 2000 -->


  		




  6
  6
  
    
<TITLE>


  		




  7
  7
  
    
: Class  DBSimpleQuery


  		




  8
  8
  
    
</TITLE>


  		












  

    
      docs/edu/ucsb/nceas/metacat/package-summary.html
    
  





  2
  2
  
    
<!--NewPage-->


  		




  3
  3
  
    
<HTML>


  		




  4
  4
  
    
<HEAD>


  		




  5
  
  
    
<!-- Generated by javadoc on Mon Apr 17 15:35:34 AKDT 2000 -->


  		




  
  5
  
    
<!-- Generated by javadoc on Tue Apr 18 13:19:07 AKDT 2000 -->


  		




  6
  6
  
    
<TITLE>


  		




  7
  7
  
    
: Package edu.ucsb.nceas.metacat


  		




  8
  8
  
    
</TITLE>


  		












  

    
      docs/edu/ucsb/nceas/metacat/DBReader.html
    
  





  2
  2
  
    
<!--NewPage-->


  		




  3
  3
  
    
<HTML>


  		




  4
  4
  
    
<HEAD>


  		




  5
  
  
    
<!-- Generated by javadoc on Mon Apr 17 15:35:35 AKDT 2000 -->


  		




  
  5
  
    
<!-- Generated by javadoc on Tue Apr 18 13:19:07 AKDT 2000 -->


  		




  6
  6
  
    
<TITLE>


  		




  7
  7
  
    
: Class  DBReader


  		




  8
  8
  
    
</TITLE>


  		












  

    
      docs/edu/ucsb/nceas/metacat/package-tree.html
    
  





  2
  2
  
    
<!--NewPage-->


  		




  3
  3
  
    
<HTML>


  		




  4
  4
  
    
<HEAD>


  		




  5
  
  
    
<!-- Generated by javadoc on Mon Apr 17 15:35:34 AKDT 2000 -->


  		




  
  5
  
    
<!-- Generated by javadoc on Tue Apr 18 13:19:07 AKDT 2000 -->


  		




  6
  6
  
    
<TITLE>


  		




  7
  7
  
    
: edu.ucsb.nceas.metacat Class Hierarchy


  		




  8
  8
  
    
</TITLE>


  		












  

    
      docs/edu/ucsb/nceas/metacat/BasicElement.html
    
  





  2
  2
  
    
<!--NewPage-->


  		




  3
  3
  
    
<HTML>


  		




  4
  4
  
    
<HEAD>


  		




  5
  
  
    
<!-- Generated by javadoc on Mon Apr 17 15:35:34 AKDT 2000 -->


  		




  
  5
  
    
<!-- Generated by javadoc on Tue Apr 18 13:19:07 AKDT 2000 -->


  		




  6
  6
  
    
<TITLE>


  		




  7
  7
  
    
: Class  BasicElement


  		




  8
  8
  
    
</TITLE>


  		












  

    
      docs/edu/ucsb/nceas/metacat/DBSAXElement.html
    
  





  2
  2
  
    
<!--NewPage-->


  		




  3
  3
  
    
<HTML>


  		




  4
  4
  
    
<HEAD>


  		




  5
  
  
    
<!-- Generated by javadoc on Mon Apr 17 15:35:35 AKDT 2000 -->


  		




  
  5
  
    
<!-- Generated by javadoc on Tue Apr 18 13:19:07 AKDT 2000 -->


  		




  6
  6
  
    
<TITLE>


  		




  7
  7
  
    
: Class  DBSAXElement


  		




  8
  8
  
    
</TITLE>


  		












  

    
      docs/help-doc.html
    
  





  2
  2
  
    
<!--NewPage-->


  		




  3
  3
  
    
<HTML>


  		




  4
  4
  
    
<HEAD>


  		




  5
  
  
    
<!-- Generated by javadoc on Mon Apr 17 15:35:35 AKDT 2000 -->


  		




  
  5
  
    
<!-- Generated by javadoc on Tue Apr 18 13:19:08 AKDT 2000 -->


  		




  6
  6
  
    
<TITLE>


  		




  7
  7
  
    
: API Help


  		




  8
  8
  
    
</TITLE>


  		












  

    
      contents.html
    
  





  39
  39
  
    
To view results that are XML formatted in this demo, it is easiest to use 


  		




  40
  40
  
    
Internet Explorer 5. Although Netscape browsers will allow you to 


  		




  41
  41
  
    
download XML documents, only IE5 will display XML at this time.


  		




  
  42
  
    
<p><a href="docs/" target="top">Browse the API for the Servlet</a>


  		




  
  43
  
    
</p>


  		




  42
  44
  
    
</body>


  		




  43
  45
  
    
</html>


  		












  

    
      MetaCatServlet.java
    
  





  47
  47
  
    
   * qformat=html -- display resultset from query in HTML<br>


  		




  48
  48
  
    
   * action=getdocument -- display an XML document in XML or HTML<br>


  		




  49
  49
  
    
   * docid=34 -- display the document with the document ID number 34<br>


  		




  
  50
  
    
   * action=putdocument -- load an XML document into the database store<br>


  		




  
  51
  
    
   * doctext -- XML text ofthe document to load into the database<br>


  		




  50
  52
  
    
 */


  		




  51
  53
  
    
public class MetaCatServlet extends HttpServlet {


  		




  52
  54
  
    

  		












  

    
      lib/contents.html
    
  





  39
  39
  
    
To view results that are XML formatted in this demo, it is easiest to use 


  		




  40
  40
  
    
Internet Explorer 5. Although Netscape browsers will allow you to 


  		




  41
  41
  
    
download XML documents, only IE5 will display XML at this time.


  		




  
  42
  
    
<p><a href="docs/" target="top">Browse the API for the Servlet</a>


  		




  
  43
  
    
</p>


  		




  42
  44
  
    
</body>


  		




  43
  45
  
    
</html>


  		












Also available in:  Unified diff