| <!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>LuceneIndexFactory (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="LuceneIndexFactory (Apache Geode 1.15.1)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":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/LuceneIndexExistsException.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/LuceneIndexNotFoundException.html" title="class 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/LuceneIndexFactory.html" target="_top">Frames</a></li> |
| <li><a href="LuceneIndexFactory.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>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </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 LuceneIndexFactory" class="title">Interface LuceneIndexFactory</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">LuceneIndexFactory</span></pre> |
| <div class="block">A factory for creating a lucene index on the current member. Obtain a factory from |
| <a href="../../../../../org/apache/geode/cache/lucene/LuceneService.html#createIndexFactory--"><code>LuceneService.createIndexFactory()</code></a>. |
| |
| Configure the index using the add methods, and then call <a href="../../../../../org/apache/geode/cache/lucene/LuceneIndexFactory.html#create-java.lang.String-java.lang.String-"><code>create(String, String)</code></a> to |
| create the index.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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><a href="../../../../../org/apache/geode/cache/lucene/LuceneIndexFactory.html" title="interface in org.apache.geode.cache.lucene">LuceneIndexFactory</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/lucene/LuceneIndexFactory.html#addField-java.lang.String-">addField</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> name)</code> |
| <div class="block">Add a field to be indexed</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/geode/cache/lucene/LuceneIndexFactory.html" title="interface in org.apache.geode.cache.lucene">LuceneIndexFactory</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/lucene/LuceneIndexFactory.html#addField-java.lang.String-org.apache.lucene.analysis.Analyzer-">addField</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> name, |
| org.apache.lucene.analysis.Analyzer analyzer)</code> |
| <div class="block">Add a field to be indexed, using the specified analyzer.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/lucene/LuceneIndexFactory.html#create-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> regionPath)</code> |
| <div class="block">Create the index on this member.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/geode/cache/lucene/LuceneIndexFactory.html" title="interface in org.apache.geode.cache.lucene">LuceneIndexFactory</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/lucene/LuceneIndexFactory.html#setFields-java.util.Map-">setFields</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<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>,org.apache.lucene.analysis.Analyzer> fieldMap)</code> |
| <div class="block">Set the list of fields to be indexed.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/geode/cache/lucene/LuceneIndexFactory.html" title="interface in org.apache.geode.cache.lucene">LuceneIndexFactory</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/lucene/LuceneIndexFactory.html#setFields-java.lang.String...-">setFields</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>... fields)</code> |
| <div class="block">Set the list of fields to be indexed.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/geode/cache/lucene/LuceneIndexFactory.html" title="interface in org.apache.geode.cache.lucene">LuceneIndexFactory</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/lucene/LuceneIndexFactory.html#setLuceneSerializer-org.apache.geode.cache.lucene.LuceneSerializer-">setLuceneSerializer</a></span>(<a href="../../../../../org/apache/geode/cache/lucene/LuceneSerializer.html" title="interface in org.apache.geode.cache.lucene">LuceneSerializer</a> luceneSerializer)</code> |
| <div class="block">Configure the way objects are converted to lucene documents for this lucene index</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="addField-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addField</h4> |
| <pre><a href="../../../../../org/apache/geode/cache/lucene/LuceneIndexFactory.html" title="interface in org.apache.geode.cache.lucene">LuceneIndexFactory</a> addField(<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> name)</pre> |
| <div class="block">Add a field to be indexed</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - A field of the object to index. Only fields listed here will be stored in the |
| index. Fields should map to PDX fieldNames if the object is serialized with PDX, or to |
| java fields on the object otherwise. The special field name |
| <a href="../../../../../org/apache/geode/cache/lucene/LuceneService.html#REGION_VALUE_FIELD"><code>LuceneService.REGION_VALUE_FIELD</code></a> indicates that the entire value should be |
| stored as a single field in the index.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this factory</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setFields-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFields</h4> |
| <pre><a href="../../../../../org/apache/geode/cache/lucene/LuceneIndexFactory.html" title="interface in org.apache.geode.cache.lucene">LuceneIndexFactory</a> setFields(<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>... fields)</pre> |
| <div class="block">Set the list of fields to be indexed.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fields</code> - Fields of the object to index. Only fields listed here will be stored in the |
| index. Fields should map to PDX fieldNames if the object is serialized with PDX, or to |
| java fields on the object otherwise. The special field name |
| <a href="../../../../../org/apache/geode/cache/lucene/LuceneService.html#REGION_VALUE_FIELD"><code>LuceneService.REGION_VALUE_FIELD</code></a> indicates that the entire value should be |
| stored as a single field in the index.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this factory</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addField-java.lang.String-org.apache.lucene.analysis.Analyzer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addField</h4> |
| <pre><a href="../../../../../org/apache/geode/cache/lucene/LuceneIndexFactory.html" title="interface in org.apache.geode.cache.lucene">LuceneIndexFactory</a> addField(<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> name, |
| org.apache.lucene.analysis.Analyzer analyzer)</pre> |
| <div class="block">Add a field to be indexed, using the specified analyzer.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - A field of the object to index. Only fields listed here will be stored in the |
| index. Fields should map to PDX fieldNames if the object is serialized with PDX, or to |
| java fields on the object otherwise. The special field name |
| <a href="../../../../../org/apache/geode/cache/lucene/LuceneService.html#REGION_VALUE_FIELD"><code>LuceneService.REGION_VALUE_FIELD</code></a> indicates that the entire value should be |
| stored as a single field in the index.</dd> |
| <dd><code>analyzer</code> - The analyzer to use for this this field. Analyzers are used by Lucene to |
| tokenize your field into individual words.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this factory</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setFields-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFields</h4> |
| <pre><a href="../../../../../org/apache/geode/cache/lucene/LuceneIndexFactory.html" title="interface in org.apache.geode.cache.lucene">LuceneIndexFactory</a> setFields(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<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>,org.apache.lucene.analysis.Analyzer> fieldMap)</pre> |
| <div class="block">Set the list of fields to be indexed.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldMap</code> - Fields of the object to index, with the analyzer to be used for each field. |
| Only fields listed here will be stored in the index. Fields should map to PDX fieldNames |
| if the object is serialized with PDX, or to java fields on the object otherwise. The |
| special field name <a href="../../../../../org/apache/geode/cache/lucene/LuceneService.html#REGION_VALUE_FIELD"><code>LuceneService.REGION_VALUE_FIELD</code></a> indicates that the entire |
| value should be stored as a single field in the index.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this factory</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="create-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>create</h4> |
| <pre>void 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> regionPath)</pre> |
| <div class="block">Create the index on this member.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>indexName</code> - name of the index.</dd> |
| <dd><code>regionPath</code> - The region to index. The entries added to this region will be indexes.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setLuceneSerializer-org.apache.geode.cache.lucene.LuceneSerializer-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setLuceneSerializer</h4> |
| <pre><a href="../../../../../org/apache/geode/cache/lucene/LuceneIndexFactory.html" title="interface in org.apache.geode.cache.lucene">LuceneIndexFactory</a> setLuceneSerializer(<a href="../../../../../org/apache/geode/cache/lucene/LuceneSerializer.html" title="interface in org.apache.geode.cache.lucene">LuceneSerializer</a> luceneSerializer)</pre> |
| <div class="block">Configure the way objects are converted to lucene documents for this lucene index</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>luceneSerializer</code> - A callback which converts a region value to a lucene document or |
| documents to be stored in the index.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this factory</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>Geode 1.4</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/LuceneIndexExistsException.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/LuceneIndexNotFoundException.html" title="class 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/LuceneIndexFactory.html" target="_top">Frames</a></li> |
| <li><a href="LuceneIndexFactory.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>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </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> |
