<!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>AdvancedSearchQueryGroup (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="AdvancedSearchQueryGroup (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/AdvancedSearchQueryGroup.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/AdvancedSearchPathQuery.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/AdvancedSearchQueryTerm.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/AdvancedSearchQueryGroup.html" target="_top">Frames</a></li> <li><a href="AdvancedSearchQueryGroup.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 AdvancedSearchQueryGroup" class="title">Class AdvancedSearchQueryGroup</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>edu.ucsb.nceas.metacat.advancedsearch.AdvancedSearchQueryGroup</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <hr> <br> <pre>public class <span class="typeNameLabel">AdvancedSearchQueryGroup</span> extends java.lang.Object</pre> <dl> <dt><span class="simpleTagLabel">Author:</span></dt> <dd>dcosta AdvancedSearchQueryGroup holds the data needed to produce a valid querygroup string. A querygroup is composed of one or more querygroups and/or queryterms.</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/AdvancedSearchQueryGroup.html#AdvancedSearchQueryGroup-java.lang.String-java.lang.String-">AdvancedSearchQueryGroup</a></span>(java.lang.String operator, java.lang.String indent)</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="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>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/advancedsearch/AdvancedSearchQueryGroup.html#addQueryGroup-edu.ucsb.nceas.metacat.advancedsearch.AdvancedSearchQueryGroup-">addQueryGroup</a></span>(<a href="../../../../../edu/ucsb/nceas/metacat/advancedsearch/AdvancedSearchQueryGroup.html" title="class in edu.ucsb.nceas.metacat.advancedsearch">AdvancedSearchQueryGroup</a> queryGroup)</code> <div class="block">Adds a AdvancedSearchQueryGroup to this AdvancedSearchQueryGroup's list of querygroups.</div> </td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/advancedsearch/AdvancedSearchQueryGroup.html#addQueryTerm-edu.ucsb.nceas.metacat.advancedsearch.AdvancedSearchQueryTerm-">addQueryTerm</a></span>(<a href="../../../../../edu/ucsb/nceas/metacat/advancedsearch/AdvancedSearchQueryTerm.html" title="class in edu.ucsb.nceas.metacat.advancedsearch">AdvancedSearchQueryTerm</a> queryTerm)</code> <div class="block">Adds a AdvancedSearchQueryTerm to this AdvancedSearchQueryGroup's list of queryterms.</div> </td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/advancedsearch/AdvancedSearchQueryGroup.html#setIncludeOuterQueryGroup-boolean-">setIncludeOuterQueryGroup</a></span>(boolean b)</code> <div class="block">Sets the boolean value of includeOuterQueryGroup.</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/AdvancedSearchQueryGroup.html#toString--">toString</a></span>()</code> <div class="block">Creates the XML string that represents this AdvancedSearchQueryGroup, including the querygroups and queryterms that are descendants of this querygroup.</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, 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="AdvancedSearchQueryGroup-java.lang.String-java.lang.String-"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>AdvancedSearchQueryGroup</h4> <pre>public AdvancedSearchQueryGroup(java.lang.String operator, java.lang.String indent)</pre> <div class="block">Constructor. Initializes the operator and the indent.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>operator</code> - Must be either "INTERSECT" or "UNION"</dd> <dd><code>indent</code> - A string of spaces for indenting the xml output</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="addQueryGroup-edu.ucsb.nceas.metacat.advancedsearch.AdvancedSearchQueryGroup-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>addQueryGroup</h4> <pre>public void addQueryGroup(<a href="../../../../../edu/ucsb/nceas/metacat/advancedsearch/AdvancedSearchQueryGroup.html" title="class in edu.ucsb.nceas.metacat.advancedsearch">AdvancedSearchQueryGroup</a> queryGroup)</pre> <div class="block">Adds a AdvancedSearchQueryGroup to this AdvancedSearchQueryGroup's list of querygroups.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>queryGroup</code> - The AdvancedSearchQueryGroup object to be added to the list.</dd> </dl> </li> </ul> <a name="addQueryTerm-edu.ucsb.nceas.metacat.advancedsearch.AdvancedSearchQueryTerm-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>addQueryTerm</h4> <pre>public void addQueryTerm(<a href="../../../../../edu/ucsb/nceas/metacat/advancedsearch/AdvancedSearchQueryTerm.html" title="class in edu.ucsb.nceas.metacat.advancedsearch">AdvancedSearchQueryTerm</a> queryTerm)</pre> <div class="block">Adds a AdvancedSearchQueryTerm to this AdvancedSearchQueryGroup's list of queryterms.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>queryTerm</code> - The AdvancedSearchQueryTerm object to be added to the list.</dd> </dl> </li> </ul> <a name="setIncludeOuterQueryGroup-boolean-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setIncludeOuterQueryGroup</h4> <pre>public void setIncludeOuterQueryGroup(boolean b)</pre> <div class="block">Sets the boolean value of includeOuterQueryGroup. This enables an optimization. If the user enter search values for only one part of the advanced search form, then includeOuterQueryGroup can be set to false. When false, the QueryGroup object will omit the outer query group from the PathQuery, resulting in a less nested SQL statement.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>b</code> - When false, allows the outer QueryGroup to be stripped off, resulting in a less nested SQL statement.</dd> </dl> </li> </ul> <a name="toString--"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>toString</h4> <pre>public java.lang.String toString()</pre> <div class="block">Creates the XML string that represents this AdvancedSearchQueryGroup, including the querygroups and queryterms that are descendants of this querygroup.</div> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code>toString</code> in class <code>java.lang.Object</code></dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>A XML string fragment representing this querygroup.</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/AdvancedSearchQueryGroup.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/AdvancedSearchPathQuery.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/AdvancedSearchQueryTerm.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/AdvancedSearchQueryGroup.html" target="_top">Frames</a></li> <li><a href="AdvancedSearchQueryGroup.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>