<!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>MetacatSolrIndex (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="MetacatSolrIndex (MetaCat API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":10,"i2":10,"i3":10,"i4":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/MetacatSolrIndex.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/index/MetacatSolrEngineDescriptionHandler.html" title="class in edu.ucsb.nceas.metacat.index"><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/index/MetacatSolrIndex.html" target="_top">Frames</a></li>
<li><a href="MetacatSolrIndex.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>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </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.index</div>
<h2 title="Class MetacatSolrIndex" class="title">Class MetacatSolrIndex</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>edu.ucsb.nceas.metacat.index.MetacatSolrIndex</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">MetacatSolrIndex</span>
extends java.lang.Object</pre>
<div class="block">This class will query the solr server and return the result.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>tao</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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 <a href="../../../../../edu/ucsb/nceas/metacat/index/MetacatSolrIndex.html" title="class in edu.ucsb.nceas.metacat.index">MetacatSolrIndex</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/index/MetacatSolrIndex.html#getInstance--">getInstance</a></span>()</code> </td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.io.InputStream</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/index/MetacatSolrIndex.html#query-org.apache.solr.common.params.SolrParams-java.util.Set-boolean-">query</a></span>(org.apache.solr.common.params.SolrParams solrParams,
java.util.Set<org.dataone.service.types.v1.Subject> authorizedSubjects,
boolean isMNadmin)</code>
<div class="block">Handle the query when the query is on the key/value format</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.io.InputStream</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/index/MetacatSolrIndex.html#query-java.lang.String-java.util.Set-boolean-">query</a></span>(java.lang.String query,
java.util.Set<org.dataone.service.types.v1.Subject> authorizedSubjects,
boolean isMNadmin)</code>
<div class="block">Query the solr server</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/index/MetacatSolrIndex.html#submit-org.dataone.service.types.v1.Identifier-org.dataone.service.types.v2.SystemMetadata-java.util.Map-boolean-">submit</a></span>(org.dataone.service.types.v1.Identifier pid,
org.dataone.service.types.v2.SystemMetadata systemMetadata,
java.util.Map<java.lang.String,java.util.List<java.lang.Object>> fields,
boolean followRevisions)</code> </td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/index/MetacatSolrIndex.html#submitDeleteTask-org.dataone.service.types.v1.Identifier-org.dataone.service.types.v2.SystemMetadata-">submitDeleteTask</a></span>(org.dataone.service.types.v1.Identifier pid,
org.dataone.service.types.v2.SystemMetadata sysMeta)</code>
<div class="block">Submit a deleting-index task</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">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getInstance--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInstance</h4>
<pre>public static <a href="../../../../../edu/ucsb/nceas/metacat/index/MetacatSolrIndex.html" title="class in edu.ucsb.nceas.metacat.index">MetacatSolrIndex</a> getInstance()
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="query-java.lang.String-java.util.Set-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>query</h4>
<pre>public java.io.InputStream query(java.lang.String query,
java.util.Set<org.dataone.service.types.v1.Subject> authorizedSubjects,
boolean isMNadmin)
throws org.apache.solr.client.solrj.SolrServerException,
java.io.IOException,
edu.ucsb.nceas.utilities.PropertyNotFoundException,
java.sql.SQLException,
java.lang.ClassNotFoundException,
javax.xml.parsers.ParserConfigurationException,
org.xml.sax.SAXException,
org.dataone.service.exceptions.NotImplemented,
org.dataone.service.exceptions.NotFound,
org.dataone.service.exceptions.UnsupportedType</pre>
<div class="block">Query the solr server</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>query</code> - the solr query</dd>
<dd><code>authorizedSubjects</code> - the authorized subjects in this query session</dd>
<dd><code>isMNadmin</code> - the indicator of the authorized subjects are the mn admin or not</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the result as the InputStream</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.solr.client.solrj.SolrServerException</code></dd>
<dd><code>java.lang.ClassNotFoundException</code></dd>
<dd><code>java.sql.SQLException</code></dd>
<dd><code>edu.ucsb.nceas.utilities.PropertyNotFoundException</code></dd>
<dd><code>org.xml.sax.SAXException</code></dd>
<dd><code>javax.xml.parsers.ParserConfigurationException</code></dd>
<dd><code>org.dataone.service.exceptions.UnsupportedType</code></dd>
<dd><code>org.dataone.service.exceptions.NotFound</code></dd>
<dd><code>org.dataone.service.exceptions.NotImplemented</code></dd>
<dd><code>java.io.IOException</code></dd>
</dl>
</li>
</ul>
<a name="query-org.apache.solr.common.params.SolrParams-java.util.Set-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>query</h4>
<pre>public java.io.InputStream query(org.apache.solr.common.params.SolrParams solrParams,
java.util.Set<org.dataone.service.types.v1.Subject> authorizedSubjects,
boolean isMNadmin)
throws org.apache.solr.client.solrj.SolrServerException,
java.io.IOException,
edu.ucsb.nceas.utilities.PropertyNotFoundException,
java.sql.SQLException,
java.lang.ClassNotFoundException,
javax.xml.parsers.ParserConfigurationException,
org.xml.sax.SAXException,
org.dataone.service.exceptions.NotImplemented,
org.dataone.service.exceptions.NotFound,
org.dataone.service.exceptions.UnsupportedType</pre>
<div class="block">Handle the query when the query is on the key/value format</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>solrParams</code> - the query with the key/value format</dd>
<dd><code>authorizedSubjects</code> - the authorized subjects in this query session</dd>
<dd><code>isMNadmin</code> - the indicator of the authorized subjects are the mn admin or not</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the query result as the InputStream object</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.solr.client.solrj.SolrServerException</code></dd>
<dd><code>java.io.IOException</code></dd>
<dd><code>edu.ucsb.nceas.utilities.PropertyNotFoundException</code></dd>
<dd><code>java.sql.SQLException</code></dd>
<dd><code>java.lang.ClassNotFoundException</code></dd>
<dd><code>javax.xml.parsers.ParserConfigurationException</code></dd>
<dd><code>org.xml.sax.SAXException</code></dd>
<dd><code>org.dataone.service.exceptions.NotImplemented</code></dd>
<dd><code>org.dataone.service.exceptions.NotFound</code></dd>
<dd><code>org.dataone.service.exceptions.UnsupportedType</code></dd>
</dl>
</li>
</ul>
<a name="submitDeleteTask-org.dataone.service.types.v1.Identifier-org.dataone.service.types.v2.SystemMetadata-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>submitDeleteTask</h4>
<pre>public void submitDeleteTask(org.dataone.service.types.v1.Identifier pid,
org.dataone.service.types.v2.SystemMetadata sysMeta)</pre>
<div class="block">Submit a deleting-index task</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pid</code> - the pid's solr document will be deleted.</dd>
</dl>
</li>
</ul>
<a name="submit-org.dataone.service.types.v1.Identifier-org.dataone.service.types.v2.SystemMetadata-java.util.Map-boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>submit</h4>
<pre>public void submit(org.dataone.service.types.v1.Identifier pid,
org.dataone.service.types.v2.SystemMetadata systemMetadata,
java.util.Map<java.lang.String,java.util.List<java.lang.Object>> fields,
boolean followRevisions)</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/MetacatSolrIndex.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/index/MetacatSolrEngineDescriptionHandler.html" title="class in edu.ucsb.nceas.metacat.index"><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/index/MetacatSolrIndex.html" target="_top">Frames</a></li>
<li><a href="MetacatSolrIndex.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>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </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>