| <!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_291) on Mon Jan 10 11:05:25 MSK 2022 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>IndexQuery (Ignite 2.12.0)</title> |
| <meta name="date" content="2022-01-10"> |
| <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="IndexQuery (Ignite 2.12.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":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/IndexQuery.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/FieldsQueryCursor.html" title="interface in org.apache.ignite.cache.query"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/ignite/cache/query/IndexQueryCriteriaBuilder.html" title="class in org.apache.ignite.cache.query"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/ignite/cache/query/IndexQuery.html" target="_top">Frames</a></li> |
| <li><a href="IndexQuery.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="#fields.inherited.from.class.org.apache.ignite.cache.query.Query">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>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">org.apache.ignite.cache.query</div> |
| <h2 title="Class IndexQuery" class="title">Class IndexQuery<span class='angle_bracket'><</span>K,V<span class='angle_bracket'>></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'><</span>javax.cache.Cache.Entry<span class='angle_bracket'><</span>K,V<span class='angle_bracket'>></span><span class='angle_bracket'>></span></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.ignite.cache.query.IndexQuery<span class='angle_bracket'><</span>K,V<span class='angle_bracket'>></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">IndexQuery<span class='angle_bracket'><</span>K,V<span class='angle_bracket'>></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'><</span>javax.cache.Cache.Entry<span class='angle_bracket'><</span>K,V<span class='angle_bracket'>></span><span class='angle_bracket'>></span></pre> |
| <div class="block">Index queries work over distributed indexes and retrieve cache entries that match the specified criteria. |
| <code>QueryCursor</code> delivers sorted cache entries by the order defined for queried index. |
| |
| <code>IndexQuery</code> has to be initialized with cache value class or type. The algorithm of discovering index is as follows: |
| 1. If <a href="../../../../../org/apache/ignite/cache/query/IndexQuery.html#idxName"><code>idxName</code></a> is set, then use it. |
| 2. If <a href="../../../../../org/apache/ignite/cache/query/IndexQuery.html#idxName"><code>idxName</code></a> is not set, then find an index that matches criteria fields. |
| 3. If neither <a href="../../../../../org/apache/ignite/cache/query/IndexQuery.html#idxName"><code>idxName</code></a>, nor <a href="../../../../../org/apache/ignite/cache/query/IndexQuery.html#setCriteria-java.util.List-"><code>setCriteria(List)</code></a> is used, then perform index scan over PK index for specified Value type. |
| |
| Conjuction of items in <a href="../../../../../org/apache/ignite/cache/query/IndexQuery.html#criteria"><code>criteria</code></a> has to represent a valid range to traverse the index tree.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../serialized-form.html#org.apache.ignite.cache.query.IndexQuery">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 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"> </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/IndexQuery.html#IndexQuery-java.lang.Class-">IndexQuery</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'><</span>?<span class='angle_bracket'>></span> valCls)</code> |
| <div class="block">Specify index with cache value class.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/ignite/cache/query/IndexQuery.html#IndexQuery-java.lang.Class-java.lang.String-">IndexQuery</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'><</span>?<span class='angle_bracket'>></span> valCls, |
| @Nullable <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> idxName)</code> |
| <div class="block">Specify index with cache value class and index name.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/ignite/cache/query/IndexQuery.html#IndexQuery-java.lang.String-">IndexQuery</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> valType)</code> |
| <div class="block">Specify index with cache value type.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/ignite/cache/query/IndexQuery.html#IndexQuery-java.lang.String-java.lang.String-">IndexQuery</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> valType, |
| @Nullable <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> idxName)</code> |
| <div class="block">Specify index with cache value type and index name.</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><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><span class='angle_bracket'><</span><a href="../../../../../org/apache/ignite/cache/query/IndexQueryCriterion.html" title="interface in org.apache.ignite.cache.query">IndexQueryCriterion</a><span class='angle_bracket'>></span></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/ignite/cache/query/IndexQuery.html#getCriteria--">getCriteria</a></span>()</code> |
| <div class="block">Index query criteria.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/ignite/lang/IgniteBiPredicate.html" title="interface in org.apache.ignite.lang">IgniteBiPredicate</a><span class='angle_bracket'><</span><a href="../../../../../org/apache/ignite/cache/query/IndexQuery.html" title="type parameter in IndexQuery">K</a>,<a href="../../../../../org/apache/ignite/cache/query/IndexQuery.html" title="type parameter in IndexQuery">V</a><span class='angle_bracket'>></span></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/ignite/cache/query/IndexQuery.html#getFilter--">getFilter</a></span>()</code> |
| <div class="block">Gets remote cache entries filter.</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/IndexQuery.html#getIndexName--">getIndexName</a></span>()</code> |
| <div class="block">Index name.</div> |
| </td> |
| </tr> |
| <tr id="i3" 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/IndexQuery.html#getValueType--">getValueType</a></span>()</code> |
| <div class="block">Cache Value type.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/ignite/cache/query/IndexQuery.html" title="class in org.apache.ignite.cache.query">IndexQuery</a><span class='angle_bracket'><</span><a href="../../../../../org/apache/ignite/cache/query/IndexQuery.html" title="type parameter in IndexQuery">K</a>,<a href="../../../../../org/apache/ignite/cache/query/IndexQuery.html" title="type parameter in IndexQuery">V</a><span class='angle_bracket'>></span></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/ignite/cache/query/IndexQuery.html#setCriteria-org.apache.ignite.cache.query.IndexQueryCriterion...-">setCriteria</a></span>(<a href="../../../../../org/apache/ignite/cache/query/IndexQueryCriterion.html" title="interface in org.apache.ignite.cache.query">IndexQueryCriterion</a>... criteria)</code> |
| <div class="block">Sets conjunction (AND) criteria for index query.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/ignite/cache/query/IndexQuery.html" title="class in org.apache.ignite.cache.query">IndexQuery</a><span class='angle_bracket'><</span><a href="../../../../../org/apache/ignite/cache/query/IndexQuery.html" title="type parameter in IndexQuery">K</a>,<a href="../../../../../org/apache/ignite/cache/query/IndexQuery.html" title="type parameter in IndexQuery">V</a><span class='angle_bracket'>></span></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/ignite/cache/query/IndexQuery.html#setCriteria-java.util.List-">setCriteria</a></span>(<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><span class='angle_bracket'><</span><a href="../../../../../org/apache/ignite/cache/query/IndexQueryCriterion.html" title="interface in org.apache.ignite.cache.query">IndexQueryCriterion</a><span class='angle_bracket'>></span> criteria)</code> |
| <div class="block">Sets conjunction (AND) criteria for index query.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/ignite/cache/query/IndexQuery.html" title="class in org.apache.ignite.cache.query">IndexQuery</a><span class='angle_bracket'><</span><a href="../../../../../org/apache/ignite/cache/query/IndexQuery.html" title="type parameter in IndexQuery">K</a>,<a href="../../../../../org/apache/ignite/cache/query/IndexQuery.html" title="type parameter in IndexQuery">V</a><span class='angle_bracket'>></span></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/ignite/cache/query/IndexQuery.html#setFilter-org.apache.ignite.lang.IgniteBiPredicate-">setFilter</a></span>(<a href="../../../../../org/apache/ignite/lang/IgniteBiPredicate.html" title="interface in org.apache.ignite.lang">IgniteBiPredicate</a><span class='angle_bracket'><</span><a href="../../../../../org/apache/ignite/cache/query/IndexQuery.html" title="type parameter in IndexQuery">K</a>,<a href="../../../../../org/apache/ignite/cache/query/IndexQuery.html" title="type parameter in IndexQuery">V</a><span class='angle_bracket'>></span> filter)</code> |
| <div class="block">Sets remote cache entries filter.</div> |
| </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 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>, <a href="../../../../../org/apache/ignite/cache/query/Query.html#setLocal-boolean-">setLocal</a>, <a href="../../../../../org/apache/ignite/cache/query/Query.html#setPageSize-int-">setPageSize</a>, <a href="../../../../../org/apache/ignite/cache/query/Query.html#toString--">toString</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 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="IndexQuery-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>IndexQuery</h4> |
| <pre>public IndexQuery(<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'><</span>?<span class='angle_bracket'>></span> valCls)</pre> |
| <div class="block">Specify index with cache value class.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>valCls</code> - Cache value class.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="IndexQuery-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>IndexQuery</h4> |
| <pre>public IndexQuery(<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> valType)</pre> |
| <div class="block">Specify index with cache value type.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>valType</code> - Cache value type.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="IndexQuery-java.lang.Class-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>IndexQuery</h4> |
| <pre>public IndexQuery(<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'><</span>?<span class='angle_bracket'>></span> valCls, |
| @Nullable |
| @Nullable <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> idxName)</pre> |
| <div class="block">Specify index with cache value class and index name.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>valCls</code> - Cache value class.</dd> |
| <dd><code>idxName</code> - Index name.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="IndexQuery-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>IndexQuery</h4> |
| <pre>public IndexQuery(<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> valType, |
| @Nullable |
| @Nullable <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> idxName)</pre> |
| <div class="block">Specify index with cache value type and index name.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>valType</code> - Cache value type.</dd> |
| <dd><code>idxName</code> - Index name.</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="setCriteria-org.apache.ignite.cache.query.IndexQueryCriterion...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCriteria</h4> |
| <pre>public <a href="../../../../../org/apache/ignite/cache/query/IndexQuery.html" title="class in org.apache.ignite.cache.query">IndexQuery</a><span class='angle_bracket'><</span><a href="../../../../../org/apache/ignite/cache/query/IndexQuery.html" title="type parameter in IndexQuery">K</a>,<a href="../../../../../org/apache/ignite/cache/query/IndexQuery.html" title="type parameter in IndexQuery">V</a><span class='angle_bracket'>></span> setCriteria(<a href="../../../../../org/apache/ignite/cache/query/IndexQueryCriterion.html" title="interface in org.apache.ignite.cache.query">IndexQueryCriterion</a>... criteria)</pre> |
| <div class="block">Sets conjunction (AND) criteria for index query.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>criteria</code> - Criteria to set.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>this</code> for chaining.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setCriteria-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCriteria</h4> |
| <pre>public <a href="../../../../../org/apache/ignite/cache/query/IndexQuery.html" title="class in org.apache.ignite.cache.query">IndexQuery</a><span class='angle_bracket'><</span><a href="../../../../../org/apache/ignite/cache/query/IndexQuery.html" title="type parameter in IndexQuery">K</a>,<a href="../../../../../org/apache/ignite/cache/query/IndexQuery.html" title="type parameter in IndexQuery">V</a><span class='angle_bracket'>></span> setCriteria(<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><span class='angle_bracket'><</span><a href="../../../../../org/apache/ignite/cache/query/IndexQueryCriterion.html" title="interface in org.apache.ignite.cache.query">IndexQueryCriterion</a><span class='angle_bracket'>></span> criteria)</pre> |
| <div class="block">Sets conjunction (AND) criteria for index query.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>criteria</code> - Criteria to set.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>this</code> for chaining.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCriteria--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCriteria</h4> |
| <pre>public <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><span class='angle_bracket'><</span><a href="../../../../../org/apache/ignite/cache/query/IndexQueryCriterion.html" title="interface in org.apache.ignite.cache.query">IndexQueryCriterion</a><span class='angle_bracket'>></span> getCriteria()</pre> |
| <div class="block">Index query criteria.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>List of criteria for this index query.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getValueType--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValueType</h4> |
| <pre>public <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> getValueType()</pre> |
| <div class="block">Cache Value type.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Cache Value type.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getIndexName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIndexName</h4> |
| <pre>public <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> getIndexName()</pre> |
| <div class="block">Index name.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Index name.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setFilter-org.apache.ignite.lang.IgniteBiPredicate-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFilter</h4> |
| <pre>public <a href="../../../../../org/apache/ignite/cache/query/IndexQuery.html" title="class in org.apache.ignite.cache.query">IndexQuery</a><span class='angle_bracket'><</span><a href="../../../../../org/apache/ignite/cache/query/IndexQuery.html" title="type parameter in IndexQuery">K</a>,<a href="../../../../../org/apache/ignite/cache/query/IndexQuery.html" title="type parameter in IndexQuery">V</a><span class='angle_bracket'>></span> setFilter(<a href="../../../../../org/apache/ignite/lang/IgniteBiPredicate.html" title="interface in org.apache.ignite.lang">IgniteBiPredicate</a><span class='angle_bracket'><</span><a href="../../../../../org/apache/ignite/cache/query/IndexQuery.html" title="type parameter in IndexQuery">K</a>,<a href="../../../../../org/apache/ignite/cache/query/IndexQuery.html" title="type parameter in IndexQuery">V</a><span class='angle_bracket'>></span> filter)</pre> |
| <div class="block">Sets remote cache entries filter.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>filter</code> - Predicate for remote filtering of query result cursor.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>this</code> for chaining.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFilter--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getFilter</h4> |
| <pre>public <a href="../../../../../org/apache/ignite/lang/IgniteBiPredicate.html" title="interface in org.apache.ignite.lang">IgniteBiPredicate</a><span class='angle_bracket'><</span><a href="../../../../../org/apache/ignite/cache/query/IndexQuery.html" title="type parameter in IndexQuery">K</a>,<a href="../../../../../org/apache/ignite/cache/query/IndexQuery.html" title="type parameter in IndexQuery">V</a><span class='angle_bracket'>></span> getFilter()</pre> |
| <div class="block">Gets remote cache entries filter.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Filter.</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/IndexQuery.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/FieldsQueryCursor.html" title="interface in org.apache.ignite.cache.query"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/ignite/cache/query/IndexQueryCriteriaBuilder.html" title="class in org.apache.ignite.cache.query"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/ignite/cache/query/IndexQuery.html" target="_top">Frames</a></li> |
| <li><a href="IndexQuery.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="#fields.inherited.from.class.org.apache.ignite.cache.query.Query">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>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><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>2022 Copyright © 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>: ver. <strong>2.12.0</strong> </td> </tr> <tr style="padding: 0; margin: 0"> <td> <b>Release Date</b> </td> <td>: January 10 2022 </td> </tr> </tbody> </table> </td> </tr> </table></small></p> |
| </body> |
| </html> |
