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: bojilova $'

 *     '$Date: 2000-08-30 11:19:41 -0700 (Wed, 30 Aug 2000) $'

 * '$Revision: 421 $'

 */

package edu.ucsb.nceas.metacat;

import java.net.*;

import java.sql.*;

/**

 * A class that generates an Accession Number and will check a submitted

 * accession number for uniqueness and register it into the db connection

 */

public class AccessionNumber  {

    /**

     * Get an accession number from the user, check it for uniqueness 

     * and register it into new db connection. If no accession number is

     * provided by the user, generate one from the database and return it.

     *

     * @param accNumber - accession # if provided or null if not

     * @param action - INSERT, UPDATE or DELETE.

     * When "INSERT" and accession # provided is not unique, get next one.

     * If it is unique, use it.

     * When "INSERT" and accession # is null, get a new one.

     * When "UPDATE", accession # is required. 

     * When "DELETE", accession # is required. 

     */

    public String generate (String accNumber, String action) 

        throws AccessionNumberException, SQLException, ClassNotFoundException

    {

        String globalName = null;

        String localId = null;

        // Open a connection to the database

        MetaCatUtil   util = new MetaCatUtil();

        String defaultGlobalName = util.getOption("defaultGlobalName");

        String sep = util.getOption("accNumberSeparator");

        try {

            // Open a new connection to the database

            Connection conn = util.openDBConnection();

            conn.setAutoCommit(true);

            // split the acc # in 2 parts - global name & local id

            if ( accNumber != null ) {

                globalName = getGlobalName(accNumber, sep);

                localId = getLocalId(accNumber, sep);

            }    

            // register unique acc #

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

                if ( accNumber == null )

                  return put(conn, defaultGlobalName, null, sep);

                else

                  return put(conn, globalName, localId, sep);

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

                if ( accNumber == null ) {

                  throw (new AccessionNumberException("Accession number is " +

                         "required."));

                } else if (!accNumberIsCurrent(conn, accNumber)) {

                  throw (new AccessionNumberException("Document " +

                         "not found for accession #: " + accNumber));

                } else {

                  return (globalName + sep + localId);

                }

            }

            conn.close();        

        } catch (StringIndexOutOfBoundsException siobe) {

            MetaCatUtil.debugMessage(

                       "Error on AccessionNumber.generate(): " + 

                       siobe.getMessage());

            throw (new AccessionNumberException("Accession number invalid, " +

                   "expecting character \'" + sep + "'."));

        } catch (SQLException e) {

            System.err.println(

                       "Error on AccessionNumber.genAccessionNumber(): " + 

                       e.getMessage());

            throw e;

        }    

        throw (new AccessionNumberException("Fatal Error in " +

               "accession number generation: "));

    }    

    /** put unique accession # into db connection */

    private String put (Connection conn, String globalName, 

                String localId, String sep) 

                throws SQLException

    {

        Integer l = null;

        try {

            if ( localId == null ) 

                l = new Integer(get(conn, globalName) + 1); 

            else if ( accNumberUsed(conn, globalName, localId) )

                l = new Integer(get(conn, globalName) + 1); 

            else

                l = new Integer(localId); 

            // insert globalName & l

            PreparedStatement pstmt;

            pstmt = conn.prepareStatement(

                    "INSERT INTO xml_acc_numbers (global_name, local_id) " + 

                    "VALUES (?, ?)");

            pstmt.setString(1,globalName);

            pstmt.setString(2,l.toString());

            pstmt.execute();

            pstmt.close();

        } catch (SQLException e) {

            System.err.println(

                   "Error on AccessionNumber.put(conn, globalName, localId): " 

                   + e.getMessage());

            throw e;

        }    

        return globalName + sep + l;

    }

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

    private boolean accNumberUsed(Connection conn, String globalName, 

                String localId) throws SQLException {

      boolean hasAccNumber = false;

      try {

        PreparedStatement pstmt;

        pstmt = conn.prepareStatement(

                "SELECT 'x' FROM xml_acc_numbers " + 

                "WHERE global_name LIKE ? AND local_id = ?");

        pstmt.setString(1,globalName);

        pstmt.setString(2,localId);

        pstmt.execute();

        ResultSet rs = pstmt.getResultSet();

        hasAccNumber = rs.next();

        pstmt.close();

      } catch (SQLException e) {

        System.err.println("Error on AccessionNumber.unique(globalName, " +

                           "localId): " + e.getMessage());

        throw e;

      }    

      return hasAccNumber;

    }    

    /** check for existence of Accesssion Number in xml_documents table */

    private boolean accNumberIsCurrent(

                Connection conn, String accNumber) throws SQLException {

      boolean hasCurrentAccNumber = false;

      try {

        PreparedStatement pstmt;

        pstmt = conn.prepareStatement(

                "SELECT 'x' FROM xml_documents " + 

                "WHERE docid LIKE ?");

        pstmt.setString(1, accNumber);

        pstmt.execute();

        ResultSet rs = pstmt.getResultSet();

        hasCurrentAccNumber = rs.next();

        pstmt.close();

      } catch (SQLException e) {

        System.err.println(

          "Error on AccessionNumber.accNumberIsCurrent(globalName, " +

          "localId): " + e.getMessage());

        throw e;

      }    

      return hasCurrentAccNumber;

    }    

    /** get the last in order local ID by a given global name */

    private int get (Connection conn, String globalName) 

                throws SQLException

    {

        try {

            PreparedStatement pstmt;

            pstmt = conn.prepareStatement(

                    "SELECT max(local_id) FROM xml_acc_numbers " + 

                    "WHERE global_name LIKE ?");

            pstmt.setString(1,globalName);

            pstmt.execute();

            ResultSet rs = pstmt.getResultSet();

            boolean hasLocalId = rs.next();

            if (hasLocalId)

                return rs.getInt(1);

            pstmt.close();

        } catch (SQLException e) {

            System.err.println(

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

            throw e;

        }    

        return 0;

    }

    // get the global part of the accession number

    private String getGlobalName (String accNumber, String sep) 

        throws StringIndexOutOfBoundsException {

        return accNumber.substring(0, accNumber.lastIndexOf(sep));

    }    

    // get the local part of the accession number

    private String getLocalId (String accNumber, String sep)

        throws StringIndexOutOfBoundsException {

        return accNumber.substring(accNumber.lastIndexOf(sep)+1);

    }    

}

/**

 * '$Log$

 * 'Revision 1.11  2000/08/14 20:53:33  jones

 * 'Added "release" keyword to all metacat source files so that the release

 * 'number will be evident in software distributions.

 * '

 * 'Revision 1.10  2000/06/27 04:31:07  jones

 * 'Fixed bugs associated with the new UPDATE and DELETE functions of

 * 'DBWriter.  There were problematic interactions between some static

 * 'variables used in DBEntityResolver and the way in which the

 * 'Servlet objects are re-used across multiple client invocations.

 * '

 * 'Generally cleaned up error reporting.  Now all errors and success

 * 'results are reported as XML documents from MetaCatServlet.  Need

 * 'to make the command line tools do the same.

 * '

 * 'Revision 1.9  2000/06/26 10:35:04  jones

 * 'Merged in substantial changes to DBWriter and associated classes and to

 * 'the MetaCatServlet in order to accomodate the new UPDATE and DELETE

 * 'functions.  The command line tools and the parameters for the

 * 'servlet have changed substantially.

 * '

 * 'Revision 1.8.2.5  2000/06/26 08:38:01  jones

 * 'Added DELETE feature to DBWriter.  Now takes an action "DELETE" and a

 * 'docid and will move the record from the xml_documents table to the

 * 'xml_revisions table.

 * 'Modified option parsing to support option symbols on command line.

 * '

 * 'Revision 1.8.2.4  2000/06/25 23:11:40  jones

 * 'Documentation update

 * '

 * 'Revision 1.8.2.3  2000/06/25 23:08:31  jones

 * 'Minor change to excpetion handling

 * ''

 */