Metacat

/**

 *      Name: AccessionNumber.java

 *   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

 *

 *   Version: '$Id: AccessionNumber.java 171 2000-06-16 22:39:50Z bojilova $'

 */

package edu.ucsb.nceas.metacat;

import java.net.*;

import java.sql.*;

import java.util.PropertyResourceBundle;

/**

 * A class that gets Accession Number, check for uniqueness and register it

 * into db connection

 */

public class AccessionNumber  {

    /**

     * This method gets Accession Number (if any), check for uniqueness 

     * and register it into new db connection

     * @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 static String generate (String accNumber, String action) 

        throws ClassNotFoundException, StringIndexOutOfBoundsException, 

               SQLException

    {

        String globalName = null;

        String localId = null;

        PropertyResourceBundle options = null;

        options = (PropertyResourceBundle)

            PropertyResourceBundle.getBundle("edu.ucsb.nceas.metacat.metacat");

        String dbDriver = (String)options.handleGetObject("dbDriver");

        String defaultDB = (String)options.handleGetObject("defaultDB");

        String user = (String)options.handleGetObject("user");

        String password = (String)options.handleGetObject("password");

        String defaultGlobalName = 

               (String)options.handleGetObject("defaultGlobalName");

        String sep = (String)options.handleGetObject("accNumberSeparator");

        try {

            // Open a new connection to the database

            Connection conn = MetaCatUtil.openDBConnection(dbDriver, 

                              defaultDB, user, password);

            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 == "INSERT" )

                if ( accNumber == null )

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

                else

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

            conn.close();        

        } catch (SQLException e) {

            System.out.println(

                       "Error on AccessionNumber.genAccessionNumber(): " + 

                       e.getMessage());

            throw e;

        }    

        return null;        

    }    

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

    private static 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 ( exist(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.out.println(

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

                   + e.getMessage());

            throw e;

        }    

        return globalName + sep + l;

    }

    /** check for existance of Accesssion Number */

    private static boolean exist (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.out.println("Error on AccessionNumber.unique(globalName, " +

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

            throw e;

        }    

        return hasAccNumber;

    }    

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

    private static 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.out.println(

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

            throw e;

        }    

        return 0;

    }

    // get the global part of the accession number

    private static String getGlobalName (String accNumber, String sep) 

        throws StringIndexOutOfBoundsException {

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

    }    

    // get the local part of the accession number

    private static String getLocalId (String accNumber, String sep)

        throws StringIndexOutOfBoundsException {

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

    }    

}