<!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:52 UTC 2020 -->
<title>DocumentUtil (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="DocumentUtil (MetaCat API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":9,"i12":9,"i13":9,"i14":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/DocumentUtil.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/util/DeleteOnCloseFileInputStream.html" title="class in edu.ucsb.nceas.metacat.util"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../../edu/ucsb/nceas/metacat/util/EMLVersionsTransformer.html" title="class in edu.ucsb.nceas.metacat.util"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?edu/ucsb/nceas/metacat/util/DocumentUtil.html" target="_top">Frames</a></li>
<li><a href="DocumentUtil.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.util</div>
<h2 title="Class DocumentUtil" class="title">Class DocumentUtil</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>edu.ucsb.nceas.metacat.util.DocumentUtil</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">DocumentUtil</span>
extends java.lang.Object</pre>
<div class="block">A suite of utility classes for the metadata catalog server</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 <a href="../../../../../edu/ucsb/nceas/dbadapter/AbstractDatabase.html" title="class in edu.ucsb.nceas.dbadapter">AbstractDatabase</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/util/DocumentUtil.html#dbAdapter">dbAdapter</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/util/DocumentUtil.html#DocumentUtil--">DocumentUtil</a></span>()</code> </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="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/util/DocumentUtil.html#appendRev-java.lang.String-">appendRev</a></span>(java.lang.String docid)</code>
<div class="block">If the given docid only have one seperter, we need
append rev for it.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/util/DocumentUtil.html#generateDocumentId-int-">generateDocumentId</a></span>(int revision)</code>
<div class="block">Create a unique docid for use in inserts and updates using the default
prefix from the document.accNumPrefix property.</div>
</td>
</tr>
<tr id="i2" 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/util/DocumentUtil.html#generateDocumentId-java.lang.String-int-">generateDocumentId</a></span>(java.lang.String idPrefix,
int revision)</code>
<div class="block">Create a unique docid for use in inserts and updates using the prefix
that is provided.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/util/DocumentUtil.html#getAccessionNumberFromEcogridIdentifier-java.lang.String-">getAccessionNumberFromEcogridIdentifier</a></span>(java.lang.String identifier)</code>
<div class="block">Eocgorid identifier will look like: ecogrid://knb/tao.1.1
The AccessionNumber tao.1.1 will be returned.</div>
</td>
</tr>
<tr id="i4" 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/util/DocumentUtil.html#getDocIdFromAccessionNumber-java.lang.String-">getDocIdFromAccessionNumber</a></span>(java.lang.String accessionNumber)</code>
<div class="block">This method will get docid from an AccessionNumber.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/util/DocumentUtil.html#getDocIdFromInlineDataID-java.lang.String-">getDocIdFromInlineDataID</a></span>(java.lang.String inlineDataID)</code>
<div class="block">Method to get docidwithrev from eml2 inline data id The eml inline data
id would look like eml.200.2.3</div>
</td>
</tr>
<tr id="i6" 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/util/DocumentUtil.html#getDocIdFromString-java.lang.String-">getDocIdFromString</a></span>(java.lang.String str)</code>
<div class="block">Utility method to get docid from a given string</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/util/DocumentUtil.html#getDocIdWithRevFromOnlineURL-java.lang.String-">getDocIdWithRevFromOnlineURL</a></span>(java.lang.String url)</code>
<div class="block">Get docid from online/url string</div>
</td>
</tr>
<tr id="i8" 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/util/DocumentUtil.html#getInlineDataIdWithoutRev-java.lang.String-">getInlineDataIdWithoutRev</a></span>(java.lang.String accessionNumber)</code>
<div class="block">This method will get inline data id without the revision number.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/util/DocumentUtil.html#getRevisionFromAccessionNumber-java.lang.String-">getRevisionFromAccessionNumber</a></span>(java.lang.String accessionNumber)</code>
<div class="block">This method will get revision from an AccessionNumber.</div>
</td>
</tr>
<tr id="i10" 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/util/DocumentUtil.html#getRevisionStringFromString-java.lang.String-">getRevisionStringFromString</a></span>(java.lang.String str)</code>
<div class="block">Utility method to get version string from a given string</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/util/DocumentUtil.html#getSmartDocId-java.lang.String-">getSmartDocId</a></span>(java.lang.String str)</code>
<div class="block">This method will call both getDocIdFromString and
getDocIdFromAccessionNumber.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/util/DocumentUtil.html#getVersionFromString-java.lang.String-">getVersionFromString</a></span>(java.lang.String str)</code>
<div class="block">Utility method to get version number from a given string</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/util/DocumentUtil.html#isAuthorized-java.io.PrintWriter-java.util.Hashtable-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-">isAuthorized</a></span>(java.io.PrintWriter out,
java.util.Hashtable<java.lang.String,java.lang.String[]> params,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)</code> </td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>static java.util.Stack<<a href="../../../../../edu/ucsb/nceas/metacat/NodeRecord.html" title="class in edu.ucsb.nceas.metacat">NodeRecord</a>></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/util/DocumentUtil.html#reviseStack-java.util.Stack-">reviseStack</a></span>(java.util.Stack<<a href="../../../../../edu/ucsb/nceas/metacat/NodeRecord.html" title="class in edu.ucsb.nceas.metacat">NodeRecord</a>> stack)</code>
<div class="block">Revise stack change a stack to opposite order</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="dbAdapter">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>dbAdapter</h4>
<pre>public static <a href="../../../../../edu/ucsb/nceas/dbadapter/AbstractDatabase.html" title="class in edu.ucsb.nceas.dbadapter">AbstractDatabase</a> dbAdapter</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="DocumentUtil--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DocumentUtil</h4>
<pre>public DocumentUtil()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getDocIdWithRevFromOnlineURL-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDocIdWithRevFromOnlineURL</h4>
<pre>public static java.lang.String getDocIdWithRevFromOnlineURL(java.lang.String url)</pre>
<div class="block">Get docid from online/url string</div>
</li>
</ul>
<a name="getAccessionNumberFromEcogridIdentifier-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAccessionNumberFromEcogridIdentifier</h4>
<pre>public static java.lang.String getAccessionNumberFromEcogridIdentifier(java.lang.String identifier)</pre>
<div class="block">Eocgorid identifier will look like: ecogrid://knb/tao.1.1
The AccessionNumber tao.1.1 will be returned. If the given doesn't
contains ecogrid, null will be returned.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>identifier</code> - String</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>String</dd>
</dl>
</li>
</ul>
<a name="getDocIdFromString-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDocIdFromString</h4>
<pre>public static java.lang.String getDocIdFromString(java.lang.String str)</pre>
<div class="block">Utility method to get docid from a given string</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>string,</code> - the given string should be these two format: 1) str1.str2
in this case docid= str1.str2 2) str1.str2.str3, in this case
docid =str1.str2</dd>
<dd><code>the</code> - sperator char</dd>
</dl>
</li>
</ul>
<a name="getVersionFromString-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVersionFromString</h4>
<pre>public static int getVersionFromString(java.lang.String str)
throws java.lang.NumberFormatException</pre>
<div class="block">Utility method to get version number from a given string</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>string,</code> - the given string should be these two format: 1)
str1.str2(no version) version =-1; 2) str1.str2.str3, in this
case version = str3; 3) other, vresion =-2</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NumberFormatException</code></dd>
</dl>
</li>
</ul>
<a name="getRevisionStringFromString-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRevisionStringFromString</h4>
<pre>public static java.lang.String getRevisionStringFromString(java.lang.String str)
throws java.lang.NumberFormatException</pre>
<div class="block">Utility method to get version string from a given string</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>string,</code> - the given string should be these two format: 1)
str1.str2(no version) version=null; 2) str1.str2.str3, in
this case version = str3; 3) other, vresion =null;</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NumberFormatException</code></dd>
</dl>
</li>
</ul>
<a name="appendRev-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>appendRev</h4>
<pre>public static java.lang.String appendRev(java.lang.String docid)
throws edu.ucsb.nceas.utilities.PropertyNotFoundException,
java.sql.SQLException,
<a href="../../../../../edu/ucsb/nceas/metacat/McdbDocNotFoundException.html" title="class in edu.ucsb.nceas.metacat">McdbDocNotFoundException</a></pre>
<div class="block">If the given docid only have one seperter, we need
append rev for it. The rev come from xml_documents</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>edu.ucsb.nceas.utilities.PropertyNotFoundException</code></dd>
<dd><code>java.sql.SQLException</code></dd>
<dd><code><a href="../../../../../edu/ucsb/nceas/metacat/McdbDocNotFoundException.html" title="class in edu.ucsb.nceas.metacat">McdbDocNotFoundException</a></code></dd>
</dl>
</li>
</ul>
<a name="getDocIdFromAccessionNumber-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDocIdFromAccessionNumber</h4>
<pre>public static java.lang.String getDocIdFromAccessionNumber(java.lang.String accessionNumber)</pre>
<div class="block">This method will get docid from an AccessionNumber. There is no
assumption the accessnumber will be str1.str2.str3. It can be more. So
we think the docid will be get rid of last part</div>
</li>
</ul>
<a name="getInlineDataIdWithoutRev-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInlineDataIdWithoutRev</h4>
<pre>public static java.lang.String getInlineDataIdWithoutRev(java.lang.String accessionNumber)</pre>
<div class="block">This method will get inline data id without the revision number.
So if inlineData.1.2 is passed as input, inlineData.2 is returned.</div>
</li>
</ul>
<a name="getSmartDocId-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSmartDocId</h4>
<pre>public static java.lang.String getSmartDocId(java.lang.String str)</pre>
<div class="block">This method will call both getDocIdFromString and
getDocIdFromAccessionNumber. So first, if the string looks str1.str2,
the docid will be str1.str2. If the string is str1.str2.str3, the docid
will be str1.str2. If the string is str1.str2.str3.str4 or more, the
docid will be str1.str2.str3. If the string look like str1, null will be
returned</div>
</li>
</ul>
<a name="getRevisionFromAccessionNumber-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRevisionFromAccessionNumber</h4>
<pre>public static int getRevisionFromAccessionNumber(java.lang.String accessionNumber)
throws java.lang.NumberFormatException</pre>
<div class="block">This method will get revision from an AccessionNumber. There is no
assumption the accessnumber will be str1.str2.str3. It can be more. So
we think the docid will be get rid of last part</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NumberFormatException</code></dd>
</dl>
</li>
</ul>
<a name="getDocIdFromInlineDataID-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDocIdFromInlineDataID</h4>
<pre>public static java.lang.String getDocIdFromInlineDataID(java.lang.String inlineDataID)</pre>
<div class="block">Method to get docidwithrev from eml2 inline data id The eml inline data
id would look like eml.200.2.3</div>
</li>
</ul>
<a name="reviseStack-java.util.Stack-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reviseStack</h4>
<pre>public static java.util.Stack<<a href="../../../../../edu/ucsb/nceas/metacat/NodeRecord.html" title="class in edu.ucsb.nceas.metacat">NodeRecord</a>> reviseStack(java.util.Stack<<a href="../../../../../edu/ucsb/nceas/metacat/NodeRecord.html" title="class in edu.ucsb.nceas.metacat">NodeRecord</a>> stack)</pre>
<div class="block">Revise stack change a stack to opposite order</div>
</li>
</ul>
<a name="isAuthorized-java.io.PrintWriter-java.util.Hashtable-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAuthorized</h4>
<pre>public static void isAuthorized(java.io.PrintWriter out,
java.util.Hashtable<java.lang.String,java.lang.String[]> params,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
throws <a href="../../../../../edu/ucsb/nceas/metacat/shared/MetacatUtilException.html" title="class in edu.ucsb.nceas.metacat.shared">MetacatUtilException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../edu/ucsb/nceas/metacat/shared/MetacatUtilException.html" title="class in edu.ucsb.nceas.metacat.shared">MetacatUtilException</a></code></dd>
</dl>
</li>
</ul>
<a name="generateDocumentId-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>generateDocumentId</h4>
<pre>public static java.lang.String generateDocumentId(int revision)</pre>
<div class="block">Create a unique docid for use in inserts and updates using the default
prefix from the document.accNumPrefix property. Does not include the
'revision' part of the id if revision is '0', otherwise sets the
revision number to 'revision'.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>idPrefix</code> - the prefix to be used to construct the scope portion of the docid</dd>
<dd><code>revision</code> - the integer revision to use for this docid</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a String docid based on the current date and time</dd>
</dl>
</li>
</ul>
<a name="generateDocumentId-java.lang.String-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>generateDocumentId</h4>
<pre>public static java.lang.String generateDocumentId(java.lang.String idPrefix,
int revision)</pre>
<div class="block">Create a unique docid for use in inserts and updates using the prefix
that is provided. Does not include the 'revision' part of the id if
revision is '0', otherwise sets the revision number to 'revision'.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>idPrefix</code> - the prefix to be used to construct the scope portion of the docid</dd>
<dd><code>revision</code> - the integer revision to use for this docid</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a String docid based on the current date and time</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/DocumentUtil.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/util/DeleteOnCloseFileInputStream.html" title="class in edu.ucsb.nceas.metacat.util"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../../edu/ucsb/nceas/metacat/util/EMLVersionsTransformer.html" title="class in edu.ucsb.nceas.metacat.util"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?edu/ucsb/nceas/metacat/util/DocumentUtil.html" target="_top">Frames</a></li>
<li><a href="DocumentUtil.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>