<!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:51 UTC 2020 -->
<title>ClientViewHelper (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="ClientViewHelper (MetaCat API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":9,"i2":10,"i3":10,"i4":9,"i5":9,"i6":9,"i7":9,"i8":10,"i9":9,"i10":9,"i11":10,"i12":10,"i13":10,"i14":10,"i15":9,"i16":10,"i17":10,"i18":10,"i19":9,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":9,"i28":10,"i29":9,"i30":9};
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/ClientViewHelper.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/clientview/ClientViewBeanInfo.html" title="class in edu.ucsb.nceas.metacat.clientview"><span class="typeNameLink">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?edu/ucsb/nceas/metacat/clientview/ClientViewHelper.html" target="_top">Frames</a></li>
<li><a href="ClientViewHelper.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.clientview</div>
<h2 title="Class ClientViewHelper" class="title">Class ClientViewHelper</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>edu.ucsb.nceas.metacat.clientview.ClientViewHelper</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">ClientViewHelper</span>
extends java.lang.Object</pre>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>barteau</dd>
</dl>
</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 java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/clientview/ClientViewHelper.html#DOWNLOAD_ACTION">DOWNLOAD_ACTION</a></span></code> </td>
</tr>
<tr 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/clientview/ClientViewHelper.html#PERMISSION_TYPE_ALLOW">PERMISSION_TYPE_ALLOW</a></span></code> </td>
</tr>
<tr 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/clientview/ClientViewHelper.html#PERMISSION_TYPE_DISALLOW">PERMISSION_TYPE_DISALLOW</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/clientview/ClientViewHelper.html#ClientViewHelper-javax.servlet.http.HttpServletRequest-">ClientViewHelper</a></span>(javax.servlet.http.HttpServletRequest request)</code>
<div class="block">Creates a new instance of ClientViewHelper, using info in an HttpServletRequest
for initializing.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/clientview/ClientViewHelper.html#ClientViewHelper-java.lang.String-java.lang.String-edu.ucsb.nceas.metacat.clientview.ClientView-">ClientViewHelper</a></span>(java.lang.String host,
java.lang.String context,
<a href="../../../../../edu/ucsb/nceas/metacat/clientview/ClientView.html" title="class in edu.ucsb.nceas.metacat.clientview">ClientView</a> bean)</code>
<div class="block">Creates a new instance of ClientViewHelper, using parameter values
for initializing.</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>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/clientview/ClientViewHelper.html#clientRequest-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-">clientRequest</a></span>(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)</code>
<div class="block">Main web API method for handling various actions.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../edu/ucsb/nceas/metacat/clientview/ClientViewHelper.html" title="class in edu.ucsb.nceas.metacat.clientview">ClientViewHelper</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/clientview/ClientViewHelper.html#clientViewHelperInstance-javax.servlet.http.HttpServletRequest-">clientViewHelperInstance</a></span>(javax.servlet.http.HttpServletRequest request)</code>
<div class="block">This is a convenience method to reduce the amount of code in a Metacat Client.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../edu/ucsb/nceas/metacat/client/MetacatClient.html" title="class in edu.ucsb.nceas.metacat.client">MetacatClient</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/clientview/ClientViewHelper.html#getMetacatClient--">getMetacatClient</a></span>()</code> </td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>org.w3c.dom.Document</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/clientview/ClientViewHelper.html#getMetadataDoc--">getMetadataDoc</a></span>()</code> </td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static org.w3c.dom.Node</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/clientview/ClientViewHelper.html#getNode-javax.xml.xpath.XPath-java.lang.String-org.w3c.dom.Node-">getNode</a></span>(javax.xml.xpath.XPath xPath,
java.lang.String expression,
org.w3c.dom.Node root)</code> </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/clientview/ClientViewHelper.html#getNodeText-javax.xml.xpath.XPath-java.lang.String-org.w3c.dom.Node-">getNodeText</a></span>(javax.xml.xpath.XPath xPath,
java.lang.String expression,
org.w3c.dom.Node root)</code> </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/clientview/ClientViewHelper.html#getNodeTextList-javax.xml.xpath.XPath-java.lang.String-org.w3c.dom.Node-">getNodeTextList</a></span>(javax.xml.xpath.XPath xPath,
java.lang.String expression,
org.w3c.dom.Node root)</code> </td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static java.util.Stack</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/clientview/ClientViewHelper.html#getNodeTextStack-javax.xml.xpath.XPath-java.lang.String-org.w3c.dom.Node-">getNodeTextStack</a></span>(javax.xml.xpath.XPath xpathInstance,
java.lang.String xpathExpr,
org.w3c.dom.Node parentNode)</code> </td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.util.TreeMap</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/clientview/ClientViewHelper.html#getSelectQueryMap--">getSelectQueryMap</a></span>()</code>
<div class="block">Queries Metacat for document listings, and returns the results in a TreeMap,
where the key is the Doc Id, and the value is the Create Date.</div>
</td>
</tr>
<tr id="i9" 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/clientview/ClientViewHelper.html#getStringFromInputStream-java.io.InputStream-">getStringFromInputStream</a></span>(java.io.InputStream input)</code> </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/clientview/ClientViewHelper.html#getTextContent-javax.xml.xpath.XPath-org.w3c.dom.Node-">getTextContent</a></span>(javax.xml.xpath.XPath xPath,
org.w3c.dom.Node elementNode)</code> </td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>java.util.HashMap<java.lang.String,java.lang.Object></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/clientview/ClientViewHelper.html#handleClientRequest-com.oreilly.servlet.multipart.MultipartParser-">handleClientRequest</a></span>(com.oreilly.servlet.multipart.MultipartParser multipartParser)</code>
<div class="block">Main method for handling various actions.</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/clientview/ClientViewHelper.html#handleDocIdSelect--">handleDocIdSelect</a></span>()</code> </td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/clientview/ClientViewHelper.html#handleFileUpdate-com.oreilly.servlet.multipart.MultipartParser-">handleFileUpdate</a></span>(com.oreilly.servlet.multipart.MultipartParser multipartParser)</code> </td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/clientview/ClientViewHelper.html#handlePackageUpload-edu.ucsb.nceas.metacat.clientview.ClientView-com.oreilly.servlet.multipart.MultipartParser-">handlePackageUpload</a></span>(<a href="../../../../../edu/ucsb/nceas/metacat/clientview/ClientView.html" title="class in edu.ucsb.nceas.metacat.clientview">ClientView</a> clientViewBean,
com.oreilly.servlet.multipart.MultipartParser multipartParser)</code>
<div class="block">Handles metadata file and data file uploads for inserting new
Metacat data packages.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/clientview/ClientViewHelper.html#isElementContentWhitespace-org.w3c.dom.Text-">isElementContentWhitespace</a></span>(org.w3c.dom.Text textNode)</code> </td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/clientview/ClientViewHelper.html#isLoggedIn--">isLoggedIn</a></span>()</code>
<div class="block">A convenience method to be used by client code that requires
the user to be logged in.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/clientview/ClientViewHelper.html#makeRedirectUrl--">makeRedirectUrl</a></span>()</code> </td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/clientview/ClientViewHelper.html#nextVersion-java.lang.String-java.lang.String-">nextVersion</a></span>(java.lang.String lastDocId,
java.lang.String xPathQuery)</code> </td>
</tr>
<tr id="i19" 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/clientview/ClientViewHelper.html#parseFileInfo-java.lang.String-">parseFileInfo</a></span>(java.lang.String fileName)</code> </td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/clientview/ClientViewHelper.html#parseXml-java.lang.String-java.lang.String-">parseXml</a></span>(java.lang.String elementName,
java.lang.String xml)</code> </td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>org.w3c.dom.Document</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/clientview/ClientViewHelper.html#query-java.lang.String-java.lang.String-java.lang.String-">query</a></span>(java.lang.String pathExpr,
java.lang.String pathValue,
java.lang.String returnFld)</code>
<div class="block">Query metacat for documents that 'CONTAINS' the value at the specified XPath
expression.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/clientview/ClientViewHelper.html#setLoggedIn-boolean-">setLoggedIn</a></span>(boolean isLoggedIn)</code> </td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/clientview/ClientViewHelper.html#setLoggedIn-java.lang.String-">setLoggedIn</a></span>(java.lang.String serverResponse)</code>
<div class="block">After calling "login(ldapUserName, pwd)", call this with the username
and servers response message.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/clientview/ClientViewHelper.html#setMetadataDoc-org.w3c.dom.Document-">setMetadataDoc</a></span>(org.w3c.dom.Document doc)</code> </td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/clientview/ClientViewHelper.html#setMetadataDoc-java.io.InputStream-">setMetadataDoc</a></span>(java.io.InputStream ioStream)</code> </td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/clientview/ClientViewHelper.html#setMetadataDoc-java.lang.String-">setMetadataDoc</a></span>(java.lang.String docId)</code> </td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/clientview/ClientViewHelper.html#setTextContent-javax.xml.xpath.XPath-org.w3c.dom.Node-java.lang.String-">setTextContent</a></span>(javax.xml.xpath.XPath xPath,
org.w3c.dom.Node elementNode,
java.lang.String content)</code> </td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/clientview/ClientViewHelper.html#setUserName-java.lang.String-">setUserName</a></span>(java.lang.String userName)</code> </td>
</tr>
<tr id="i29" 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/clientview/ClientViewHelper.html#toZipFileName-java.lang.String-">toZipFileName</a></span>(java.lang.String fileName)</code> </td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/clientview/ClientViewHelper.html#updateNodeText-org.w3c.dom.Node-javax.xml.xpath.XPath-java.lang.String-java.lang.String-">updateNodeText</a></span>(org.w3c.dom.Node root,
javax.xml.xpath.XPath xPath,
java.lang.String expression,
java.lang.String text)</code> </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="DOWNLOAD_ACTION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DOWNLOAD_ACTION</h4>
<pre>public static final java.lang.String DOWNLOAD_ACTION</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#edu.ucsb.nceas.metacat.clientview.ClientViewHelper.DOWNLOAD_ACTION">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="PERMISSION_TYPE_ALLOW">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PERMISSION_TYPE_ALLOW</h4>
<pre>public static final java.lang.String PERMISSION_TYPE_ALLOW</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#edu.ucsb.nceas.metacat.clientview.ClientViewHelper.PERMISSION_TYPE_ALLOW">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="PERMISSION_TYPE_DISALLOW">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PERMISSION_TYPE_DISALLOW</h4>
<pre>public static final java.lang.String PERMISSION_TYPE_DISALLOW</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#edu.ucsb.nceas.metacat.clientview.ClientViewHelper.PERMISSION_TYPE_DISALLOW">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="ClientViewHelper-javax.servlet.http.HttpServletRequest-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ClientViewHelper</h4>
<pre>public ClientViewHelper(javax.servlet.http.HttpServletRequest request)
throws <a href="../../../../../edu/ucsb/nceas/metacat/client/MetacatInaccessibleException.html" title="class in edu.ucsb.nceas.metacat.client">MetacatInaccessibleException</a></pre>
<div class="block">Creates a new instance of ClientViewHelper, using info in an HttpServletRequest
for initializing.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>request</code> - HttpServletRequest, sent from the client browser.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../edu/ucsb/nceas/metacat/client/MetacatInaccessibleException.html" title="class in edu.ucsb.nceas.metacat.client">MetacatInaccessibleException</a></code> - Thrown</dd>
</dl>
</li>
</ul>
<a name="ClientViewHelper-java.lang.String-java.lang.String-edu.ucsb.nceas.metacat.clientview.ClientView-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ClientViewHelper</h4>
<pre>public ClientViewHelper(java.lang.String host,
java.lang.String context,
<a href="../../../../../edu/ucsb/nceas/metacat/clientview/ClientView.html" title="class in edu.ucsb.nceas.metacat.clientview">ClientView</a> bean)
throws <a href="../../../../../edu/ucsb/nceas/metacat/client/MetacatInaccessibleException.html" title="class in edu.ucsb.nceas.metacat.client">MetacatInaccessibleException</a></pre>
<div class="block">Creates a new instance of ClientViewHelper, using parameter values
for initializing. This constructor is plain java code so it's the portal of
choice for JUnit testing.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>host</code> - The host with port (if needed), such as "localhost:8084".</dd>
<dd><code>context</code> - The application root context.</dd>
<dd><code>bean</code> - ClientView instance, with pre-populated values.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../edu/ucsb/nceas/metacat/client/MetacatInaccessibleException.html" title="class in edu.ucsb.nceas.metacat.client">MetacatInaccessibleException</a></code> - thrown</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="clientRequest-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clientRequest</h4>
<pre>public java.lang.String clientRequest(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)</pre>
<div class="block">Main web API method for handling various actions.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>request</code> - HttpServletRequest</dd>
<dd><code>response</code> - HttpServletResponse</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>String message</dd>
</dl>
</li>
</ul>
<a name="handleClientRequest-com.oreilly.servlet.multipart.MultipartParser-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>handleClientRequest</h4>
<pre>public java.util.HashMap<java.lang.String,java.lang.Object> handleClientRequest(com.oreilly.servlet.multipart.MultipartParser multipartParser)</pre>
<div class="block">Main method for handling various actions.
Note: This is mostly plain java code so it is JUnit friendly
(pass null as the MulipartParser).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>multipartParser</code> - Only needed if the action is "Upload".</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>HashMap containing "message", and possibly several other values. If
the action is Download, than this will contain all needed values
to pass to handleDownloadResponse.</dd>
</dl>
</li>
</ul>
<a name="clientViewHelperInstance-javax.servlet.http.HttpServletRequest-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clientViewHelperInstance</h4>
<pre>public static <a href="../../../../../edu/ucsb/nceas/metacat/clientview/ClientViewHelper.html" title="class in edu.ucsb.nceas.metacat.clientview">ClientViewHelper</a> clientViewHelperInstance(javax.servlet.http.HttpServletRequest request)</pre>
<div class="block">This is a convenience method to reduce the amount of code in a Metacat Client.
It handles creating/reusing (per session) an instance of a ClientViewHelper.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>request</code> - Since this is intended to be used by an Http client, it is passed the
available "request" variable (the HttpServletRequest).</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>ClientViewHelper instance.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../edu/ucsb/nceas/metacat/client/MetacatInaccessibleException.html" title="class in edu.ucsb.nceas.metacat.client">MetacatInaccessibleException</a></code> - Received by MetacatFactory.</dd>
</dl>
</li>
</ul>
<a name="isLoggedIn--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isLoggedIn</h4>
<pre>public boolean isLoggedIn()</pre>
<div class="block">A convenience method to be used by client code that requires
the user to be logged in. NOTE: setUser() must have been called first,
otherwise it will always return false.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>boolean true if user has logged in for this session, false otherwise.</dd>
</dl>
</li>
</ul>
<a name="setLoggedIn-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLoggedIn</h4>
<pre>public void setLoggedIn(java.lang.String serverResponse)</pre>
<div class="block">After calling "login(ldapUserName, pwd)", call this with the username
and servers response message. You can than use isLoggedIn() to determine if
the user is logged in, getLoginResponseElement(), etc. The user name will also
used by calls to doMetadataUpload() for Document Id creation (scope).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>userName</code> - User name</dd>
<dd><code>serverResponse</code> - XML login response sent from Metacat.</dd>
</dl>
</li>
</ul>
<a name="setLoggedIn-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLoggedIn</h4>
<pre>public void setLoggedIn(boolean isLoggedIn)</pre>
</li>
</ul>
<a name="setUserName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUserName</h4>
<pre>public void setUserName(java.lang.String userName)</pre>
</li>
</ul>
<a name="parseXml-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parseXml</h4>
<pre>public java.lang.String parseXml(java.lang.String elementName,
java.lang.String xml)</pre>
</li>
</ul>
<a name="handleDocIdSelect--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>handleDocIdSelect</h4>
<pre>public java.lang.String handleDocIdSelect()</pre>
</li>
</ul>
<a name="handlePackageUpload-edu.ucsb.nceas.metacat.clientview.ClientView-com.oreilly.servlet.multipart.MultipartParser-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>handlePackageUpload</h4>
<pre>public java.lang.String handlePackageUpload(<a href="../../../../../edu/ucsb/nceas/metacat/clientview/ClientView.html" title="class in edu.ucsb.nceas.metacat.clientview">ClientView</a> clientViewBean,
com.oreilly.servlet.multipart.MultipartParser multipartParser)
throws java.lang.Exception</pre>
<div class="block">Handles metadata file and data file uploads for inserting new
Metacat data packages. Note: if content type is not "multipart/form-data",
nothing will happen.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>request</code> - HTTP request.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A 1-line status message for the user.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></dd>
</dl>
</li>
</ul>
<a name="handleFileUpdate-com.oreilly.servlet.multipart.MultipartParser-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>handleFileUpdate</h4>
<pre>public java.lang.String handleFileUpdate(com.oreilly.servlet.multipart.MultipartParser multipartParser)
throws java.lang.Exception</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></dd>
</dl>
</li>
</ul>
<a name="getSelectQueryMap--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSelectQueryMap</h4>
<pre>public java.util.TreeMap getSelectQueryMap()</pre>
<div class="block">Queries Metacat for document listings, and returns the results in a TreeMap,
where the key is the Doc Id, and the value is the Create Date. If the document
contains the specified 'returnfield', an addtional entry will be created with
the value being a Vector of sub-DocId's. The key of this entry will be the
original DocId with some addtional text added.
Reads bean properties 'pathExpr' (String[]), 'pathValue' (String)
and 'returnfield' (String).</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>TreeMap</dd>
</dl>
</li>
</ul>
<a name="query-java.lang.String-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>query</h4>
<pre>public org.w3c.dom.Document query(java.lang.String pathExpr,
java.lang.String pathValue,
java.lang.String returnFld)</pre>
<div class="block">Query metacat for documents that 'CONTAINS' the value at the specified XPath
expression. Additionally, returns another non-standard field value.
Standard info contains: DocId, DocName, DocType, CreateDate, and UpdateDate.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pathExpr</code> - String contianing an XPath expression.</dd>
<dd><code>pathValue</code> - String containing a comparison value at the XPath expression.</dd>
<dd><code>returnFld</code> - String containing an XPath expression to a field which will be returned
in addition to the standard info.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>DOM Document containing the results.</dd>
</dl>
</li>
</ul>
<a name="setMetadataDoc-org.w3c.dom.Document-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMetadataDoc</h4>
<pre>public void setMetadataDoc(org.w3c.dom.Document doc)</pre>
</li>
</ul>
<a name="setMetadataDoc-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMetadataDoc</h4>
<pre>public void setMetadataDoc(java.lang.String docId)
throws java.lang.Exception</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></dd>
</dl>
</li>
</ul>
<a name="setMetadataDoc-java.io.InputStream-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMetadataDoc</h4>
<pre>public void setMetadataDoc(java.io.InputStream ioStream)
throws java.io.IOException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
</dl>
</li>
</ul>
<a name="getMetadataDoc--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMetadataDoc</h4>
<pre>public org.w3c.dom.Document getMetadataDoc()</pre>
</li>
</ul>
<a name="nextVersion-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nextVersion</h4>
<pre>public java.lang.String nextVersion(java.lang.String lastDocId,
java.lang.String xPathQuery)
throws javax.xml.xpath.XPathExpressionException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>javax.xml.xpath.XPathExpressionException</code></dd>
</dl>
</li>
</ul>
<a name="getMetacatClient--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMetacatClient</h4>
<pre>public <a href="../../../../../edu/ucsb/nceas/metacat/client/MetacatClient.html" title="class in edu.ucsb.nceas.metacat.client">MetacatClient</a> getMetacatClient()</pre>
</li>
</ul>
<a name="parseFileInfo-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parseFileInfo</h4>
<pre>public static java.lang.String[] parseFileInfo(java.lang.String fileName)</pre>
</li>
</ul>
<a name="updateNodeText-org.w3c.dom.Node-javax.xml.xpath.XPath-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateNodeText</h4>
<pre>public static void updateNodeText(org.w3c.dom.Node root,
javax.xml.xpath.XPath xPath,
java.lang.String expression,
java.lang.String text)</pre>
</li>
</ul>
<a name="getNode-javax.xml.xpath.XPath-java.lang.String-org.w3c.dom.Node-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNode</h4>
<pre>public static org.w3c.dom.Node getNode(javax.xml.xpath.XPath xPath,
java.lang.String expression,
org.w3c.dom.Node root)</pre>
</li>
</ul>
<a name="getNodeText-javax.xml.xpath.XPath-java.lang.String-org.w3c.dom.Node-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNodeText</h4>
<pre>public static java.lang.String getNodeText(javax.xml.xpath.XPath xPath,
java.lang.String expression,
org.w3c.dom.Node root)</pre>
</li>
</ul>
<a name="getNodeTextList-javax.xml.xpath.XPath-java.lang.String-org.w3c.dom.Node-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNodeTextList</h4>
<pre>public static java.lang.String[] getNodeTextList(javax.xml.xpath.XPath xPath,
java.lang.String expression,
org.w3c.dom.Node root)</pre>
</li>
</ul>
<a name="getNodeTextStack-javax.xml.xpath.XPath-java.lang.String-org.w3c.dom.Node-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNodeTextStack</h4>
<pre>public static java.util.Stack getNodeTextStack(javax.xml.xpath.XPath xpathInstance,
java.lang.String xpathExpr,
org.w3c.dom.Node parentNode)</pre>
</li>
</ul>
<a name="getStringFromInputStream-java.io.InputStream-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStringFromInputStream</h4>
<pre>public static java.lang.String getStringFromInputStream(java.io.InputStream input)</pre>
</li>
</ul>
<a name="makeRedirectUrl--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>makeRedirectUrl</h4>
<pre>public java.lang.String makeRedirectUrl()</pre>
</li>
</ul>
<a name="toZipFileName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toZipFileName</h4>
<pre>public static java.lang.String toZipFileName(java.lang.String fileName)</pre>
</li>
</ul>
<a name="setTextContent-javax.xml.xpath.XPath-org.w3c.dom.Node-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTextContent</h4>
<pre>public static void setTextContent(javax.xml.xpath.XPath xPath,
org.w3c.dom.Node elementNode,
java.lang.String content)
throws org.w3c.dom.DOMException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.w3c.dom.DOMException</code></dd>
</dl>
</li>
</ul>
<a name="getTextContent-javax.xml.xpath.XPath-org.w3c.dom.Node-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTextContent</h4>
<pre>public static java.lang.String getTextContent(javax.xml.xpath.XPath xPath,
org.w3c.dom.Node elementNode)
throws org.w3c.dom.DOMException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.w3c.dom.DOMException</code></dd>
</dl>
</li>
</ul>
<a name="isElementContentWhitespace-org.w3c.dom.Text-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isElementContentWhitespace</h4>
<pre>public static boolean isElementContentWhitespace(org.w3c.dom.Text textNode)</pre>
</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/ClientViewHelper.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/clientview/ClientViewBeanInfo.html" title="class in edu.ucsb.nceas.metacat.clientview"><span class="typeNameLink">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?edu/ucsb/nceas/metacat/clientview/ClientViewHelper.html" target="_top">Frames</a></li>
<li><a href="ClientViewHelper.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>