<!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>QueryTerm (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="QueryTerm (MetaCat API)"; } } catch(err) { } //--> var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":9,"i9":10,"i10":10,"i11":10,"i12":42,"i13":9}; var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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/QueryTerm.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/QuerySpecification.html" title="class in edu.ucsb.nceas.metacat"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../../edu/ucsb/nceas/metacat/ReadOnlyChecker.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/QueryTerm.html" target="_top">Frames</a></li> <li><a href="QueryTerm.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 QueryTerm" class="title">Class QueryTerm</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>edu.ucsb.nceas.metacat.QueryTerm</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <hr> <br> <pre>public class <span class="typeNameLabel">QueryTerm</span> extends java.lang.Object</pre> <div class="block">a utility class that represents a single term in a 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/QueryTerm.html#CONTAINS">CONTAINS</a></span></code> </td> </tr> <tr 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/QueryTerm.html#EQUALS">EQUALS</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/QueryTerm.html#QueryTerm-boolean-java.lang.String-java.lang.String-">QueryTerm</a></span>(boolean casesensitive, java.lang.String searchmode, java.lang.String value)</code> <div class="block">Construct a new instance of a query term for a free text search (using the value only)</div> </td> </tr> <tr class="rowColor"> <td class="colOne"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/QueryTerm.html#QueryTerm-boolean-java.lang.String-java.lang.String-java.lang.String-">QueryTerm</a></span>(boolean casesensitive, java.lang.String searchmode, java.lang.String value, java.lang.String pathexpr)</code> <div class="block">Construct a new instance of a query term for a structured search (matching the value only for those nodes in the pathexpr)</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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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/QueryTerm.html#getPathExpression--">getPathExpression</a></span>()</code> <div class="block">get the path expression parameter</div> </td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/QueryTerm.html#getPercentageSymbolCount--">getPercentageSymbolCount</a></span>()</code> <div class="block">get the percentage count for one query term</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/QueryTerm.html#getSearchMode--">getSearchMode</a></span>()</code> <div class="block">get the searchmode parameter</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/QueryTerm.html#getValue--">getValue</a></span>()</code> <div class="block">get the Value parameter</div> </td> </tr> <tr id="i4" class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/QueryTerm.html#hasSameSearchValue-edu.ucsb.nceas.metacat.QueryTerm-">hasSameSearchValue</a></span>(<a href="../../../../edu/ucsb/nceas/metacat/QueryTerm.html" title="class in edu.ucsb.nceas.metacat">QueryTerm</a> term)</code> <div class="block">Compare two query terms to see if they have same search value.</div> </td> </tr> <tr id="i5" class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/QueryTerm.html#isCaseSensitive--">isCaseSensitive</a></span>()</code> <div class="block">determine if the QueryTerm is case sensitive</div> </td> </tr> <tr id="i6" class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/QueryTerm.html#isInUnionGroup--">isInUnionGroup</a></span>()</code> <div class="block">If this query group in Union group</div> </td> </tr> <tr id="i7" class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/QueryTerm.html#isNotEqualTerm--">isNotEqualTerm</a></span>()</code> </td> </tr> <tr id="i8" 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/QueryTerm.html#predicate2SQL-java.lang.String-java.util.List-">predicate2SQL</a></span>(java.lang.String predicate, java.util.List<java.lang.Object> predicateParameterValues)</code> </td> </tr> <tr id="i9" class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/QueryTerm.html#printSearchExprSQL-java.util.List-">printSearchExprSQL</a></span>(java.util.List<java.lang.Object> parameterValues)</code> </td> </tr> <tr id="i10" class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/QueryTerm.html#printSQL-boolean-java.util.List-">printSQL</a></span>(boolean useXMLIndex, java.util.List<java.lang.Object> parameterValues)</code> <div class="block">create a SQL serialization of the query that this instance represents</div> </td> </tr> <tr id="i11" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/QueryTerm.html#setInUnionGroup-boolean-">setInUnionGroup</a></span>(boolean inUnionGroup)</code> <div class="block">Set the query term in a union group</div> </td> </tr> <tr id="i12" class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/QueryTerm.html#toString--">toString</a></span>()</code> <div class="block"><span class="deprecatedLabel">Deprecated.</span> <div class="block"><span class="deprecationComment">This should not be used for performing the query because the parameter values are not bound in the raw SQL</span></div> </div> </td> </tr> <tr id="i13" 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/QueryTerm.html#useNestedStatements-java.lang.String-java.util.List-">useNestedStatements</a></span>(java.lang.String pathexpr, java.util.List<java.lang.Object> parameterValues)</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, 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="CONTAINS"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>CONTAINS</h4> <pre>public static final java.lang.String CONTAINS</pre> <dl> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="../../../../constant-values.html#edu.ucsb.nceas.metacat.QueryTerm.CONTAINS">Constant Field Values</a></dd> </dl> </li> </ul> <a name="EQUALS"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>EQUALS</h4> <pre>public static final java.lang.String EQUALS</pre> <dl> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="../../../../constant-values.html#edu.ucsb.nceas.metacat.QueryTerm.EQUALS">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="QueryTerm-boolean-java.lang.String-java.lang.String-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>QueryTerm</h4> <pre>public QueryTerm(boolean casesensitive, java.lang.String searchmode, java.lang.String value)</pre> <div class="block">Construct a new instance of a query term for a free text search (using the value only)</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>casesensitive</code> - flag indicating whether case is used to match</dd> <dd><code>searchmode</code> - determines what kind of substring match is performed (one of starts-with|ends-with|contains|matches-exactly)</dd> <dd><code>value</code> - the text value to match</dd> </dl> </li> </ul> <a name="QueryTerm-boolean-java.lang.String-java.lang.String-java.lang.String-"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>QueryTerm</h4> <pre>public QueryTerm(boolean casesensitive, java.lang.String searchmode, java.lang.String value, java.lang.String pathexpr)</pre> <div class="block">Construct a new instance of a query term for a structured search (matching the value only for those nodes in the pathexpr)</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>casesensitive</code> - flag indicating whether case is used to match</dd> <dd><code>searchmode</code> - determines what kind of substring match is performed (one of starts-with|ends-with|contains|matches-exactly)</dd> <dd><code>value</code> - the text value to match</dd> <dd><code>pathexpr</code> - the hierarchical path to the nodes to be searched</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="isCaseSensitive--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>isCaseSensitive</h4> <pre>public boolean isCaseSensitive()</pre> <div class="block">determine if the QueryTerm is case sensitive</div> </li> </ul> <a name="getSearchMode--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getSearchMode</h4> <pre>public java.lang.String getSearchMode()</pre> <div class="block">get the searchmode parameter</div> </li> </ul> <a name="getValue--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getValue</h4> <pre>public java.lang.String getValue()</pre> <div class="block">get the Value parameter</div> </li> </ul> <a name="getPathExpression--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getPathExpression</h4> <pre>public java.lang.String getPathExpression()</pre> <div class="block">get the path expression parameter</div> </li> </ul> <a name="getPercentageSymbolCount--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getPercentageSymbolCount</h4> <pre>public int getPercentageSymbolCount()</pre> <div class="block">get the percentage count for one query term</div> </li> </ul> <a name="setInUnionGroup-boolean-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setInUnionGroup</h4> <pre>public void setInUnionGroup(boolean inUnionGroup)</pre> <div class="block">Set the query term in a union group</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>inUnionGroup</code> - </dd> </dl> </li> </ul> <a name="isInUnionGroup--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>isInUnionGroup</h4> <pre>public boolean isInUnionGroup()</pre> <div class="block">If this query group in Union group</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> </dl> </li> </ul> <a name="printSearchExprSQL-java.util.List-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>printSearchExprSQL</h4> <pre>public java.lang.String printSearchExprSQL(java.util.List<java.lang.Object> parameterValues)</pre> </li> </ul> <a name="isNotEqualTerm--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>isNotEqualTerm</h4> <pre>public boolean isNotEqualTerm()</pre> </li> </ul> <a name="printSQL-boolean-java.util.List-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>printSQL</h4> <pre>public java.lang.String printSQL(boolean useXMLIndex, java.util.List<java.lang.Object> parameterValues)</pre> <div class="block">create a SQL serialization of the query that this instance represents</div> </li> </ul> <a name="useNestedStatements-java.lang.String-java.util.List-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>useNestedStatements</h4> <pre>public static java.lang.String useNestedStatements(java.lang.String pathexpr, java.util.List<java.lang.Object> parameterValues)</pre> </li> </ul> <a name="predicate2SQL-java.lang.String-java.util.List-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>predicate2SQL</h4> <pre>public static java.lang.String predicate2SQL(java.lang.String predicate, java.util.List<java.lang.Object> predicateParameterValues)</pre> </li> </ul> <a name="toString--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>toString</h4> <pre>public java.lang.String toString()</pre> <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">This should not be used for performing the query because the parameter values are not bound in the raw SQL</span></div> <div class="block">Show a string representation of the query</div> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code>toString</code> in class <code>java.lang.Object</code></dd> </dl> </li> </ul> <a name="hasSameSearchValue-edu.ucsb.nceas.metacat.QueryTerm-"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>hasSameSearchValue</h4> <pre>public boolean hasSameSearchValue(<a href="../../../../edu/ucsb/nceas/metacat/QueryTerm.html" title="class in edu.ucsb.nceas.metacat">QueryTerm</a> term)</pre> <div class="block">Compare two query terms to see if they have same search value.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>term</code> - </dd> <dt><span class="returnLabel">Returns:</span></dt> </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/QueryTerm.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/QuerySpecification.html" title="class in edu.ucsb.nceas.metacat"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../../edu/ucsb/nceas/metacat/ReadOnlyChecker.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/QueryTerm.html" target="_top">Frames</a></li> <li><a href="QueryTerm.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>