Metacat

/**

 *  '$RCSfile$'

 *    Purpose: A Class that creates an XML text document

 *             from a query to a relational DB containing a DOM representation

 *  Copyright: 2000 Regents of the University of California and the

 *             National Center for Ecological Analysis and Synthesis

 *    Authors: Matt Jones

 *    Release: @release@

 *

 *   '$Author$'

 *     '$Date$'

 * '$Revision$'

 */

package edu.ucsb.nceas.metacat;

import java.sql.*;

import java.io.PrintWriter;

import java.util.TreeSet;

/** 

 * A Class that creates an XML text document

 * from a query to a relational DB containing a DOM representation

 */

public class DBReader {

  private Connection	conn = null;

  /**

   * main routine used for testing.

   * <p>

   * Usage: java DBReader <docid>

   *

   * @param nodeid the id number of the root of the subtree to display

   */

  static public void main(String[] args) {

     if (args.length < 1)

     {

        System.err.println("Wrong number of arguments!!!");

        System.err.println("USAGE: java DBReader <docid>");

        return;

     } else {

        try {

          String docid = args[0];

          // Open a connection to the database

          MetaCatUtil   util = new MetaCatUtil();

          Connection dbconn = util.openDBConnection();

          DBReader rd = new DBReader( dbconn );

          String xml = rd.readXMLDocument(docid);

          System.out.println(xml);

        } catch (McdbException me) {

          me.toXml(new PrintWriter(System.err));

        } catch (Exception e) {

          System.err.println("EXCEPTION HANDLING REQUIRED");

          System.err.println(e.getMessage());

          e.printStackTrace(System.err);

        }

     }

  }

  /**

   * construct a DBReader instance.

   *

   * Generally, one calls readXMLDocument() after constructing the instance

   *

   * @param conn the database connection from which to read the document

   */

  public DBReader( Connection conn ) 

  {

    this.conn = conn;

  }

  /**

   * Create an XML document from the database for the document with ID docid

   *

   * @param docid the document identifier that we want retrieved

   */

  public String readXMLDocument(String docid) 

         throws McdbException

  {

    try {

      StringBuffer doc = new StringBuffer();

      // Look up the document information

      DoctypeInfo dti = getDoctypeInfo(docid);

      String docname = dti.getDocname();

      String doctype = dti.getDoctype();

      String sysid = dti.getSystemID();

      long rootnodeid = dti.getRootNodeID();

      // Download all of the document nodes using a single SQL query

      TreeSet nodeRecordList = getNodeRecordList(docid);

      // Create the elements from the downloaded nodes

      //ElementNode element = new ElementNode(conn, rootnodeid);

      ElementNode element = new ElementNode(nodeRecordList, rootnodeid);

      // Append the resulting document to the StringBuffer

      doc.append("<?xml version=\"1.0\"?>\n");

      if (docname != null) {

        if ((doctype != null) && (sysid != null)) {

          doc.append("<!DOCTYPE " + docname + " PUBLIC \"" + doctype + 

                     "\" \"" + sysid + "\">\n");

        } else {

          doc.append("<!DOCTYPE " + docname + ">\n");

        }

      }

      doc.append(element.toString());

      return (doc.toString());

    } catch (McdbException ex) {

      throw ex;

    } catch (Throwable t) {

      throw new McdbException("Error reading document " + docid + ".");

    }

  }

  /**

   * Look up the document type information from the database

   *

   * @param docid the id of the document to look up

   */

  public DoctypeInfo getDoctypeInfo(String docid) 

         throws McdbException 

  {

    PreparedStatement pstmt;

    String doctype = null;

    String docname = null;

    String sysid   = null;

    long rootnodeid = 0;

    DoctypeInfo dti = null;

    try {

      pstmt =

        conn.prepareStatement("SELECT docname,doctype,rootnodeid " +

                                "FROM xml_documents " +

                               "WHERE docid = ?");

      // Bind the values to the query

      pstmt.setString(1, docid);

      pstmt.execute();

      ResultSet rs = pstmt.getResultSet();

      boolean tableHasRows = rs.next();

      if (tableHasRows) {

        docname    = rs.getString(1);

        doctype    = rs.getString(2);

        rootnodeid = rs.getLong(3);

      } 

      pstmt.close();

      if (doctype != null) {

        pstmt =

          conn.prepareStatement("SELECT system_id " +

                                  "FROM xml_catalog " +

                                 "WHERE public_id = ?");

        // Bind the values to the query

        pstmt.setString(1, doctype);

        pstmt.execute();

        rs = pstmt.getResultSet();

        tableHasRows = rs.next();

        if (tableHasRows) {

          sysid  = rs.getString(1);

        } 

        pstmt.close();

      }

    } catch (SQLException e) {

      throw new McdbException("Error accessing database connection.", e);

    }

    if (docname != null) {

      dti = new DoctypeInfo(docname, doctype, sysid, rootnodeid);

      return dti;

    } else {

      throw new McdbDocNotFoundException("Document not found: " + docid);

    }

  }

  /**

   * Look up the node data from the database

   *

   * @param docid the id of the document to look up

   */

  public TreeSet getNodeRecordList(String docid) 

         throws McdbException 

  {

    PreparedStatement pstmt;

    TreeSet nodeRecordList = new TreeSet(new NodeComparator());

    long nodeid = 0;

    long parentnodeid = 0;

    long nodeindex = 0;

    String nodetype = null;

    String nodename = null;

    String nodedata = null;

    try {

      pstmt =

      conn.prepareStatement("SELECT nodeid,parentnodeid,nodeindex, " +

           "nodetype,nodename,"+               

           "replace(" +

           "replace(" +

           "replace(nodedata,'&','&') " +

           ",'<','&lt;') " +

           ",'>','>') " +

           "FROM xml_nodes WHERE docid = ?");

      // Bind the values to the query

      pstmt.setString(1, docid);

      pstmt.execute();

      ResultSet rs = pstmt.getResultSet();

      boolean tableHasRows = rs.next();

      while (tableHasRows) {

        nodeid = rs.getLong(1);

        parentnodeid = rs.getLong(2);

        nodeindex = rs.getLong(3);

        nodetype = rs.getString(4);

        nodename = rs.getString(5);

        nodedata = rs.getString(6);

        // add the data to the node record list hashtable

        NodeRecord currentRecord = new NodeRecord(nodeid, parentnodeid, 

                                   nodeindex, nodetype, nodename, nodedata);

        nodeRecordList.add(currentRecord);

        // Advance to the next node

        tableHasRows = rs.next();

      } 

      pstmt.close();

    } catch (SQLException e) {

      throw new McdbException("Error accessing database connection.", e);

    }

    if (nodeRecordList != null) {

      return nodeRecordList;

    } else {

      throw new McdbException("Error getting node data: " + docid);

    }

  }

  /**

   * A utility class that encapsulates document type information

   */

  public class DoctypeInfo {

    private String docname = null;

    private String doctype = null;

    private String system_id = null;

    private long rootnodeid;

    /**

     * Constructor

     */

    public DoctypeInfo(String docname, String doctype, 

                       String system_id, long rootnodeid) {

      this.docname = docname;

      this.doctype = doctype;

      this.system_id = system_id;

      this.rootnodeid = rootnodeid;

    }

    /**

     * get the document name

     */

    public String getDocname() {

      return docname;

    }

    /**

     * get the document type

     */

    public String getDoctype() {

      return doctype;

    }

    /**

     * get the system identifier

     */

    public String getSystemID() {

      return system_id;

    }

    /**

     * get the root node identifier

     */

    public long getRootNodeID() {

      return rootnodeid;

    }

  }

}