| <!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 --> |
| <title>LuceneQueryFactory (Apache Geode 1.15.1)</title> |
| <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="LuceneQueryFactory (Apache Geode 1.15.1)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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="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/geode/cache/lucene/LuceneQueryException.html" title="class in org.apache.geode.cache.lucene"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/geode/cache/lucene/LuceneQueryProvider.html" title="interface in org.apache.geode.cache.lucene"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/geode/cache/lucene/LuceneQueryFactory.html" target="_top">Frames</a></li> |
| <li><a href="LuceneQueryFactory.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </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.geode.cache.lucene</div> |
| <h2 title="Interface LuceneQueryFactory" class="title">Interface LuceneQueryFactory</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">LuceneQueryFactory</span></pre> |
| <div class="block">Factory for configuring a Lucene query. Use this factory to set parameters of the query such as |
| page size, result limit, and query expression. To get an instance of this factory call |
| <a href="../../../../../org/apache/geode/cache/lucene/LuceneService.html#createLuceneQueryFactory--"><code>LuceneService.createLuceneQueryFactory()</code></a>. |
| <P> |
| To use this factory configure it with the <code>set</code> methods and then call one of the |
| create methods on this class. <a href="../../../../../org/apache/geode/cache/lucene/LuceneQueryFactory.html#create-java.lang.String-java.lang.String-java.lang.String-java.lang.String-"><code>create(String, String, String, String)</code></a> creates a query by |
| parsing a query string. <a href="../../../../../org/apache/geode/cache/lucene/LuceneQueryFactory.html#create-java.lang.String-java.lang.String-org.apache.geode.cache.lucene.LuceneQueryProvider-"><code>create(String, String, LuceneQueryProvider)</code></a> creates a query |
| based on a custom Lucene <a href="../../../../../org/apache/geode/cache/query/Query.html" title="interface in org.apache.geode.cache.query"><code>Query</code></a> object.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/lucene/LuceneQueryFactory.html#DEFAULT_LIMIT">DEFAULT_LIMIT</a></span></code> |
| <div class="block">Default query result limit is 100</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/lucene/LuceneQueryFactory.html#DEFAULT_PAGESIZE">DEFAULT_PAGESIZE</a></span></code> |
| <div class="block">Default page size of result is 0, which means no pagination</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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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><K,V> <a href="../../../../../org/apache/geode/cache/lucene/LuceneQuery.html" title="interface in org.apache.geode.cache.lucene">LuceneQuery</a><K,V></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/lucene/LuceneQueryFactory.html#create-java.lang.String-java.lang.String-org.apache.geode.cache.lucene.LuceneQueryProvider-">create</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> indexName, |
| <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> regionName, |
| <a href="../../../../../org/apache/geode/cache/lucene/LuceneQueryProvider.html" title="interface in org.apache.geode.cache.lucene">LuceneQueryProvider</a> provider)</code> |
| <div class="block"> |
| Create a query based on a programmatically constructed Lucene <a href="../../../../../org/apache/geode/cache/query/Query.html" title="interface in org.apache.geode.cache.query"><code>Query</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><K,V> <a href="../../../../../org/apache/geode/cache/lucene/LuceneQuery.html" title="interface in org.apache.geode.cache.lucene">LuceneQuery</a><K,V></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/lucene/LuceneQueryFactory.html#create-java.lang.String-java.lang.String-java.lang.String-java.lang.String-">create</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> indexName, |
| <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> regionName, |
| <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> queryString, |
| <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> defaultField)</code> |
| <div class="block">Creates a query based on a query string which is parsed by Lucene's |
| <code>StandardQueryParser</code>.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/geode/cache/lucene/LuceneQueryFactory.html" title="interface in org.apache.geode.cache.lucene">LuceneQueryFactory</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/lucene/LuceneQueryFactory.html#setLimit-int-">setLimit</a></span>(int limit)</code> |
| <div class="block">Set maximum number of results for a query.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/geode/cache/lucene/LuceneQueryFactory.html" title="interface in org.apache.geode.cache.lucene">LuceneQueryFactory</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/lucene/LuceneQueryFactory.html#setPageSize-int-">setPageSize</a></span>(int pageSize)</code> |
| <div class="block">Set page size for a query result.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="DEFAULT_LIMIT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_LIMIT</h4> |
| <pre>static final int DEFAULT_LIMIT</pre> |
| <div class="block">Default query result limit is 100</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.geode.cache.lucene.LuceneQueryFactory.DEFAULT_LIMIT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_PAGESIZE"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DEFAULT_PAGESIZE</h4> |
| <pre>static final int DEFAULT_PAGESIZE</pre> |
| <div class="block">Default page size of result is 0, which means no pagination</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.geode.cache.lucene.LuceneQueryFactory.DEFAULT_PAGESIZE">Constant Field Values</a></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="setPageSize-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPageSize</h4> |
| <pre><a href="../../../../../org/apache/geode/cache/lucene/LuceneQueryFactory.html" title="interface in org.apache.geode.cache.lucene">LuceneQueryFactory</a> setPageSize(int pageSize)</pre> |
| <div class="block">Set page size for a query result. The default page size is 0 which means no pagination.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pageSize</code> - the page size for a query result</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this factory</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the value is less than 0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setLimit-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLimit</h4> |
| <pre><a href="../../../../../org/apache/geode/cache/lucene/LuceneQueryFactory.html" title="interface in org.apache.geode.cache.lucene">LuceneQueryFactory</a> setLimit(int limit)</pre> |
| <div class="block">Set maximum number of results for a query. By default, the limit is set to |
| <a href="../../../../../org/apache/geode/cache/lucene/LuceneQueryFactory.html#DEFAULT_LIMIT"><code>DEFAULT_LIMIT</code></a> which is 100.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>limit</code> - the maximum number of results for a query</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this factory</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the value is less than or equal to zero.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="create-java.lang.String-java.lang.String-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>create</h4> |
| <pre><K,V> <a href="../../../../../org/apache/geode/cache/lucene/LuceneQuery.html" title="interface in org.apache.geode.cache.lucene">LuceneQuery</a><K,V> create(<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> indexName, |
| <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> regionName, |
| <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> queryString, |
| <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> defaultField)</pre> |
| <div class="block">Creates a query based on a query string which is parsed by Lucene's |
| <code>StandardQueryParser</code>. See the javadocs for <code>StandardQueryParser</code> for details on |
| the syntax of the query string. The query string and default field as passed as is to |
| <code>StandardQueryParser.parse(String, String)</code></div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>K</code> - the key type in the query results</dd> |
| <dd><code>V</code> - the value type in the query results</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>regionName</code> - region name</dd> |
| <dd><code>indexName</code> - index name</dd> |
| <dd><code>queryString</code> - Query string parsed by Lucene's StandardQueryParser</dd> |
| <dd><code>defaultField</code> - default field used by the Lucene's StandardQueryParser</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>LuceneQuery object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="create-java.lang.String-java.lang.String-org.apache.geode.cache.lucene.LuceneQueryProvider-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>create</h4> |
| <pre><K,V> <a href="../../../../../org/apache/geode/cache/lucene/LuceneQuery.html" title="interface in org.apache.geode.cache.lucene">LuceneQuery</a><K,V> create(<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> indexName, |
| <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> regionName, |
| <a href="../../../../../org/apache/geode/cache/lucene/LuceneQueryProvider.html" title="interface in org.apache.geode.cache.lucene">LuceneQueryProvider</a> provider)</pre> |
| <div class="block"><p> |
| Create a query based on a programmatically constructed Lucene <a href="../../../../../org/apache/geode/cache/query/Query.html" title="interface in org.apache.geode.cache.query"><code>Query</code></a>. This can be used |
| for queries that are not covered by <code>StandardQueryParser</code>, such as range queries. |
| <p> |
| Because Geode may execute the Lucene query on multiple nodes in parallel and <a href="../../../../../org/apache/geode/cache/query/Query.html" title="interface in org.apache.geode.cache.query"><code>Query</code></a> is |
| not serializable, this method requires a serializable <a href="../../../../../org/apache/geode/cache/lucene/LuceneQueryProvider.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneQueryProvider</code></a> that can |
| create a <a href="../../../../../org/apache/geode/cache/query/Query.html" title="interface in org.apache.geode.cache.query"><code>Query</code></a> on the nodes hosting the Lucene index. |
| <p> |
| Here's an example of using this method to create a range query on an integer field called |
| "age." |
| |
| <pre> |
| <code> |
| LuceneQuery query = factory.create("index", "region", index -> IntPoint.newRangeQuery("age", 20, 30)) |
| </code> |
| </pre></div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>K</code> - the key type in the query results</dd> |
| <dd><code>V</code> - the value type in the query results</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>indexName</code> - index name</dd> |
| <dd><code>regionName</code> - region name</dd> |
| <dd><code>provider</code> - constructs and provides a Lucene <a href="../../../../../org/apache/geode/cache/query/Query.html" title="interface in org.apache.geode.cache.query"><code>Query</code></a>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>LuceneQuery object</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="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/geode/cache/lucene/LuceneQueryException.html" title="class in org.apache.geode.cache.lucene"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/geode/cache/lucene/LuceneQueryProvider.html" title="interface in org.apache.geode.cache.lucene"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/geode/cache/lucene/LuceneQueryFactory.html" target="_top">Frames</a></li> |
| <li><a href="LuceneQueryFactory.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
