Metacat

/**

 *  '$RCSfile$'

 *    Purpose: A class that gets Accession Number, check for uniqueness

 *             and register it into db

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

 *             National Center for Ecological Analysis and Synthesis

 *    Authors: Jivka Bojilova, Matt Jones

 *    Release: @release@

 *

 *   '$Author: sgarg $'

 *     '$Date: 2004-08-19 18:20:39 -0700 (Thu, 19 Aug 2004) $'

 * '$Revision: 2246 $'

 *

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

import java.sql.*;

import edu.ucsb.nceas.dbadapter.AbstractDatabase;

/**

 * (on insert of XML document)

 * Generates a unique Accession Number or if provided check it

 * for uniqueness and register it into the db connection

 * (on update or delete of XML document)

 * Check for existance of provided Accession Number

 *

 */

public class AccessionNumber  {

  private static final AbstractDatabase dbAdapter = MetaCatUtil.dbAdapter;

  //private Connection conn = null;

  private String sitecode = null;

  private String sep = null;

  private String docid = null;

  private String rev = null;

  /**

   * Construct an AccessionNumber

   */

  //public AccessionNumber ()

         //throws SQLException, ClassNotFoundException

  //{

    // Open a connection to the database from here

    //this((new MetaCatUtil()).openDBConnection());

  //}

  /**

   * Construct an AccessionNumber

   *

   * @param conn the db connection to read from and write Accession# to

   */

  public AccessionNumber ()

  {

    this.sitecode = MetaCatUtil.getOption("sitecode");

    this.sep = MetaCatUtil.getOption("accNumSeparator");

    //this.conn = conn;

  }

  /** NEW - WHEN CLIENT ALWAYS PROVIDE ACCESSION NUMBER INCLUDING REV IN IT

   * Construct an AccessionNumber

   *

   * @param conn the db connection to read Accession number from

   * @param accnum the accession number to be checked for validness

   */

  public AccessionNumber (String accnum, String action)

           throws AccessionNumberException, SQLException, NumberFormatException

 {

    this();

    this.rev = null;

    this.docid = accnum;

    if ( accnum != null ) {

      int firstIndex = accnum.indexOf(this.sep);

      int lastIndex = accnum.lastIndexOf(this.sep);

      if ( firstIndex != lastIndex ) {

        //this docid contains a revision number

        this.rev = accnum.substring(lastIndex + 1);

        this.docid = accnum.substring(0, lastIndex);

      }

    }

    // INSERT

    if ( action.equals("INSERT")) {

      // check accession number for validness

      if ( docid == null ) {

        throw new AccessionNumberException("Accession number is required.");

      // rev is not provided; throw an exception to prevent the insertion

      } else if ( rev == null ) {

        throw new AccessionNumberException

                  ("Revision number is required and must be 1.");

      // docid is used; throw an exception to prevent the insertion

      } else if ( accNumberUsed(docid) ) {

        throw new AccessionNumberException

                  ("Accession number " + docid + " is already in use.");

      // rev is <> 1; throw an exception to prevent the insertion

      } /*else if ( !rev.equals("1")) {

        throw new AccessionNumberException("Revision number must be 1.");

      }*/

    // UPDATE or DELETE

    } else if ( action.equals("UPDATE") || action.equals("DELETE")) {

      String l_rev = "";

      int reversionNumber = 1;

      if(rev != null){

        reversionNumber = Integer.parseInt(rev);

      }

      // Accession# is not provided; throw an exception to prevent the action

      if ( docid == null ) {

        throw new AccessionNumberException("Accession number is required.");

      // rev is not provided; throw an exception to prevent the action

      } else if ( rev == null ) {

        throw new AccessionNumberException

                  ("Revision number is required.");

      // Accession# is not current (not in xml_documents); throw an exception

      } else if ( !accNumberIsCurrent(docid) ) {

        throw new AccessionNumberException

                  ("Document not found for Accession number " + docid);

      //Revision number is less than or equal the recent one; throw a exception

      } else if ( action.equals("UPDATE") &&

                  reversionNumber <= getLastRevisionNumber(docid) ) {

        throw new AccessionNumberException

                 ("Next revision number couldn't be less than or equal "

                                              + getLastRevisionNumber(docid));

      // Revision number is not the recent one; throw an exception

      } else if ( action.equals("DELETE") &&

                  !rev.equals(l_rev = getLastRevision(docid)) ) {

        throw new AccessionNumberException

                  ("Last revision number is "+ l_rev);

      }

    }

  }

  /**

   * Generate an Accession Number of form <sidecode>.<uniqueid>.<revisionid>

   * where <revisionid> is always 1.

   *

   * @param docid <sitecode>.<uniqueid> part of Accession Number

   * @param action INSERT, UPDATE or DELETE action

   */

  public String generate(String docid, String action)

                throws AccessionNumberException, SQLException

  {

    return generate(docid, "1", action);

  }

  /**

   * Generate an Accession Number of form <sidecode>.<uniqueid>.<revisionid>

   *

   * @param docid <sitecode>.<uniqueid> part of Accession Number

   * @param rev <revisionid> of Accession Number

   * @param action INSERT, UPDATE or DELETE action

   */

  public String generate(String docid, String rev, String action)

                throws AccessionNumberException, SQLException

  {

    try {

      // INSERT

      if ( action.equals("INSERT")) {

        // get a new docid

        if ( docid == null ) {

          String sitecode = getSitecode();

          String uniqueid = getUniqueID(sitecode);

          return sitecode + sep + uniqueid;

        // docid is used; throw an exception to prevent the insertion

        } else if ( accNumberUsed(docid) ) {

          throw new AccessionNumberException

                    ("Accession number " + docid + " is already in use.");

        // rev is <> 1; throw an exception to prevent the insertion

        } else if ( !rev.equals("1") ) {

          throw new AccessionNumberException

                    ("Revision number must be 1.");

        // docid is not used and rev=1; return it

        } else {

          return docid;

        }

      // UPDATE or DELETE

      } else if ( action.equals("UPDATE") || action.equals("DELETE")) {

        // Accession# is not provided; throw an exception to prevent the action

        if ( docid == null ) {

          throw new AccessionNumberException("Accession number is required.");

        // Accession# is not current (not in xml_documents); throw an exception

        } else if ( !accNumberIsCurrent(docid) ) {

          throw new AccessionNumberException

          ("Document not found for Accession number " + docid);

        // Revision number is not the recent one; throw an exception

        } else if ( !rev.equals(getLastRevision(docid)) ) {

          throw new AccessionNumberException

          ("Revision number must be the recent.");

        // Accession# is current (present in xml_documents); return it

        } else {

          return docid;

        }

      }

    } catch (SQLException e) {

      throw new SQLException

      ("Error on AccessionNumber.generate(): " + e.getMessage());

    }

    // never comes here

    throw new

    AccessionNumberException("Fatal Error in accession number generation.");

  }

  // get local sitecode

  private String getSitecode()

  {

    return this.sitecode;

  }

  // get Unique ID from DB sequence

  private String getUniqueID (String sitecode) throws SQLException

  {

    String uniqueid;

    String sysdate = dbAdapter.getDateTimeFunction();

    DBConnection conn = null;

    int serialNumber = -1;

    try {

      PreparedStatement pstmt = null;

      //check out DBConnection

      conn=DBConnectionPool.getDBConnection("AccessionNumber.getUniqueID");

      serialNumber=conn.getCheckOutSerialNumber();

      pstmt = conn.prepareStatement

              ("INSERT INTO accession_number (site_code, date_created) " +

               "VALUES (?, " + sysdate + ")");

      pstmt.setString(1, sitecode);

      pstmt.execute();

      pstmt.close();

      uniqueid = "" + dbAdapter.getUniqueID(conn.getConnections(),

                                                          "accession_number");

      //because we only count the connection usage one when it check in

      //but it use twice. So we need to increase one

      conn.increaseUsageCount(1);

    } catch (SQLException e) {

      throw new

      SQLException("Error on AccessionNumber.getUniqueID(): "+e.getMessage());

    }

    finally

    {

      DBConnectionPool.returnDBConnection(conn, serialNumber);

    }

    return uniqueid;

  }

  /** check for existence of Accesssion Number xml_acc_numbers table */

  public static boolean accNumberUsed ( String accNumber )

                  throws SQLException {

    boolean hasAccNumber = false;

    DBConnection conn = null;

    int serialNumber = -1;

    try {

      PreparedStatement pstmt = null;

      //check out DBConnection

      conn=DBConnectionPool.getDBConnection("AccessionNumber.accNumberUsed");

      serialNumber=conn.getCheckOutSerialNumber();

      pstmt = conn.prepareStatement(

                "SELECT 'x' FROM xml_documents " +

                "WHERE docid = ? " +

                "UNION " +

                "SELECT 'x' FROM xml_revisions " +

                "WHERE docid = ?");

      pstmt.setString(1,accNumber);

      pstmt.setString(2,accNumber);

      pstmt.execute();

      ResultSet rs = pstmt.getResultSet();

      hasAccNumber = rs.next();

      pstmt.close();

    } catch (SQLException e) {

      throw new SQLException

      ("Error on AccessionNumber.accNumberUsed(accNumber): " + e.getMessage());

    }

    finally

    {

      DBConnectionPool.returnDBConnection(conn, serialNumber);

    }

    return hasAccNumber;

  }

  // check for existence of Accesssion Number in xml_documents table

  private boolean accNumberIsCurrent(String accNumber) throws SQLException {

    boolean hasCurrentAccNumber = false;

    DBConnection conn = null;

    int serialNumber = -1;

    try {

      PreparedStatement pstmt = null;

      //check out DBConnection

      conn=DBConnectionPool.getDBConnection("AccessionNumber.accNumberIsCurre");

      serialNumber=conn.getCheckOutSerialNumber();

      pstmt = conn.prepareStatement(

                "SELECT 'x' FROM xml_documents " +

                "WHERE docid = ?");

      pstmt.setString(1, accNumber);

      pstmt.execute();

      ResultSet rs = pstmt.getResultSet();

      hasCurrentAccNumber = rs.next();

      pstmt.close();

    } catch (SQLException e) {

      throw new SQLException(

          "Error on AccessionNumber.accNumberIsCurrent(String accNumber): " +

          e.getMessage());

    }

    finally

    {

      DBConnectionPool.returnDBConnection(conn, serialNumber);

    }

    return hasCurrentAccNumber;

  }

  // get the recent revision number for docid

  private String getLastRevision(String docid) throws SQLException

  {

    String rev = "";

    DBConnection conn = null;

    int serialNumber = -1;

    try {

      PreparedStatement pstmt = null;

      //check out DBConnection

      conn=DBConnectionPool.getDBConnection("AccessionNumber.getLastRevision");

      serialNumber=conn.getCheckOutSerialNumber();

      pstmt = conn.prepareStatement

              ("SELECT rev FROM xml_documents WHERE docid='" + docid + "'");

      pstmt.execute();

      ResultSet rs = pstmt.getResultSet();

      boolean hasRow = rs.next();

      rev = rs.getString(1);

      pstmt.close();

    } catch (SQLException e) {

      throw new SQLException(

      "Error on AccessionNumber.getLastRevision(): " + e.getMessage());

    }

    finally

    {

      DBConnectionPool.returnDBConnection(conn,serialNumber);

    }

    return rev;

  }

  /**

    * Get last revision number from database for a docid

    * The return value is integer because we want compare it to there new one

    * @param docid <sitecode>.<uniqueid> part of Accession Number

    */

  private int getLastRevisionNumber(String docId) throws SQLException

  {

    int rev = 1;

    DBConnection conn =null;

    int serialNumber = -1;

    try {

      PreparedStatement pStmt = null;

      //check out DBConnection

      conn=DBConnectionPool.getDBConnection("AccessionNumber.getLastRevisionN");

      serialNumber=conn.getCheckOutSerialNumber();

      pStmt = conn.prepareStatement

              ("SELECT rev FROM xml_documents WHERE docid='" + docId + "'");

      pStmt.execute();

      ResultSet rs = pStmt.getResultSet();

      boolean hasRow = rs.next();

      rev = rs.getInt(1);

      pStmt.close();

    } catch (SQLException e) {

      throw new SQLException(

      "Error on AccessionNumber.getLastRevision(): " + e.getMessage());

    }

    finally

    {

      DBConnectionPool.returnDBConnection(conn,serialNumber);

    }

    return rev;

  }

  // get the next revision number for docid

  private String getNextRevision(String docid) throws SQLException

  {

    String rev = "";

    DBConnection conn = null;

    int serialNumber = -1;

    try {

      PreparedStatement pstmt = null;

      //check out DBConnection

      conn=DBConnectionPool.getDBConnection("AccessionNumber.getNextRevision");

      serialNumber=conn.getCheckOutSerialNumber();

      pstmt = conn.prepareStatement

              ("SELECT rev+1 FROM xml_documents WHERE docid='" + docid + "'");

      pstmt.execute();

      ResultSet rs = pstmt.getResultSet();

      boolean hasRow = rs.next();

      rev = rs.getString(1);

      pstmt.close();

    } catch (SQLException e) {

      throw new SQLException(

      "Error on AccessionNumber.getNextRevision(): " + e.getMessage());

    }

    finally

    {

      DBConnectionPool.returnDBConnection(conn, serialNumber);

    }

    return rev;

  }

  /**

   * returns the docid encoded in this accession number

   */

  public String getDocid() {

    return this.docid;

  }

  /**

   * returns the revision number encoded in this accession number

   */

  public String getRev()

  {

    return this.rev;

  }

}