<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_265) on Tue Aug 25 19:30:50 UTC 2020 -->
<title>DBQuery (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="DBQuery (MetaCat API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9,"i3":10,"i4":10,"i5":9,"i6":10,"i7":10,"i8":10,"i9":10,"i10":9,"i11":10,"i12":10,"i13":9,"i14":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/DBQuery.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/DBEntityResolver.html" title="class in edu.ucsb.nceas.metacat"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../edu/ucsb/nceas/metacat/DBSAXHandler.html" title="class in edu.ucsb.nceas.metacat"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?edu/ucsb/nceas/metacat/DBQuery.html" target="_top">Frames</a></li>
<li><a href="DBQuery.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field.summary">Field</a> | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field.detail">Field</a> | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">edu.ucsb.nceas.metacat</div>
<h2 title="Class DBQuery" class="title">Class DBQuery</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>edu.ucsb.nceas.metacat.DBQuery</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">DBQuery</span>
extends java.lang.Object</pre>
<div class="block">A Class that searches a relational DB for elements and attributes that have
free text matches a query string, or structured query matches to a path
specified node in the XML hierarchy. It returns a result set consisting of
the document ID for each document that satisfies the query</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 java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/DBQuery.html#XPATHQUERYOFFINFO">XPATHQUERYOFFINFO</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/DBQuery.html#DBQuery--">DBQuery</a></span>()</code>
<div class="block">construct an instance of the DBQuery class</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/DBQuery.html#DBQuery-java.util.Vector-">DBQuery</a></span>(java.util.Vector docids)</code>
<div class="block">Construct an instance of DBQuery Class
BUT accept a docid Vector that will supersede
the query.printSQL() method
If a docid Vector is passed in,
the docids will be used to create a simple IN query
without the multiple subselects of the printSQL() method
Using this constructor, we just check for
a docidOverride Vector in the findResultDoclist() method</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/DBQuery.html#clearQueryResultCache--">clearQueryResultCache</a></span>()</code>
<div class="block">Method to clear the query result cache.</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/DBQuery.html#createQuery-java.lang.String-">createQuery</a></span>(java.lang.String value)</code>
<div class="block">format a simple free-text value query as an XML document that conforms
to the pathquery.dtd and is appropriate for submission to the DBQuery
structured query engine</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/DBQuery.html#createQuery-java.lang.String-java.lang.String-">createQuery</a></span>(java.lang.String value,
java.lang.String doctype)</code>
<div class="block">format a simple free-text value query as an XML document that conforms
to the pathquery.dtd and is appropriate for submission to the DBQuery
structured query engine</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.lang.StringBuffer</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/DBQuery.html#createResultDocument-java.lang.String-edu.ucsb.nceas.metacat.QuerySpecification-java.io.Writer-java.lang.String-java.lang.String:A-boolean-">createResultDocument</a></span>(java.lang.String xmlquery,
<a href="../../../../edu/ucsb/nceas/metacat/QuerySpecification.html" title="class in edu.ucsb.nceas.metacat">QuerySpecification</a> qspec,
java.io.Writer out,
java.lang.String user,
java.lang.String[] groups,
boolean useXMLIndex)</code>
<div class="block">Transforms a hashtable of documents to an xml or html result and sent
the content to outputstream.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.lang.StringBuffer</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/DBQuery.html#createResultDocument-java.lang.String-edu.ucsb.nceas.metacat.QuerySpecification-java.io.Writer-java.lang.String-java.lang.String:A-boolean-int-int-java.lang.String-java.lang.String-boolean-">createResultDocument</a></span>(java.lang.String xmlquery,
<a href="../../../../edu/ucsb/nceas/metacat/QuerySpecification.html" title="class in edu.ucsb.nceas.metacat">QuerySpecification</a> qspec,
java.io.Writer out,
java.lang.String user,
java.lang.String[] groups,
boolean useXMLIndex,
int pagesize,
int pagestart,
java.lang.String sessionid,
java.lang.String qformat,
boolean includeGuid)</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/DBQuery.html#createSQuery-java.util.Hashtable-">createSQuery</a></span>(java.util.Hashtable params)</code>
<div class="block">format a structured query as an XML document that conforms to the
pathquery.dtd and is appropriate for submission to the DBQuery
structured query engine</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/DBQuery.html#findDocuments-javax.servlet.http.HttpServletResponse-java.io.Writer-java.util.Hashtable-java.lang.String-java.lang.String:A-java.lang.String-">findDocuments</a></span>(javax.servlet.http.HttpServletResponse response,
java.io.Writer out,
java.util.Hashtable params,
java.lang.String user,
java.lang.String[] groups,
java.lang.String sessionid)</code>
<div class="block">Method put the search result set into out printerwriter</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/DBQuery.html#getOperator--">getOperator</a></span>()</code> </td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/DBQuery.html#getQformat--">getQformat</a></span>()</code> </td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>java.util.zip.ZipOutputStream</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/DBQuery.html#getZippedPackage-java.lang.String-javax.servlet.ServletOutputStream-java.lang.String-java.lang.String:A-java.lang.String-">getZippedPackage</a></span>(java.lang.String docIdString,
javax.servlet.ServletOutputStream out,
java.lang.String user,
java.lang.String[] groups,
java.lang.String passWord)</code>
<div class="block">put a data packadge into a zip output stream</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/DBQuery.html#main-java.lang.String:A-">main</a></span>(java.lang.String[] args)</code>
<div class="block">the main routine used to test the DBQuery utility.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/DBQuery.html#performPathquery-java.lang.String-java.lang.String-java.lang.String:A-">performPathquery</a></span>(java.lang.String xmlquery,
java.lang.String user,
java.lang.String[] groups)</code> </td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/DBQuery.html#setOperator-java.lang.String-">setOperator</a></span>(java.lang.String operator)</code>
<div class="block">Specifies if and how docid overrides should be included in the general query</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>static java.sql.PreparedStatement</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/DBQuery.html#setPreparedStatementValues-java.util.List-java.sql.PreparedStatement-">setPreparedStatementValues</a></span>(java.util.List<java.lang.Object> parameterValues,
java.sql.PreparedStatement pstmt)</code>
<div class="block">Set the parameter values in the prepared statement using instrospection
of the given value objects</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/DBQuery.html#setQformat-java.lang.String-">setQformat</a></span>(java.lang.String qformat)</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="XPATHQUERYOFFINFO">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>XPATHQUERYOFFINFO</h4>
<pre>public static final java.lang.String XPATHQUERYOFFINFO</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#edu.ucsb.nceas.metacat.DBQuery.XPATHQUERYOFFINFO">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="DBQuery--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DBQuery</h4>
<pre>public DBQuery()
throws edu.ucsb.nceas.utilities.PropertyNotFoundException</pre>
<div class="block">construct an instance of the DBQuery class
<p>
Generally, one would call the findDocuments() routine after creating an
instance to specify the search query
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>parserName</code> - the fully qualified name of a Java class implementing
the org.xml.sax.XMLReader interface</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>edu.ucsb.nceas.utilities.PropertyNotFoundException</code></dd>
</dl>
</li>
</ul>
<a name="DBQuery-java.util.Vector-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DBQuery</h4>
<pre>public DBQuery(java.util.Vector docids)
throws edu.ucsb.nceas.utilities.PropertyNotFoundException</pre>
<div class="block">Construct an instance of DBQuery Class
BUT accept a docid Vector that will supersede
the query.printSQL() method
If a docid Vector is passed in,
the docids will be used to create a simple IN query
without the multiple subselects of the printSQL() method
Using this constructor, we just check for
a docidOverride Vector in the findResultDoclist() method</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>docids</code> - List of docids to display in the resultset</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>edu.ucsb.nceas.utilities.PropertyNotFoundException</code></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="main-java.lang.String:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>main</h4>
<pre>public static void main(java.lang.String[] args)</pre>
<div class="block">the main routine used to test the DBQuery utility.
<p>
Usage: java DBQuery <xmlfile>
NOTE: encoding should be provided for best results</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>xmlfile</code> - the filename of the xml file containing the query</dd>
</dl>
</li>
</ul>
<a name="findDocuments-javax.servlet.http.HttpServletResponse-java.io.Writer-java.util.Hashtable-java.lang.String-java.lang.String:A-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findDocuments</h4>
<pre>public void findDocuments(javax.servlet.http.HttpServletResponse response,
java.io.Writer out,
java.util.Hashtable params,
java.lang.String user,
java.lang.String[] groups,
java.lang.String sessionid)
throws edu.ucsb.nceas.utilities.PropertyNotFoundException</pre>
<div class="block">Method put the search result set into out printerwriter</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>resoponse</code> - the return response</dd>
<dd><code>out</code> - the output printer</dd>
<dd><code>params</code> - the paratermer hashtable</dd>
<dd><code>user</code> - the user name (it maybe different to the one in param)</dd>
<dd><code>groups</code> - the group array</dd>
<dd><code>sessionid</code> - the sessionid</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.dataone.service.exceptions.NotImplemented</code></dd>
<dd><code>edu.ucsb.nceas.utilities.PropertyNotFoundException</code></dd>
</dl>
</li>
</ul>
<a name="createResultDocument-java.lang.String-edu.ucsb.nceas.metacat.QuerySpecification-java.io.Writer-java.lang.String-java.lang.String:A-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createResultDocument</h4>
<pre>public java.lang.StringBuffer createResultDocument(java.lang.String xmlquery,
<a href="../../../../edu/ucsb/nceas/metacat/QuerySpecification.html" title="class in edu.ucsb.nceas.metacat">QuerySpecification</a> qspec,
java.io.Writer out,
java.lang.String user,
java.lang.String[] groups,
boolean useXMLIndex)</pre>
<div class="block">Transforms a hashtable of documents to an xml or html result and sent
the content to outputstream. Keep going untill hastable is empty. stop it.
add the QuerySpecification as parameter is for ecogrid. But it is duplicate
to xmlquery String</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>xmlquery</code> - </dd>
<dd><code>qspec</code> - </dd>
<dd><code>out</code> - </dd>
<dd><code>user</code> - </dd>
<dd><code>groups</code> - </dd>
<dd><code>useXMLIndex</code> - </dd>
<dd><code>sessionid</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
<a name="performPathquery-java.lang.String-java.lang.String-java.lang.String:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>performPathquery</h4>
<pre>public java.lang.String performPathquery(java.lang.String xmlquery,
java.lang.String user,
java.lang.String[] groups)
throws edu.ucsb.nceas.utilities.PropertyNotFoundException,
java.io.IOException</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>xmlquery</code> - </dd>
<dd><code>user</code> - </dd>
<dd><code>groups</code> - </dd>
<dd><code>useXMLIndex</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
<dd><code>edu.ucsb.nceas.utilities.PropertyNotFoundException</code></dd>
</dl>
</li>
</ul>
<a name="createResultDocument-java.lang.String-edu.ucsb.nceas.metacat.QuerySpecification-java.io.Writer-java.lang.String-java.lang.String:A-boolean-int-int-java.lang.String-java.lang.String-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createResultDocument</h4>
<pre>public java.lang.StringBuffer createResultDocument(java.lang.String xmlquery,
<a href="../../../../edu/ucsb/nceas/metacat/QuerySpecification.html" title="class in edu.ucsb.nceas.metacat">QuerySpecification</a> qspec,
java.io.Writer out,
java.lang.String user,
java.lang.String[] groups,
boolean useXMLIndex,
int pagesize,
int pagestart,
java.lang.String sessionid,
java.lang.String qformat,
boolean includeGuid)</pre>
</li>
</ul>
<a name="clearQueryResultCache--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearQueryResultCache</h4>
<pre>public static void clearQueryResultCache()</pre>
<div class="block">Method to clear the query result cache.</div>
</li>
</ul>
<a name="setPreparedStatementValues-java.util.List-java.sql.PreparedStatement-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPreparedStatementValues</h4>
<pre>public static java.sql.PreparedStatement setPreparedStatementValues(java.util.List<java.lang.Object> parameterValues,
java.sql.PreparedStatement pstmt)
throws java.sql.SQLException</pre>
<div class="block">Set the parameter values in the prepared statement using instrospection
of the given value objects</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>parameterValues</code> - </dd>
<dd><code>pstmt</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.sql.SQLException</code></dd>
</dl>
</li>
</ul>
<a name="createSQuery-java.util.Hashtable-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createSQuery</h4>
<pre>public static java.lang.String createSQuery(java.util.Hashtable params)
throws edu.ucsb.nceas.utilities.PropertyNotFoundException</pre>
<div class="block">format a structured query as an XML document that conforms to the
pathquery.dtd and is appropriate for submission to the DBQuery
structured query engine</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>params</code> - The list of parameters that should be included in the
query</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>edu.ucsb.nceas.utilities.PropertyNotFoundException</code></dd>
</dl>
</li>
</ul>
<a name="createQuery-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createQuery</h4>
<pre>public static java.lang.String createQuery(java.lang.String value,
java.lang.String doctype)</pre>
<div class="block">format a simple free-text value query as an XML document that conforms
to the pathquery.dtd and is appropriate for submission to the DBQuery
structured query engine</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - the text string to search for in the xml catalog</dd>
<dd><code>doctype</code> - the type of documents to include in the result set -- use
"any" or "ANY" for unfiltered result sets</dd>
</dl>
</li>
</ul>
<a name="createQuery-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createQuery</h4>
<pre>public static java.lang.String createQuery(java.lang.String value)</pre>
<div class="block">format a simple free-text value query as an XML document that conforms
to the pathquery.dtd and is appropriate for submission to the DBQuery
structured query engine</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - the text string to search for in the xml catalog</dd>
</dl>
</li>
</ul>
<a name="getOperator--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOperator</h4>
<pre>public java.lang.String getOperator()</pre>
</li>
</ul>
<a name="setOperator-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOperator</h4>
<pre>public void setOperator(java.lang.String operator)</pre>
<div class="block">Specifies if and how docid overrides should be included in the general query</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>operator</code> - null, UNION, or INTERSECT (see QueryGroup)</dd>
</dl>
</li>
</ul>
<a name="getQformat--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQformat</h4>
<pre>public java.lang.String getQformat()</pre>
</li>
</ul>
<a name="setQformat-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setQformat</h4>
<pre>public void setQformat(java.lang.String qformat)</pre>
</li>
</ul>
<a name="getZippedPackage-java.lang.String-javax.servlet.ServletOutputStream-java.lang.String-java.lang.String:A-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getZippedPackage</h4>
<pre>public java.util.zip.ZipOutputStream getZippedPackage(java.lang.String docIdString,
javax.servlet.ServletOutputStream out,
java.lang.String user,
java.lang.String[] groups,
java.lang.String passWord)
throws java.lang.ClassNotFoundException,
java.io.IOException,
java.sql.SQLException,
<a href="../../../../edu/ucsb/nceas/metacat/McdbException.html" title="class in edu.ucsb.nceas.metacat">McdbException</a>,
java.lang.NumberFormatException,
java.lang.Exception</pre>
<div class="block">put a data packadge into a zip output stream</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>docId,</code> - which the user want to put into zip output stream,it has version</dd>
<dd><code>out,</code> - a servletoutput stream which the zip output stream will be
put</dd>
<dd><code>user,</code> - the username of the user</dd>
<dd><code>groups,</code> - the group of the user</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.ClassNotFoundException</code></dd>
<dd><code>java.io.IOException</code></dd>
<dd><code>java.sql.SQLException</code></dd>
<dd><code><a href="../../../../edu/ucsb/nceas/metacat/McdbException.html" title="class in edu.ucsb.nceas.metacat">McdbException</a></code></dd>
<dd><code>java.lang.NumberFormatException</code></dd>
<dd><code>java.lang.Exception</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/DBQuery.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/DBEntityResolver.html" title="class in edu.ucsb.nceas.metacat"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../edu/ucsb/nceas/metacat/DBSAXHandler.html" title="class in edu.ucsb.nceas.metacat"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?edu/ucsb/nceas/metacat/DBQuery.html" target="_top">Frames</a></li>
<li><a href="DBQuery.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>