Metacat

/**

 *   '$Author: tao $'

 *     '$Date: 2003-02-04 15:55:01 -0800 (Tue, 04 Feb 2003) $'

 * '$Revision: 1388 $'

 *

 * 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.sql.*;

import java.util.*;

import java.net.*;

public class RelationHandler //implements Runnable

{

  private Thread btThread = null;

  private DBConnection connection = null;

  private String docid = null;

  MetaCatUtil util = new MetaCatUtil();

  // The hashtable's key is String vector, subject parentid , relation ship

  // prarent id and object parent id. Element is a vetor too. subject, relation

  // and object

  private Hashtable parentNodeIdList = new Hashtable();

  private static final int SUBJECTINDEX = 0;

  private static final int RELATIONINDEX = 1;

  private static final int OBJECTINDEX = 2;

  /** 

   * Constructor for this class.  finds all of the relations to a single xml

   * document and writes them to the database.  This includes transitive

   * relations.

   * @param docid the ID of the XML document to index.

   */

  public RelationHandler(String docid, DBConnection conn)

              throws McdbException, SQLException, AccessionNumberException

  {

    this.connection = conn;

    this.docid = docid;

    putRelations();

  }

  /**

   * insert the relations specified in the triples into xml_relation table

   */ 

  private void putRelations() 

              throws McdbException, SQLException, AccessionNumberException

  {

    String packagetype = null;

    String subject = null;

    String subjectParentId = null;

    String subDoctype = null;

    String relationship = null;

    String relationshipParentId = null;

    String object = null;

    String objectParentId = null;

    String objDoctype = null;

    PreparedStatement pstmt = null; // to get the relations from xml_nodes

    PreparedStatement tstmt = null; // to insert each relation into xml_relation

    MetaCatUtil.debugMessage("Running relation handler!", 40);

    /* 

     * PSEUDO-CODE ALGORITHM:

     * deletes all of the relations with a docid of @docid.

     * for each new relation r in xml_nodes

     *   put r into xml_relation

     */

    //DocumentImpl xmldoc = new DocumentImpl(conn,docid,false);

    packagetype = (new DocumentImpl(docid,false)).getDoctype();

    // first delete the relations for this package document if any

    deleteRelations(docid);

    // to put the new relations get them out of xml_nodes

    pstmt = connection.prepareStatement

                                (QuerySpecification.printPackageSQL(docid));

    //increase usage cont

    connection.increaseUsageCount(1);

    pstmt.execute();

    ResultSet rs = pstmt.getResultSet();

    boolean hasmorerows = rs.next();

    while(hasmorerows) {

      Vector parentId = new Vector();

      Vector sbjReObj = new Vector();

      boolean mergeSubject = false;

      boolean mergeRelation = false;

      boolean mergerObject = false;

      subject = rs.getString(1);

      subjectParentId = rs.getString(2);

      relationship = rs.getString(3);

      relationshipParentId = rs.getString(4);

      object = rs.getString(5);

      objectParentId = rs.getString(6);

      MetaCatUtil.debugMessage("oringal subjectparentid: " + 

                                                subjectParentId, 40);

      MetaCatUtil.debugMessage("oringinal subject: "+subject);

      MetaCatUtil.debugMessage("oringal relation parentid: "+ 

                                relationshipParentId, 40);

      MetaCatUtil.debugMessage("oringinal relationship: "+relationship, 40);

      MetaCatUtil.debugMessage("oringal objectparentid: "+ 

                                objectParentId, 40);

      MetaCatUtil.debugMessage("oringinal object: "+object, 40);

      if ( hasSameId(subjectParentId) )

      {

        // subject was splited and need to conbined

        String prefixSubject = getValueFromParentIdList(subjectParentId);

        if (prefixSubject !=null && !prefixSubject.equals(subject))

        {

          MetaCatUtil.debugMessage("merger subject: "+prefixSubject + 

                                    subject, 40);

          subject = prefixSubject + subject;

          mergeSubject = true;

        }

      }

      if ( hasSameId(relationshipParentId) )

      {

        // relationship need to be combined

        String relationPrefix = getValueFromParentIdList(relationshipParentId);

        if (relationPrefix != null && !relationPrefix.equals(relationship))

        {

          MetaCatUtil.debugMessage("merge relation: "+ relationPrefix + 

                                    relationship);

          relationship = relationPrefix + relationship;

          mergeRelation = true;

        }

      }

      if ( hasSameId(objectParentId) )

      {

        String objectPrefix = getValueFromParentIdList(objectParentId);

        if (objectPrefix != null && !objectPrefix.equals(object))

        {

          MetaCatUtil.debugMessage("merge object: "+ objectPrefix + object);

          object = objectPrefix + object;

          mergerObject = true;

        }

      }

      if (mergeSubject)

      {

        removeEntryFromParentIdList(subjectParentId);

      }

      if (mergeRelation)

      {

        removeEntryFromParentIdList(relationshipParentId);

      }

      if (mergerObject)

      {

        removeEntryFromParentIdList(objectParentId);

      }

      // Store the parentids into parentId vector

      parentId.addElement(subjectParentId);

      parentId.addElement(relationshipParentId);

      parentId.addElement(objectParentId);

      // Store the value into sbjRelObj vector

      sbjReObj.addElement(subject);

      sbjReObj.addElement(relationship);

      sbjReObj.addElement(object);

      // Store the parent id and value into hashtable

      parentNodeIdList.put(parentId, sbjReObj);

      hasmorerows = rs.next();

    }

    Enumeration en = parentNodeIdList.elements();

    if (en.hasMoreElements()) {

      tstmt = connection.prepareStatement("INSERT INTO xml_relation (" +

                                    "docid,packagetype,subject,subdoctype," +

                                    "relationship, object, objdoctype) " + 

                                    "VALUES (?, ?, ?, ?, ?, ?, ?)");

      //increase usage count

      connection.increaseUsageCount(1);

    }

    while (en.hasMoreElements())

    {

      Vector values = (Vector)en.nextElement();

      // cut out the revision number for subject and object

      subject = (new DocumentIdentifier((String)values.elementAt(SUBJECTINDEX)))

                                                        .getIdentifier();

      relationship = (String)values.elementAt(RELATIONINDEX);

      object = (new DocumentIdentifier((String)values.elementAt(OBJECTINDEX)))

                                                      .getIdentifier();

      //subDoctype and objDoctype are N/A

      subDoctype = null;

      objDoctype = null;

      //put the new relation into xml_relation

      tstmt.setString(1, docid);

      tstmt.setString(2, packagetype);

      tstmt.setString(3, subject);

      tstmt.setString(4, subDoctype);

      tstmt.setString(5, relationship);

      tstmt.setString(6, object);

      tstmt.setString(7, objDoctype);

      tstmt.execute(); 

    }

    if ( tstmt != null ) {

      tstmt.close();

    }

    pstmt.close();

    connection.commit();

  }

  /*

   * A method to check if a parentid is already in the paretnIdlist

   */

   public boolean hasSameId(String parentId)

   {

     boolean hasSame = false;

     if (parentId == null || parentId.equals(""))

     {

       return hasSame;

     }

     Enumeration en = parentNodeIdList.keys();

     // go throught hashtable

     while (en.hasMoreElements())

     {

       Vector keys = (Vector)en.nextElement();

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

       {

         String obj = (String)keys.elementAt(i);

         if ( obj != null && obj.equals(parentId) )

         {

           hasSame = true;

         }//if

       }//for

     }//while

     return hasSame;

   }

   /*

    * Get a value from parentidlist for a given paretnIdlist

    */

   public String getValueFromParentIdList(String parentId)

   {

     String value = null;

     int    index = -1; // index in vector keys which has same parentid to 

                        // given id

     // Check the parameter

     if ( parentId == null || parentId.equals("") )

     {

       return value;

     }

     Enumeration en = parentNodeIdList.keys();

     // go throught hashtable

     while (en.hasMoreElements())

     {

       Vector keys = (Vector)en.nextElement();

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

       {

         String obj = (String)keys.elementAt(i);

         if ( obj != null && obj.equals(parentId) )

         {

           index = i;

         }//if

         if (index != -1)

         {

           // get the element vector to the key

           Vector element = (Vector)parentNodeIdList.get(keys);

           // get string

           value = (String)element.elementAt(index);

         }

         // reset index

         index = -1;

       }//for

     }//while

     MetaCatUtil.debugMessage("The value for given parent id " + parentId +

                              "is " + value, 40);

     return value;

   }

   /*

    * A method to remove a entry in hashtable for given parentid

    */

   private void removeEntryFromParentIdList(String parentId)

   {

     if (parentId==null || parentId.equals(""))

     {

       return;

     }

     Enumeration en = parentNodeIdList.keys();

     // go throught hashtable

     while (en.hasMoreElements())

     {

       Vector keys = (Vector)en.nextElement();

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

       {

         String obj = (String)keys.elementAt(i);

         if ( obj != null && obj.equals(parentId) )

         {

            parentNodeIdList.remove(keys);

         }//if

       }//for

     }//while

   } 

  /**

   * Deletes all of the relations with a docid of 'docid'.

   * @param docid the docid of the package which relations to delete.

   */

  public void deleteRelations(String docid) throws SQLException

  {

    try {

      PreparedStatement pstmt = connection.prepareStatement(

                                "DELETE FROM xml_relation " +

                                "WHERE docid = '" + docid + "'");

      //increase usage count

      connection.increaseUsageCount(1);

      pstmt.execute();

      pstmt.close();

    } catch(SQLException e) {

      MetaCatUtil.debugMessage("error in RelationHandler.deleteRelations(): " + 

                          e.getMessage());

      System.out.println("error in RelationHandler.deleteRelations(): " + 

                          e.getMessage());

      throw e;

    }

  }

  /**

   * Get the access file id for a package

   * @param docid the document identifier of the package

   * @return the document identifier of the access file for that package

   */

  public String getAccessFileID(String docid) throws SQLException

  {

    String aclid = null;

    PreparedStatement pstmt = null;

    DBConnection dbConn = null;

    int serialNumber = -1;

    StringBuffer sql = new StringBuffer();

    sql.append("SELECT docid FROM xml_documents WHERE docid in (SELECT subject ");

    sql.append("FROM xml_relation WHERE docid='").append(docid);

    sql.append("' AND (");

    Vector accessdoctypes = MetaCatUtil.getOptionList(

                              MetaCatUtil.getOption("accessdoctype"));

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

    {

      String atype = (String)accessdoctypes.elementAt(i);

      sql.append("doctype='").append(atype).append("'");

      if(i < accessdoctypes.size()-1)

      {

        sql.append(" OR ");

      }

    }

    sql.append("))");

    //System.out.println("new sql script: " + sql.toString());

    /*

    PreparedStatement pstmt = 

      conn.prepareStatement("SELECT docid FROM xml_documents " +

                            "WHERE docid in " +

                            "(SELECT subject FROM xml_relation " +

                            "WHERE docid = ?) " +

                            "AND doctype = ?");

    pstmt.setString(1, docid);

    pstmt.setString(2, MetaCatUtil.getOption("accessdoctype"));

    */

    try

    {

      dbConn=DBConnectionPool.

                  getDBConnection("RelationHandler.getAccessFileID");

      serialNumber=dbConn.getCheckOutSerialNumber();

      pstmt = dbConn.prepareStatement(sql.toString());

      pstmt.execute();

      ResultSet rs = pstmt.getResultSet();

      boolean hasRow = rs.next();

      if (hasRow) {

        aclid = rs.getString(1);

      }

      pstmt.close();

    }//try

    finally

    {

      try

      {

        pstmt.close();

      }//try

      finally

      {

        DBConnectionPool.returnDBConnection(dbConn, serialNumber);

      }//finally

    }//finally

    return aclid;

  }

}