Metacat

/**

 *    Purpose: A Class that represents a structured query, and can be

 *             constructed from an XML serialization conforming to

 *             pathquery.dtd. The printSQL() method can be used to print

 *             a SQL serialization of the query.

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

 *             National Center for Ecological Analysis and Synthesis

 *    Authors: Matt Jones

 *     '$Date$'

 * '$Revision$'

 * This program is free software; you can redistribute it and/or modify

 * it under the terms of the GNU General Public License as published by

 * the Free Software Foundation; either version 2 of the License, or

 * (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

package edu.ucsb.nceas.metacat;

import java.io.*;

import java.util.Stack;

import org.xml.sax.SAXException;

import org.xml.sax.SAXParseException;

import org.xml.sax.helpers.XMLReaderFactory;

import org.xml.sax.helpers.DefaultHandler;

 * constructed from an XML serialization conforming to @see pathquery.dtd.

 * The printSQL() method can be used to print a SQL serialization of the query.

  private String queryTitle;

  /** List of document types to be returned using package back tracing */

  private Stack queryStack;

  private String currentPathexpr;

   * construct an instance of the QuerySpecification class

   *

   *                  to pathquery.dtd) as a Reader

   * @param parserName the fully qualified name of a Java Class implementing

         String accNumberSeparator ) throws IOException {

    filterDocList = new Vector();

    queryStack   = new Stack();

    siteList = new Vector();

    // Initialize the parser and read the queryspec

      System.err.println("SAX parser not instantiated properly.");

    }

      parser.parse(new InputSource(queryspec));

    } catch (SAXException e) {

                         "QuerySpecification.QuerySpecification");

  }

  /**

   * construct an instance of the QuerySpecification class

   *

   *                  to pathquery.dtd) as a String

   * @param parserName the fully qualified name of a Java Class implementing

   *                  the org.xml.sax.Parser interface

         String accNumberSeparator) throws IOException {

    this(new StringReader(queryspec), parserName, accNumberSeparator);

  /** Main routine for testing */

  static public void main(String[] args) {

     if (args.length < 1) {

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

       System.err.println("USAGE: java QuerySpecification <xmlfile>");

       return;

     } else {

       boolean useXMLIndex = true;

       if ( args[i].equals( "-noindex" ) ) {

         useXMLIndex = false;

         i++;

       }

       String xmlfile  = args[i];

                                        util.getOption("accNumberSeparator"));

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

       }

     }

  }

  /**

   * Returns true if the parsed query contains and extended xml query

   * (i.e. there is at least one <returnfield> in the pathquery document)

   */

  public boolean containsExtendedSQL()

  {

    if(containsExtendedSQL)

    {

      return true;

    }

    else

    {

      return false;

    }

  }

  /**

   */

  public String getIdentifier()

  {

    return meta_file_id;

  }

  /**

   * method to set the identifier of this query

   */

  public void setIdentifier(String id) {

    this.meta_file_id = id;

  }

  /**

   * Accessor method to return the title of this Query

   */

  public String getQueryTitle()

  {

    return queryTitle;

  }

  /**

   * method to set the title of this query

   */

  public void setQueryTitle(String title)

  {

    this.queryTitle = title;

  }

  /**

   * Accessor method to return a vector of the return document types as

   * defined in the <returndoctype> tag in the pathquery dtd.

   */

  public Vector getReturnDocList()

  {

    return this.returnDocList;

  }

  /**

   * method to set the list of return docs of this query

   */

  public void setReturnDocList(Vector returnDocList)

  {

    this.returnDocList = returnDocList;

  }

  /**

   * Accessor method to return a vector of the filter doc types as

   * defined in the <filterdoctype> tag in the pathquery dtd.

   */

  public Vector getFilterDocList()

  {

    return this.filterDocList;

  }

  /**

   * method to set the list of filter docs of this query

   */

  public void setFilterDocList(Vector filterDocList)

  {

    this.filterDocList = filterDocList;

  }

  /**

   * defined in the <returnfield> tag in the pathquery dtd.

   */

  public Vector getReturnFieldList()

  {

    return this.returnFieldList;

  }

   */

  public void setReturnFieldList(Vector returnFieldList)

  {

    this.returnFieldList = returnFieldList;

  }

  /**

   * Accessor method to return a vector of the owner fields as

   * defined in the <owner> tag in the pathquery dtd.

   */

  public Vector getOwnerList()

  {

    return this.ownerList;

  }

  /**

   * method to set the list of owners used to constrain this query

   */

  public void setOwnerList(Vector ownerList)

  {

    this.ownerList = ownerList;

  }

  /**

   * Accessor method to return a vector of the site fields as

   * defined in the <site> tag in the pathquery dtd.

   */

  public Vector getSiteList()

  {

    return this.siteList;

  }

  /**

   * method to set the list of sites used to constrain this query

   */

  public void setSiteList(Vector siteList)

  {

    this.siteList = siteList;

  }

  /**

   * get the QueryGroup used to express query constraints

   */

  public QueryGroup getQueryGroup()

  {

    return query;

  }

  /**

   */

    XMLReader parser = null;

    try {

      // Get an instance of the parser

      parser.setContentHandler(this);

    } catch (Exception e) {

                           e.toString());

    return parser;

  }

   * callback method used by the SAX Parser when the start tag of an

   * element is detected. Used in this context to parse and store

   * the query information in class variables.

   */

                            String qName, Attributes atts)

    if (atts != null) {

      int len = atts.getLength();

      for (int i = 0; i < len; i++) {

    }

        query = currentGroup;

        QueryGroup parentGroup = (QueryGroup)queryStack.peek();

        parentGroup.addChild(currentGroup);

   * callback method used by the SAX Parser when the end tag of an

   * element is detected. Used in this context to parse and store

   * the query information in class variables.

   */

                          String qName) throws SAXException {

      boolean isCaseSensitive = (new Boolean(

              leaving.getAttribute("casesensitive"))).booleanValue();

      QueryTerm currentTerm = null;

      if (currentPathexpr == null) {

        currentTerm = new QueryTerm(isCaseSensitive,

                      leaving.getAttribute("searchmode"),currentValue);

      } else {

        currentTerm = new QueryTerm(isCaseSensitive,

                      leaving.getAttribute("searchmode"),currentValue,

                      currentPathexpr);

      }

      QueryGroup currentGroup = (QueryGroup)queryStack.peek();

      currentGroup.addChild(currentTerm);

      currentValue = null;

      currentPathexpr = null;

    } else if (leaving.getTagName().equals("querygroup")) {

      QueryGroup leavingGroup = (QueryGroup)queryStack.pop();

   * callback method used by the SAX Parser when the text sequences of an

   * xml stream are detected. Used in this context to parse and store

   * the query information in class variables.

   */

    String inputString = new String(ch, start, length);

    BasicNode currentNode = (BasicNode)elementStack.peek();

    String currentTag = currentNode.getTagName();

    if (currentTag.equals("meta_file_id")) {

      meta_file_id = inputString;

      queryTitle = inputString;

      currentValue = inputString;

    } else if (currentTag.equals("pathexpr")) {

      currentPathexpr = inputString;

      filterDocList.add(inputString);

      returnFieldList.add(inputString);

      containsExtendedSQL = true;

      filterDocList.add(inputString);

      ownerList.add(inputString);

    } else if (currentTag.equals("site")) {

      siteList.add(inputString);

  }

   * create a SQL serialization of the query that this instance represents

   */

    self.append(") ");

    // list will be searched if the tag is present

    if (!filterDocList.isEmpty()) {

      self.append(" AND (");

        String currentDoctype = (String)en.nextElement();

        if (firstdoctype) {

           self.append(" doctype = '" + currentDoctype + "'");

          self.append(" OR doctype = '" + currentDoctype + "'");

        }

      }

      self.append(") ");

    }

    // This is an implicit OR for the list of owners

    if (!ownerList.isEmpty()) {

      boolean first = true;

      self.append(" AND (");

      Enumeration en = ownerList.elements();

      while (en.hasMoreElements()) {

        String current = (String)en.nextElement();

        if (first) {

           first = false;

           self.append(" user_owner = '" + current + "'");

        } else {

          self.append(" OR user_owner = '" + current + "'");

        }

      }

      self.append(") ");

    }

    // Add SQL to filter for sites requested in the query

    // This is an implicit OR for the list of sites

    if (!siteList.isEmpty()) {

      boolean first = true;

      self.append(" AND (");

      Enumeration en = siteList.elements();

      while (en.hasMoreElements()) {

        String current = (String)en.nextElement();

        if (first) {

           first = false;

           self.append(" SUBSTR(docid, 1, INSTR(docid, '" +

               accNumberSeparator + "')-1) = '" + current + "'");

        } else {

          self.append(" OR SUBSTR(docid, 1, INSTR(docid, '" +

               accNumberSeparator + "')-1) = '" + current + "'");

        }

      }

      self.append(") ");

    }

  }

  /**

   * This method prints sql based upon the <returnfield> tag in the

   * pathquery document.  This allows for customization of the

   * returned fields

    StringBuffer self = new StringBuffer();

    self.append("from xml_index, xml_nodes where xml_index.nodeid=");

    self.append("xml_nodes.parentnodeid and (xml_index.path like '");

    //put the returnfields into the query

    //the for loop allows for multiple fields

    for(int i=0; i<returnFieldList.size(); i++)

    {

      if(firstfield)

      {

        firstfield = false;

      }

      else

      {

      }

    }

    self.append(doclist);

  }

  public static String printRelationSQL(String docid)

  {

    StringBuffer self = new StringBuffer();

    self.append("objdoctype from xml_relation ");

  }

  public static String printPackageSQL()

  {

    StringBuffer self = new StringBuffer();

    self.append("select z.nodedata, x.nodedata, y.nodedata from ");

    self.append("(select nodeid, parentnodeid from xml_index where path like ");

    self.append("where s.parentnodeid = rel.parentnodeid ");

    self.append("and rel.parentnodeid = o.parentnodeid ");

    self.append("and x.parentnodeid in rel.nodeid ");

    self.append("and y.parentnodeid in o.nodeid ");

    self.append("and z.parentnodeid in s.nodeid ");

    //self.append("and z.nodedata like '%");

    //self.append(docid);

    //self.append("%'");

    return self.toString();

  }

  /**

   * under a specific docid

   * @param docid the docid to search for.

   */

  public static String printPackageSQL(String docid)

  {

    StringBuffer self = new StringBuffer();

    self.append("select z.nodedata, x.nodedata, y.nodedata from ");

    self.append("(select nodeid, parentnodeid from xml_index where path like ");

    self.append("where s.parentnodeid = rel.parentnodeid ");

    self.append("and rel.parentnodeid = o.parentnodeid ");

    self.append("and x.parentnodeid in rel.nodeid ");

    self.append("and y.parentnodeid in o.nodeid ");

    self.append("and z.parentnodeid in s.nodeid ");

    self.append("and z.docid like '").append(docid).append("'");

    return self.toString();

  }

  /**

   * Returns all of the relations that has a certain docid in the subject

   * or the object.

   *

   * @param docid the docid to search for

   */

  public static String printPackageSQL(String subDocidURL, String objDocidURL)

  {

    StringBuffer self = new StringBuffer();

    self.append("select z.nodedata, x.nodedata, y.nodedata from ");

    self.append("(select nodeid, parentnodeid from xml_index where path like ");

    self.append("where s.parentnodeid = rel.parentnodeid ");

    self.append("and rel.parentnodeid = o.parentnodeid ");

    self.append("and x.parentnodeid in rel.nodeid ");

    self.append("and y.parentnodeid in o.nodeid ");

    self.append("and z.parentnodeid in s.nodeid ");

    self.append("and (z.nodedata like '");

    self.append(subDocidURL);

    self.append("' or y.nodedata like '");

    self.append(objDocidURL);

    self.append("')");

    return self.toString();

  }

  public static String printGetDocByDoctypeSQL(String docid)

  {

    StringBuffer self = new StringBuffer();

    self.append("FROM xml_documents WHERE docid IN (");

    self.append(docid).append(")");

    return self.toString();

  }

  /**

   * This should become a way to get the XML serialization of the query.

   */

//DOCTITLE attr cleared from the db

//    return "meta_file_id=" + meta_file_id + "\n" +

//           "querytitle=" + querytitle + "\n" + query;

  private class QueryGroup {

    private Vector children = null;  // the list of query terms and groups

     * construct a new QueryGroup

     *

     */

      this.operator = operator;

    }

     * Add a child QueryGroup to this QueryGroup

     *

     * @param qgroup the query group to be added to the list of terms

     */

      children.add((Object)qgroup);

    }

     * Add a child QueryTerm to this QueryGroup

     *

     * @param qterm the query term to be added to the list of terms

     */

      children.add((Object)qterm);

    }

     * Retrieve an Enumeration of query terms for this QueryGroup

     */

      return children.elements();

    }

     * create a SQL serialization of the query that this instance represents

     */

      boolean first = true;

      self.append("(");

      Enumeration en= getChildren();

      while (en.hasMoreElements()) {

        Object qobject = en.nextElement();

        if (first) {

          first = false;

        } else {

        if (qobject instanceof QueryGroup) {

          QueryGroup qg = (QueryGroup)qobject;

          QueryTerm qt = (QueryTerm)qobject;

          System.err.println("qobject wrong type: fatal error");

        }

      }

      self.append(") \n");

      return self.toString();

    }

     * create a String description of the query that this instance represents.

     * This should become a way to get the XML serialization of the query.

     */

      StringBuffer self = new StringBuffer();

      while (en.hasMoreElements()) {

        Object qobject = en.nextElement();