<!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>MetacatHelper (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="MetacatHelper (MetaCat API)"; } } catch(err) { } //--> var methods = {"i0":10,"i1":10,"i2":10,"i3":10}; var tabs = {65535:["t0","All 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/MetacatHelper.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/advancedsearch/LTERSite.html" title="class in edu.ucsb.nceas.metacat.advancedsearch"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../../../edu/ucsb/nceas/metacat/advancedsearch/MetacatLogin.html" title="class in edu.ucsb.nceas.metacat.advancedsearch"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?edu/ucsb/nceas/metacat/advancedsearch/MetacatHelper.html" target="_top">Frames</a></li> <li><a href="MetacatHelper.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>Field | </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>Field | </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.advancedsearch</div> <h2 title="Class MetacatHelper" class="title">Class MetacatHelper</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>edu.ucsb.nceas.metacat.advancedsearch.MetacatHelper</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <hr> <br> <pre>public class <span class="typeNameLabel">MetacatHelper</span> extends java.lang.Object</pre> <dl> <dt><span class="simpleTagLabel">Author:</span></dt> <dd>dcosta MetacatHelper provides auxiliary methods for helping the advanced search classes interact with Metacat.</dd> </dl> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList"> <!-- ======== 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/advancedsearch/MetacatHelper.html#MetacatHelper--">MetacatHelper</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="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/advancedsearch/MetacatHelper.html#constructDN-java.lang.String-java.lang.String-">constructDN</a></span>(java.lang.String username, java.lang.String organization)</code> <div class="block">Constructs a DN (Distinguished Name) string for the ecoinformatics.org LDAP.</div> </td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/advancedsearch/MetacatHelper.html#constructMetacatURL-java.lang.String-int-java.lang.String-">constructMetacatURL</a></span>(java.lang.String serverName, int serverPort, java.lang.String contextString)</code> <div class="block">Constructs a URL to the metacat servlet.</div> </td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/advancedsearch/MetacatHelper.html#getResultsetXSL-javax.servlet.http.HttpServletRequest-">getResultsetXSL</a></span>(javax.servlet.http.HttpServletRequest request)</code> <div class="block">Gets the path to the resultset XSL file.</div> </td> </tr> <tr id="i3" class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/advancedsearch/MetacatHelper.html#getResultsJSP--">getResultsJSP</a></span>()</code> <div class="block">Gets the relative path to the advancedsearchresults.jsp file.</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"> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor.detail"> <!-- --> </a> <h3>Constructor Detail</h3> <a name="MetacatHelper--"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>MetacatHelper</h4> <pre>public MetacatHelper()</pre> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method.detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="constructDN-java.lang.String-java.lang.String-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>constructDN</h4> <pre>public java.lang.String constructDN(java.lang.String username, java.lang.String organization)</pre> <div class="block">Constructs a DN (Distinguished Name) string for the ecoinformatics.org LDAP.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>username</code> - The LDAP uid, e.g. "dcosta"</dd> <dd><code>organization</code> - The LDAP organization, e.g. "LTER"</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>DN The distinguished name string.</dd> </dl> </li> </ul> <a name="constructMetacatURL-java.lang.String-int-java.lang.String-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>constructMetacatURL</h4> <pre>public java.lang.String constructMetacatURL(java.lang.String serverName, int serverPort, java.lang.String contextString)</pre> <div class="block">Constructs a URL to the metacat servlet.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>serverName</code> - A server name, e.g. "prairie.lternet.edu"</dd> <dd><code>serverPort</code> - A server port, e.g. 8080. If no port is required in the URL, pass a 0 and the argument will be ignored.</dd> <dd><code>contextString</code> - The context under which metacat is running, e.g. "knb".</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>metacatURL The URL to the metacat servlet.</dd> </dl> </li> </ul> <a name="getResultsJSP--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getResultsJSP</h4> <pre>public java.lang.String getResultsJSP()</pre> <div class="block">Gets the relative path to the advancedsearchresults.jsp file.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>resultsJSP The relative path to the advanced search results JSP.</dd> </dl> </li> </ul> <a name="getResultsetXSL-javax.servlet.http.HttpServletRequest-"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>getResultsetXSL</h4> <pre>public java.lang.String getResultsetXSL(javax.servlet.http.HttpServletRequest request)</pre> <div class="block">Gets the path to the resultset XSL file.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>request</code> - The HttpServletRequest object.</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>xslPath The real path to the resultset XSL file.</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/MetacatHelper.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/advancedsearch/LTERSite.html" title="class in edu.ucsb.nceas.metacat.advancedsearch"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../../../edu/ucsb/nceas/metacat/advancedsearch/MetacatLogin.html" title="class in edu.ucsb.nceas.metacat.advancedsearch"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?edu/ucsb/nceas/metacat/advancedsearch/MetacatHelper.html" target="_top">Frames</a></li> <li><a href="MetacatHelper.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>Field | </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>Field | </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>