<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!-- NewPage --> <html lang="en"> <head> <!-- Generated by javadoc (1.8.0_265) on Tue Aug 25 19:30:50 UTC 2020 --> <title>DBUtil (MetaCat API)</title> <meta name="date" content="2020-08-25"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../../../script.js"></script> </head> <body> <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { parent.document.title="DBUtil (MetaCat API)"; } } catch(err) { } //--> var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":10,"i5":9,"i6":10,"i7":9,"i8":9,"i9":10,"i10":9,"i11":10,"i12":10}; var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; var tableTab = "tableTab"; var activeTableTab = "activeTableTab"; </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> <div class="topNav"><a name="navbar.top"> <!-- --> </a> <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> <a name="navbar.top.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../../overview-summary.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="class-use/DBUtil.html">Use</a></li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../../index-all.html">Index</a></li> <li><a href="../../../../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList"> <li><a href="../../../../edu/ucsb/nceas/metacat/DBTransform.html" title="class in edu.ucsb.nceas.metacat"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../../edu/ucsb/nceas/metacat/DBValidate.html" title="class in edu.ucsb.nceas.metacat"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?edu/ucsb/nceas/metacat/DBUtil.html" target="_top">Frames</a></li> <li><a href="DBUtil.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_top"> <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- allClassesLink = document.getElementById("allclasses_navbar_top"); if(window==top) { allClassesLink.style.display = "block"; } else { allClassesLink.style.display = "none"; } //--> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li><a href="#field.summary">Field</a> | </li> <li><a href="#constructor.summary">Constr</a> | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li><a href="#field.detail">Field</a> | </li> <li><a href="#constructor.detail">Constr</a> | </li> <li><a href="#method.detail">Method</a></li> </ul> </div> <a name="skip.navbar.top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> <!-- ======== START OF CLASS DATA ======== --> <div class="header"> <div class="subTitle">edu.ucsb.nceas.metacat</div> <h2 title="Class DBUtil" class="title">Class DBUtil</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>edu.ucsb.nceas.metacat.DBUtil</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <hr> <br> <pre>public class <span class="typeNameLabel">DBUtil</span> extends java.lang.Object</pre> <div class="block">A suite of utility classes for querying DB</div> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList"> <!-- =========== FIELD SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="field.summary"> <!-- --> </a> <h3>Field Summary</h3> <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> <caption><span>Fields</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Field and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/DBUtil.html#NONEEXIST">NONEEXIST</a></span></code> </td> </tr> </table> </li> </ul> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor.summary"> <!-- --> </a> <h3>Constructor Summary</h3> <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> <caption><span>Constructors</span><span class="tabEnd"> </span></caption> <tr> <th class="colOne" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> <td class="colOne"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/DBUtil.html#DBUtil--">DBUtil</a></span>()</code> <div class="block">Construct an instance of the utility class</div> </td> </tr> </table> </li> </ul> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="method.summary"> <!-- --> </a> <h3>Method Summary</h3> <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> <tr id="i0" class="altColor"> <td class="colFirst"><code>static java.lang.String</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/DBUtil.html#findDataSetDocIdForGivenDocument-java.lang.String-">findDataSetDocIdForGivenDocument</a></span>(java.lang.String givenDocId)</code> <div class="block">To a given docid, found a dataset docid which contains the the given docid This will be done by searching xml_relation table If couldn't find, null will be return</div> </td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code>static java.util.Vector<java.lang.String></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/DBUtil.html#getAllDocids-java.lang.String-">getAllDocids</a></span>(java.lang.String scope)</code> <div class="block">get the latest Accession Number from a particular scope</div> </td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code>static java.util.Vector<java.lang.String></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/DBUtil.html#getAllDocidsByType-java.lang.String-boolean-">getAllDocidsByType</a></span>(java.lang.String doctype, boolean includeRevs)</code> <div class="block">return all docids with a given doctype on all servers</div> </td> </tr> <tr id="i3" class="rowColor"> <td class="colFirst"><code>static java.util.Vector<java.lang.String></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/DBUtil.html#getAllDocidsByType-java.lang.String-boolean-int-">getAllDocidsByType</a></span>(java.lang.String doctype, boolean includeRevs, int serverLocation)</code> <div class="block">return all docids with a given doctype for a given server</div> </td> </tr> <tr id="i4" class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/DBUtil.html#getCurrentRevisionAndDocTypeForGivenDocument-java.lang.String-">getCurrentRevisionAndDocTypeForGivenDocument</a></span>(java.lang.String givenDocId)</code> <div class="block">Method to get current revision and doctype for a given docid The output will look like "rev;doctype"</div> </td> </tr> <tr id="i5" class="rowColor"> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/DBUtil.html#getLatestRevisionInDocumentTable-java.lang.String-">getLatestRevisionInDocumentTable</a></span>(java.lang.String docIdWithoutRev)</code> <div class="block">Get last revision number from database for a docid If couldn't find an entry, -1 will return The return value is integer because we want compare it to there new one</div> </td> </tr> <tr id="i6" class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/DBUtil.html#getMaxDocid-java.lang.String-">getMaxDocid</a></span>(java.lang.String scope)</code> <div class="block">get the latest Accession Number from a particular scope</div> </td> </tr> <tr id="i7" class="rowColor"> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/DBUtil.html#getMaxRevFromRevisionTable-java.lang.String-">getMaxRevFromRevisionTable</a></span>(java.lang.String docIdWithoutRev)</code> <div class="block">Method to return max rev number in xml_revision for given docid.</div> </td> </tr> <tr id="i8" class="altColor"> <td class="colFirst"><code>static java.util.Vector<java.lang.Integer></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/DBUtil.html#getRevListFromRevisionTable-java.lang.String-">getRevListFromRevisionTable</a></span>(java.lang.String docIdWithoutRev)</code> <div class="block">Method to return a rev list in xml_revision for given docid.</div> </td> </tr> <tr id="i9" class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/DBUtil.html#idExists-java.lang.String-">idExists</a></span>(java.lang.String docid)</code> <div class="block">return true if the given docid is registered in either the xml_documents or xml_revisions table</div> </td> </tr> <tr id="i10" class="altColor"> <td class="colFirst"><code>static void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/DBUtil.html#main-java.lang.String:A-">main</a></span>(java.lang.String[] args)</code> <div class="block">main routine used for testing.</div> </td> </tr> <tr id="i11" class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/DBUtil.html#readDoctypes--">readDoctypes</a></span>()</code> <div class="block">read all doctypes from db connection in XML format select all Public Id from xml_catalog table</div> </td> </tr> <tr id="i12" class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/DBUtil.html#readDTDSchema-java.lang.String-">readDTDSchema</a></span>(java.lang.String doctype)</code> <div class="block">read DTD or Schema file from Metacat's XML catalog system</div> </td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> <!-- --> </a> <h3>Methods inherited from class java.lang.Object</h3> <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> </ul> </li> </ul> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList"> <!-- ============ FIELD DETAIL =========== --> <ul class="blockList"> <li class="blockList"><a name="field.detail"> <!-- --> </a> <h3>Field Detail</h3> <a name="NONEEXIST"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>NONEEXIST</h4> <pre>public static final int NONEEXIST</pre> <dl> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="../../../../constant-values.html#edu.ucsb.nceas.metacat.DBUtil.NONEEXIST">Constant Field Values</a></dd> </dl> </li> </ul> </li> </ul> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor.detail"> <!-- --> </a> <h3>Constructor Detail</h3> <a name="DBUtil--"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>DBUtil</h4> <pre>public DBUtil()</pre> <div class="block">Construct an instance of the utility class</div> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method.detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="main-java.lang.String:A-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>main</h4> <pre>public static void main(java.lang.String[] args)</pre> <div class="block">main routine used for testing. <p> Usage: java DBUtil <-dt|-dg></div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>-dt</code> - for selecting all doctypes -dg for selecting DataGuide</dd> </dl> </li> </ul> <a name="readDoctypes--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>readDoctypes</h4> <pre>public java.lang.String readDoctypes() throws java.sql.SQLException</pre> <div class="block">read all doctypes from db connection in XML format select all Public Id from xml_catalog table</div> <dl> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code>java.sql.SQLException</code></dd> </dl> </li> </ul> <a name="readDTDSchema-java.lang.String-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>readDTDSchema</h4> <pre>public java.lang.String readDTDSchema(java.lang.String doctype) throws java.sql.SQLException, java.net.MalformedURLException, java.io.IOException, edu.ucsb.nceas.utilities.PropertyNotFoundException</pre> <div class="block">read DTD or Schema file from Metacat's XML catalog system</div> <dl> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code>java.sql.SQLException</code></dd> <dd><code>java.net.MalformedURLException</code></dd> <dd><code>java.io.IOException</code></dd> <dd><code>edu.ucsb.nceas.utilities.PropertyNotFoundException</code></dd> </dl> </li> </ul> <a name="getMaxDocid-java.lang.String-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getMaxDocid</h4> <pre>public java.lang.String getMaxDocid(java.lang.String scope) throws java.sql.SQLException</pre> <div class="block">get the latest Accession Number from a particular scope</div> <dl> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code>java.sql.SQLException</code></dd> </dl> </li> </ul> <a name="idExists-java.lang.String-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>idExists</h4> <pre>public boolean idExists(java.lang.String docid) throws java.sql.SQLException</pre> <div class="block">return true if the given docid is registered in either the xml_documents or xml_revisions table</div> <dl> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code>java.sql.SQLException</code></dd> </dl> </li> </ul> <a name="getAllDocidsByType-java.lang.String-boolean-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getAllDocidsByType</h4> <pre>public static java.util.Vector<java.lang.String> getAllDocidsByType(java.lang.String doctype, boolean includeRevs) throws java.sql.SQLException</pre> <div class="block">return all docids with a given doctype on all servers</div> <dl> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code>java.sql.SQLException</code></dd> </dl> </li> </ul> <a name="getAllDocidsByType-java.lang.String-boolean-int-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getAllDocidsByType</h4> <pre>public static java.util.Vector<java.lang.String> getAllDocidsByType(java.lang.String doctype, boolean includeRevs, int serverLocation) throws java.sql.SQLException</pre> <div class="block">return all docids with a given doctype for a given server</div> <dl> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code>java.sql.SQLException</code></dd> </dl> </li> </ul> <a name="getAllDocids-java.lang.String-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getAllDocids</h4> <pre>public static java.util.Vector<java.lang.String> getAllDocids(java.lang.String scope) throws java.sql.SQLException</pre> <div class="block">get the latest Accession Number from a particular scope</div> <dl> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code>java.sql.SQLException</code></dd> </dl> </li> </ul> <a name="findDataSetDocIdForGivenDocument-java.lang.String-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>findDataSetDocIdForGivenDocument</h4> <pre>public static java.lang.String findDataSetDocIdForGivenDocument(java.lang.String givenDocId)</pre> <div class="block">To a given docid, found a dataset docid which contains the the given docid This will be done by searching xml_relation table If couldn't find, null will be return</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>givenDocId,</code> - the docid which we want to find</dd> </dl> </li> </ul> <a name="getCurrentRevisionAndDocTypeForGivenDocument-java.lang.String-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getCurrentRevisionAndDocTypeForGivenDocument</h4> <pre>public java.lang.String getCurrentRevisionAndDocTypeForGivenDocument(java.lang.String givenDocId) throws java.sql.SQLException</pre> <div class="block">Method to get current revision and doctype for a given docid The output will look like "rev;doctype"</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>givenDocId,</code> - the docid which we want</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code>java.sql.SQLException</code></dd> </dl> </li> </ul> <a name="getMaxRevFromRevisionTable-java.lang.String-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getMaxRevFromRevisionTable</h4> <pre>public static int getMaxRevFromRevisionTable(java.lang.String docIdWithoutRev) throws java.sql.SQLException</pre> <div class="block">Method to return max rev number in xml_revision for given docid.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>docId</code> - </dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>integer that holds max revision number</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code>java.sql.SQLException</code></dd> </dl> </li> </ul> <a name="getRevListFromRevisionTable-java.lang.String-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getRevListFromRevisionTable</h4> <pre>public static java.util.Vector<java.lang.Integer> getRevListFromRevisionTable(java.lang.String docIdWithoutRev) throws java.sql.SQLException</pre> <div class="block">Method to return a rev list in xml_revision for given docid.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>docId</code> - </dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>is a vector which contains Integer object</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code>java.sql.SQLException</code></dd> </dl> </li> </ul> <a name="getLatestRevisionInDocumentTable-java.lang.String-"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>getLatestRevisionInDocumentTable</h4> <pre>public static int getLatestRevisionInDocumentTable(java.lang.String docIdWithoutRev) throws java.sql.SQLException</pre> <div class="block">Get last revision number from database for a docid If couldn't find an entry, -1 will return The return value is integer because we want compare it to there new one</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>docid</code> - <sitecode>. <uniqueid>part of Accession Number</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code>java.sql.SQLException</code></dd> </dl> </li> </ul> </li> </ul> </li> </ul> </div> </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> <div class="bottomNav"><a name="navbar.bottom"> <!-- --> </a> <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> <a name="navbar.bottom.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../../overview-summary.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="class-use/DBUtil.html">Use</a></li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../../index-all.html">Index</a></li> <li><a href="../../../../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList"> <li><a href="../../../../edu/ucsb/nceas/metacat/DBTransform.html" title="class in edu.ucsb.nceas.metacat"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../../edu/ucsb/nceas/metacat/DBValidate.html" title="class in edu.ucsb.nceas.metacat"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?edu/ucsb/nceas/metacat/DBUtil.html" target="_top">Frames</a></li> <li><a href="DBUtil.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_bottom"> <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- allClassesLink = document.getElementById("allclasses_navbar_bottom"); if(window==top) { allClassesLink.style.display = "block"; } else { allClassesLink.style.display = "none"; } //--> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li><a href="#field.summary">Field</a> | </li> <li><a href="#constructor.summary">Constr</a> | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li><a href="#field.detail">Field</a> | </li> <li><a href="#constructor.detail">Constr</a> | </li> <li><a href="#method.detail">Method</a></li> </ul> </div> <a name="skip.navbar.bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> <p class="legalCopy"><small><i>Copyright © 2020 Regents of the University of California. All Rights Reserved.</i></small></p> </body> </html>