edu.ku.brc.specify.dbsupport.CollectionAutoNumber.java Source code

Introduction

Here is the source code for edu.ku.brc.specify.dbsupport.CollectionAutoNumber.java

Source

/* Copyright (C) 2015, University of Kansas Center for Research
 * 
 * Specify Software Project, specify@ku.edu, Biodiversity Institute,
 * 1345 Jayhawk Boulevard, Lawrence, Kansas, 66045, USA
 * 
 * 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
*/
package edu.ku.brc.specify.dbsupport;

import java.sql.Connection;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.Statement;
import java.util.Properties;
import java.util.Vector;

import org.apache.log4j.Logger;
import org.hibernate.Session;

import edu.ku.brc.af.core.AppContextMgr;
import edu.ku.brc.af.core.db.AutoNumberGeneric;
import edu.ku.brc.af.ui.forms.formatters.UIFieldFormatterIFace;
import edu.ku.brc.dbsupport.DBConnection;
import edu.ku.brc.specify.datamodel.AutoNumberingScheme;
import edu.ku.brc.specify.datamodel.Collection;
import edu.ku.brc.specify.datamodel.CollectionObject;
import edu.ku.brc.util.Pair;

/**
 * Note: 'getHighestObject' from the base class never gets called. This class' getHighestObject gets called directly from
 * the owning object which is CatalogNumberUIFieldFormatter. This only 
 * 
 * @author rod
 *
 * @code_status Beta
 *
 * Jun 20, 2007
 *
 */
public class CollectionAutoNumber extends AutoNumberGeneric {
    protected static final Logger log = Logger.getLogger(CollectionAutoNumber.class);

    /**
     * Default Constructor. 
     */
    public CollectionAutoNumber() {
        super();

        classObj = CollectionObject.class;
        fieldName = "catalogNumber";
    }

    /**
     * Constructor with args.
     * @param properties the args
     */
    public CollectionAutoNumber(final Properties properties) {
        super(properties);
    }

    /* (non-Javadoc)
     * @see edu.ku.brc.af.core.db.AutoNumberGeneric#getHighestObject(edu.ku.brc.af.ui.forms.formatters.UIFieldFormatterIFace, org.hibernate.Session, java.lang.String, edu.ku.brc.util.Pair, edu.ku.brc.util.Pair)
     */
    @Override
    protected String getHighestObject(final UIFieldFormatterIFace formatter, final Session session,
            final String value, final Pair<Integer, Integer> yearPos, final Pair<Integer, Integer> pos)
            throws Exception {
        boolean doDebug = false;

        Collection currCol = AppContextMgr.getInstance().getClassObject(Collection.class);
        AutoNumberingScheme catNumScheme = currCol.getNumberingSchemesByType(CollectionObject.getClassTableId());
        if (catNumScheme == null) {
            throw new RuntimeException("The Catalog Numbering Scheme cannot be null! Collection Table ID: "
                    + CollectionObject.getClassTableId());
        }
        catNumScheme = (AutoNumberingScheme) session.merge(catNumScheme);

        if (doDebug)
            System.out.println("CatNumScheme: " + catNumScheme.getSchemeName());

        Vector<Integer> ids = new Vector<Integer>();
        for (Collection collection : catNumScheme.getCollections()) {
            if (doDebug)
                System.out.println(
                        "adding ID: " + collection.getCollectionId() + "  " + collection.getCollectionName());
            ids.add(collection.getCollectionId());
        }

        StringBuilder sb = new StringBuilder(
                "SELECT CatalogNumber FROM collectionobject WHERE CollectionMemberID IN (");
        Connection conn = null;
        Statement stmt = null;

        for (int i = 0; i < ids.size(); i++) {
            if (i > 0)
                sb.append(',');
            sb.append(ids.get(i));
        }
        sb.append(") ORDER BY CatalogNumber DESC");
        log.debug(sb.toString());

        try {
            conn = DBConnection.getInstance().getConnection();
            stmt = conn.createStatement(ResultSet.TYPE_SCROLL_INSENSITIVE, ResultSet.CONCUR_READ_ONLY);
            ResultSet rs = stmt.executeQuery(sb.toString());

            String catNum = null;
            if (rs.next()) {
                catNum = rs.getString(1);
            }
            rs.close();

            return catNum;

        } catch (SQLException e) {
            edu.ku.brc.af.core.UsageTracker.incrSQLUsageCount();
            edu.ku.brc.exceptions.ExceptionTracker.getInstance().capture(CollectionAutoNumber.class, e);
            log.error("Exception caught: " + e); //$NON-NLS-1$
            e.printStackTrace();

        } finally {
            try {
                if (stmt != null)
                    stmt.close();

            } catch (SQLException e) {
                edu.ku.brc.af.core.UsageTracker.incrSQLUsageCount();
                edu.ku.brc.exceptions.ExceptionTracker.getInstance().capture(CollectionAutoNumber.class, e);
                log.error("Exception caught: " + e.toString()); //$NON-NLS-1$
                e.printStackTrace();
            }
        }

        return null;
    }

}