<!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>AdvancedSearch (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="AdvancedSearch (MetaCat API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":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/AdvancedSearch.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>Prev Class</li>
<li><a href="../../../../../edu/ucsb/nceas/metacat/advancedsearch/AdvancedSearchBean.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/AdvancedSearch.html" target="_top">Frames</a></li>
<li><a href="AdvancedSearch.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 AdvancedSearch" class="title">Class AdvancedSearch</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>edu.ucsb.nceas.metacat.advancedsearch.AdvancedSearch</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">AdvancedSearch</span>
extends java.lang.Object</pre>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>dcosta
AdvancedSearch class constructs queries that use the pathquery feature of
Metacat. It can execute either an advanced search, where the user fills in
fields in a web form, or a simple search on a string.</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/AdvancedSearch.html#AdvancedSearch-edu.ucsb.nceas.metacat.advancedsearch.AdvancedSearchBean-">AdvancedSearch</a></span>(<a href="../../../../../edu/ucsb/nceas/metacat/advancedsearch/AdvancedSearchBean.html" title="class in edu.ucsb.nceas.metacat.advancedsearch">AdvancedSearchBean</a> advancedSearchBean)</code>
<div class="block">Constructor.</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/advancedsearch/AdvancedSearch.html#executeAdvancedSearch-java.lang.String-edu.ucsb.nceas.metacat.client.Metacat-java.lang.String-java.lang.String-">executeAdvancedSearch</a></span>(java.lang.String metacatURL,
<a href="../../../../../edu/ucsb/nceas/metacat/client/Metacat.html" title="interface in edu.ucsb.nceas.metacat.client">Metacat</a> metacat,
java.lang.String qformat,
java.lang.String xslPath)</code>
<div class="block">Builds and runs an advanced search, returning HTML result string.</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/AdvancedSearch.html#executeSearch-java.lang.String-edu.ucsb.nceas.metacat.client.Metacat-java.lang.String-java.lang.String-java.lang.String-">executeSearch</a></span>(java.lang.String metacatURL,
<a href="../../../../../edu/ucsb/nceas/metacat/client/Metacat.html" title="interface in edu.ucsb.nceas.metacat.client">Metacat</a> metacat,
java.lang.String qformat,
java.lang.String xslPath,
java.lang.String value)</code>
<div class="block">Builds and runs a simple search, returning HTML result string.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/advancedsearch/AdvancedSearch.html#main-java.lang.String:A-">main</a></span>(java.lang.String[] argv)</code>
<div class="block">Main program to run a test query from the command line.</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="AdvancedSearch-edu.ucsb.nceas.metacat.advancedsearch.AdvancedSearchBean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AdvancedSearch</h4>
<pre>public AdvancedSearch(<a href="../../../../../edu/ucsb/nceas/metacat/advancedsearch/AdvancedSearchBean.html" title="class in edu.ucsb.nceas.metacat.advancedsearch">AdvancedSearchBean</a> advancedSearchBean)</pre>
<div class="block">Constructor. Used when the user has filled in an Advanced Search form.
The property values are contained in the advancedSearchBean object.
For a simple search, the advancedSearchBean object is passed as null.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>advancedSearchBean</code> - An AdvancedSearch bean.</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="executeAdvancedSearch-java.lang.String-edu.ucsb.nceas.metacat.client.Metacat-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executeAdvancedSearch</h4>
<pre>public java.lang.String executeAdvancedSearch(java.lang.String metacatURL,
<a href="../../../../../edu/ucsb/nceas/metacat/client/Metacat.html" title="interface in edu.ucsb.nceas.metacat.client">Metacat</a> metacat,
java.lang.String qformat,
java.lang.String xslPath)</pre>
<div class="block">Builds and runs an advanced search, returning HTML result string.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>metacatURL</code> - URL to the metacat servlet</dd>
<dd><code>metacat</code> - A metacat client object, possible null.</dd>
<dd><code>qformat</code> - The qformat (skin) to use when displaying results.</dd>
<dd><code>xslPath</code> - File path to the resultset.xsl stylesheet.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>htmlString HTML string representation of the search results.</dd>
</dl>
</li>
</ul>
<a name="executeSearch-java.lang.String-edu.ucsb.nceas.metacat.client.Metacat-java.lang.String-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executeSearch</h4>
<pre>public java.lang.String executeSearch(java.lang.String metacatURL,
<a href="../../../../../edu/ucsb/nceas/metacat/client/Metacat.html" title="interface in edu.ucsb.nceas.metacat.client">Metacat</a> metacat,
java.lang.String qformat,
java.lang.String xslPath,
java.lang.String value)</pre>
<div class="block">Builds and runs a simple search, returning HTML result string.
For a simple search, the AdvancedSearchBean object can be null because
all we need is a string value to search on.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>metacatURL</code> - URL to the metacat servlet</dd>
<dd><code>metacat</code> - A metacat client object, possible null.</dd>
<dd><code>qformat</code> - The qformat (skin) to use when displaying results.</dd>
<dd><code>xslPath</code> - File path to the resultset.xsl stylesheet.</dd>
<dd><code>value</code> - String value to search on.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>htmlString HTML string representation of the search results.</dd>
</dl>
</li>
</ul>
<a name="main-java.lang.String:A-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>main</h4>
<pre>public static void main(java.lang.String[] argv)</pre>
<div class="block">Main program to run a test query from the command line.
Pass the server name, server port, and path to resultset.xsl as the first
three command line arguments:</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>argv[0]</code> - The server name, e.g. "earth.lternet.edu"</dd>
<dd><code>argv[1]</code> - The server port, e.g. "8080", or 0 if no port needs
to be specified.</dd>
<dd><code>argv[2]</code> - The context string, e.g. "knb"</dd>
<dd><code>argv[3]</code> - The path to the resultset.xsl stylesheet, e.g.
"C:/Tomcat5/webapps/query/style/common/resultset.xsl"</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/AdvancedSearch.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>Prev Class</li>
<li><a href="../../../../../edu/ucsb/nceas/metacat/advancedsearch/AdvancedSearchBean.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/AdvancedSearch.html" target="_top">Frames</a></li>
<li><a href="AdvancedSearch.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>