blob: e875dc9d5cacf8a914ecfa65a3bb0b6c3cb50e9f [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_261) on Mon Dec 20 14:15:52 MSK 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>TextQuery (Ignite 2.11.1)</title>
<meta name="date" content="2021-12-20">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<link rel='shortcut icon' href='https://ignite.apache.org/favicon.ico'/>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="TextQuery (Ignite 2.11.1)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":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/TextQuery.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/ignite/cache/query/SqlQuery.html" title="class in org.apache.ignite.cache.query"><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/ignite/cache/query/TextQuery.html" target="_top">Frames</a></li>
<li><a href="TextQuery.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>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.apache.ignite.cache.query.Query">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.ignite.cache.query</div>
<h2 title="Class TextQuery" class="title">Class TextQuery<span class='angle_bracket'>&lt;</span>K,V<span class='angle_bracket'>&gt;</span></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/ignite/cache/query/Query.html" title="class in org.apache.ignite.cache.query">org.apache.ignite.cache.query.Query</a><span class='angle_bracket'>&lt;</span>javax.cache.Cache.Entry<span class='angle_bracket'>&lt;</span>K,V<span class='angle_bracket'>&gt;</span><span class='angle_bracket'>&gt;</span></li>
<li>
<ul class="inheritance">
<li>org.apache.ignite.cache.query.TextQuery<span class='angle_bracket'>&lt;</span>K,V<span class='angle_bracket'>&gt;</span></li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd>
</dl>
<hr>
<br>
<pre>public final class <span class="typeNameLabel">TextQuery<span class='angle_bracket'>&lt;</span>K,V<span class='angle_bracket'>&gt;</span></span>
extends <a href="../../../../../org/apache/ignite/cache/query/Query.html" title="class in org.apache.ignite.cache.query">Query</a><span class='angle_bracket'>&lt;</span>javax.cache.Cache.Entry<span class='angle_bracket'>&lt;</span>K,V<span class='angle_bracket'>&gt;</span><span class='angle_bracket'>&gt;</span></pre>
<div class="block"><h1 class="header">Full Text Queries</h1>
Ignite supports full text queries based on Apache Lucene engine.
Note that all fields that are expected to show up in text query results must be annotated with <a href="../../../../../org/apache/ignite/cache/query/annotations/QueryTextField.html" title="annotation in org.apache.ignite.cache.query.annotations"><code>QueryTextField</code></a>
<h2 class="header">Query usage</h2>
Ignite TextQuery supports classic Lucene query syntax.
See Lucene classic MultiFieldQueryParser and StandardAnalyzer javadoc for details.
As an example, suppose we have data model consisting of <code>'Employee'</code> class defined as follows:
<pre name="code" class="java">
public class Person {
private long id;
private String name;
// Index for text search.
&#64;QueryTextField
private String resume;
...
}
</pre>
Here is a possible query that will use Lucene text search to scan all resumes to
check if employees have <code>Master</code> degree:
<pre name="code" class="java">
Query&lt;Cache.Entry&lt;Long, Person&gt;&gt; qry =
new TextQuery(Person.class, "Master");
// Query all cache nodes.
cache.query(qry).getAll();
</pre></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/ignite/IgniteCache.html#query-org.apache.ignite.cache.query.Query-"><code>IgniteCache.query(Query)</code></a>,
<a href="../../../../../serialized-form.html#org.apache.ignite.cache.query.TextQuery">Serialized Form</a></dd>
</dl>
</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>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.ignite.cache.query.Query">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.ignite.cache.query.<a href="../../../../../org/apache/ignite/cache/query/Query.html" title="class in org.apache.ignite.cache.query">Query</a></h3>
<code><a href="../../../../../org/apache/ignite/cache/query/Query.html#DFLT_PAGE_SIZE">DFLT_PAGE_SIZE</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/ignite/cache/query/TextQuery.html#TextQuery-java.lang.Class-java.lang.String-">TextQuery</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><span class='angle_bracket'>&lt;</span>?<span class='angle_bracket'>&gt;</span>&nbsp;type,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;txt)</code>
<div class="block">Constructs query for the given search string.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/ignite/cache/query/TextQuery.html#TextQuery-java.lang.Class-java.lang.String-int-">TextQuery</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><span class='angle_bracket'>&lt;</span>?<span class='angle_bracket'>&gt;</span>&nbsp;type,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;txt,
int&nbsp;limit)</code>
<div class="block">Constructs query for the given search string.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/ignite/cache/query/TextQuery.html#TextQuery-java.lang.String-java.lang.String-">TextQuery</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;type,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;txt)</code>
<div class="block">Constructs query for the given search string.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/ignite/cache/query/TextQuery.html#TextQuery-java.lang.String-java.lang.String-int-">TextQuery</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;type,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;txt,
int&nbsp;limit)</code>
<div class="block">Constructs query for the given search string.</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">&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>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/ignite/cache/query/TextQuery.html#getLimit--">getLimit</a></span>()</code>
<div class="block">Gets limit to response records count.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/ignite/cache/query/TextQuery.html#getText--">getText</a></span>()</code>
<div class="block">Gets text search string.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/ignite/cache/query/TextQuery.html#getType--">getType</a></span>()</code>
<div class="block">Gets type for query.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/ignite/cache/query/TextQuery.html" title="class in org.apache.ignite.cache.query">TextQuery</a><span class='angle_bracket'>&lt;</span><a href="../../../../../org/apache/ignite/cache/query/TextQuery.html" title="type parameter in TextQuery">K</a>,<a href="../../../../../org/apache/ignite/cache/query/TextQuery.html" title="type parameter in TextQuery">V</a><span class='angle_bracket'>&gt;</span></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/ignite/cache/query/TextQuery.html#setLimit-int-">setLimit</a></span>(int&nbsp;limit)</code>
<div class="block">Sets limit to response records count.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/ignite/cache/query/TextQuery.html" title="class in org.apache.ignite.cache.query">TextQuery</a><span class='angle_bracket'>&lt;</span><a href="../../../../../org/apache/ignite/cache/query/TextQuery.html" title="type parameter in TextQuery">K</a>,<a href="../../../../../org/apache/ignite/cache/query/TextQuery.html" title="type parameter in TextQuery">V</a><span class='angle_bracket'>&gt;</span></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/ignite/cache/query/TextQuery.html#setLocal-boolean-">setLocal</a></span>(boolean&nbsp;loc)</code>
<div class="block">Sets whether this query should be executed on local node only.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/ignite/cache/query/TextQuery.html" title="class in org.apache.ignite.cache.query">TextQuery</a><span class='angle_bracket'>&lt;</span><a href="../../../../../org/apache/ignite/cache/query/TextQuery.html" title="type parameter in TextQuery">K</a>,<a href="../../../../../org/apache/ignite/cache/query/TextQuery.html" title="type parameter in TextQuery">V</a><span class='angle_bracket'>&gt;</span></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/ignite/cache/query/TextQuery.html#setPageSize-int-">setPageSize</a></span>(int&nbsp;pageSize)</code>
<div class="block">Sets optional page size, if <code>0</code>, then default is used.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/ignite/cache/query/TextQuery.html" title="class in org.apache.ignite.cache.query">TextQuery</a><span class='angle_bracket'>&lt;</span><a href="../../../../../org/apache/ignite/cache/query/TextQuery.html" title="type parameter in TextQuery">K</a>,<a href="../../../../../org/apache/ignite/cache/query/TextQuery.html" title="type parameter in TextQuery">V</a><span class='angle_bracket'>&gt;</span></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/ignite/cache/query/TextQuery.html#setText-java.lang.String-">setText</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;txt)</code>
<div class="block">Sets text search string.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/ignite/cache/query/TextQuery.html" title="class in org.apache.ignite.cache.query">TextQuery</a><span class='angle_bracket'>&lt;</span><a href="../../../../../org/apache/ignite/cache/query/TextQuery.html" title="type parameter in TextQuery">K</a>,<a href="../../../../../org/apache/ignite/cache/query/TextQuery.html" title="type parameter in TextQuery">V</a><span class='angle_bracket'>&gt;</span></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/ignite/cache/query/TextQuery.html#setType-java.lang.Class-">setType</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><span class='angle_bracket'>&lt;</span>?<span class='angle_bracket'>&gt;</span>&nbsp;type)</code>
<div class="block">Sets type for query.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/ignite/cache/query/TextQuery.html" title="class in org.apache.ignite.cache.query">TextQuery</a><span class='angle_bracket'>&lt;</span><a href="../../../../../org/apache/ignite/cache/query/TextQuery.html" title="type parameter in TextQuery">K</a>,<a href="../../../../../org/apache/ignite/cache/query/TextQuery.html" title="type parameter in TextQuery">V</a><span class='angle_bracket'>&gt;</span></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/ignite/cache/query/TextQuery.html#setType-java.lang.String-">setType</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;type)</code>
<div class="block">Sets type for query.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/ignite/cache/query/TextQuery.html#toString--">toString</a></span>()</code></td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.ignite.cache.query.Query">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.ignite.cache.query.<a href="../../../../../org/apache/ignite/cache/query/Query.html" title="class in org.apache.ignite.cache.query">Query</a></h3>
<code><a href="../../../../../org/apache/ignite/cache/query/Query.html#getPageSize--">getPageSize</a>, <a href="../../../../../org/apache/ignite/cache/query/Query.html#isLocal--">isLocal</a>, <a href="../../../../../org/apache/ignite/cache/query/Query.html#prepare-int:A-">prepare</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#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="TextQuery-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TextQuery</h4>
<pre>public&nbsp;TextQuery(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;type,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;txt)</pre>
<div class="block">Constructs query for the given search string.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>type</code> - Type.</dd>
<dd><code>txt</code> - Search string.</dd>
</dl>
</li>
</ul>
<a name="TextQuery-java.lang.String-java.lang.String-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TextQuery</h4>
<pre>public&nbsp;TextQuery(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;type,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;txt,
int&nbsp;limit)</pre>
<div class="block">Constructs query for the given search string.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>type</code> - Type.</dd>
<dd><code>txt</code> - Search string.</dd>
<dd><code>limit</code> - Limits response records count. If 0 or less, considered to be no limit.</dd>
</dl>
</li>
</ul>
<a name="TextQuery-java.lang.Class-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TextQuery</h4>
<pre>public&nbsp;TextQuery(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><span class='angle_bracket'>&lt;</span>?<span class='angle_bracket'>&gt;</span>&nbsp;type,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;txt)</pre>
<div class="block">Constructs query for the given search string.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>type</code> - Type.</dd>
<dd><code>txt</code> - Search string.</dd>
</dl>
</li>
</ul>
<a name="TextQuery-java.lang.Class-java.lang.String-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>TextQuery</h4>
<pre>public&nbsp;TextQuery(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><span class='angle_bracket'>&lt;</span>?<span class='angle_bracket'>&gt;</span>&nbsp;type,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;txt,
int&nbsp;limit)</pre>
<div class="block">Constructs query for the given search string.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>type</code> - Type.</dd>
<dd><code>txt</code> - Search string.</dd>
<dd><code>limit</code> - Limits response records count. If 0 or less, considered to be no limit.</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="getType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getType</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getType()</pre>
<div class="block">Gets type for query.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Type.</dd>
</dl>
</li>
</ul>
<a name="setType-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setType</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/ignite/cache/query/TextQuery.html" title="class in org.apache.ignite.cache.query">TextQuery</a><span class='angle_bracket'>&lt;</span><a href="../../../../../org/apache/ignite/cache/query/TextQuery.html" title="type parameter in TextQuery">K</a>,<a href="../../../../../org/apache/ignite/cache/query/TextQuery.html" title="type parameter in TextQuery">V</a><span class='angle_bracket'>&gt;</span>&nbsp;setType(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><span class='angle_bracket'>&lt;</span>?<span class='angle_bracket'>&gt;</span>&nbsp;type)</pre>
<div class="block">Sets type for query.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>type</code> - Type.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>this</code> For chaining.</dd>
</dl>
</li>
</ul>
<a name="setType-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setType</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/ignite/cache/query/TextQuery.html" title="class in org.apache.ignite.cache.query">TextQuery</a><span class='angle_bracket'>&lt;</span><a href="../../../../../org/apache/ignite/cache/query/TextQuery.html" title="type parameter in TextQuery">K</a>,<a href="../../../../../org/apache/ignite/cache/query/TextQuery.html" title="type parameter in TextQuery">V</a><span class='angle_bracket'>&gt;</span>&nbsp;setType(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;type)</pre>
<div class="block">Sets type for query.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>type</code> - Type.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>this</code> For chaining.</dd>
</dl>
</li>
</ul>
<a name="getText--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getText</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getText()</pre>
<div class="block">Gets text search string.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Text search string.</dd>
</dl>
</li>
</ul>
<a name="setText-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setText</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/ignite/cache/query/TextQuery.html" title="class in org.apache.ignite.cache.query">TextQuery</a><span class='angle_bracket'>&lt;</span><a href="../../../../../org/apache/ignite/cache/query/TextQuery.html" title="type parameter in TextQuery">K</a>,<a href="../../../../../org/apache/ignite/cache/query/TextQuery.html" title="type parameter in TextQuery">V</a><span class='angle_bracket'>&gt;</span>&nbsp;setText(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;txt)</pre>
<div class="block">Sets text search string.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>txt</code> - Text search string.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>this</code> For chaining.</dd>
</dl>
</li>
</ul>
<a name="getLimit--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLimit</h4>
<pre>public&nbsp;int&nbsp;getLimit()</pre>
<div class="block">Gets limit to response records count.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Limit value.</dd>
</dl>
</li>
</ul>
<a name="setLimit-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLimit</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/ignite/cache/query/TextQuery.html" title="class in org.apache.ignite.cache.query">TextQuery</a><span class='angle_bracket'>&lt;</span><a href="../../../../../org/apache/ignite/cache/query/TextQuery.html" title="type parameter in TextQuery">K</a>,<a href="../../../../../org/apache/ignite/cache/query/TextQuery.html" title="type parameter in TextQuery">V</a><span class='angle_bracket'>&gt;</span>&nbsp;setLimit(int&nbsp;limit)</pre>
<div class="block">Sets limit to response records count.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>limit</code> - If 0 or less, considered to be no limit.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>this</code> For chaining.</dd>
</dl>
</li>
</ul>
<a name="setPageSize-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPageSize</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/ignite/cache/query/TextQuery.html" title="class in org.apache.ignite.cache.query">TextQuery</a><span class='angle_bracket'>&lt;</span><a href="../../../../../org/apache/ignite/cache/query/TextQuery.html" title="type parameter in TextQuery">K</a>,<a href="../../../../../org/apache/ignite/cache/query/TextQuery.html" title="type parameter in TextQuery">V</a><span class='angle_bracket'>&gt;</span>&nbsp;setPageSize(int&nbsp;pageSize)</pre>
<div class="block">Sets optional page size, if <code>0</code>, then default is used.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/ignite/cache/query/Query.html#setPageSize-int-">setPageSize</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/ignite/cache/query/Query.html" title="class in org.apache.ignite.cache.query">Query</a><span class='angle_bracket'>&lt;</span>javax.cache.Cache.Entry<span class='angle_bracket'>&lt;</span><a href="../../../../../org/apache/ignite/cache/query/TextQuery.html" title="type parameter in TextQuery">K</a>,<a href="../../../../../org/apache/ignite/cache/query/TextQuery.html" title="type parameter in TextQuery">V</a><span class='angle_bracket'>&gt;</span><span class='angle_bracket'>&gt;</span></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pageSize</code> - Optional page size.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>this</code> for chaining.</dd>
</dl>
</li>
</ul>
<a name="setLocal-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLocal</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/ignite/cache/query/TextQuery.html" title="class in org.apache.ignite.cache.query">TextQuery</a><span class='angle_bracket'>&lt;</span><a href="../../../../../org/apache/ignite/cache/query/TextQuery.html" title="type parameter in TextQuery">K</a>,<a href="../../../../../org/apache/ignite/cache/query/TextQuery.html" title="type parameter in TextQuery">V</a><span class='angle_bracket'>&gt;</span>&nbsp;setLocal(boolean&nbsp;loc)</pre>
<div class="block">Sets whether this query should be executed on local node only.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/ignite/cache/query/Query.html#setLocal-boolean-">setLocal</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/ignite/cache/query/Query.html" title="class in org.apache.ignite.cache.query">Query</a><span class='angle_bracket'>&lt;</span>javax.cache.Cache.Entry<span class='angle_bracket'>&lt;</span><a href="../../../../../org/apache/ignite/cache/query/TextQuery.html" title="type parameter in TextQuery">K</a>,<a href="../../../../../org/apache/ignite/cache/query/TextQuery.html" title="type parameter in TextQuery">V</a><span class='angle_bracket'>&gt;</span><span class='angle_bracket'>&gt;</span></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>loc</code> - Local flag.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>this</code> for chaining.</dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/ignite/cache/query/Query.html#toString--">toString</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/ignite/cache/query/Query.html" title="class in org.apache.ignite.cache.query">Query</a><span class='angle_bracket'>&lt;</span>javax.cache.Cache.Entry<span class='angle_bracket'>&lt;</span><a href="../../../../../org/apache/ignite/cache/query/TextQuery.html" title="type parameter in TextQuery">K</a>,<a href="../../../../../org/apache/ignite/cache/query/TextQuery.html" title="type parameter in TextQuery">V</a><span class='angle_bracket'>&gt;</span><span class='angle_bracket'>&gt;</span></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/TextQuery.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/ignite/cache/query/SqlQuery.html" title="class in org.apache.ignite.cache.query"><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/ignite/cache/query/TextQuery.html" target="_top">Frames</a></li>
<li><a href="TextQuery.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>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.apache.ignite.cache.query.Query">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><table width="100%" border="0" cellspacing=0 cellpadding=0 style="padding: 5px"> <tr> <td> <table style="padding-left: 0; margin: 0"> <tbody style="padding: 0; margin: 0"> <tr style="padding: 0; margin: 0"> <td> <a target=_blank href="https://ignite.apache.org"><nobr>2021 Copyright &#169; Apache Software Foundation</nobr></a> </td> </tr> </tbody> </table> </td> <td width="100%" align="right" valign="center"> <a href="https://twitter.com/ApacheIgnite" class="twitter-follow-button" data-show-count="false" data-size="large">Follow @ApacheIgnite</a> </td> </tr> <tr> <td colspan="2" valign="top" align="left"> <table style="padding-left: 0; margin: 0"> <tbody style="padding: 0; margin: 0"> <tr style="padding: 0; margin: 0"> <td> <b>Ignite Database and Caching Platform</b> </td> <td>:&nbsp;&nbsp; ver. <strong>2.11.1</strong> </td> </tr> <tr style="padding: 0; margin: 0"> <td> <b>Release Date</b> </td> <td>:&nbsp;&nbsp; December 20 2021 </td> </tr> </tbody> </table> </td> </tr> </table></small></p>
</body>
</html>