Metacat

/**

 *             XML hierarchy.  It returns a result set consisting of the

 *  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

import java.io.File;

import java.io.FileInputStream;

import java.io.FileOutputStream;

import java.io.IOException;

import java.io.InputStream;

import java.io.InputStreamReader;

import java.io.OutputStreamWriter;

import java.io.Reader;

import java.io.StringReader;

import java.io.StringWriter;

import java.io.Writer;

import java.sql.ResultSet;

import java.sql.SQLException;

import java.util.ArrayList;

import java.util.Date;

import java.util.Hashtable;

import java.util.Iterator;

import java.util.Vector;

import java.util.zip.ZipEntry;

import java.util.zip.ZipOutputStream;

import edu.ucsb.nceas.metacat.database.DBConnectionPool;

import edu.ucsb.nceas.utilities.triple.TripleCollection;

 * free text matches a query string, or structured query matches to a path

 * specified node in the XML hierarchy. It returns a result set consisting of

 * the document ID for each document that satisfies the query

{

    private String qformat = "xml";

    // are we combining the query with docid list and, if so, using INTERSECT or UNION?

    private String operator = null;

    private String parserName = null;

    private final boolean METACAT_SPATIAL = true;

         it is a vector of vector  **/

    // a hash table serves as query reuslt cache. Key of hashtable

    // Capacity of the query result cache

    static {

    	int qryRsltCacheSize = 0;

    	try {

    		System.err.println("Could not get QUERYRESULTCACHESIZE property in static block: "

					+ pnfe.getMessage());

    	}

    	QUERYRESULTCACHESIZE = qryRsltCacheSize;

    }

    private static final int NONPAGESIZE = 99999999;

     * the main routine used to test the DBQuery utility.

     * <p>

     * Usage: java DBQuery <xmlfile>

     */

    static public void main(String[] args)

    {

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

            System.err.println("USAGE: java DBQuery [-t] [-index] <xmlfile>");

            return;

        } else {

            try {

                boolean showRuntime = false;

                boolean useXMLIndex = false;

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

                    showRuntime = true;

                    i++;

                }

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

                    useXMLIndex = true;

                    i++;

                }

                String xmlfile = args[i];

                double startTime = System.currentTimeMillis();

                //Connection dbconn = util.openDBConnection();

                StringBuffer result = new StringBuffer();

                String document = null;

                String docid = null;

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

                result.append("<resultset>\n");

                    Enumeration doclist = nodelist.keys();

                    while (doclist.hasMoreElements()) {

                        docid = (String) doclist.nextElement();

                        document = (String) nodelist.get(docid);

                        result.append("  <document>\n    " + document

                                + "\n  </document>\n");

                    }

                }

                // Time the request if asked for

                double stopTime = System.currentTimeMillis();

                double dbOpenTime = (connTime - startTime) / 1000;

                double readTime = (stopTime - connTime) / 1000;

                double executionTime = (stopTime - startTime) / 1000;

                if (showRuntime) {

                    System.out.print("  " + executionTime);

                    System.out.print("  " + dbOpenTime);

                    System.out.print("  " + readTime);

                    System.out.print("  " + nodelist.size());

                    System.out.println();

                }

                //System.out.println(result);

                //write into a file "result.txt"

                if (!showRuntime) {

                    File f = new File("./result.txt");

                    out.write(result.toString());

                    out.flush();

                    out.close();

                    fw.close();

                }

                System.err.println("Error in DBQuery.main");

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

                e.printStackTrace(System.err);

            }

        }

    }

     * construct an instance of the DBQuery class

     * Generally, one would call the findDocuments() routine after creating an

     * instance to specify the search query

     * </p>

     *            the org.xml.sax.XMLReader interface

     */

     *

     * Construct an instance of DBQuery Class

     * BUT accept a docid Vector that will supersede

     * the query.printSQL() method

     *

     * If a docid Vector is passed in,

     * the docids will be used to create a simple IN query

     * without the multiple subselects of the printSQL() method

     *

     * Using this constructor, we just check for

     * a docidOverride Vector in the findResultDoclist() method

     *

     * @param docids List of docids to display in the resultset

     */

    	// docids vector into couple vectors.

    	logMetacat.info("DBQuery.DBQuery - The application result size in metacat.properties is "+size);

    	if (docids != null && docids.size() > size)

    	{

    		int index = 0;

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

    		{

    			if (index < size)

    			{

    				subset.add(docids.elementAt(i));

    				index ++;

    			}

    			else

    			{

    				docidOverride.add(subset);

    				subset = new Vector();

    				subset.add(docids.elementAt(i));

    			    index = 1;

    			}

    		}

    		if (!subset.isEmpty())

    		{

    			docidOverride.add(subset);

    		}

    	}

    	else

    	{

    		this.docidOverride.add(docids);

    	}

    }

  /**

   * Method put the search result set into out printerwriter

   * @param resoponse the return response

   * @param out the output printer

   * @param params the paratermer hashtable

   * @param user the user name (it maybe different to the one in param)

   * @param groups the group array

   * @param sessionid  the sessionid

   */

  public void findDocuments(HttpServletResponse response,

    findDocuments(response, out, params, user, groups, sessionid, useXMLIndex);

  }

     * @param resoponse the return response

     * @param out the output printer

     * @param params the paratermer hashtable

     * @param user the user name (it maybe different to the one in param)

     * @param groups the group array

     * @param sessionid  the sessionid

                                         String sessionid, boolean useXMLIndex)

      int pagestart = 0;

      if(params.containsKey("pagesize") && params.containsKey("pagestart"))

      {

        String pagesizeStr = ((String[])params.get("pagesize"))[0];

        String pagestartStr = ((String[])params.get("pagestart"))[0];

        if(pagesizeStr != null && pagestartStr != null)

        {

          pagesize = (new Integer(pagesizeStr)).intValue();

          pagestart = (new Integer(pagestartStr)).intValue();

        }

      }

      String qformat = null;

    	xmlquery = ((String[])params.get("query"))[0];

        logMetacat.info("DBQuery.findDocuments - xmlquery: " + xmlquery);

      catch (Exception ee)

      {

                  + ee.getMessage());

      }

      QuerySpecification qspec = null;

      if ( xmlquery != null)

      {

         xmlquery = transformQuery(xmlquery);

         try

         {

           qspec = new QuerySpecification(xmlquery,

                                          parserName,

         catch (Exception ee)

         {

      }

        //xml format

        {

            response.setContentType("text/xml");

        }

          pagesize, pagestart, sessionid, qformat);

      else

      {

        //knb format, in this case we will get whole result and sent it out

        try

        {

         response.setContentType("text/html");

         }

                                 "-//W3C//HTML//EN", qformat, out, params,

                                 sessionid);

         transferWarnLimit = Long.parseLong(PropertyService.getProperty("dbquery.transformTimeWarnLimit"));

         if (transformRunTime > transferWarnLimit) {

         	logMetacat.warn("DBQuery.findDocuments - The time to transfrom resultset from xml to html format is "

                  		                             + transformRunTime);

         }

          MetacatUtil.writeDebugToDelimiteredFile(" " + transformRunTime, false);

        catch(Exception e)

        {

      }//else

  /**

   * Transforms a hashtable of documents to an xml or html result and sent

   * the content to outputstream. Keep going untill hastable is empty. stop it.

   * add the QuerySpecification as parameter is for ecogrid. But it is duplicate

   * to xmlquery String

   * @param xmlquery

   * @param qspec

   * @param out

   * @param user

   * @param groups

   * @param useXMLIndex

   * @param sessionid

   * @return

   */

    public StringBuffer createResultDocument(String xmlquery,

                                              QuerySpecification qspec,

                                              boolean useXMLIndex)

    {

   * Transforms a hashtable of documents to an xml or html result and sent

   * add the QuerySpecification as parameter is for ecogrid. But it is duplicate

   * to xmlquery String

                                            QuerySpecification qspec,

                                            String qformat)

    DBConnection dbconn = null;

    int serialNumber = -1;

    StringBuffer resultset = new StringBuffer();

    //try to get the cached version first

    // HttpSession sess = (HttpSession)sessionHash.get(sessionid);

    resultset.append("<resultset>\n");

    resultset.append("  <pagesize>" + pagesize + "</pagesize>\n");

    resultset.append("  <nextpage>" + (pagestart + 1) + "</nextpage>\n");

    resultset.append("  <previouspage>" + (pagestart - 1) + "</previouspage>\n");

    	  out.write(resultset.toString());

		} catch (IOException e) {

			logMetacat.error(e.getMessage(), e);

		}

      {

        dbconn = DBConnectionPool.getDBConnection("DBQuery.findDocuments");

        serialNumber = dbconn.getCheckOutSerialNumber();

        // search the doc list

        StringBuffer resultContent = new StringBuffer();

        if (docidOverride == null || docidOverride.size() == 0)

        {

                    dbconn, useXMLIndex, pagesize, pagestart,

        else

        {

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

        	{

        		StringBuffer subset = findResultDoclist(qspec, out, user, groups,

                        dbconn, useXMLIndex, pagesize, pagestart,

        	}

        }

      catch (IOException ioe)

      {

      catch (SQLException e)

      {

      catch (Exception ee)

      {

      finally

      {

        DBConnectionPool.returnDBConnection(dbconn, serialNumber);

      } //finally

    }//if

    resultset.append(closeRestultset);

    if (out != null)

    {

		out.write(closeRestultset);

		} catch (IOException e) {

			logMetacat.error(e.getMessage(), e);

		}

  }//createResultDocuments

     * Find the doc list which match the query

     */

    private StringBuffer findResultDoclist(QuerySpecification qspec,

                                      Vector givenDocids, String qformat)

    {

  	  List<Object> parameterValues = new ArrayList<Object>();

      int count = 0;

      int index = 0;

      String docid = null;

      String docname = null;

      String doctype = null;

      String createDate = null;

      String updateDate = null;

      StringBuffer document = null;

      double startTime = 0;

      // this is a hack for offset. in postgresql 7, if the returned docid list is too long,

      //the extend query which base on the docid will be too long to be run. So we

      // have to cut them into different parts. Page query don't need it somehow.

      if (out == null)

        // for html page, we put everything into one page

      else

      {

          offset =

       * Check the docidOverride Vector

       * if defined, we bypass the qspec.printSQL() method

       * and contruct a simpler query based on a

       * list of docids rather than a bunch of subselects

       */

	  List<Object> docidValues = new ArrayList<Object>();

          parameterValues.addAll(docidValues);

    	  docidCondition.append( " docid IN (" );

        		  docidCondition.append(",");

        	  }

    	  // include the docids, either exclusively, or in conjuction with the query

    	  if (operator == null) {

    		  query = "SELECT docid, docname, doctype, date_created, date_updated, rev FROM xml_documents WHERE";

              query = query + docidCondition.toString();

    		  // start with the keyword query, but add conditions

              parameterValues.addAll(docidValues);

              if (!query.endsWith("WHERE")) {

	              if (operator.equalsIgnoreCase(QueryGroup.UNION)) {

	            	  myOperator =  " OR ";

	              }

	              else {

	            	  myOperator =  " AND ";

	              }

              }

              query = query + myOperator + docidCondition.toString();

    	  }

      List<Object> ownerValues = new ArrayList<Object>();

      String ownerQuery = getOwnerQuery(user, ownerValues);

      // otherwise we don't need (owner has all permission by default)

      if (!query.equals(ownerQuery))

      {

        // set user name and group

        qspec.setUserName(user);

        qspec.setGroup(groups);

        // Get access query

        String accessQuery = qspec.getAccessQuery();

            query = query + accessQuery;

        } else {

            query = query + accessQuery.substring(4, accessQuery.length());

        }

      pstmt = dbconn.prepareStatement(query);

      // set all the values we have collected

      pstmt = setPreparedStatementValues(parameterValues, pstmt);

      String queryCacheKey = null;

      if (user != null && user.equalsIgnoreCase("public")