/ - Diff - Metacat - Ecoinformatics Redmine

     <!--
       * contents.html
+      *
       *      Authors: Matt Jones
       *    Copyright: 2000 Regents of the University of California and the
       *               National Center for Ecological Analysis and Synthesis
       *  For Details: http://www.nceas.ucsb.edu/
       *      Created: 2000 April 5
       *      Version: 0.01
       *    File Info: '$Id$'
+      *
       * This is an HTML document for displaying examples of the use of
       * Oracle XML tools
     -->
     <html>
     <head>
     <title>MetaCat</title>
     </head>
     <body bgcolor="white">
     <b>MetaCat</b>
     <p>
     A simple query against a flexible metadata catalog.
     </p>
     </body>
     </html>

                 dbstring = args[3];
+              }
               new DBSAXWriter(filename, user, password, dbstring);
               // Open a connection to the database
               Connection dbconn = MetaCatUtil.openDBConnection(
                     "oracle.jdbc.driver.OracleDriver",
                     dbstring, user, password);
               new DBSAXWriter(filename, dbconn);
               System.out.println("Document processing finished for: " + filename);
             } catch (Exception e) {
-...
        * construct a new instance of the class to write an XML file to the database
+       *
        * @param filename the filename to be loaded into the database
        * @param user the username to use for the database connection
        * @param password the password to use for the database connection
        * @param dbstring the connection info to use for the database connection
        * @param conn the database connection to which to write the XML file
        */
       public DBSAXWriter( String filename, String user,
                       String password, String dbstring)
       public DBSAXWriter( String filename, Connection conn)
                       throws IOException,
                              SQLException,
                              ClassNotFoundException
+       {
          // Open a connection to the database
          conn = openDBConnection(
                     "oracle.jdbc.driver.OracleDriver",
                     dbstring, user, password);
          this.conn = conn;
          //
          // Set up the SAX document handlers for parsing
-...
+       }
        /** Utility method to establish the JDBC connection */
        private Connection openDBConnection(String dbDriver, String connection,
                     String user, String password)
                     throws SQLException, ClassNotFoundException {
          // Load the Oracle JDBC driver
          Class.forName (dbDriver);
          // Connect to the database
          Connection conn = DriverManager.getConnection( connection, user, password);
          return conn;
+       }
        /** Utility method to convert a file handle into a URL */
        static public URL fileToURL(File file)
+       {

     import java.io.PrintWriter;
     import java.io.IOException;
     import java.io.Reader;
     import java.io.StringReader;
     import java.util.Enumeration;
     import java.util.Hashtable;
     import java.net.URL;
     import java.net.MalformedURLException;
     import java.sql.Connection;
     import javax.servlet.ServletConfig;
     import javax.servlet.ServletContext;
-...
     import javax.servlet.http.HttpServletResponse;
     import javax.servlet.http.HttpUtils;
     import oracle.xml.parser.v2.XSLStylesheet;
     import oracle.xml.parser.v2.XSLException;
     import oracle.xml.parser.v2.XMLDocumentFragment;
     import oracle.xml.parser.v2.XSLProcessor;
     /**
      * A metadata catalog server implemented as a Java Servlet
+       *
        * <p>Valid parameters are:<br>
        * action=query -- query the values of all elements and attributes
        *                     and return a result set of nodes<br>
        * action=getdocument -- display an XML document in XML or HTML<br>
        * qformat=xml -- display resultset from query in XML<br>
        * qformat=html -- display resultset from query in HTML<br>
        * action=getdocument -- display an XML document in XML or HTML<br>
        * docid=34 -- display the document with the document ID number 34<br>
      */
     public class MetaCatServlet extends HttpServlet {
-...
       private ServletContext	context = null;
       DBSimpleQuery		queryobj = null;
       DBReader		docreader = null;
       static  String 	user = "jones";
       static  String 	password = "your-pw-goes-here";
       static  String 	defaultDB = "jdbc:oracle:thin:@localhost:1521:test";
       static  String 	user = MetaCatUtil.user;
       static  String 	password = MetaCatUtil.password;
       static  String 	defaultDB = MetaCatUtil.defaultDB;
       static  String 	resultStyleURL = "file:///home/httpd/html/xmltodb/resultset.xsl";
       /**
        * Initialize the servlet by creating appropriate database connections
        */
       public void init( ServletConfig config ) throws ServletException {
         try {
           super.init( config );
-...
           this.context = config.getServletContext();
           try {
             queryobj = new DBSimpleQuery(user, password, defaultDB);
             docreader = new DBReader(user, password, defaultDB);
             // Open a connection to the database
             Connection dbconn = MetaCatUtil.openDBConnection(
                     "oracle.jdbc.driver.OracleDriver",
                     defaultDB, user, password);
             queryobj = new DBSimpleQuery(dbconn);
             docreader = new DBReader(dbconn);
           } catch (Exception e) {
+          }
         } catch ( ServletException ex ) {
-...
+        }
+      }
       /** Handle "GET" method requests from HTTP clients */
       public void doGet (HttpServletRequest request, HttpServletResponse response)
         throws ServletException, IOException {
-...
         handleGetOrPost(response, params);
+      }
       /** Handle "POST" method requests from HTTP clients */
       public void doPost( HttpServletRequest request, HttpServletResponse response)
         throws ServletException, IOException {
-...
+      }
       /**
        * routine to control servlet response depending on the action requested
        * Valid "action" parameters are:
        *     query -- query the text values of all elements and attributes
        *              and return a result set of nodes
        *  getdocument -- display an XML document in XML or HTML given a document ID
        * Control servlet response depending on the action parameter specified
        */
       private void handleGetOrPost(HttpServletResponse response, Hashtable params)
         throws ServletException, IOException {
-...
           handleQueryAction(out, params, response);
         } else if (action.equals("getdocument")) {
           handleGetDocumentAction(out, params, response);
         } else {
           out.println("Error: action not registered.  Please report this error.");
+        }
         // Close the stream to the client
         out.close();
+      }
       /**
        * Handle the database query request and return a result set, possibly
        * transformed from XML into HTML
        */
       private void handleQueryAction(PrintWriter out, Hashtable params,
                    HttpServletResponse response) {
           // Run the query
           String query = ((String[])params.get("query"))[0];
           Hashtable nodelist = queryobj.findRootNodes(query);
           // set content type and other response header fields first
           response.setContentType("text/xml");
           // Create a buffer to hold the xml result
           StringBuffer resultset = new StringBuffer();
           // Print the resulting root nodes
           long nodeid;
           out.println("<?xml version=\"1.0\"?>\n");
           out.println("<resultset>\n");
           out.println("  <query>" + query + "</query>");
           resultset.append("<?xml version=\"1.0\"?>\n");
           resultset.append("<resultset>\n");
           resultset.append("  <query>" + query + "</query>");
           Enumeration rootlist = nodelist.keys();
           while (rootlist.hasMoreElements()) {
             nodeid = ((Long)rootlist.nextElement()).longValue();
             out.println("  <nodeid>" + nodeid + "</nodeid>");
             resultset.append("  <nodeid>" + nodeid + "</nodeid>");
+          }
           out.println("</resultset>");
           resultset.append("</resultset>");
           String qformat = ((String[])params.get("qformat"))[0];
           if (qformat.equals("xml")) {
             // set content type and other response header fields first
             response.setContentType("text/xml");
             out.println(resultset.toString());
           } else if (qformat.equals("html")) {
             // set content type and other response header fields first
             response.setContentType("text/html");
             //out.println("Converting to HTML...");
             XMLDocumentFragment htmldoc = null;
             try {
               XSLStylesheet style = new XSLStylesheet(new URL(resultStyleURL), null);
               htmldoc = (new XSLProcessor()).processXSL(style,
                          (Reader)(new StringReader(resultset.toString())),null);
               htmldoc.print(out);
             } catch (Exception e) {
               out.println("Error transforming document:\n" + e.getMessage());
+            }
+          }
+      }
       /**
        * Handle the database getdocument request and return a XML document,
        * possibly transformed from XML into HTML
        */
       private void handleGetDocumentAction(PrintWriter out, Hashtable params,
                    HttpServletResponse response) {
           // Get the document indicated
-...
           response.setContentType("text/xml");
           out.println(doc);
           // Print the resulting root nodes
           //out.println("<?xml version=\"1.0\"?>\n");
           //out.println("<docid>" + docid + "</docid>");
+      }
+    }

                 dbstring = args[3];
+              }
               // Open a connection to the database
               Connection dbconn = MetaCatUtil.openDBConnection(
                                   "oracle.jdbc.driver.OracleDriver",
                                   dbstring, user, password);
               // Execute the simple query
               DBSimpleQuery rd = new DBSimpleQuery(user, password, dbstring);
               DBSimpleQuery rd = new DBSimpleQuery(dbconn);
               Hashtable nodelist = rd.findRootNodes(query);
               // Print the reulting root nodes
-...
       /**
        * construct an instance of the DBSimpleQuery class
+       *
        * Generally, one would call the findRootNodes() routine after creating
        * an instance to specify the query to search for
        * <p>Generally, one would call the findRootNodes() routine after creating
        * an instance to specify the search query</p>
+       *
        * @param user the username to use for the database connection
        * @param password the password to use for the database connection
        * @param dbstring the connection info to use for the database connection
        * @param conn the JDBC connection that we use for the query
        */
       public DBSimpleQuery( String user, String password, String dbstring)
       public DBSimpleQuery( Connection conn )
                       throws IOException,
                              SQLException,
                              ClassNotFoundException
+      {
          // Open a connection to the database
          conn = openDBConnection(
                     "oracle.jdbc.driver.OracleDriver",
                     dbstring, user, password);
         this.conn = conn;
+      }
       /** Utility message to establish a JDBC database connection */
       private Connection openDBConnection(String dbDriver, String connection,
                     String user, String password)
                     throws SQLException, ClassNotFoundException {
          // Load the Oracle JDBC driver
          Class.forName (dbDriver);
          // Connect to the database
          Connection conn = DriverManager.getConnection( connection, user, password);
          return conn;
+      }
       /**
        * routine to search the elements and attributes looking to match query
+       *

                 dbstring = args[3];
+              }
               DBReader rd = new DBReader(user, password, dbstring);
               // Open a connection to the database
               Connection dbconn = MetaCatUtil.openDBConnection(
                     "oracle.jdbc.driver.OracleDriver",
                     dbstring, user, password);
               DBReader rd = new DBReader( dbconn );
               String xml = rd.readXMLDocument(nodeid);
               System.out.println(xml);
-...
+       *
        * Generally, one calls readXMLDocument() after constructing the instance
+       *
        * @param user the username to use for the database connection
        * @param password the password to use for the database connection
        * @param dbstring the connection info to use for the database connection
        * @param conn the database connection from which to read the document
        */
       public DBReader( String user, String password, String dbstring)
       public DBReader( Connection conn )
                       throws IOException,
                              SQLException,
                              ClassNotFoundException
+      {
          // Open a connection to the database
          conn = openDBConnection(
                     "oracle.jdbc.driver.OracleDriver",
                     dbstring, user, password);
         this.conn = conn;
+      }
       /** open a connection to the database with the supplied information */
       private Connection openDBConnection(String dbDriver, String connection,
                     String user, String password)
                     throws SQLException, ClassNotFoundException {
          // Load the Oracle JDBC driver
          Class.forName (dbDriver);
          // Connect to the database
          Connection conn = DriverManager.getConnection( connection, user, password);
          return conn;
+      }
       /**
        * Create an XML document from the database starting with the element
        * having element_id nodeid

     import java.sql.Connection;
     import java.sql.DriverManager;
     import java.sql.SQLException;
     /**
      * A suite of utility classes for the metadata catalog server
      */
     public class MetaCatUtil {
       static  String 	user = "jones";
       static  String 	password = "your-pw-goes-here";
       static  String 	defaultDB = "jdbc:oracle:thin:@localhost:1521:test";
       /**
        * Utility method to establish a JDBC database connection
+       *
        * @param dbDriver the string representing the database driver
        * @param connection the string representing the database connectin parameters
        * @param user name of the user to use for database connection
        * @param password password for the user to use for database connection
        */
       public static Connection openDBConnection(String dbDriver, String connection,
                     String user, String password)
                     throws SQLException, ClassNotFoundException {
          // Load the Oracle JDBC driver
          Class.forName (dbDriver);
          // Connect to the database
          Connection conn = DriverManager.getConnection( connection, user, password);
          return conn;
+      }
+    }

                 dbstring = args[3];
+              }
               new DBSAXWriter(filename, user, password, dbstring);
               // Open a connection to the database
               Connection dbconn = MetaCatUtil.openDBConnection(
                     "oracle.jdbc.driver.OracleDriver",
                     dbstring, user, password);
               new DBSAXWriter(filename, dbconn);
               System.out.println("Document processing finished for: " + filename);
             } catch (Exception e) {
-...
        * construct a new instance of the class to write an XML file to the database
+       *
        * @param filename the filename to be loaded into the database
        * @param user the username to use for the database connection
        * @param password the password to use for the database connection
        * @param dbstring the connection info to use for the database connection
        * @param conn the database connection to which to write the XML file
        */
       public DBSAXWriter( String filename, String user,
                       String password, String dbstring)
       public DBSAXWriter( String filename, Connection conn)
                       throws IOException,
                              SQLException,
                              ClassNotFoundException
+       {
          // Open a connection to the database
          conn = openDBConnection(
                     "oracle.jdbc.driver.OracleDriver",
                     dbstring, user, password);
          this.conn = conn;
          //
          // Set up the SAX document handlers for parsing
-...
+       }
        /** Utility method to establish the JDBC connection */
        private Connection openDBConnection(String dbDriver, String connection,
                     String user, String password)
                     throws SQLException, ClassNotFoundException {
          // Load the Oracle JDBC driver
          Class.forName (dbDriver);
          // Connect to the database
          Connection conn = DriverManager.getConnection( connection, user, password);
          return conn;
+       }
        /** Utility method to convert a file handle into a URL */
        static public URL fileToURL(File file)
+       {

                 dbstring = args[3];
+              }
               DBReader rd = new DBReader(user, password, dbstring);
               // Open a connection to the database
               Connection dbconn = MetaCatUtil.openDBConnection(
                     "oracle.jdbc.driver.OracleDriver",
                     dbstring, user, password);
               DBReader rd = new DBReader( dbconn );
               String xml = rd.readXMLDocument(nodeid);
               System.out.println(xml);
-...
+       *
        * Generally, one calls readXMLDocument() after constructing the instance
+       *
        * @param user the username to use for the database connection
        * @param password the password to use for the database connection
        * @param dbstring the connection info to use for the database connection
        * @param conn the database connection from which to read the document
        */
       public DBReader( String user, String password, String dbstring)
       public DBReader( Connection conn )
                       throws IOException,
                              SQLException,
                              ClassNotFoundException
+      {
          // Open a connection to the database
          conn = openDBConnection(
                     "oracle.jdbc.driver.OracleDriver",
                     dbstring, user, password);
         this.conn = conn;
+      }
       /** open a connection to the database with the supplied information */
       private Connection openDBConnection(String dbDriver, String connection,
                     String user, String password)
                     throws SQLException, ClassNotFoundException {
          // Load the Oracle JDBC driver
          Class.forName (dbDriver);
          // Connect to the database
          Connection conn = DriverManager.getConnection( connection, user, password);
          return conn;
+      }
       /**
        * Create an XML document from the database starting with the element
        * having element_id nodeid

     <!--NewPage-->
     <HTML>
     <HEAD>
     <!-- Generated by javadoc on Tue Apr 11 19:05:41 AKDT 2000 -->
     <!-- Generated by javadoc on Mon Apr 17 13:49:15 AKDT 2000 -->
     <TITLE>
     : Class  ReaderElement
     </TITLE>
-...
     <TR>
     <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
     &nbsp;<A HREF="DBSimpleQuery.html"><B>PREV CLASS</B></A>&nbsp;
     &nbsp;<A HREF="MetaCatServlet.html"><B>PREV CLASS</B></A>&nbsp;
     &nbsp;NEXT CLASS</FONT></TD>
     <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
       <A HREF="index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
-...
     <TR>
     <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
     &nbsp;<A HREF="DBSimpleQuery.html"><B>PREV CLASS</B></A>&nbsp;
     &nbsp;<A HREF="MetaCatServlet.html"><B>PREV CLASS</B></A>&nbsp;
     &nbsp;NEXT CLASS</FONT></TD>
     <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
       <A HREF="index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;

     <!--NewPage-->
     <HTML>
     <HEAD>
     <!-- Generated by javadoc on Tue Apr 11 19:05:41 AKDT 2000 -->
     <!-- Generated by javadoc on Mon Apr 17 13:49:15 AKDT 2000 -->
     <TITLE>
     : Index
     </TITLE>
-...
     Constructor for class <A HREF="DBSAXWriter.html">DBSAXWriter</A>
     <DD>construct a new instance of the class to write an XML file to the database
     <DT><A HREF="DBSimpleQuery.html"><B>DBSimpleQuery</B></A> - class <A HREF="DBSimpleQuery.html">DBSimpleQuery</A>.<DD>A Class that searches a relational DB for elements and attributes that
      have free text matches to the query string.</DL>
      have free text matches to the query string.<DT><A HREF="DBSimpleQuery.html#DBSimpleQuery(java.lang.String, java.lang.String, java.lang.String)"><B>DBSimpleQuery(String, String, String)</B></A> -
     Constructor for class <A HREF="DBSimpleQuery.html">DBSimpleQuery</A>
     <DD>construct an instance of the DBSimpleQuery class
      Generally, one would call the findRootNodes() routine after creating
      an instance to specify the query to search for
     <DT><A HREF="MetaCatServlet.html#doGet(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)"><B>doGet(HttpServletRequest, HttpServletResponse)</B></A> -
     Method in class <A HREF="MetaCatServlet.html">MetaCatServlet</A>
     <DD>Handle "GET" method requests from HTTP clients
     <DT><A HREF="MetaCatServlet.html#doPost(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)"><B>doPost(HttpServletRequest, HttpServletResponse)</B></A> -
     Method in class <A HREF="MetaCatServlet.html">MetaCatServlet</A>
     <DD>Handle "POST" method requests from HTTP clients
     </DL>
     <HR>
     <A NAME="_E_"><!-- --></A><H2>
     <B>E</B></H2>
-...
     Method in class <A HREF="DBSAXHandler.html">DBSAXHandler</A>
     <DD>SAX Handler that is called for each XML text node that is Ignorable
      white space
     <DT><A HREF="MetaCatServlet.html#init(javax.servlet.ServletConfig)"><B>init(ServletConfig)</B></A> -
     Method in class <A HREF="MetaCatServlet.html">MetaCatServlet</A>
     <DD>Initialize the servlet by creating appropriate database connections
     </DL>
     <HR>
     <A NAME="_M_"><!-- --></A><H2>
-...
     <DT><A HREF="DBSimpleQuery.html#main(java.lang.String[])"><B>main(String[])</B></A> -
     Static method in class <A HREF="DBSimpleQuery.html">DBSimpleQuery</A>
     <DD>the main routine used to test the DBSimpleQuery utility.
     <DT><A HREF="MetaCatServlet.html"><B>MetaCatServlet</B></A> - class <A HREF="MetaCatServlet.html">MetaCatServlet</A>.<DD>A metadata catalog server implemented as a Java Servlet
      <DT><A HREF="MetaCatServlet.html#MetaCatServlet()"><B>MetaCatServlet()</B></A> -
     Constructor for class <A HREF="MetaCatServlet.html">MetaCatServlet</A>
     <DD>&nbsp;
     </DL>
     <HR>
     <A NAME="_R_"><!-- --></A><H2>

     <!--NewPage-->
     <HTML>
     <HEAD>
     <!-- Generated by javadoc on Tue Apr 11 19:05:41 AKDT 2000 -->
     <!-- Generated by javadoc on Mon Apr 17 13:49:15 AKDT 2000 -->
     <TITLE>
     All Classes
     </TITLE>
-...
     <BR>
     <A HREF="DBSimpleQuery.html" TARGET="classFrame">DBSimpleQuery</A>
     <BR>
     <A HREF="MetaCatServlet.html" TARGET="classFrame">MetaCatServlet</A>
     <BR>
     <A HREF="ReaderElement.html" TARGET="classFrame">ReaderElement</A>
     <BR>
     </FONT></TD>

     <!--NewPage-->
     <HTML>
     <HEAD>
     <!-- Generated by javadoc on Tue Apr 11 19:05:41 AKDT 2000 -->
     <!-- Generated by javadoc on Mon Apr 17 13:49:15 AKDT 2000 -->
     <TITLE>
     </TITLE>

     <!--NewPage-->
     <HTML>
     <HEAD>
     <!-- Generated by javadoc on Tue Apr 11 19:05:41 AKDT 2000 -->
     <!-- Generated by javadoc on Mon Apr 17 13:49:15 AKDT 2000 -->
     <TITLE>
     : Class  DBSimpleQuery
     </TITLE>
-...
     <TR>
     <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
     &nbsp;<A HREF="DBSAXWriter.html"><B>PREV CLASS</B></A>&nbsp;
     &nbsp;<A HREF="ReaderElement.html"><B>NEXT CLASS</B></A></FONT></TD>
     &nbsp;<A HREF="MetaCatServlet.html"><B>NEXT CLASS</B></A></FONT></TD>
     <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
       <A HREF="index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
     &nbsp;<A HREF="DBSimpleQuery.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
     </TR>
     <TR>
     <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
       SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
       SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
     <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
     DETAIL: &nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
     DETAIL: &nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
     </TR>
     </TABLE>
     <!-- =========== END OF NAVBAR =========== -->
-...
     <!-- ======== CONSTRUCTOR SUMMARY ======== -->
     <A NAME="constructor_summary"><!-- --></A>
     <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
     <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
     <TD COLSPAN=2><FONT SIZE="+2">
     <B>Constructor Summary</B></FONT></TD>
     </TR>
     <TR BGCOLOR="white" CLASS="TableRowColor">
     <TD><CODE><B><A HREF="DBSimpleQuery.html#DBSimpleQuery(java.lang.String, java.lang.String, java.lang.String)">DBSimpleQuery</A></B>(java.lang.String&nbsp;user,
                   java.lang.String&nbsp;password,
                   java.lang.String&nbsp;dbstring)</CODE>
     <BR>
     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;construct an instance of the DBSimpleQuery class
      Generally, one would call the findRootNodes() routine after creating
      an instance to specify the query to search for</TD>
     </TR>
     </TABLE>
     &nbsp;
     <!-- ========== METHOD SUMMARY =========== -->
     <A NAME="method_summary"><!-- --></A>
-...
     <!-- ========= CONSTRUCTOR DETAIL ======== -->
     <A NAME="constructor_detail"><!-- --></A>
     <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
     <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
     <TD COLSPAN=1><FONT SIZE="+2">
     <B>Constructor Detail</B></FONT></TD>
     </TR>
     </TABLE>
     <A NAME="DBSimpleQuery(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
     DBSimpleQuery</H3>
     <PRE>
     public <B>DBSimpleQuery</B>(java.lang.String&nbsp;user,
                          java.lang.String&nbsp;password,
                          java.lang.String&nbsp;dbstring)
                   throws java.io.IOException,
                          java.sql.SQLException,
                          java.lang.ClassNotFoundException</PRE>
     <DL>
     <DD>construct an instance of the DBSimpleQuery class
      Generally, one would call the findRootNodes() routine after creating
      an instance to specify the query to search for<DD><DL>
     <DT><B>Parameters:</B><DD><CODE>user</CODE> - the username to use for the database connection<DD><CODE>password</CODE> - the password to use for the database connection<DD><CODE>dbstring</CODE> - the connection info to use for the database connection</DL>
     </DD>
     </DL>
     <!-- ============ METHOD DETAIL ========== -->
     <A NAME="method_detail"><!-- --></A>
-...
     <TR>
     <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
     &nbsp;<A HREF="DBSAXWriter.html"><B>PREV CLASS</B></A>&nbsp;
     &nbsp;<A HREF="ReaderElement.html"><B>NEXT CLASS</B></A></FONT></TD>
     &nbsp;<A HREF="MetaCatServlet.html"><B>NEXT CLASS</B></A></FONT></TD>
     <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
       <A HREF="index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
     &nbsp;<A HREF="DBSimpleQuery.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
     </TR>
     <TR>
     <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
       SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
       SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
     <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
     DETAIL: &nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
     DETAIL: &nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
     </TR>
     </TABLE>
     <!-- =========== END OF NAVBAR =========== -->

     <!--NewPage-->
     <HTML>
     <HEAD>
     <!-- Generated by javadoc on Tue Apr 11 19:05:41 AKDT 2000 -->
     <!-- Generated by javadoc on Mon Apr 17 13:49:15 AKDT 2000 -->
     <TITLE>
     : Class  BasicElement
     </TITLE>

     <!--NewPage-->
     <HTML>
     <HEAD>
     <!-- Generated by javadoc on Tue Apr 11 19:05:41 AKDT 2000 -->
     <!-- Generated by javadoc on Mon Apr 17 13:49:15 AKDT 2000 -->
     <TITLE>
     : API Help
     </TITLE>

     <!--NewPage-->
     <HTML>
     <HEAD>
     <!-- Generated by javadoc on Tue Apr 11 19:05:41 AKDT 2000 -->
     <!-- Generated by javadoc on Mon Apr 17 13:49:15 AKDT 2000 -->
     <TITLE>
     Serialized Form
     </TITLE>
-...
     <H1>
     Serialized Form</H1>
     </CENTER>
     <A NAME="MetaCatServlet"><!-- --></A>
     <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
     <TR BGCOLOR="#CCCCFF" CLASS="TableSubHeadingColor">
     <TD COLSPAN=2><FONT SIZE="+2">
     <B>Class <A HREF="MetaCatServlet.html">MetaCatServlet</A> implements Serializable</B></FONT></TD>
     </TR>
     </TABLE>
     <P>
     <A NAME="serializedForm"><!-- --></A>
     <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
     <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
     <TD COLSPAN=1><FONT SIZE="+2">
     <B>Serialized Fields</B></FONT></TD>
     </TR>
     </TABLE>
     <H3>
     config</H3>
     <PRE>
     javax.servlet.ServletConfig <B>config</B></PRE>
     <DL>
     </DL>
     <HR>
     <H3>
     context</H3>
     <PRE>
     javax.servlet.ServletContext <B>context</B></PRE>
     <DL>
     </DL>
     <HR>
     <H3>
     docreader</H3>
     <PRE>
     <A HREF="DBReader.html">DBReader</A> <B>docreader</B></PRE>
     <DL>
     </DL>
     <HR>
     <H3>
     queryobj</H3>
     <PRE>
     <A HREF="DBSimpleQuery.html">DBSimpleQuery</A> <B>queryobj</B></PRE>
     <DL>
     </DL>
     <P>
     <HR>
     <!-- ========== START OF NAVBAR ========== -->
     <A NAME="navbar_bottom"><!-- --></A>
     <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">

     <!--NewPage-->
     <HTML>
     <HEAD>
     <!-- Generated by javadoc on Tue Apr 11 19:05:41 AKDT 2000 -->
     <!-- Generated by javadoc on Mon Apr 17 13:49:15 AKDT 2000 -->
     <TITLE>
     : Class  DBSAXWriter
     </TITLE>

     <!--NewPage-->
     <HTML>
     <HEAD>
     <!-- Generated by javadoc on Tue Apr 11 19:05:41 AKDT 2000 -->
     <!-- Generated by javadoc on Mon Apr 17 13:49:15 AKDT 2000 -->
     <TITLE>
     : Class  DBSAXHandler
     </TITLE>

     <!--NewPage-->
     <HTML>
     <HEAD>
     <!-- Generated by javadoc on Tue Apr 11 19:05:41 AKDT 2000 -->
     <!-- Generated by javadoc on Mon Apr 17 13:49:14 AKDT 2000 -->
     <TITLE>
     : Class Hierarchy
     </TITLE>
-...
     <LI TYPE="circle">class java.lang.Object<UL>
     <LI TYPE="circle">class <A HREF="BasicElement.html"><B>BasicElement</B></A><UL>
     <LI TYPE="circle">class <A HREF="DBSAXElement.html"><B>DBSAXElement</B></A><LI TYPE="circle">class <A HREF="ReaderElement.html"><B>ReaderElement</B></A></UL>
     <LI TYPE="circle">class <A HREF="DBReader.html"><B>DBReader</B></A><LI TYPE="circle">class <A HREF="DBSAXWriter.html"><B>DBSAXWriter</B></A><LI TYPE="circle">class <A HREF="DBSimpleQuery.html"><B>DBSimpleQuery</B></A><LI TYPE="circle">class org.xml.sax.HandlerBase (implements org.xml.sax.DocumentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler)
     <LI TYPE="circle">class <A HREF="DBReader.html"><B>DBReader</B></A><LI TYPE="circle">class <A HREF="DBSAXWriter.html"><B>DBSAXWriter</B></A><LI TYPE="circle">class <A HREF="DBSimpleQuery.html"><B>DBSimpleQuery</B></A><LI TYPE="circle">class javax.servlet.GenericServlet (implements java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig)
     <UL>
     <LI TYPE="circle">class javax.servlet.http.HttpServlet (implements java.io.Serializable)
     <UL>
     <LI TYPE="circle">class <A HREF="MetaCatServlet.html"><B>MetaCatServlet</B></A></UL>
     </UL>
     <LI TYPE="circle">class org.xml.sax.HandlerBase (implements org.xml.sax.DocumentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler)
     <UL>
     <LI TYPE="circle">class oracle.xml.parser.v2.DefaultXMLDocumentHandler (implements oracle.xml.parser.v2.XMLDocumentHandler)
     <UL>
     <LI TYPE="circle">class <A HREF="DBSAXHandler.html"><B>DBSAXHandler</B></A></UL>

     <!--NewPage-->
     <HTML>
     <HEAD>
     <!-- Generated by javadoc on Tue Apr 11 19:05:41 AKDT 2000-->
     <!-- Generated by javadoc on Mon Apr 17 13:49:15 AKDT 2000-->
     <TITLE>
     Generated Documentation (Untitled)
     </TITLE>

     <!--NewPage-->
     <HTML>
     <HEAD>
     <!-- Generated by javadoc on Tue Apr 11 19:05:41 AKDT 2000 -->
     <!-- Generated by javadoc on Mon Apr 17 13:49:15 AKDT 2000 -->
     <TITLE>
     : Class  DBReader
     </TITLE>

     <!--NewPage-->
     <HTML>
     <HEAD>
     <!-- Generated by javadoc on Tue Apr 11 19:05:41 AKDT 2000 -->
     <!-- Generated by javadoc on Mon Apr 17 13:49:15 AKDT 2000 -->
     <TITLE>
     : Deprecated List
     </TITLE>

     <!--NewPage-->
     <HTML>
     <HEAD>
     <!-- Generated by javadoc on Tue Apr 11 19:05:41 AKDT 2000 -->
     <!-- Generated by javadoc on Mon Apr 17 13:49:15 AKDT 2000 -->
     <TITLE>
     : Class  DBSAXElement
     </TITLE>

      .page    {font-family: Tahoma, sans-serif; background-color:white}
      .emlbody    {font-family: Tahoma, sans-serif; background-color:white}
      .rowodd  {background-color: #CCCCCC; color: black; vertical-align: top}
      .roweven {background-color: #F8F8F8; color: black; vertical-align: top}
      .rowlight {background-color: #CCCCFF; color: black; vertical-align: top}
      .rowwhite {background-color: #FFFFFF; color: black; vertical-align: top}
      .coleven {}
      .colodd  {}
      .shaded  {background-color: #DDDDDD; color: black}

     import java.sql.Connection;
     import java.sql.DriverManager;
     import java.sql.SQLException;
     /**
      * A suite of utility classes for the metadata catalog server
      */
     public class MetaCatUtil {
       static  String 	user = "jones";
       static  String 	password = "your-pw-goes-here";
       static  String 	defaultDB = "jdbc:oracle:thin:@localhost:1521:test";
       /**
        * Utility method to establish a JDBC database connection
+       *
        * @param dbDriver the string representing the database driver
        * @param connection the string representing the database connectin parameters
        * @param user name of the user to use for database connection
        * @param password password for the user to use for database connection
        */
       public static Connection openDBConnection(String dbDriver, String connection,
                     String user, String password)
                     throws SQLException, ClassNotFoundException {
          // Load the Oracle JDBC driver
          Class.forName (dbDriver);
          // Connect to the database
          Connection conn = DriverManager.getConnection( connection, user, password);
          return conn;
+      }
+    }

     Simple database query against MetaCat<br>
     <form action="/servlets/MetaCatServlet" target="right" method="POST">
       <input type="hidden" name="action" value="query">
       <input type="text" name="query" size="15">
       <input type="text" name="query" value="Value1" size="15">
       <input type="submit" value="Run query">
       <br />
       <input type="checkbox" name="convert" value="true">Results in HTML
       Format:
       <input type="radio" name="qformat" value="xml">XML
       <input type="radio" name="qformat" value="html" checked>HTML
     </form>
     <p>
     <a href="/servlets/MetaCatServlet?action=getdocument&docid=1"
        target="right">Test Document Display (1)</a><br>
     <a href="/servlets/MetaCatServlet?action=getdocument&docid=31"
        target="right">Test Document Display (31)</a>
     For the test database, some valid values for the search that produce document
     results include "Value1" and "lakename"
     </p>
     <p>
     To view results that are XML formatted in this demo, it is easiest to use
     Internet Explorer 5. Although Netscape browsers will allow you to
     download XML documents, only IE5 will display XML at this time.
     </body>
     </html>

                 dbstring = args[3];
+              }
               // Open a connection to the database
               Connection dbconn = MetaCatUtil.openDBConnection(
                                   "oracle.jdbc.driver.OracleDriver",
                                   dbstring, user, password);
               // Execute the simple query
               DBSimpleQuery rd = new DBSimpleQuery(user, password, dbstring);
               DBSimpleQuery rd = new DBSimpleQuery(dbconn);
               Hashtable nodelist = rd.findRootNodes(query);
               // Print the reulting root nodes
-...
       /**
        * construct an instance of the DBSimpleQuery class
+       *
        * Generally, one would call the findRootNodes() routine after creating
        * an instance to specify the query to search for
        * <p>Generally, one would call the findRootNodes() routine after creating
        * an instance to specify the search query</p>
+       *
        * @param user the username to use for the database connection
        * @param password the password to use for the database connection
        * @param dbstring the connection info to use for the database connection
        * @param conn the JDBC connection that we use for the query
        */
       public DBSimpleQuery( String user, String password, String dbstring)
       public DBSimpleQuery( Connection conn )
                       throws IOException,
                              SQLException,
                              ClassNotFoundException
+      {
          // Open a connection to the database
          conn = openDBConnection(
                     "oracle.jdbc.driver.OracleDriver",
                     dbstring, user, password);
         this.conn = conn;
+      }
       /** Utility message to establish a JDBC database connection */
       private Connection openDBConnection(String dbDriver, String connection,
                     String user, String password)
                     throws SQLException, ClassNotFoundException {
          // Load the Oracle JDBC driver
          Class.forName (dbDriver);
          // Connect to the database
          Connection conn = DriverManager.getConnection( connection, user, password);
          return conn;
+      }
       /**
        * routine to search the elements and attributes looking to match query
+       *

      .page    {font-family: Tahoma, sans-serif; background-color:white}
      .emlbody    {font-family: Tahoma, sans-serif; background-color:white}
      .rowodd  {background-color: #CCCCCC; color: black; vertical-align: top}
      .roweven {background-color: #F8F8F8; color: black; vertical-align: top}
      .rowlight {background-color: #CCCCFF; color: black; vertical-align: top}
      .rowwhite {background-color: #FFFFFF; color: black; vertical-align: top}
      .coleven {}
      .colodd  {}
      .shaded  {background-color: #DDDDDD; color: black}

      .page    {font-family: Tahoma, sans-serif; background-color:white}
      .emlbody    {font-family: Tahoma, sans-serif; background-color:white}
      .rowodd  {background-color: #CCCCCC; color: black; vertical-align: top}
      .roweven {background-color: #F8F8F8; color: black; vertical-align: top}
      .rowlight {background-color: #CCCCFF; color: black; vertical-align: top}
      .rowwhite {background-color: #FFFFFF; color: black; vertical-align: top}
      .coleven {}
      .colodd  {}
      .shaded  {background-color: #DDDDDD; color: black}

     all: orasax reader query servlet
     orasax:
     orasax: util
     	javac -classpath "$(CPATH)" \
     		DBSAXWriter.java \
     		BasicElement.java \
-...
     		DBWriter.java \
     		DBElement.java
     reader:
     reader: util
     	javac -classpath "$(CPATH)" \
     		DBReader.java \
     		BasicElement.java \
-...
     		BasicElement.class \
     		/home/httpd/servlets/
     query:
     query: util
     	javac -classpath "$(CPATH)" \
     		DBSimpleQuery.java
     	cp DBSimpleQuery.class /home/httpd/servlets/
-...
     	javac -classpath "$(CPATH)" MetaCatServlet.java
     	cp MetaCatServlet.class /home/httpd/servlets/
     util:
     	javac -classpath "$(CPATH)" \
     		MetaCatUtil.java
     	cp MetaCatUtil.class /home/httpd/servlets/
     test:
     	java -cp $(CPATH) DBSAXWriter test.xml $(USER) $(PW)

     import java.io.PrintWriter;
     import java.io.IOException;
     import java.io.Reader;
     import java.io.StringReader;
     import java.util.Enumeration;
     import java.util.Hashtable;
     import java.net.URL;
     import java.net.MalformedURLException;
     import java.sql.Connection;
     import javax.servlet.ServletConfig;
     import javax.servlet.ServletContext;
-...
     import javax.servlet.http.HttpServletResponse;
     import javax.servlet.http.HttpUtils;
     import oracle.xml.parser.v2.XSLStylesheet;
     import oracle.xml.parser.v2.XSLException;
     import oracle.xml.parser.v2.XMLDocumentFragment;
     import oracle.xml.parser.v2.XSLProcessor;
     /**
      * A metadata catalog server implemented as a Java Servlet
+       *
        * <p>Valid parameters are:<br>
        * action=query -- query the values of all elements and attributes
        *                     and return a result set of nodes<br>
        * action=getdocument -- display an XML document in XML or HTML<br>
        * qformat=xml -- display resultset from query in XML<br>
        * qformat=html -- display resultset from query in HTML<br>
        * action=getdocument -- display an XML document in XML or HTML<br>
        * docid=34 -- display the document with the document ID number 34<br>
      */
     public class MetaCatServlet extends HttpServlet {
-...
       private ServletContext	context = null;
       DBSimpleQuery		queryobj = null;
       DBReader		docreader = null;
       static  String 	user = "jones";
       static  String 	password = "your-pw-goes-here";
       static  String 	defaultDB = "jdbc:oracle:thin:@localhost:1521:test";
       static  String 	user = MetaCatUtil.user;
       static  String 	password = MetaCatUtil.password;
       static  String 	defaultDB = MetaCatUtil.defaultDB;
       static  String 	resultStyleURL = "file:///home/httpd/html/xmltodb/resultset.xsl";
       /**
        * Initialize the servlet by creating appropriate database connections
        */
       public void init( ServletConfig config ) throws ServletException {
         try {
           super.init( config );
-...
           this.context = config.getServletContext();
           try {
             queryobj = new DBSimpleQuery(user, password, defaultDB);
             docreader = new DBReader(user, password, defaultDB);
             // Open a connection to the database
             Connection dbconn = MetaCatUtil.openDBConnection(
                     "oracle.jdbc.driver.OracleDriver",
                     defaultDB, user, password);
             queryobj = new DBSimpleQuery(dbconn);
             docreader = new DBReader(dbconn);
           } catch (Exception e) {
+          }
         } catch ( ServletException ex ) {
-...
+        }
+      }
       /** Handle "GET" method requests from HTTP clients */
       public void doGet (HttpServletRequest request, HttpServletResponse response)
         throws ServletException, IOException {
-...
         handleGetOrPost(response, params);
+      }
       /** Handle "POST" method requests from HTTP clients */
       public void doPost( HttpServletRequest request, HttpServletResponse response)
         throws ServletException, IOException {
-...
+      }
       /**
        * routine to control servlet response depending on the action requested
        * Valid "action" parameters are:
        *     query -- query the text values of all elements and attributes
        *              and return a result set of nodes
        *  getdocument -- display an XML document in XML or HTML given a document ID
        * Control servlet response depending on the action parameter specified
        */
       private void handleGetOrPost(HttpServletResponse response, Hashtable params)
         throws ServletException, IOException {
-...
           handleQueryAction(out, params, response);
         } else if (action.equals("getdocument")) {
           handleGetDocumentAction(out, params, response);
         } else {
           out.println("Error: action not registered.  Please report this error.");
+        }
         // Close the stream to the client
         out.close();
+      }
       /**
        * Handle the database query request and return a result set, possibly
        * transformed from XML into HTML
        */
       private void handleQueryAction(PrintWriter out, Hashtable params,
                    HttpServletResponse response) {
           // Run the query
           String query = ((String[])params.get("query"))[0];
           Hashtable nodelist = queryobj.findRootNodes(query);
           // set content type and other response header fields first
           response.setContentType("text/xml");
           // Create a buffer to hold the xml result
           StringBuffer resultset = new StringBuffer();
           // Print the resulting root nodes
           long nodeid;
           out.println("<?xml version=\"1.0\"?>\n");
           out.println("<resultset>\n");
           out.println("  <query>" + query + "</query>");
           resultset.append("<?xml version=\"1.0\"?>\n");
           resultset.append("<resultset>\n");
           resultset.append("  <query>" + query + "</query>");
           Enumeration rootlist = nodelist.keys();
           while (rootlist.hasMoreElements()) {
             nodeid = ((Long)rootlist.nextElement()).longValue();
             out.println("  <nodeid>" + nodeid + "</nodeid>");
             resultset.append("  <nodeid>" + nodeid + "</nodeid>");
+          }
           out.println("</resultset>");
           resultset.append("</resultset>");
           String qformat = ((String[])params.get("qformat"))[0];
           if (qformat.equals("xml")) {
             // set content type and other response header fields first
             response.setContentType("text/xml");
             out.println(resultset.toString());
           } else if (qformat.equals("html")) {
             // set content type and other response header fields first
             response.setContentType("text/html");
             //out.println("Converting to HTML...");
             XMLDocumentFragment htmldoc = null;
             try {
               XSLStylesheet style = new XSLStylesheet(new URL(resultStyleURL), null);
               htmldoc = (new XSLProcessor()).processXSL(style,
                          (Reader)(new StringReader(resultset.toString())),null);
               htmldoc.print(out);
             } catch (Exception e) {
               out.println("Error transforming document:\n" + e.getMessage());
+            }
+          }
+      }
       /**
        * Handle the database getdocument request and return a XML document,
        * possibly transformed from XML into HTML
        */
       private void handleGetDocumentAction(PrintWriter out, Hashtable params,
                    HttpServletResponse response) {
           // Get the document indicated
-...
           response.setContentType("text/xml");
           out.println(doc);
           // Print the resulting root nodes
           //out.println("<?xml version=\"1.0\"?>\n");
           //out.println("<docid>" + docid + "</docid>");
+      }
+    }

     Simple database query against MetaCat<br>
     <form action="/servlets/MetaCatServlet" target="right" method="POST">
       <input type="hidden" name="action" value="query">
       <input type="text" name="query" size="15">
       <input type="text" name="query" value="Value1" size="15">
       <input type="submit" value="Run query">
       <br />
       <input type="checkbox" name="convert" value="true">Results in HTML
       Format:
       <input type="radio" name="qformat" value="xml">XML

Project

General

Profile

Metacat

Revision 50

Added by Matt Jones over 24 years ago