1
|
/**
|
2
|
* '$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
|
* Release: @release@
|
9
|
*
|
10
|
* '$Author: tao $'
|
11
|
* '$Date: 2002-06-13 11:37:38 -0700 (Thu, 13 Jun 2002) $'
|
12
|
* '$Revision: 1215 $'
|
13
|
*
|
14
|
* This program is free software; you can redistribute it and/or modify
|
15
|
* it under the terms of the GNU General Public License as published by
|
16
|
* the Free Software Foundation; either version 2 of the License, or
|
17
|
* (at your option) any later version.
|
18
|
*
|
19
|
* This program is distributed in the hope that it will be useful,
|
20
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
21
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
22
|
* GNU General Public License for more details.
|
23
|
*
|
24
|
* You should have received a copy of the GNU General Public License
|
25
|
* along with this program; if not, write to the Free Software
|
26
|
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
27
|
*/
|
28
|
|
29
|
package edu.ucsb.nceas.metacat;
|
30
|
|
31
|
import java.net.*;
|
32
|
import java.sql.*;
|
33
|
|
34
|
import edu.ucsb.nceas.dbadapter.AbstractDatabase;
|
35
|
|
36
|
/**
|
37
|
* (on insert of XML document)
|
38
|
* Generates a unique Accession Number or if provided check it
|
39
|
* for uniqueness and register it into the db connection
|
40
|
* (on update or delete of XML document)
|
41
|
* Check for existance of provided Accession Number
|
42
|
*
|
43
|
*/
|
44
|
public class AccessionNumber {
|
45
|
|
46
|
private static final AbstractDatabase dbAdapter = MetaCatUtil.dbAdapter;
|
47
|
|
48
|
//private Connection conn = null;
|
49
|
private String sitecode = null;
|
50
|
private String sep = null;
|
51
|
private String docid = null;
|
52
|
private String rev = null;
|
53
|
|
54
|
/**
|
55
|
* Construct an AccessionNumber
|
56
|
*/
|
57
|
//public AccessionNumber ()
|
58
|
//throws SQLException, ClassNotFoundException
|
59
|
//{
|
60
|
// Open a connection to the database from here
|
61
|
//this((new MetaCatUtil()).openDBConnection());
|
62
|
//}
|
63
|
|
64
|
/**
|
65
|
* Construct an AccessionNumber
|
66
|
*
|
67
|
* @param conn the db connection to read from and write Accession# to
|
68
|
*/
|
69
|
public AccessionNumber ()
|
70
|
{
|
71
|
this.sitecode = MetaCatUtil.getOption("sitecode");
|
72
|
this.sep = MetaCatUtil.getOption("accNumSeparator");
|
73
|
//this.conn = conn;
|
74
|
}
|
75
|
|
76
|
/** NEW - WHEN CLIENT ALWAYS PROVIDE ACCESSION NUMBER INCLUDING REV IN IT
|
77
|
* Construct an AccessionNumber
|
78
|
*
|
79
|
* @param conn the db connection to read Accession number from
|
80
|
* @param accnum the accession number to be checked for validness
|
81
|
*/
|
82
|
public AccessionNumber (String accnum, String action)
|
83
|
throws AccessionNumberException, SQLException, NumberFormatException
|
84
|
{
|
85
|
this();
|
86
|
|
87
|
this.rev = null;
|
88
|
this.docid = accnum;
|
89
|
if ( accnum != null ) {
|
90
|
int firstIndex = accnum.indexOf(this.sep);
|
91
|
int lastIndex = accnum.lastIndexOf(this.sep);
|
92
|
if ( firstIndex != lastIndex ) {
|
93
|
//this docid contains a revision number
|
94
|
this.rev = accnum.substring(lastIndex + 1);
|
95
|
this.docid = accnum.substring(0, lastIndex);
|
96
|
}
|
97
|
}
|
98
|
|
99
|
// INSERT
|
100
|
if ( action.equals("INSERT")) {
|
101
|
|
102
|
// check accession number for validness
|
103
|
if ( docid == null ) {
|
104
|
throw new AccessionNumberException("Accession number is required.");
|
105
|
|
106
|
// rev is not provided; throw an exception to prevent the insertion
|
107
|
} else if ( rev == null ) {
|
108
|
throw new AccessionNumberException
|
109
|
("Revision number is required and must be 1.");
|
110
|
|
111
|
// docid is used; throw an exception to prevent the insertion
|
112
|
} else if ( accNumberUsed(docid) ) {
|
113
|
throw new AccessionNumberException
|
114
|
("Accession number " + docid + " is already in use.");
|
115
|
|
116
|
// rev is <> 1; throw an exception to prevent the insertion
|
117
|
} /*else if ( !rev.equals("1")) {
|
118
|
throw new AccessionNumberException("Revision number must be 1.");
|
119
|
}*/
|
120
|
|
121
|
// UPDATE or DELETE
|
122
|
} else if ( action.equals("UPDATE") || action.equals("DELETE")) {
|
123
|
String l_rev = "";
|
124
|
int reversionNumber=Integer.parseInt(rev);
|
125
|
|
126
|
// Accession# is not provided; throw an exception to prevent the action
|
127
|
if ( docid == null ) {
|
128
|
throw new AccessionNumberException("Accession number is required.");
|
129
|
|
130
|
// rev is not provided; throw an exception to prevent the action
|
131
|
} else if ( rev == null ) {
|
132
|
throw new AccessionNumberException
|
133
|
("Revision number is required.");
|
134
|
|
135
|
// Accession# is not current (not in xml_documents); throw an exception
|
136
|
} else if ( !accNumberIsCurrent(docid) ) {
|
137
|
throw new AccessionNumberException
|
138
|
("Document not found for Accession number " + docid);
|
139
|
|
140
|
//Revision number is less than or equal the recent one; throw a exception
|
141
|
} else if ( action.equals("UPDATE") &&
|
142
|
reversionNumber <= getLastRevisionNumber(docid) ) {
|
143
|
throw new AccessionNumberException
|
144
|
("Next revision number couldn't be less than or equal "
|
145
|
+ getLastRevisionNumber(docid));
|
146
|
|
147
|
// Revision number is not the recent one; throw an exception
|
148
|
} else if ( action.equals("DELETE") &&
|
149
|
!rev.equals(l_rev = getLastRevision(docid)) ) {
|
150
|
throw new AccessionNumberException
|
151
|
("Last revision number is "+ l_rev);
|
152
|
}
|
153
|
}
|
154
|
}
|
155
|
|
156
|
/**
|
157
|
* Generate an Accession Number of form <sidecode>.<uniqueid>.<revisionid>
|
158
|
* where <revisionid> is always 1.
|
159
|
*
|
160
|
* @param docid <sitecode>.<uniqueid> part of Accession Number
|
161
|
* @param action INSERT, UPDATE or DELETE action
|
162
|
*/
|
163
|
public String generate(String docid, String action)
|
164
|
throws AccessionNumberException, SQLException
|
165
|
{
|
166
|
return generate(docid, "1", action);
|
167
|
}
|
168
|
|
169
|
/**
|
170
|
* Generate an Accession Number of form <sidecode>.<uniqueid>.<revisionid>
|
171
|
*
|
172
|
* @param docid <sitecode>.<uniqueid> part of Accession Number
|
173
|
* @param rev <revisionid> of Accession Number
|
174
|
* @param action INSERT, UPDATE or DELETE action
|
175
|
*/
|
176
|
public String generate(String docid, String rev, String action)
|
177
|
throws AccessionNumberException, SQLException
|
178
|
{
|
179
|
try {
|
180
|
// INSERT
|
181
|
if ( action.equals("INSERT")) {
|
182
|
|
183
|
// get a new docid
|
184
|
if ( docid == null ) {
|
185
|
String sitecode = getSitecode();
|
186
|
String uniqueid = getUniqueID(sitecode);
|
187
|
|
188
|
return sitecode + sep + uniqueid;
|
189
|
|
190
|
// docid is used; throw an exception to prevent the insertion
|
191
|
} else if ( accNumberUsed(docid) ) {
|
192
|
throw new AccessionNumberException
|
193
|
("Accession number " + docid + " is already in use.");
|
194
|
// rev is <> 1; throw an exception to prevent the insertion
|
195
|
} else if ( !rev.equals("1") ) {
|
196
|
throw new AccessionNumberException
|
197
|
("Revision number must be 1.");
|
198
|
// docid is not used and rev=1; return it
|
199
|
} else {
|
200
|
return docid;
|
201
|
}
|
202
|
|
203
|
// UPDATE or DELETE
|
204
|
} else if ( action.equals("UPDATE") || action.equals("DELETE")) {
|
205
|
|
206
|
// Accession# is not provided; throw an exception to prevent the action
|
207
|
if ( docid == null ) {
|
208
|
throw new AccessionNumberException("Accession number is required.");
|
209
|
|
210
|
// Accession# is not current (not in xml_documents); throw an exception
|
211
|
} else if ( !accNumberIsCurrent(docid) ) {
|
212
|
throw new AccessionNumberException
|
213
|
("Document not found for Accession number " + docid);
|
214
|
|
215
|
// Revision number is not the recent one; throw an exception
|
216
|
} else if ( !rev.equals(getLastRevision(docid)) ) {
|
217
|
throw new AccessionNumberException
|
218
|
("Revision number must be the recent.");
|
219
|
|
220
|
// Accession# is current (present in xml_documents); return it
|
221
|
} else {
|
222
|
return docid;
|
223
|
}
|
224
|
}
|
225
|
|
226
|
} catch (SQLException e) {
|
227
|
throw new SQLException
|
228
|
("Error on AccessionNumber.generate(): " + e.getMessage());
|
229
|
}
|
230
|
|
231
|
// never comes here
|
232
|
throw new
|
233
|
AccessionNumberException("Fatal Error in accession number generation.");
|
234
|
}
|
235
|
|
236
|
// get local sitecode
|
237
|
private String getSitecode()
|
238
|
{
|
239
|
return this.sitecode;
|
240
|
}
|
241
|
|
242
|
// get Unique ID from DB sequence
|
243
|
private String getUniqueID (String sitecode) throws SQLException
|
244
|
{
|
245
|
String uniqueid;
|
246
|
String sysdate = dbAdapter.getDateTimeFunction();
|
247
|
DBConnection conn = null;
|
248
|
int serialNumber = -1;
|
249
|
try {
|
250
|
PreparedStatement pstmt = null;
|
251
|
|
252
|
//check out DBConnection
|
253
|
conn=DBConnectionPool.getDBConnection("AccessionNumber.getUniqueID");
|
254
|
serialNumber=conn.getCheckOutSerialNumber();
|
255
|
pstmt = conn.prepareStatement
|
256
|
("INSERT INTO accession_number (site_code, date_created) " +
|
257
|
"VALUES (?, " + sysdate + ")");
|
258
|
pstmt.setString(1, sitecode);
|
259
|
pstmt.execute();
|
260
|
pstmt.close();
|
261
|
|
262
|
uniqueid = "" + dbAdapter.getUniqueID(conn.getConnections(),
|
263
|
"accession_number");
|
264
|
//because we only count the connection usage one when it check in
|
265
|
//but it use twice. So we need to increase one
|
266
|
conn.increaseUsageCount(1);
|
267
|
|
268
|
} catch (SQLException e) {
|
269
|
throw new
|
270
|
SQLException("Error on AccessionNumber.getUniqueID(): "+e.getMessage());
|
271
|
}
|
272
|
finally
|
273
|
{
|
274
|
DBConnectionPool.returnDBConnection(conn, serialNumber);
|
275
|
}
|
276
|
return uniqueid;
|
277
|
}
|
278
|
|
279
|
/** check for existence of Accesssion Number xml_acc_numbers table */
|
280
|
public boolean accNumberUsed ( String accNumber )
|
281
|
throws SQLException {
|
282
|
|
283
|
boolean hasAccNumber = false;
|
284
|
DBConnection conn = null;
|
285
|
int serialNumber = -1;
|
286
|
|
287
|
try {
|
288
|
PreparedStatement pstmt = null;
|
289
|
//check out DBConnection
|
290
|
conn=DBConnectionPool.getDBConnection("AccessionNumber.accNumberUsed");
|
291
|
serialNumber=conn.getCheckOutSerialNumber();
|
292
|
pstmt = conn.prepareStatement(
|
293
|
"SELECT 'x' FROM xml_documents " +
|
294
|
"WHERE docid = ? " +
|
295
|
"UNION " +
|
296
|
"SELECT 'x' FROM xml_revisions " +
|
297
|
"WHERE docid = ?");
|
298
|
pstmt.setString(1,accNumber);
|
299
|
pstmt.setString(2,accNumber);
|
300
|
pstmt.execute();
|
301
|
ResultSet rs = pstmt.getResultSet();
|
302
|
hasAccNumber = rs.next();
|
303
|
pstmt.close();
|
304
|
|
305
|
} catch (SQLException e) {
|
306
|
throw new SQLException
|
307
|
("Error on AccessionNumber.accNumberUsed(accNumber): " + e.getMessage());
|
308
|
}
|
309
|
finally
|
310
|
{
|
311
|
DBConnectionPool.returnDBConnection(conn, serialNumber);
|
312
|
}
|
313
|
|
314
|
return hasAccNumber;
|
315
|
}
|
316
|
|
317
|
// check for existence of Accesssion Number in xml_documents table
|
318
|
private boolean accNumberIsCurrent(String accNumber) throws SQLException {
|
319
|
|
320
|
boolean hasCurrentAccNumber = false;
|
321
|
DBConnection conn = null;
|
322
|
int serialNumber = -1;
|
323
|
|
324
|
try {
|
325
|
PreparedStatement pstmt = null;
|
326
|
//check out DBConnection
|
327
|
conn=DBConnectionPool.getDBConnection("AccessionNumber.accNumberIsCurre");
|
328
|
serialNumber=conn.getCheckOutSerialNumber();
|
329
|
pstmt = conn.prepareStatement(
|
330
|
"SELECT 'x' FROM xml_documents " +
|
331
|
"WHERE docid = ?");
|
332
|
pstmt.setString(1, accNumber);
|
333
|
pstmt.execute();
|
334
|
ResultSet rs = pstmt.getResultSet();
|
335
|
hasCurrentAccNumber = rs.next();
|
336
|
pstmt.close();
|
337
|
|
338
|
} catch (SQLException e) {
|
339
|
throw new SQLException(
|
340
|
"Error on AccessionNumber.accNumberIsCurrent(String accNumber): " +
|
341
|
e.getMessage());
|
342
|
}
|
343
|
finally
|
344
|
{
|
345
|
DBConnectionPool.returnDBConnection(conn, serialNumber);
|
346
|
}
|
347
|
|
348
|
return hasCurrentAccNumber;
|
349
|
}
|
350
|
|
351
|
// get the recent revision number for docid
|
352
|
private String getLastRevision(String docid) throws SQLException
|
353
|
{
|
354
|
String rev = "";
|
355
|
DBConnection conn = null;
|
356
|
int serialNumber = -1;
|
357
|
|
358
|
try {
|
359
|
PreparedStatement pstmt = null;
|
360
|
//check out DBConnection
|
361
|
conn=DBConnectionPool.getDBConnection("AccessionNumber.getLastRevision");
|
362
|
serialNumber=conn.getCheckOutSerialNumber();
|
363
|
pstmt = conn.prepareStatement
|
364
|
("SELECT rev FROM xml_documents WHERE docid='" + docid + "'");
|
365
|
pstmt.execute();
|
366
|
|
367
|
ResultSet rs = pstmt.getResultSet();
|
368
|
boolean hasRow = rs.next();
|
369
|
rev = rs.getString(1);
|
370
|
pstmt.close();
|
371
|
|
372
|
} catch (SQLException e) {
|
373
|
throw new SQLException(
|
374
|
"Error on AccessionNumber.getLastRevision(): " + e.getMessage());
|
375
|
}
|
376
|
finally
|
377
|
{
|
378
|
DBConnectionPool.returnDBConnection(conn,serialNumber);
|
379
|
}
|
380
|
|
381
|
return rev;
|
382
|
}
|
383
|
|
384
|
/**
|
385
|
* Get last revision number from database for a docid
|
386
|
* The return value is integer because we want compare it to there new one
|
387
|
* @param docid <sitecode>.<uniqueid> part of Accession Number
|
388
|
*/
|
389
|
private int getLastRevisionNumber(String docId) throws SQLException
|
390
|
{
|
391
|
int rev = 1;
|
392
|
DBConnection conn =null;
|
393
|
int serialNumber = -1;
|
394
|
|
395
|
try {
|
396
|
PreparedStatement pStmt = null;
|
397
|
//check out DBConnection
|
398
|
conn=DBConnectionPool.getDBConnection("AccessionNumber.getLastRevisionN");
|
399
|
serialNumber=conn.getCheckOutSerialNumber();
|
400
|
|
401
|
pStmt = conn.prepareStatement
|
402
|
("SELECT rev FROM xml_documents WHERE docid='" + docId + "'");
|
403
|
pStmt.execute();
|
404
|
|
405
|
ResultSet rs = pStmt.getResultSet();
|
406
|
boolean hasRow = rs.next();
|
407
|
rev = rs.getInt(1);
|
408
|
pStmt.close();
|
409
|
|
410
|
} catch (SQLException e) {
|
411
|
throw new SQLException(
|
412
|
"Error on AccessionNumber.getLastRevision(): " + e.getMessage());
|
413
|
}
|
414
|
finally
|
415
|
{
|
416
|
DBConnectionPool.returnDBConnection(conn,serialNumber);
|
417
|
}
|
418
|
return rev;
|
419
|
}
|
420
|
|
421
|
// get the next revision number for docid
|
422
|
private String getNextRevision(String docid) throws SQLException
|
423
|
{
|
424
|
String rev = "";
|
425
|
DBConnection conn = null;
|
426
|
int serialNumber = -1;
|
427
|
try {
|
428
|
PreparedStatement pstmt = null;
|
429
|
//check out DBConnection
|
430
|
conn=DBConnectionPool.getDBConnection("AccessionNumber.getNextRevision");
|
431
|
serialNumber=conn.getCheckOutSerialNumber();
|
432
|
pstmt = conn.prepareStatement
|
433
|
("SELECT rev+1 FROM xml_documents WHERE docid='" + docid + "'");
|
434
|
pstmt.execute();
|
435
|
|
436
|
ResultSet rs = pstmt.getResultSet();
|
437
|
boolean hasRow = rs.next();
|
438
|
rev = rs.getString(1);
|
439
|
pstmt.close();
|
440
|
|
441
|
} catch (SQLException e) {
|
442
|
throw new SQLException(
|
443
|
"Error on AccessionNumber.getNextRevision(): " + e.getMessage());
|
444
|
}
|
445
|
finally
|
446
|
{
|
447
|
DBConnectionPool.returnDBConnection(conn, serialNumber);
|
448
|
}
|
449
|
|
450
|
return rev;
|
451
|
}
|
452
|
|
453
|
/**
|
454
|
* returns the docid encoded in this accession number
|
455
|
*/
|
456
|
public String getDocid() {
|
457
|
|
458
|
return this.docid;
|
459
|
}
|
460
|
|
461
|
/**
|
462
|
* returns the revision number encoded in this accession number
|
463
|
*/
|
464
|
public String getRev()
|
465
|
{
|
466
|
return this.rev;
|
467
|
}
|
468
|
|
469
|
}
|