Google Git
Sign in
apache / velocity-site / bf726f637e8a1fa3c08452b38086afe5496e61ba / . / src / content / tools / 3.1 / apidocs / org / apache / velocity / tools / examples / showcase / tool / MySearchTool.html
blob: c3a0fad68c06755c9338f35c769d0b8fb6a84e29 [file] [log] [blame]
<!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_191) on Sat Feb 27 22:01:12 CET 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>MySearchTool (VelocityTools 3.1 API)</title>
<meta name="date" content="2021-02-27">
<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="MySearchTool (VelocityTools 3.1 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":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/MySearchTool.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="../../../../../../../org/apache/velocity/tools/examples/showcase/tool/LayoutLinkTool.html" title="class in org.apache.velocity.tools.examples.showcase.tool"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/velocity/tools/examples/showcase/tool/MySearchTool.html" target="_top">Frames</a></li>
<li><a href="MySearchTool.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li><a href="#nested.classes.inherited.from.class.org.apache.velocity.tools.view.AbstractSearchTool">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.apache.velocity.tools.view.AbstractSearchTool">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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">org.apache.velocity.tools.examples.showcase.tool</div>
<h2 title="Class MySearchTool" class="title">Class MySearchTool</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../../org/apache/velocity/tools/generic/SafeConfig.html" title="class in org.apache.velocity.tools.generic">org.apache.velocity.tools.generic.SafeConfig</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../../org/apache/velocity/tools/view/PagerTool.html" title="class in org.apache.velocity.tools.view">org.apache.velocity.tools.view.PagerTool</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../../org/apache/velocity/tools/view/AbstractSearchTool.html" title="class in org.apache.velocity.tools.view">org.apache.velocity.tools.view.AbstractSearchTool</a></li>
<li>
<ul class="inheritance">
<li>org.apache.velocity.tools.examples.showcase.tool.MySearchTool</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">MySearchTool</span>
extends <a href="../../../../../../../org/apache/velocity/tools/view/AbstractSearchTool.html" title="class in org.apache.velocity.tools.view">AbstractSearchTool</a></pre>
<div class="block">This is meant to demonstrate how to extend the AbstractSearchTool.
A typical implementation would have no static Set as a database,
, not have store() methods, and have a real
executeQuery(criteria) implementation. But this works for the
purposes of this demo.</div>
<dl>
<dt><span class="simpleTagLabel">Version:</span></dt>
<dd>$Id: MySearchTool.java 479724 2006-11-27 18:49:37Z nbubna $</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Nathan Bubna</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.velocity.tools.view.AbstractSearchTool">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;org.apache.velocity.tools.view.<a href="../../../../../../../org/apache/velocity/tools/view/AbstractSearchTool.html" title="class in org.apache.velocity.tools.view">AbstractSearchTool</a></h3>
<code><a href="../../../../../../../org/apache/velocity/tools/view/AbstractSearchTool.StoredResults.html" title="class in org.apache.velocity.tools.view">AbstractSearchTool.StoredResults</a></code></li>
</ul>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.velocity.tools.view.AbstractSearchTool">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.velocity.tools.view.<a href="../../../../../../../org/apache/velocity/tools/view/AbstractSearchTool.html" title="class in org.apache.velocity.tools.view">AbstractSearchTool</a></h3>
<code><a href="../../../../../../../org/apache/velocity/tools/view/AbstractSearchTool.html#DEFAULT_CRITERIA_KEY">DEFAULT_CRITERIA_KEY</a>, <a href="../../../../../../../org/apache/velocity/tools/view/AbstractSearchTool.html#STORED_RESULTS_KEY">STORED_RESULTS_KEY</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.velocity.tools.view.PagerTool">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.velocity.tools.view.<a href="../../../../../../../org/apache/velocity/tools/view/PagerTool.html" title="class in org.apache.velocity.tools.view">PagerTool</a></h3>
<code><a href="../../../../../../../org/apache/velocity/tools/view/PagerTool.html#DEFAULT_INDEX_KEY">DEFAULT_INDEX_KEY</a>, <a href="../../../../../../../org/apache/velocity/tools/view/PagerTool.html#DEFAULT_ITEMS_PER_PAGE">DEFAULT_ITEMS_PER_PAGE</a>, <a href="../../../../../../../org/apache/velocity/tools/view/PagerTool.html#DEFAULT_ITEMS_PER_PAGE_KEY">DEFAULT_ITEMS_PER_PAGE_KEY</a>, <a href="../../../../../../../org/apache/velocity/tools/view/PagerTool.html#DEFAULT_NEW_ITEMS_KEY">DEFAULT_NEW_ITEMS_KEY</a>, <a href="../../../../../../../org/apache/velocity/tools/view/PagerTool.html#DEFAULT_SLIP_SIZE">DEFAULT_SLIP_SIZE</a>, <a href="../../../../../../../org/apache/velocity/tools/view/PagerTool.html#DEFAULT_SLIP_SIZE_KEY">DEFAULT_SLIP_SIZE_KEY</a>, <a href="../../../../../../../org/apache/velocity/tools/view/PagerTool.html#session">session</a>, <a href="../../../../../../../org/apache/velocity/tools/view/PagerTool.html#STORED_ITEMS_KEY">STORED_ITEMS_KEY</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.velocity.tools.generic.SafeConfig">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.velocity.tools.generic.<a href="../../../../../../../org/apache/velocity/tools/generic/SafeConfig.html" title="class in org.apache.velocity.tools.generic">SafeConfig</a></h3>
<code><a href="../../../../../../../org/apache/velocity/tools/generic/SafeConfig.html#LOCK_CONFIG_KEY">LOCK_CONFIG_KEY</a>, <a href="../../../../../../../org/apache/velocity/tools/generic/SafeConfig.html#log">log</a>, <a href="../../../../../../../org/apache/velocity/tools/generic/SafeConfig.html#LOGGER_NAME_KEY">LOGGER_NAME_KEY</a>, <a href="../../../../../../../org/apache/velocity/tools/generic/SafeConfig.html#SAFE_MODE_KEY">SAFE_MODE_KEY</a>, <a href="../../../../../../../org/apache/velocity/tools/generic/SafeConfig.html#USE_CLASS_LOGGER_KEY">USE_CLASS_LOGGER_KEY</a></code></li>
</ul>
</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">&nbsp;</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="../../../../../../../org/apache/velocity/tools/examples/showcase/tool/MySearchTool.html#MySearchTool--">MySearchTool</a></span>()</code>&nbsp;</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/velocity/tools/examples/showcase/tool/MySearchTool.html#executeQuery-java.lang.Object-">executeQuery</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;crit)</code>
<div class="block">This is a very simplistic implementation that looks for the
string value of the criteria in the string value of every item
in our stupid static database.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/velocity/tools/examples/showcase/tool/MySearchTool.html#getCreateSession--">getCreateSession</a></span>()</code>
<div class="block">Override to create a session in which to store search results.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/velocity/tools/examples/showcase/tool/MySearchTool.html#store-java.util.Collection-">store</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&nbsp;items)</code>
<div class="block">Adds the specified items to our static "database".</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/velocity/tools/examples/showcase/tool/MySearchTool.html#store-java.util.Map-">store</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&nbsp;items)</code>
<div class="block">Adds the entries of the specified map to our static "database".</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/velocity/tools/examples/showcase/tool/MySearchTool.html#store-java.lang.Object-">store</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;item)</code>
<div class="block">Adds the specified item to our static "database".</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.velocity.tools.view.AbstractSearchTool">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.velocity.tools.view.<a href="../../../../../../../org/apache/velocity/tools/view/AbstractSearchTool.html" title="class in org.apache.velocity.tools.view">AbstractSearchTool</a></h3>
<code><a href="../../../../../../../org/apache/velocity/tools/view/AbstractSearchTool.html#getCriteria--">getCriteria</a>, <a href="../../../../../../../org/apache/velocity/tools/view/AbstractSearchTool.html#getCriteriaKey--">getCriteriaKey</a>, <a href="../../../../../../../org/apache/velocity/tools/view/AbstractSearchTool.html#getItems--">getItems</a>, <a href="../../../../../../../org/apache/velocity/tools/view/AbstractSearchTool.html#getStoredItems--">getStoredItems</a>, <a href="../../../../../../../org/apache/velocity/tools/view/AbstractSearchTool.html#getStoredResults--">getStoredResults</a>, <a href="../../../../../../../org/apache/velocity/tools/view/AbstractSearchTool.html#reset--">reset</a>, <a href="../../../../../../../org/apache/velocity/tools/view/AbstractSearchTool.html#setCriteria-java.lang.Object-">setCriteria</a>, <a href="../../../../../../../org/apache/velocity/tools/view/AbstractSearchTool.html#setCriteriaKey-java.lang.String-">setCriteriaKey</a>, <a href="../../../../../../../org/apache/velocity/tools/view/AbstractSearchTool.html#setStoredItems-java.util.List-">setStoredItems</a>, <a href="../../../../../../../org/apache/velocity/tools/view/AbstractSearchTool.html#setStoredResults-org.apache.velocity.tools.view.AbstractSearchTool.StoredResults-">setStoredResults</a>, <a href="../../../../../../../org/apache/velocity/tools/view/AbstractSearchTool.html#setup-javax.servlet.http.HttpServletRequest-">setup</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.velocity.tools.view.PagerTool">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.velocity.tools.view.<a href="../../../../../../../org/apache/velocity/tools/view/PagerTool.html" title="class in org.apache.velocity.tools.view">PagerTool</a></h3>
<code><a href="../../../../../../../org/apache/velocity/tools/view/PagerTool.html#getFirstIndex--">getFirstIndex</a>, <a href="../../../../../../../org/apache/velocity/tools/view/PagerTool.html#getIndex--">getIndex</a>, <a href="../../../../../../../org/apache/velocity/tools/view/PagerTool.html#getIndexKey--">getIndexKey</a>, <a href="../../../../../../../org/apache/velocity/tools/view/PagerTool.html#getItemsPerPage--">getItemsPerPage</a>, <a href="../../../../../../../org/apache/velocity/tools/view/PagerTool.html#getItemsPerPageKey--">getItemsPerPageKey</a>, <a href="../../../../../../../org/apache/velocity/tools/view/PagerTool.html#getLastIndex--">getLastIndex</a>, <a href="../../../../../../../org/apache/velocity/tools/view/PagerTool.html#getNewItemsKey--">getNewItemsKey</a>, <a href="../../../../../../../org/apache/velocity/tools/view/PagerTool.html#getNextIndex--">getNextIndex</a>, <a href="../../../../../../../org/apache/velocity/tools/view/PagerTool.html#getPage--">getPage</a>, <a href="../../../../../../../org/apache/velocity/tools/view/PagerTool.html#getPageDescription--">getPageDescription</a>, <a href="../../../../../../../org/apache/velocity/tools/view/PagerTool.html#getPageNumber--">getPageNumber</a>, <a href="../../../../../../../org/apache/velocity/tools/view/PagerTool.html#getPageNumber-int-">getPageNumber</a>, <a href="../../../../../../../org/apache/velocity/tools/view/PagerTool.html#getPagesAvailable--">getPagesAvailable</a>, <a href="../../../../../../../org/apache/velocity/tools/view/PagerTool.html#getPrevIndex--">getPrevIndex</a>, <a href="../../../../../../../org/apache/velocity/tools/view/PagerTool.html#getSlip--">getSlip</a>, <a href="../../../../../../../org/apache/velocity/tools/view/PagerTool.html#getSlipSize--">getSlipSize</a>, <a href="../../../../../../../org/apache/velocity/tools/view/PagerTool.html#getSlipSizeKey--">getSlipSizeKey</a>, <a href="../../../../../../../org/apache/velocity/tools/view/PagerTool.html#getTotal--">getTotal</a>, <a href="../../../../../../../org/apache/velocity/tools/view/PagerTool.html#hasItems--">hasItems</a>, <a href="../../../../../../../org/apache/velocity/tools/view/PagerTool.html#setCreateSession-boolean-">setCreateSession</a>, <a href="../../../../../../../org/apache/velocity/tools/view/PagerTool.html#setIndex-int-">setIndex</a>, <a href="../../../../../../../org/apache/velocity/tools/view/PagerTool.html#setIndexKey-java.lang.String-">setIndexKey</a>, <a href="../../../../../../../org/apache/velocity/tools/view/PagerTool.html#setItems-java.util.List-">setItems</a>, <a href="../../../../../../../org/apache/velocity/tools/view/PagerTool.html#setItemsPerPage-int-">setItemsPerPage</a>, <a href="../../../../../../../org/apache/velocity/tools/view/PagerTool.html#setItemsPerPageKey-java.lang.String-">setItemsPerPageKey</a>, <a href="../../../../../../../org/apache/velocity/tools/view/PagerTool.html#setNewItemsKey-java.lang.String-">setNewItemsKey</a>, <a href="../../../../../../../org/apache/velocity/tools/view/PagerTool.html#setRequest-javax.servlet.http.HttpServletRequest-">setRequest</a>, <a href="../../../../../../../org/apache/velocity/tools/view/PagerTool.html#setSlipSize-int-">setSlipSize</a>, <a href="../../../../../../../org/apache/velocity/tools/view/PagerTool.html#setSlipSizeKey-java.lang.String-">setSlipSizeKey</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.velocity.tools.generic.SafeConfig">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.velocity.tools.generic.<a href="../../../../../../../org/apache/velocity/tools/generic/SafeConfig.html" title="class in org.apache.velocity.tools.generic">SafeConfig</a></h3>
<code><a href="../../../../../../../org/apache/velocity/tools/generic/SafeConfig.html#configure-java.util.Map-">configure</a>, <a href="../../../../../../../org/apache/velocity/tools/generic/SafeConfig.html#configure-org.apache.velocity.tools.generic.ValueParser-">configure</a>, <a href="../../../../../../../org/apache/velocity/tools/generic/SafeConfig.html#getLog--">getLog</a>, <a href="../../../../../../../org/apache/velocity/tools/generic/SafeConfig.html#initLogger-org.apache.velocity.tools.generic.ValueParser-">initLogger</a>, <a href="../../../../../../../org/apache/velocity/tools/generic/SafeConfig.html#isConfigLocked--">isConfigLocked</a>, <a href="../../../../../../../org/apache/velocity/tools/generic/SafeConfig.html#isSafeMode--">isSafeMode</a>, <a href="../../../../../../../org/apache/velocity/tools/generic/SafeConfig.html#setLockConfig-boolean-">setLockConfig</a>, <a href="../../../../../../../org/apache/velocity/tools/generic/SafeConfig.html#setSafeMode-boolean-">setSafeMode</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></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="MySearchTool--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MySearchTool</h4>
<pre>public&nbsp;MySearchTool()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="store-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>store</h4>
<pre>public&nbsp;void&nbsp;store(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;item)</pre>
<div class="block">Adds the specified item to our static "database".
You would not do this in a normal application!</div>
</li>
</ul>
<a name="store-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>store</h4>
<pre>public&nbsp;void&nbsp;store(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&nbsp;items)</pre>
<div class="block">Adds the entries of the specified map to our static "database".
You would not do this in a normal application!</div>
</li>
</ul>
<a name="store-java.util.Collection-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>store</h4>
<pre>public&nbsp;void&nbsp;store(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&nbsp;items)</pre>
<div class="block">Adds the specified items to our static "database".
You would not do this in a normal application!</div>
</li>
</ul>
<a name="getCreateSession--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCreateSession</h4>
<pre>public&nbsp;boolean&nbsp;getCreateSession()</pre>
<div class="block">Override to create a session in which to store search results.
This is done to make the demo work well. In a normal app, it
would probably not be the search tool's responsibility to ensure
that there is a session.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../../../org/apache/velocity/tools/view/PagerTool.html#getCreateSession--">getCreateSession</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../../org/apache/velocity/tools/view/PagerTool.html" title="class in org.apache.velocity.tools.view">PagerTool</a></code></dd>
</dl>
</li>
</ul>
<a name="executeQuery-java.lang.Object-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>executeQuery</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&nbsp;executeQuery(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;crit)</pre>
<div class="block">This is a very simplistic implementation that looks for the
string value of the criteria in the string value of every item
in our stupid static database. If the criteria string is in
the item string, it is added to the result list.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/velocity/tools/view/AbstractSearchTool.html#executeQuery-java.lang.Object-">executeQuery</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../../org/apache/velocity/tools/view/AbstractSearchTool.html" title="class in org.apache.velocity.tools.view">AbstractSearchTool</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>crit</code> - search criteria</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util"><code>List</code></a> of results for this query</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/MySearchTool.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="../../../../../../../org/apache/velocity/tools/examples/showcase/tool/LayoutLinkTool.html" title="class in org.apache.velocity.tools.examples.showcase.tool"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/velocity/tools/examples/showcase/tool/MySearchTool.html" target="_top">Frames</a></li>
<li><a href="MySearchTool.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li><a href="#nested.classes.inherited.from.class.org.apache.velocity.tools.view.AbstractSearchTool">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.apache.velocity.tools.view.AbstractSearchTool">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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>Copyright &#169; 2002&#x2013;2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>