Project

General

Profile

1 145 bojilova
/**
2 203 jones
 *  '$RCSfile$'
3
 *    Purpose: A class that gets Accession Number, check for uniqueness
4
 *             and register it into db
5
 *  Copyright: 2000 Regents of the University of California and the
6
 *             National Center for Ecological Analysis and Synthesis
7
 *    Authors: Jivka Bojilova, Matt Jones
8 145 bojilova
 *
9 203 jones
 *   '$Author$'
10
 *     '$Date$'
11
 * '$Revision$'
12 669 jones
 *
13
 * This program is free software; you can redistribute it and/or modify
14
 * it under the terms of the GNU General Public License as published by
15
 * the Free Software Foundation; either version 2 of the License, or
16
 * (at your option) any later version.
17
 *
18
 * This program is distributed in the hope that it will be useful,
19
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21
 * GNU General Public License for more details.
22
 *
23
 * You should have received a copy of the GNU General Public License
24
 * along with this program; if not, write to the Free Software
25
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 145 bojilova
 */
27
28
package edu.ucsb.nceas.metacat;
29
30 2768 jones
import java.sql.PreparedStatement;
31
import java.sql.ResultSet;
32
import java.sql.SQLException;
33 145 bojilova
34 5015 daigle
import edu.ucsb.nceas.metacat.database.DBConnection;
35
import edu.ucsb.nceas.metacat.database.DBConnectionPool;
36 5030 daigle
import edu.ucsb.nceas.metacat.properties.PropertyService;
37 4080 daigle
import edu.ucsb.nceas.utilities.PropertyNotFoundException;
38 747 bojilova
39 147 bojilova
/**
40 459 bojilova
 * (on insert of XML document)
41 2246 sgarg
 * Generates a unique Accession Number or if provided check it
42
 * for uniqueness and register it into the db connection
43 459 bojilova
 * (on update or delete of XML document)
44
 * Check for existance of provided Accession Number
45 2246 sgarg
 *
46 147 bojilova
 */
47 145 bojilova
public class AccessionNumber  {
48 2246 sgarg
49 618 bojilova
  private String sitecode = null;
50 459 bojilova
  private String sep = null;
51 779 bojilova
  private String docid = null;
52
  private String rev = null;
53 2246 sgarg
54 4080 daigle
    /**
55
	 * Construct an AccessionNumber
56
	 */
57
	private AccessionNumber() throws AccessionNumberException {
58
		try {
59 4212 daigle
			this.sitecode = PropertyService.getProperty("document.sitecode");
60
			this.sep = PropertyService.getProperty("document.accNumSeparator");
61 4080 daigle
		} catch (PropertyNotFoundException pnfe) {
62
			throw new AccessionNumberException("Could not retrieve property "
63
					+ "in constructor: " + pnfe.getMessage());
64
		}
65
	}
66
67 2246 sgarg
  /**
68 4080 daigle
	 * NEW - WHEN CLIENT ALWAYS PROVIDE ACCESSION NUMBER INCLUDING REV IN IT
69
	 * Construct an AccessionNumber
70
	 *
71
	 * @param conn
72
	 *            the db connection to read Accession number from
73
	 * @param accnum
74
	 *            the accession number to be checked for validness
75
	 */
76 2246 sgarg
  public AccessionNumber (String accnum, String action)
77 954 tao
           throws AccessionNumberException, SQLException, NumberFormatException
78
 {
79 1215 tao
    this();
80 779 bojilova
81
    this.rev = null;
82
    this.docid = accnum;
83
    if ( accnum != null ) {
84
      int firstIndex = accnum.indexOf(this.sep);
85
      int lastIndex = accnum.lastIndexOf(this.sep);
86
      if ( firstIndex != lastIndex ) {
87
        //this docid contains a revision number
88
        this.rev = accnum.substring(lastIndex + 1);
89
        this.docid = accnum.substring(0, lastIndex);
90
      }
91
    }
92 2246 sgarg
93 779 bojilova
    // INSERT
94
    if ( action.equals("INSERT")) {
95
96 2253 sgarg
        if(rev != null){
97
            try {
98
                Integer.parseInt(rev);
99
            }
100
            catch (java.lang.NumberFormatException e) {
101
                throw new AccessionNumberException(
102
                    "Revision number is required");
103
            }
104
        }
105
106 779 bojilova
      // check accession number for validness
107
      if ( docid == null ) {
108 2253 sgarg
        throw new AccessionNumberException("Accession number is required");
109 779 bojilova
110
      // rev is not provided; throw an exception to prevent the insertion
111
      } else if ( rev == null ) {
112
        throw new AccessionNumberException
113 2253 sgarg
                  ("Revision number is required");
114 779 bojilova
115
      // docid is used; throw an exception to prevent the insertion
116
      } else if ( accNumberUsed(docid) ) {
117
        throw new AccessionNumberException
118 2253 sgarg
                  ("Accession number " + docid + " is already in use");
119 2246 sgarg
120 779 bojilova
      // rev is <> 1; throw an exception to prevent the insertion
121 1054 tao
      } /*else if ( !rev.equals("1")) {
122 2253 sgarg
        throw new AccessionNumberException("Revision number must be 1");
123 1054 tao
      }*/
124 2246 sgarg
125 779 bojilova
    // UPDATE or DELETE
126
    } else if ( action.equals("UPDATE") || action.equals("DELETE")) {
127
      String l_rev = "";
128
129 2246 sgarg
      int reversionNumber = 1;
130
131
      if(rev != null){
132 2253 sgarg
          try{
133
              reversionNumber = Integer.parseInt(rev);
134
          } catch (java.lang.NumberFormatException e){
135
              throw new AccessionNumberException(
136
                      "Revision number is required");
137
          }
138 2246 sgarg
      }
139
140 779 bojilova
      // Accession# is not provided; throw an exception to prevent the action
141
      if ( docid == null ) {
142 2253 sgarg
        throw new AccessionNumberException("Accession number is required");
143 779 bojilova
144
      // rev is not provided; throw an exception to prevent the action
145
      } else if ( rev == null ) {
146
        throw new AccessionNumberException
147 2253 sgarg
                  ("Revision number is required");
148 779 bojilova
149 5189 daigle
      // Accession# is not current (not in xml_documents or xml_revisions); throw an exception
150 779 bojilova
      } else if ( !accNumberIsCurrent(docid) ) {
151
        throw new AccessionNumberException
152
                  ("Document not found for Accession number " + docid);
153
154 954 tao
      //Revision number is less than or equal the recent one; throw a exception
155 779 bojilova
      } else if ( action.equals("UPDATE") &&
156 954 tao
                  reversionNumber <= getLastRevisionNumber(docid) ) {
157 779 bojilova
        throw new AccessionNumberException
158 5350 berkley
                 ("Next revision number can't be less than or equal to "
159 954 tao
                                              + getLastRevisionNumber(docid));
160 779 bojilova
161
      // Revision number is not the recent one; throw an exception
162 2246 sgarg
      } else if ( action.equals("DELETE") &&
163 779 bojilova
                  !rev.equals(l_rev = getLastRevision(docid)) ) {
164
        throw new AccessionNumberException
165
                  ("Last revision number is "+ l_rev);
166
      }
167
    }
168
  }
169
170 459 bojilova
  /** check for existence of Accesssion Number xml_acc_numbers table */
171 2164 tao
  public static boolean accNumberUsed ( String accNumber )
172 576 bojilova
                  throws SQLException {
173 2246 sgarg
174 459 bojilova
    boolean hasAccNumber = false;
175 1215 tao
    DBConnection conn = null;
176
    int serialNumber = -1;
177 2246 sgarg
178 459 bojilova
    try {
179 1215 tao
      PreparedStatement pstmt = null;
180
      //check out DBConnection
181
      conn=DBConnectionPool.getDBConnection("AccessionNumber.accNumberUsed");
182
      serialNumber=conn.getCheckOutSerialNumber();
183 459 bojilova
      pstmt = conn.prepareStatement(
184 2246 sgarg
                "SELECT 'x' FROM xml_documents " +
185 770 bojilova
                "WHERE docid = ? " +
186 576 bojilova
                "UNION " +
187
                "SELECT 'x' FROM xml_revisions " +
188 770 bojilova
                "WHERE docid = ?");
189 576 bojilova
      pstmt.setString(1,accNumber);
190
      pstmt.setString(2,accNumber);
191 459 bojilova
      pstmt.execute();
192
      ResultSet rs = pstmt.getResultSet();
193
      hasAccNumber = rs.next();
194
      pstmt.close();
195 2246 sgarg
196 459 bojilova
    } catch (SQLException e) {
197 576 bojilova
      throw new SQLException
198
      ("Error on AccessionNumber.accNumberUsed(accNumber): " + e.getMessage());
199 1215 tao
    }
200
    finally
201
    {
202
      DBConnectionPool.returnDBConnection(conn, serialNumber);
203
    }
204 2246 sgarg
205 459 bojilova
    return hasAccNumber;
206 2246 sgarg
  }
207
208 5189 daigle
  // Check for existence of Accesssion Number in xml_documents or xml_revisions
209
  // table.  We check xml_revisions because document may have been deleted, which
210
  // will remove it from xml_documents, but a revision still exists.
211 4684 daigle
  private boolean accNumberIsCurrent(String accNumber) throws SQLException {
212 2246 sgarg
213 459 bojilova
    boolean hasCurrentAccNumber = false;
214 1215 tao
    DBConnection conn = null;
215
    int serialNumber = -1;
216 2246 sgarg
217 459 bojilova
    try {
218 1215 tao
      PreparedStatement pstmt = null;
219
      //check out DBConnection
220
      conn=DBConnectionPool.getDBConnection("AccessionNumber.accNumberIsCurre");
221
      serialNumber=conn.getCheckOutSerialNumber();
222 459 bojilova
      pstmt = conn.prepareStatement(
223 2246 sgarg
                "SELECT 'x' FROM xml_documents " +
224 770 bojilova
                "WHERE docid = ?");
225 459 bojilova
      pstmt.setString(1, accNumber);
226
      pstmt.execute();
227
      ResultSet rs = pstmt.getResultSet();
228
      hasCurrentAccNumber = rs.next();
229 5186 tao
      if(!hasCurrentAccNumber)
230
      {
231
        //need to look xml_revision table;
232
        pstmt = conn.prepareStatement(
233
            "SELECT 'x' FROM xml_revisions " +
234
            "WHERE docid = ?");
235
        pstmt.setString(1, accNumber);
236
        pstmt.execute();
237
        rs = pstmt.getResultSet();
238
        hasCurrentAccNumber = rs.next();
239
      }
240 459 bojilova
      pstmt.close();
241 2246 sgarg
242 459 bojilova
    } catch (SQLException e) {
243
      throw new SQLException(
244
          "Error on AccessionNumber.accNumberIsCurrent(String accNumber): " +
245
          e.getMessage());
246 1215 tao
    }
247
    finally
248
    {
249
      DBConnectionPool.returnDBConnection(conn, serialNumber);
250
    }
251 2246 sgarg
252 459 bojilova
    return hasCurrentAccNumber;
253 2246 sgarg
  }
254 203 jones
255 734 bojilova
  // get the recent revision number for docid
256
  private String getLastRevision(String docid) throws SQLException
257
  {
258
    String rev = "";
259 1215 tao
    DBConnection conn = null;
260
    int serialNumber = -1;
261 2246 sgarg
262 734 bojilova
    try {
263 1215 tao
      PreparedStatement pstmt = null;
264
      //check out DBConnection
265
      conn=DBConnectionPool.getDBConnection("AccessionNumber.getLastRevision");
266
      serialNumber=conn.getCheckOutSerialNumber();
267 734 bojilova
      pstmt = conn.prepareStatement
268
              ("SELECT rev FROM xml_documents WHERE docid='" + docid + "'");
269
      pstmt.execute();
270
271
      ResultSet rs = pstmt.getResultSet();
272
      boolean hasRow = rs.next();
273
      rev = rs.getString(1);
274
      pstmt.close();
275 2246 sgarg
276 734 bojilova
    } catch (SQLException e) {
277
      throw new SQLException(
278
      "Error on AccessionNumber.getLastRevision(): " + e.getMessage());
279
    }
280 1215 tao
    finally
281
    {
282
      DBConnectionPool.returnDBConnection(conn,serialNumber);
283
    }
284 734 bojilova
285
    return rev;
286
  }
287 2246 sgarg
288 954 tao
  /**
289
    * Get last revision number from database for a docid
290
    * The return value is integer because we want compare it to there new one
291
    * @param docid <sitecode>.<uniqueid> part of Accession Number
292
    */
293
  private int getLastRevisionNumber(String docId) throws SQLException
294
  {
295
    int rev = 1;
296 1215 tao
    DBConnection conn =null;
297
    int serialNumber = -1;
298 2246 sgarg
299 954 tao
    try {
300 1215 tao
      PreparedStatement pStmt = null;
301
      //check out DBConnection
302
      conn=DBConnectionPool.getDBConnection("AccessionNumber.getLastRevisionN");
303
      serialNumber=conn.getCheckOutSerialNumber();
304 2246 sgarg
305 954 tao
      pStmt = conn.prepareStatement
306
              ("SELECT rev FROM xml_documents WHERE docid='" + docId + "'");
307
      pStmt.execute();
308 734 bojilova
309 954 tao
      ResultSet rs = pStmt.getResultSet();
310
      boolean hasRow = rs.next();
311 5186 tao
      if(hasRow)
312
      {
313
        rev = rs.getInt(1);
314
      }
315 954 tao
      pStmt.close();
316 2246 sgarg
317 954 tao
    } catch (SQLException e) {
318
      throw new SQLException(
319
      "Error on AccessionNumber.getLastRevision(): " + e.getMessage());
320
    }
321 1215 tao
    finally
322
    {
323
      DBConnectionPool.returnDBConnection(conn,serialNumber);
324
    }
325 954 tao
    return rev;
326
  }
327 2246 sgarg
328 779 bojilova
  /**
329
   * returns the docid encoded in this accession number
330
   */
331
  public String getDocid() {
332
333
    return this.docid;
334
  }
335
336
  /**
337
   * returns the revision number encoded in this accession number
338
   */
339
  public String getRev()
340
  {
341
    return this.rev;
342
  }
343 2246 sgarg
344 203 jones
}