| <!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>org.apache.geode.cache.lucene (Apache Geode 1.15.0)</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="org.apache.geode.cache.lucene (Apache Geode 1.15.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </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 class="navBarCell1Rev">Package</li> |
| <li>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/execute/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../org/apache/geode/cache/lucene/management/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/geode/cache/lucene/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.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> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="header"> |
| <h1 title="Package" class="title">Package org.apache.geode.cache.lucene</h1> |
| <div class="docSummary"> |
| <div class="block">This package provides an integration with Apache Lucene that allows Geode regions to be indexed |
| in a distributed Lucene index and queries using Lucene queries.</div> |
| </div> |
| <p>See: <a href="#package.description">Description</a></p> |
| </div> |
| <div class="contentContainer"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> |
| <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/geode/cache/lucene/LuceneIndex.html" title="interface in org.apache.geode.cache.lucene">LuceneIndex</a></td> |
| <td class="colLast"> |
| <div class="block"> |
| LuceneIndex represents the Lucene index created over the data stored in Apache Geode regions.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/geode/cache/lucene/LuceneIndexFactory.html" title="interface in org.apache.geode.cache.lucene">LuceneIndexFactory</a></td> |
| <td class="colLast"> |
| <div class="block">A factory for creating a lucene index on the current member.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/geode/cache/lucene/LuceneQuery.html" title="interface in org.apache.geode.cache.lucene">LuceneQuery</a><K,V></td> |
| <td class="colLast"> |
| <div class="block"> |
| A query on a Lucene index.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/geode/cache/lucene/LuceneQueryFactory.html" title="interface in org.apache.geode.cache.lucene">LuceneQueryFactory</a></td> |
| <td class="colLast"> |
| <div class="block">Factory for configuring a Lucene query.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/geode/cache/lucene/LuceneQueryProvider.html" title="interface in org.apache.geode.cache.lucene">LuceneQueryProvider</a></td> |
| <td class="colLast"> |
| <div class="block"> |
| A factory for <code>Query</code> objects.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/geode/cache/lucene/LuceneResultStruct.html" title="interface in org.apache.geode.cache.lucene">LuceneResultStruct</a><K,V></td> |
| <td class="colLast"> |
| <div class="block">An interface which stores a single result obtained by executing a Lucene query.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/geode/cache/lucene/LuceneSerializer.html" title="interface in org.apache.geode.cache.lucene">LuceneSerializer</a><T></td> |
| <td class="colLast"> |
| <div class="block">An interface for writing the fields of an object into a lucene document</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/geode/cache/lucene/LuceneService.html" title="interface in org.apache.geode.cache.lucene">LuceneService</a></td> |
| <td class="colLast"> |
| <div class="block">The LuceneService provides the capability to create Lucene indexes and execute lucene queries on |
| data stored in Geode regions.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/geode/cache/lucene/PageableLuceneQueryResults.html" title="interface in org.apache.geode.cache.lucene">PageableLuceneQueryResults</a><K,V></td> |
| <td class="colLast"> |
| <div class="block"> |
| This interface allows you to retrieve a page of query results at a time, using the |
| <a href="../../../../../org/apache/geode/cache/lucene/PageableLuceneQueryResults.html#hasNext--"><code>PageableLuceneQueryResults.hasNext()</code></a> and <a href="../../../../../org/apache/geode/cache/lucene/PageableLuceneQueryResults.html#next--"><code>PageableLuceneQueryResults.next()</code></a> methods.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/geode/cache/lucene/FlatFormatSerializer.html" title="class in org.apache.geode.cache.lucene">FlatFormatSerializer</a></td> |
| <td class="colLast"> |
| <div class="block">A built-in <a href="../../../../../org/apache/geode/cache/lucene/LuceneSerializer.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneSerializer</code></a> to parse user's nested object into a flat format, i.e.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/geode/cache/lucene/LuceneServiceProvider.html" title="class in org.apache.geode.cache.lucene">LuceneServiceProvider</a></td> |
| <td class="colLast"> |
| <div class="block">Class for retrieving or creating the currently running instance of the LuceneService.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation"> |
| <caption><span>Exception Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Exception</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/geode/cache/lucene/LuceneIndexDestroyedException.html" title="class in org.apache.geode.cache.lucene">LuceneIndexDestroyedException</a></td> |
| <td class="colLast"> |
| <div class="block">A LuceneIndexDestroyedException is thrown if a Lucene index is attempted to be used while it is |
| being destroyed or after it has been destroyed.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/geode/cache/lucene/LuceneIndexExistsException.html" title="class in org.apache.geode.cache.lucene">LuceneIndexExistsException</a></td> |
| <td class="colLast"> |
| <div class="block">A LuceneIndexExistsException is thrown if a Lucene index that already exists is attempted to be |
| created.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/geode/cache/lucene/LuceneIndexNotFoundException.html" title="class in org.apache.geode.cache.lucene">LuceneIndexNotFoundException</a></td> |
| <td class="colLast"> |
| <div class="block">A LuceneIndexNotFoundException is thrown if a Lucene index is requested but not found.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/geode/cache/lucene/LuceneQueryException.html" title="class in org.apache.geode.cache.lucene">LuceneQueryException</a></td> |
| <td class="colLast"> |
| <div class="block">Thrown when a Lucene query fails.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| <a name="package.description"> |
| <!-- --> |
| </a> |
| <h2 title="Package org.apache.geode.cache.lucene Description">Package org.apache.geode.cache.lucene Description</h2> |
| <div class="block">This package provides an integration with Apache Lucene that allows Geode regions to be indexed |
| in a distributed Lucene index and queries using Lucene queries. |
| <p> |
| All indexing and query operations are performed through the |
| <a href="../../../../../org/apache/geode/cache/lucene/LuceneService.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneService</code></a> class. See |
| <a href="../../../../../org/apache/geode/cache/lucene/LuceneService.html" title="interface in org.apache.geode.cache.lucene"><code>LuceneService</code></a> for an example of how to add a Lucene index |
| to a Geode region. |
| <p> |
| |
| The Lucene indexes created using this API are stored in Geode and colocated with the indexed |
| region, which means they have the same availability guarantees as the underlying region. The |
| indexes are maintained asynchronously, so changes to the region may not be immediately visible in |
| the Lucene index.</div> |
| </div> |
| <!-- ======= 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 class="navBarCell1Rev">Package</li> |
| <li>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/execute/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../org/apache/geode/cache/lucene/management/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/geode/cache/lucene/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.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> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
