Added: websites/staging/lucy/trunk/content/docs/c/Lucy/Document/HitDoc.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/Lucy/Document/HitDoc.html (added) +++ websites/staging/lucy/trunk/content/docs/c/Lucy/Document/HitDoc.html Mon Apr 4 12:55:27 2016 @@ -0,0 +1,160 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> + <title>Lucy::Document::HitDoc â C API Documentation</title> + <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css"> + </head> + + <body> + + <div id="lucy-rigid_wrapper"> + + <div id="lucy-top" class="container_16 lucy-white_box_3d"> + + <div id="lucy-logo_box" class="grid_8"> + <a href="/"><img src="/images/lucy_logo_150x100.png" alt="Apache Lucyâ¢"></a> + </div> <!-- lucy-logo_box --> + + <div #id="lucy-top_nav_box" class="grid_8"> + <div id="lucy-top_nav_bar" class="container_8"> + <ul> + <li><a href="http://www.apache.org/"; title="Apache Software Foundation">Apache Software Foundation</a></li> + <li><a href="http://www.apache.org/licenses/"; title="License">License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html"; title="Sponsorship">Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html"; title="Thanks">Thanks</a></li> + <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li> + </ul> + </div> <!-- lucy-top_nav_bar --> + <p><a href="http://www.apache.org/";>Apache</a> » <a href="/">Lucy</a> » <a href="/docs/">Docs</a> » <a href="/docs/c/">C</a> » <a href="/docs/c/Lucy/">Lucy</a> » <a href="/docs/c/Lucy/Document/">Document</a></p> + <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search"; method="get"> + <input value="*.apache.org" name="sitesearch" type="hidden"/> + <input type="text" name="q" id="query" style="width:85%"> + <input type="submit" id="submit" value="Search"> + </form> + </div> <!-- lucy-top_nav_box --> + + <div class="clear"></div> + + </div> <!-- lucy-top --> + + <div id="lucy-main_content" class="container_16 lucy-white_box_3d"> + + <div class="grid_4" id="lucy-left_nav_box"> + <h6>About</h6> + <ul> + <li><a href="/">Welcome</a></li> + <li><a href="/clownfish.html">Clownfish</a></li> + <li><a href="/faq.html">FAQ</a></li> + <li><a href="/people.html">People</a></li> + </ul> + <h6>Resources</h6> + <ul> + <li><a href="/download.html">Download</a></li> + <li><a href="/mailing_lists.html">Mailing Lists</a></li> + <li><a href="/docs/">Documentation</a></li> + <li><a href="http://wiki.apache.org/lucy/";>Wiki</a></li> + <li><a href="https://issues.apache.org/jira/browse/LUCY";>Issue Tracker</a></li> + <li><a href="/version_control.html">Version Control</a></li> + </ul> + <h6>Related Projects</h6> + <ul> + <li><a href="http://lucene.apache.org/core/";>Lucene</a></li> + <li><a href="http://dezi.org/";>Dezi</a></li> + <li><a href="http://lucene.apache.org/solr/";>Solr</a></li> + <li><a href="http://lucenenet.apache.org/";>Lucene.NET</a></li> + <li><a href="http://lucene.apache.org/pylucene/";>PyLucene</a></li> + </ul> + </div> <!-- lucy-left_nav_box --> + + <div id="lucy-main_content_box" class="grid_9"> + <div class="c-api"> +<h2>Lucy::Document::HitDoc</h2> +<table> +<tr> +<td class="label">parcel</td> +<td><a href="../../lucy.html">Lucy</a></td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code><span class="prefix">LUCY_</span>HITDOC</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code><span class="prefix">lucy_</span>HitDoc</code></td> +</tr> +<tr> +<td class="label">class nickname</td> +<td><code><span class="prefix">lucy_</span>HitDoc</code></td> +</tr> +<tr> +<td class="label">header file</td> +<td><code>Lucy/Document/HitDoc.h</code></td> +</tr> +</table> +<h3>Name</h3> +<p>Lucy::Document::HitDoc â A document read from an index.</p> +<h3>Description</h3> +<p>HitDoc is the search-time relative of the index-time class Doc; it is +augmented by a numeric score attribute that Doc doesnât have.</p> +<h3>Methods</h3> +<dl> +<dt id="func_Set_Score">Set_Score</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>HitDoc_Set_Score</strong>( + <span class="prefix">lucy_</span>HitDoc *<strong>self</strong>, + float <strong>score</strong> +); +</code></pre> +<p>Set score attribute.</p> +</dd> +<dt id="func_Get_Score">Get_Score</dt> +<dd> +<pre><code>float +<span class="prefix">lucy_</span><strong>HitDoc_Get_Score</strong>( + <span class="prefix">lucy_</span>HitDoc *<strong>self</strong> +); +</code></pre> +<p>Get score attribute.</p> +</dd> +<dt id="func_Equals">Equals</dt> +<dd> +<pre><code>bool +<span class="prefix">lucy_</span><strong>HitDoc_Equals</strong>( + <span class="prefix">lucy_</span>HitDoc *<strong>self</strong>, + <span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a> *<strong>other</strong> +); +</code></pre> +<p>Indicate whether two objects are the same. By default, compares the +memory address.</p> +<dl> +<dt>other</dt> +<dd><p>Another Obj.</p> +</dd> +</dl> +</dd> +</dl> +<h3>Inheritance</h3> +<p>Lucy::Document::HitDoc is a <a href="../../Lucy/Document/Doc.html">Lucy::Document::Doc</a> is a <a href="../../Clownfish/Obj.html">Clownfish::Obj</a>.</p> +</div> + + </div> <!-- lucy-main_content_box --> + <div class="clear"></div> + + </div> <!-- lucy-main_content --> + + <div id="lucy-copyright" class="container_16"> + <p>Copyright © 2010-2015 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0</a>. + <br/> + Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The + Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their + respective owners. + </p> + </div> <!-- lucy-copyright --> + + </div> <!-- lucy-rigid_wrapper --> + + </body> +</html>
Added: websites/staging/lucy/trunk/content/docs/c/Lucy/Highlight/Highlighter.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/Lucy/Highlight/Highlighter.html (added) +++ websites/staging/lucy/trunk/content/docs/c/Lucy/Highlight/Highlighter.html Mon Apr 4 12:55:27 2016 @@ -0,0 +1,321 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> + <title>Lucy::Highlight::Highlighter â C API Documentation</title> + <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css"> + </head> + + <body> + + <div id="lucy-rigid_wrapper"> + + <div id="lucy-top" class="container_16 lucy-white_box_3d"> + + <div id="lucy-logo_box" class="grid_8"> + <a href="/"><img src="/images/lucy_logo_150x100.png" alt="Apache Lucyâ¢"></a> + </div> <!-- lucy-logo_box --> + + <div #id="lucy-top_nav_box" class="grid_8"> + <div id="lucy-top_nav_bar" class="container_8"> + <ul> + <li><a href="http://www.apache.org/"; title="Apache Software Foundation">Apache Software Foundation</a></li> + <li><a href="http://www.apache.org/licenses/"; title="License">License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html"; title="Sponsorship">Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html"; title="Thanks">Thanks</a></li> + <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li> + </ul> + </div> <!-- lucy-top_nav_bar --> + <p><a href="http://www.apache.org/";>Apache</a> » <a href="/">Lucy</a> » <a href="/docs/">Docs</a> » <a href="/docs/c/">C</a> » <a href="/docs/c/Lucy/">Lucy</a> » <a href="/docs/c/Lucy/Highlight/">Highlight</a></p> + <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search"; method="get"> + <input value="*.apache.org" name="sitesearch" type="hidden"/> + <input type="text" name="q" id="query" style="width:85%"> + <input type="submit" id="submit" value="Search"> + </form> + </div> <!-- lucy-top_nav_box --> + + <div class="clear"></div> + + </div> <!-- lucy-top --> + + <div id="lucy-main_content" class="container_16 lucy-white_box_3d"> + + <div class="grid_4" id="lucy-left_nav_box"> + <h6>About</h6> + <ul> + <li><a href="/">Welcome</a></li> + <li><a href="/clownfish.html">Clownfish</a></li> + <li><a href="/faq.html">FAQ</a></li> + <li><a href="/people.html">People</a></li> + </ul> + <h6>Resources</h6> + <ul> + <li><a href="/download.html">Download</a></li> + <li><a href="/mailing_lists.html">Mailing Lists</a></li> + <li><a href="/docs/">Documentation</a></li> + <li><a href="http://wiki.apache.org/lucy/";>Wiki</a></li> + <li><a href="https://issues.apache.org/jira/browse/LUCY";>Issue Tracker</a></li> + <li><a href="/version_control.html">Version Control</a></li> + </ul> + <h6>Related Projects</h6> + <ul> + <li><a href="http://lucene.apache.org/core/";>Lucene</a></li> + <li><a href="http://dezi.org/";>Dezi</a></li> + <li><a href="http://lucene.apache.org/solr/";>Solr</a></li> + <li><a href="http://lucenenet.apache.org/";>Lucene.NET</a></li> + <li><a href="http://lucene.apache.org/pylucene/";>PyLucene</a></li> + </ul> + </div> <!-- lucy-left_nav_box --> + + <div id="lucy-main_content_box" class="grid_9"> + <div class="c-api"> +<h2>Lucy::Highlight::Highlighter</h2> +<table> +<tr> +<td class="label">parcel</td> +<td><a href="../../lucy.html">Lucy</a></td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code><span class="prefix">LUCY_</span>HIGHLIGHTER</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code><span class="prefix">lucy_</span>Highlighter</code></td> +</tr> +<tr> +<td class="label">class nickname</td> +<td><code><span class="prefix">lucy_</span>Highlighter</code></td> +</tr> +<tr> +<td class="label">header file</td> +<td><code>Lucy/Highlight/Highlighter.h</code></td> +</tr> +</table> +<h3>Name</h3> +<p>Lucy::Highlight::Highlighter â Create and highlight excerpts.</p> +<h3>Description</h3> +<p>The Highlighter can be used to select relevant snippets from a document, +and to surround search terms with highlighting tags. It handles both stems +and phrases correctly and efficiently, using special-purpose data generated +at index-time.</p> +<h3>Functions</h3> +<dl> +<dt id="func_new">new</dt> +<dd> +<pre><code><span class="prefix">lucy_</span>Highlighter* <span class="comment">// incremented</span> +<span class="prefix">lucy_</span><strong>Highlighter_new</strong>( + <span class="prefix">lucy_</span><a href="../../Lucy/Search/Searcher.html">Searcher</a> *<strong>searcher</strong>, + <span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a> *<strong>query</strong>, + <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>field</strong>, + uint32_t <strong>excerpt_length</strong> +); +</code></pre> +<p>Create a new Highlighter.</p> +<dl> +<dt>searcher</dt> +<dd><p>An object which inherits from +<a href="../../Lucy/Search/Searcher.html">Searcher</a>, such as an +<a href="../../Lucy/Search/IndexSearcher.html">IndexSearcher</a>.</p> +</dd> +<dt>query</dt> +<dd><p>Query object or a query string.</p> +</dd> +<dt>field</dt> +<dd><p>The name of the field from which to draw the excerpt. The +field must marked as be <code>highlightable</code> (see +<a href="../../Lucy/Plan/FieldType.html">FieldType</a>).</p> +</dd> +<dt>excerpt_length</dt> +<dd><p>Maximum length of the excerpt, in characters.</p> +</dd> +</dl> +</dd> +<dt id="func_init">init</dt> +<dd> +<pre><code><span class="prefix">lucy_</span>Highlighter* +<span class="prefix">lucy_</span><strong>Highlighter_init</strong>( + <span class="prefix">lucy_</span>Highlighter *<strong>self</strong>, + <span class="prefix">lucy_</span><a href="../../Lucy/Search/Searcher.html">Searcher</a> *<strong>searcher</strong>, + <span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a> *<strong>query</strong>, + <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>field</strong>, + uint32_t <strong>excerpt_length</strong> +); +</code></pre> +<p>Initialize a Highlighter.</p> +<dl> +<dt>searcher</dt> +<dd><p>An object which inherits from +<a href="../../Lucy/Search/Searcher.html">Searcher</a>, such as an +<a href="../../Lucy/Search/IndexSearcher.html">IndexSearcher</a>.</p> +</dd> +<dt>query</dt> +<dd><p>Query object or a query string.</p> +</dd> +<dt>field</dt> +<dd><p>The name of the field from which to draw the excerpt. The +field must marked as be <code>highlightable</code> (see +<a href="../../Lucy/Plan/FieldType.html">FieldType</a>).</p> +</dd> +<dt>excerpt_length</dt> +<dd><p>Maximum length of the excerpt, in characters.</p> +</dd> +</dl> +</dd> +</dl> +<h3>Methods</h3> +<dl> +<dt id="func_Create_Excerpt">Create_Excerpt</dt> +<dd> +<pre><code><span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a>* <span class="comment">// incremented</span> +<span class="prefix">lucy_</span><strong>Highlighter_Create_Excerpt</strong>( + <span class="prefix">lucy_</span>Highlighter *<strong>self</strong>, + <span class="prefix">lucy_</span><a href="../../Lucy/Document/HitDoc.html">HitDoc</a> *<strong>hit_doc</strong> +); +</code></pre> +<p>Take a HitDoc object and return a highlighted excerpt as a string if +the HitDoc has a value for the specified <code>field</code>.</p> +</dd> +<dt id="func_Encode">Encode</dt> +<dd> +<pre><code><span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a>* <span class="comment">// incremented</span> +<span class="prefix">lucy_</span><strong>Highlighter_Encode</strong>( + <span class="prefix">lucy_</span>Highlighter *<strong>self</strong>, + <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>text</strong> +); +</code></pre> +<p>Encode text with HTML entities. This method is called internally by +<a href="../../Lucy/Highlight/Highlighter.html#func_Create_Excerpt">Create_Excerpt()</a> for each text fragment when assembling an excerpt. A +subclass can override this if the text should be encoded differently or +not at all.</p> +</dd> +<dt id="func_Highlight">Highlight</dt> +<dd> +<pre><code><span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a>* <span class="comment">// incremented</span> +<span class="prefix">lucy_</span><strong>Highlighter_Highlight</strong>( + <span class="prefix">lucy_</span>Highlighter *<strong>self</strong>, + <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>text</strong> +); +</code></pre> +<p>Highlight a small section of text. By default, prepends pre-tag and +appends post-tag. This method is called internally by <a href="../../Lucy/Highlight/Highlighter.html#func_Create_Excerpt">Create_Excerpt()</a> +when assembling an excerpt.</p> +</dd> +<dt id="func_Set_Pre_Tag">Set_Pre_Tag</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>Highlighter_Set_Pre_Tag</strong>( + <span class="prefix">lucy_</span>Highlighter *<strong>self</strong>, + <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>pre_tag</strong> +); +</code></pre> +<p>Setter. The default value is â<strong>â.</p> +</dd> +<dt id="func_Set_Post_Tag">Set_Post_Tag</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>Highlighter_Set_Post_Tag</strong>( + <span class="prefix">lucy_</span>Highlighter *<strong>self</strong>, + <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>post_tag</strong> +); +</code></pre> +<p>Setter. The default value is â</strong>â.</p> +</dd> +<dt id="func_Get_Pre_Tag">Get_Pre_Tag</dt> +<dd> +<pre><code><span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a>* +<span class="prefix">lucy_</span><strong>Highlighter_Get_Pre_Tag</strong>( + <span class="prefix">lucy_</span>Highlighter *<strong>self</strong> +); +</code></pre> +<p>Accessor.</p> +</dd> +<dt id="func_Get_Post_Tag">Get_Post_Tag</dt> +<dd> +<pre><code><span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a>* +<span class="prefix">lucy_</span><strong>Highlighter_Get_Post_Tag</strong>( + <span class="prefix">lucy_</span>Highlighter *<strong>self</strong> +); +</code></pre> +<p>Accessor.</p> +</dd> +<dt id="func_Get_Field">Get_Field</dt> +<dd> +<pre><code><span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a>* +<span class="prefix">lucy_</span><strong>Highlighter_Get_Field</strong>( + <span class="prefix">lucy_</span>Highlighter *<strong>self</strong> +); +</code></pre> +<p>Accessor.</p> +</dd> +<dt id="func_Get_Excerpt_Length">Get_Excerpt_Length</dt> +<dd> +<pre><code>uint32_t +<span class="prefix">lucy_</span><strong>Highlighter_Get_Excerpt_Length</strong>( + <span class="prefix">lucy_</span>Highlighter *<strong>self</strong> +); +</code></pre> +<p>Accessor.</p> +</dd> +<dt id="func_Get_Searcher">Get_Searcher</dt> +<dd> +<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Search/Searcher.html">Searcher</a>* +<span class="prefix">lucy_</span><strong>Highlighter_Get_Searcher</strong>( + <span class="prefix">lucy_</span>Highlighter *<strong>self</strong> +); +</code></pre> +<p>Accessor.</p> +</dd> +<dt id="func_Get_Query">Get_Query</dt> +<dd> +<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Search/Query.html">Query</a>* +<span class="prefix">lucy_</span><strong>Highlighter_Get_Query</strong>( + <span class="prefix">lucy_</span>Highlighter *<strong>self</strong> +); +</code></pre> +<p>Accessor.</p> +</dd> +<dt id="func_Get_Compiler">Get_Compiler</dt> +<dd> +<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Search/Compiler.html">Compiler</a>* +<span class="prefix">lucy_</span><strong>Highlighter_Get_Compiler</strong>( + <span class="prefix">lucy_</span>Highlighter *<strong>self</strong> +); +</code></pre> +<p>Accessor for the Lucy::Search::Compiler object derived from +<code>query</code> and <code>searcher</code>.</p> +</dd> +<dt id="func_Destroy">Destroy</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>Highlighter_Destroy</strong>( + <span class="prefix">lucy_</span>Highlighter *<strong>self</strong> +); +</code></pre> +<p>Generic destructor. Frees the struct itself but not any complex +member elements.</p> +</dd> +</dl> +<h3>Inheritance</h3> +<p>Lucy::Highlight::Highlighter is a <a href="../../Clownfish/Obj.html">Clownfish::Obj</a>.</p> +</div> + + </div> <!-- lucy-main_content_box --> + <div class="clear"></div> + + </div> <!-- lucy-main_content --> + + <div id="lucy-copyright" class="container_16"> + <p>Copyright © 2010-2015 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0</a>. + <br/> + Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The + Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their + respective owners. + </p> + </div> <!-- lucy-copyright --> + + </div> <!-- lucy-rigid_wrapper --> + + </body> +</html> Added: websites/staging/lucy/trunk/content/docs/c/Lucy/Index/BackgroundMerger.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/Lucy/Index/BackgroundMerger.html (added) +++ websites/staging/lucy/trunk/content/docs/c/Lucy/Index/BackgroundMerger.html Mon Apr 4 12:55:27 2016 @@ -0,0 +1,215 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> + <title>Lucy::Index::BackgroundMerger â C API Documentation</title> + <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css"> + </head> + + <body> + + <div id="lucy-rigid_wrapper"> + + <div id="lucy-top" class="container_16 lucy-white_box_3d"> + + <div id="lucy-logo_box" class="grid_8"> + <a href="/"><img src="/images/lucy_logo_150x100.png" alt="Apache Lucyâ¢"></a> + </div> <!-- lucy-logo_box --> + + <div #id="lucy-top_nav_box" class="grid_8"> + <div id="lucy-top_nav_bar" class="container_8"> + <ul> + <li><a href="http://www.apache.org/"; title="Apache Software Foundation">Apache Software Foundation</a></li> + <li><a href="http://www.apache.org/licenses/"; title="License">License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html"; title="Sponsorship">Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html"; title="Thanks">Thanks</a></li> + <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li> + </ul> + </div> <!-- lucy-top_nav_bar --> + <p><a href="http://www.apache.org/";>Apache</a> » <a href="/">Lucy</a> » <a href="/docs/">Docs</a> » <a href="/docs/c/">C</a> » <a href="/docs/c/Lucy/">Lucy</a> » <a href="/docs/c/Lucy/Index/">Index</a></p> + <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search"; method="get"> + <input value="*.apache.org" name="sitesearch" type="hidden"/> + <input type="text" name="q" id="query" style="width:85%"> + <input type="submit" id="submit" value="Search"> + </form> + </div> <!-- lucy-top_nav_box --> + + <div class="clear"></div> + + </div> <!-- lucy-top --> + + <div id="lucy-main_content" class="container_16 lucy-white_box_3d"> + + <div class="grid_4" id="lucy-left_nav_box"> + <h6>About</h6> + <ul> + <li><a href="/">Welcome</a></li> + <li><a href="/clownfish.html">Clownfish</a></li> + <li><a href="/faq.html">FAQ</a></li> + <li><a href="/people.html">People</a></li> + </ul> + <h6>Resources</h6> + <ul> + <li><a href="/download.html">Download</a></li> + <li><a href="/mailing_lists.html">Mailing Lists</a></li> + <li><a href="/docs/">Documentation</a></li> + <li><a href="http://wiki.apache.org/lucy/";>Wiki</a></li> + <li><a href="https://issues.apache.org/jira/browse/LUCY";>Issue Tracker</a></li> + <li><a href="/version_control.html">Version Control</a></li> + </ul> + <h6>Related Projects</h6> + <ul> + <li><a href="http://lucene.apache.org/core/";>Lucene</a></li> + <li><a href="http://dezi.org/";>Dezi</a></li> + <li><a href="http://lucene.apache.org/solr/";>Solr</a></li> + <li><a href="http://lucenenet.apache.org/";>Lucene.NET</a></li> + <li><a href="http://lucene.apache.org/pylucene/";>PyLucene</a></li> + </ul> + </div> <!-- lucy-left_nav_box --> + + <div id="lucy-main_content_box" class="grid_9"> + <div class="c-api"> +<h2>Lucy::Index::BackgroundMerger</h2> +<table> +<tr> +<td class="label">parcel</td> +<td><a href="../../lucy.html">Lucy</a></td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code><span class="prefix">LUCY_</span>BACKGROUNDMERGER</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code><span class="prefix">lucy_</span>BackgroundMerger</code></td> +</tr> +<tr> +<td class="label">class nickname</td> +<td><code><span class="prefix">lucy_</span>BGMerger</code></td> +</tr> +<tr> +<td class="label">header file</td> +<td><code>Lucy/Index/BackgroundMerger.h</code></td> +</tr> +</table> +<h3>Name</h3> +<p>Lucy::Index::BackgroundMerger â Consolidate index segments in the background.</p> +<h3>Description</h3> +<p>Adding documents to an index is usually fast, but every once in a while the +index must be compacted and an update takes substantially longer to +complete. See <a href="../../Lucy/Docs/Cookbook/FastUpdates.html">FastUpdates</a> for how to use this class to control +worst-case index update performance.</p> +<p>As with <a href="../../Lucy/Index/Indexer.html">Indexer</a>, see <a href="../../Lucy/Docs/FileLocking.html">FileLocking</a> if your index is on a +shared volume.</p> +<h3>Functions</h3> +<dl> +<dt id="func_new">new</dt> +<dd> +<pre><code><span class="prefix">lucy_</span>BackgroundMerger* <span class="comment">// incremented</span> +<span class="prefix">lucy_</span><strong>BGMerger_new</strong>( + <span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a> *<strong>index</strong>, + <span class="prefix">lucy_</span><a href="../../Lucy/Index/IndexManager.html">IndexManager</a> *<strong>manager</strong> +); +</code></pre> +<p>Open a new BackgroundMerger.</p> +<dl> +<dt>index</dt> +<dd><p>Either a string filepath or a Folder.</p> +</dd> +<dt>manager</dt> +<dd><p>An IndexManager. If not supplied, an IndexManager with +a 10-second write lock timeout will be created.</p> +</dd> +</dl> +</dd> +<dt id="func_init">init</dt> +<dd> +<pre><code><span class="prefix">lucy_</span>BackgroundMerger* +<span class="prefix">lucy_</span><strong>BGMerger_init</strong>( + <span class="prefix">lucy_</span>BackgroundMerger *<strong>self</strong>, + <span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a> *<strong>index</strong>, + <span class="prefix">lucy_</span><a href="../../Lucy/Index/IndexManager.html">IndexManager</a> *<strong>manager</strong> +); +</code></pre> +<p>Initialize a BackgroundMerger.</p> +<dl> +<dt>index</dt> +<dd><p>Either a string filepath or a Folder.</p> +</dd> +<dt>manager</dt> +<dd><p>An IndexManager. If not supplied, an IndexManager with +a 10-second write lock timeout will be created.</p> +</dd> +</dl> +</dd> +</dl> +<h3>Methods</h3> +<dl> +<dt id="func_Optimize">Optimize</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>BGMerger_Optimize</strong>( + <span class="prefix">lucy_</span>BackgroundMerger *<strong>self</strong> +); +</code></pre> +<p>Optimize the index for search-time performance. This may take a +while, as it can involve rewriting large amounts of data.</p> +</dd> +<dt id="func_Commit">Commit</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>BGMerger_Commit</strong>( + <span class="prefix">lucy_</span>BackgroundMerger *<strong>self</strong> +); +</code></pre> +<p>Commit any changes made to the index. Until this is called, none of +the changes made during an indexing session are permanent.</p> +<p>Calls <a href="../../Lucy/Index/BackgroundMerger.html#func_Prepare_Commit">Prepare_Commit()</a> implicitly if it has not already been called.</p> +</dd> +<dt id="func_Prepare_Commit">Prepare_Commit</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>BGMerger_Prepare_Commit</strong>( + <span class="prefix">lucy_</span>BackgroundMerger *<strong>self</strong> +); +</code></pre> +<p>Perform the expensive setup for <a href="../../Lucy/Index/BackgroundMerger.html#func_Commit">Commit()</a> in advance, so that <a href="../../Lucy/Index/BackgroundMerger.html#func_Commit">Commit()</a> +completes quickly.</p> +<p>Towards the end of <a href="../../Lucy/Index/BackgroundMerger.html#func_Prepare_Commit">Prepare_Commit()</a>, the BackgroundMerger attempts to +re-acquire the write lock, which is then held until <a href="../../Lucy/Index/BackgroundMerger.html#func_Commit">Commit()</a> finishes +and releases it.</p> +</dd> +<dt id="func_Destroy">Destroy</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>BGMerger_Destroy</strong>( + <span class="prefix">lucy_</span>BackgroundMerger *<strong>self</strong> +); +</code></pre> +<p>Generic destructor. Frees the struct itself but not any complex +member elements.</p> +</dd> +</dl> +<h3>Inheritance</h3> +<p>Lucy::Index::BackgroundMerger is a <a href="../../Clownfish/Obj.html">Clownfish::Obj</a>.</p> +</div> + + </div> <!-- lucy-main_content_box --> + <div class="clear"></div> + + </div> <!-- lucy-main_content --> + + <div id="lucy-copyright" class="container_16"> + <p>Copyright © 2010-2015 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0</a>. + <br/> + Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The + Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their + respective owners. + </p> + </div> <!-- lucy-copyright --> + + </div> <!-- lucy-rigid_wrapper --> + + </body> +</html> Added: websites/staging/lucy/trunk/content/docs/c/Lucy/Index/DataReader.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/Lucy/Index/DataReader.html (added) +++ websites/staging/lucy/trunk/content/docs/c/Lucy/Index/DataReader.html Mon Apr 4 12:55:27 2016 @@ -0,0 +1,247 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> + <title>Lucy::Index::DataReader â C API Documentation</title> + <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css"> + </head> + + <body> + + <div id="lucy-rigid_wrapper"> + + <div id="lucy-top" class="container_16 lucy-white_box_3d"> + + <div id="lucy-logo_box" class="grid_8"> + <a href="/"><img src="/images/lucy_logo_150x100.png" alt="Apache Lucyâ¢"></a> + </div> <!-- lucy-logo_box --> + + <div #id="lucy-top_nav_box" class="grid_8"> + <div id="lucy-top_nav_bar" class="container_8"> + <ul> + <li><a href="http://www.apache.org/"; title="Apache Software Foundation">Apache Software Foundation</a></li> + <li><a href="http://www.apache.org/licenses/"; title="License">License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html"; title="Sponsorship">Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html"; title="Thanks">Thanks</a></li> + <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li> + </ul> + </div> <!-- lucy-top_nav_bar --> + <p><a href="http://www.apache.org/";>Apache</a> » <a href="/">Lucy</a> » <a href="/docs/">Docs</a> » <a href="/docs/c/">C</a> » <a href="/docs/c/Lucy/">Lucy</a> » <a href="/docs/c/Lucy/Index/">Index</a></p> + <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search"; method="get"> + <input value="*.apache.org" name="sitesearch" type="hidden"/> + <input type="text" name="q" id="query" style="width:85%"> + <input type="submit" id="submit" value="Search"> + </form> + </div> <!-- lucy-top_nav_box --> + + <div class="clear"></div> + + </div> <!-- lucy-top --> + + <div id="lucy-main_content" class="container_16 lucy-white_box_3d"> + + <div class="grid_4" id="lucy-left_nav_box"> + <h6>About</h6> + <ul> + <li><a href="/">Welcome</a></li> + <li><a href="/clownfish.html">Clownfish</a></li> + <li><a href="/faq.html">FAQ</a></li> + <li><a href="/people.html">People</a></li> + </ul> + <h6>Resources</h6> + <ul> + <li><a href="/download.html">Download</a></li> + <li><a href="/mailing_lists.html">Mailing Lists</a></li> + <li><a href="/docs/">Documentation</a></li> + <li><a href="http://wiki.apache.org/lucy/";>Wiki</a></li> + <li><a href="https://issues.apache.org/jira/browse/LUCY";>Issue Tracker</a></li> + <li><a href="/version_control.html">Version Control</a></li> + </ul> + <h6>Related Projects</h6> + <ul> + <li><a href="http://lucene.apache.org/core/";>Lucene</a></li> + <li><a href="http://dezi.org/";>Dezi</a></li> + <li><a href="http://lucene.apache.org/solr/";>Solr</a></li> + <li><a href="http://lucenenet.apache.org/";>Lucene.NET</a></li> + <li><a href="http://lucene.apache.org/pylucene/";>PyLucene</a></li> + </ul> + </div> <!-- lucy-left_nav_box --> + + <div id="lucy-main_content_box" class="grid_9"> + <div class="c-api"> +<h2>Lucy::Index::DataReader</h2> +<table> +<tr> +<td class="label">parcel</td> +<td><a href="../../lucy.html">Lucy</a></td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code><span class="prefix">LUCY_</span>DATAREADER</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code><span class="prefix">lucy_</span>DataReader</code></td> +</tr> +<tr> +<td class="label">class nickname</td> +<td><code><span class="prefix">lucy_</span>DataReader</code></td> +</tr> +<tr> +<td class="label">header file</td> +<td><code>Lucy/Index/DataReader.h</code></td> +</tr> +</table> +<h3>Name</h3> +<p>Lucy::Index::DataReader â Abstract base class for reading index data.</p> +<h3>Description</h3> +<p>DataReader is the companion class to +<a href="../../Lucy/Index/DataWriter.html">DataWriter</a>. Every index component will +implement one of each.</p> +<h3>Functions</h3> +<dl> +<dt id="func_init">init</dt> +<dd> +<pre><code><span class="prefix">lucy_</span>DataReader* +<span class="prefix">lucy_</span><strong>DataReader_init</strong>( + <span class="prefix">lucy_</span>DataReader *<strong>self</strong>, + <span class="prefix">lucy_</span><a href="../../Lucy/Plan/Schema.html">Schema</a> *<strong>schema</strong>, + <span class="prefix">lucy_</span><a href="../../Lucy/Store/Folder.html">Folder</a> *<strong>folder</strong>, + <span class="prefix">lucy_</span><a href="../../Lucy/Index/Snapshot.html">Snapshot</a> *<strong>snapshot</strong>, + <span class="prefix">cfish_</span><a href="../../Clownfish/Vector.html">Vector</a> *<strong>segments</strong>, + int32_t <strong>seg_tick</strong> +); +</code></pre> +<p>Abstract initializer.</p> +<dl> +<dt>schema</dt> +<dd><p>A Schema.</p> +</dd> +<dt>folder</dt> +<dd><p>A Folder.</p> +</dd> +<dt>snapshot</dt> +<dd><p>A Snapshot.</p> +</dd> +<dt>segments</dt> +<dd><p>An array of Segments.</p> +</dd> +<dt>seg_tick</dt> +<dd><p>The array index of the Segment object within the +<code>segments</code> array that this particular DataReader is assigned +to, if any. A value of -1 indicates that no Segment should be +assigned.</p> +</dd> +</dl> +</dd> +</dl> +<h3>Methods</h3> +<dl> +<dt id="func_Aggregator">Aggregator <span class="comment">(abstract)</span></dt> +<dd> +<pre><code><span class="prefix">lucy_</span>DataReader* <span class="comment">// incremented</span> +<span class="prefix">lucy_</span><strong>DataReader_Aggregator</strong>( + <span class="prefix">lucy_</span>DataReader *<strong>self</strong>, + <span class="prefix">cfish_</span><a href="../../Clownfish/Vector.html">Vector</a> *<strong>readers</strong>, + <span class="prefix">lucy_</span><a href="../../Lucy/Object/I32Array.html">I32Array</a> *<strong>offsets</strong> +); +</code></pre> +<p>Create a reader which aggregates the output of several lower level +readers. Return NULL if such a reader is not valid.</p> +<dl> +<dt>readers</dt> +<dd><p>An array of DataReaders.</p> +</dd> +<dt>offsets</dt> +<dd><p>Doc id start offsets for each reader.</p> +</dd> +</dl> +</dd> +<dt id="func_Get_Schema">Get_Schema</dt> +<dd> +<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Plan/Schema.html">Schema</a>* +<span class="prefix">lucy_</span><strong>DataReader_Get_Schema</strong>( + <span class="prefix">lucy_</span>DataReader *<strong>self</strong> +); +</code></pre> +<p>Accessor for âschemaâ member var.</p> +</dd> +<dt id="func_Get_Folder">Get_Folder</dt> +<dd> +<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Store/Folder.html">Folder</a>* +<span class="prefix">lucy_</span><strong>DataReader_Get_Folder</strong>( + <span class="prefix">lucy_</span>DataReader *<strong>self</strong> +); +</code></pre> +<p>Accessor for âfolderâ member var.</p> +</dd> +<dt id="func_Get_Snapshot">Get_Snapshot</dt> +<dd> +<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Index/Snapshot.html">Snapshot</a>* +<span class="prefix">lucy_</span><strong>DataReader_Get_Snapshot</strong>( + <span class="prefix">lucy_</span>DataReader *<strong>self</strong> +); +</code></pre> +<p>Accessor for âsnapshotâ member var.</p> +</dd> +<dt id="func_Get_Segments">Get_Segments</dt> +<dd> +<pre><code><span class="prefix">cfish_</span><a href="../../Clownfish/Vector.html">Vector</a>* +<span class="prefix">lucy_</span><strong>DataReader_Get_Segments</strong>( + <span class="prefix">lucy_</span>DataReader *<strong>self</strong> +); +</code></pre> +<p>Accessor for âsegmentsâ member var.</p> +</dd> +<dt id="func_Get_Segment">Get_Segment</dt> +<dd> +<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Index/Segment.html">Segment</a>* +<span class="prefix">lucy_</span><strong>DataReader_Get_Segment</strong>( + <span class="prefix">lucy_</span>DataReader *<strong>self</strong> +); +</code></pre> +<p>Accessor for âsegmentâ member var.</p> +</dd> +<dt id="func_Get_Seg_Tick">Get_Seg_Tick</dt> +<dd> +<pre><code>int32_t +<span class="prefix">lucy_</span><strong>DataReader_Get_Seg_Tick</strong>( + <span class="prefix">lucy_</span>DataReader *<strong>self</strong> +); +</code></pre> +<p>Accessor for âseg_tickâ member var.</p> +</dd> +<dt id="func_Destroy">Destroy</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>DataReader_Destroy</strong>( + <span class="prefix">lucy_</span>DataReader *<strong>self</strong> +); +</code></pre> +<p>Generic destructor. Frees the struct itself but not any complex +member elements.</p> +</dd> +</dl> +<h3>Inheritance</h3> +<p>Lucy::Index::DataReader is a <a href="../../Clownfish/Obj.html">Clownfish::Obj</a>.</p> +</div> + + </div> <!-- lucy-main_content_box --> + <div class="clear"></div> + + </div> <!-- lucy-main_content --> + + <div id="lucy-copyright" class="container_16"> + <p>Copyright © 2010-2015 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0</a>. + <br/> + Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The + Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their + respective owners. + </p> + </div> <!-- lucy-copyright --> + + </div> <!-- lucy-rigid_wrapper --> + + </body> +</html> Added: websites/staging/lucy/trunk/content/docs/c/Lucy/Index/DataWriter.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/Lucy/Index/DataWriter.html (added) +++ websites/staging/lucy/trunk/content/docs/c/Lucy/Index/DataWriter.html Mon Apr 4 12:55:27 2016 @@ -0,0 +1,311 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> + <title>Lucy::Index::DataWriter â C API Documentation</title> + <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css"> + </head> + + <body> + + <div id="lucy-rigid_wrapper"> + + <div id="lucy-top" class="container_16 lucy-white_box_3d"> + + <div id="lucy-logo_box" class="grid_8"> + <a href="/"><img src="/images/lucy_logo_150x100.png" alt="Apache Lucyâ¢"></a> + </div> <!-- lucy-logo_box --> + + <div #id="lucy-top_nav_box" class="grid_8"> + <div id="lucy-top_nav_bar" class="container_8"> + <ul> + <li><a href="http://www.apache.org/"; title="Apache Software Foundation">Apache Software Foundation</a></li> + <li><a href="http://www.apache.org/licenses/"; title="License">License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html"; title="Sponsorship">Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html"; title="Thanks">Thanks</a></li> + <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li> + </ul> + </div> <!-- lucy-top_nav_bar --> + <p><a href="http://www.apache.org/";>Apache</a> » <a href="/">Lucy</a> » <a href="/docs/">Docs</a> » <a href="/docs/c/">C</a> » <a href="/docs/c/Lucy/">Lucy</a> » <a href="/docs/c/Lucy/Index/">Index</a></p> + <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search"; method="get"> + <input value="*.apache.org" name="sitesearch" type="hidden"/> + <input type="text" name="q" id="query" style="width:85%"> + <input type="submit" id="submit" value="Search"> + </form> + </div> <!-- lucy-top_nav_box --> + + <div class="clear"></div> + + </div> <!-- lucy-top --> + + <div id="lucy-main_content" class="container_16 lucy-white_box_3d"> + + <div class="grid_4" id="lucy-left_nav_box"> + <h6>About</h6> + <ul> + <li><a href="/">Welcome</a></li> + <li><a href="/clownfish.html">Clownfish</a></li> + <li><a href="/faq.html">FAQ</a></li> + <li><a href="/people.html">People</a></li> + </ul> + <h6>Resources</h6> + <ul> + <li><a href="/download.html">Download</a></li> + <li><a href="/mailing_lists.html">Mailing Lists</a></li> + <li><a href="/docs/">Documentation</a></li> + <li><a href="http://wiki.apache.org/lucy/";>Wiki</a></li> + <li><a href="https://issues.apache.org/jira/browse/LUCY";>Issue Tracker</a></li> + <li><a href="/version_control.html">Version Control</a></li> + </ul> + <h6>Related Projects</h6> + <ul> + <li><a href="http://lucene.apache.org/core/";>Lucene</a></li> + <li><a href="http://dezi.org/";>Dezi</a></li> + <li><a href="http://lucene.apache.org/solr/";>Solr</a></li> + <li><a href="http://lucenenet.apache.org/";>Lucene.NET</a></li> + <li><a href="http://lucene.apache.org/pylucene/";>PyLucene</a></li> + </ul> + </div> <!-- lucy-left_nav_box --> + + <div id="lucy-main_content_box" class="grid_9"> + <div class="c-api"> +<h2>Lucy::Index::DataWriter</h2> +<table> +<tr> +<td class="label">parcel</td> +<td><a href="../../lucy.html">Lucy</a></td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code><span class="prefix">LUCY_</span>DATAWRITER</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code><span class="prefix">lucy_</span>DataWriter</code></td> +</tr> +<tr> +<td class="label">class nickname</td> +<td><code><span class="prefix">lucy_</span>DataWriter</code></td> +</tr> +<tr> +<td class="label">header file</td> +<td><code>Lucy/Index/DataWriter.h</code></td> +</tr> +</table> +<h3>Name</h3> +<p>Lucy::Index::DataWriter â Write data to an index.</p> +<h3>Description</h3> +<p>DataWriter is an abstract base class for writing index data, generally in +segment-sized chunks. Each component of an index â e.g. stored fields, +lexicon, postings, deletions â is represented by a +DataWriter/<a href="../../Lucy/Index/DataReader.html">DataReader</a> pair.</p> +<p>Components may be specified per index by subclassing +<a href="../../Lucy/Plan/Architecture.html">Architecture</a>.</p> +<h3>Functions</h3> +<dl> +<dt id="func_init">init</dt> +<dd> +<pre><code><span class="prefix">lucy_</span>DataWriter* +<span class="prefix">lucy_</span><strong>DataWriter_init</strong>( + <span class="prefix">lucy_</span>DataWriter *<strong>self</strong>, + <span class="prefix">lucy_</span><a href="../../Lucy/Plan/Schema.html">Schema</a> *<strong>schema</strong>, + <span class="prefix">lucy_</span><a href="../../Lucy/Index/Snapshot.html">Snapshot</a> *<strong>snapshot</strong>, + <span class="prefix">lucy_</span><a href="../../Lucy/Index/Segment.html">Segment</a> *<strong>segment</strong>, + <span class="prefix">lucy_</span><a href="../../Lucy/Index/PolyReader.html">PolyReader</a> *<strong>polyreader</strong> +); +</code></pre> +<p>Abstract initializer.</p> +<dl> +<dt>snapshot</dt> +<dd><p>The Snapshot that will be committed at the end of the +indexing session.</p> +</dd> +<dt>segment</dt> +<dd><p>The Segment in progress.</p> +</dd> +<dt>polyreader</dt> +<dd><p>A PolyReader representing all existing data in the +index. (If the index is brand new, the PolyReader will have no +sub-readers).</p> +</dd> +</dl> +</dd> +</dl> +<h3>Methods</h3> +<dl> +<dt id="func_Add_Segment">Add_Segment <span class="comment">(abstract)</span></dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>DataWriter_Add_Segment</strong>( + <span class="prefix">lucy_</span>DataWriter *<strong>self</strong>, + <span class="prefix">lucy_</span><a href="../../Lucy/Index/SegReader.html">SegReader</a> *<strong>reader</strong>, + <span class="prefix">lucy_</span><a href="../../Lucy/Object/I32Array.html">I32Array</a> *<strong>doc_map</strong> +); +</code></pre> +<p>Add content from an existing segment into the one currently being +written.</p> +<dl> +<dt>reader</dt> +<dd><p>The SegReader containing content to add.</p> +</dd> +<dt>doc_map</dt> +<dd><p>An array of integers mapping old document ids to +new. Deleted documents are mapped to 0, indicating that they should be +skipped.</p> +</dd> +</dl> +</dd> +<dt id="func_Delete_Segment">Delete_Segment</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>DataWriter_Delete_Segment</strong>( + <span class="prefix">lucy_</span>DataWriter *<strong>self</strong>, + <span class="prefix">lucy_</span><a href="../../Lucy/Index/SegReader.html">SegReader</a> *<strong>reader</strong> +); +</code></pre> +<p>Remove a segmentâs data. The default implementation is a no-op, as +all files within the segment directory will be automatically deleted. +Subclasses which manage their own files outside of the segment system +should override this method and use it as a trigger for cleaning up +obsolete data.</p> +<dl> +<dt>reader</dt> +<dd><p>The SegReader containing content to merge, which must +represent a segment which is part of the the current snapshot.</p> +</dd> +</dl> +</dd> +<dt id="func_Merge_Segment">Merge_Segment</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>DataWriter_Merge_Segment</strong>( + <span class="prefix">lucy_</span>DataWriter *<strong>self</strong>, + <span class="prefix">lucy_</span><a href="../../Lucy/Index/SegReader.html">SegReader</a> *<strong>reader</strong>, + <span class="prefix">lucy_</span><a href="../../Lucy/Object/I32Array.html">I32Array</a> *<strong>doc_map</strong> +); +</code></pre> +<p>Move content from an existing segment into the one currently being +written.</p> +<p>The default implementation calls <a href="../../Lucy/Index/DataWriter.html#func_Add_Segment">Add_Segment()</a> then <a href="../../Lucy/Index/DataWriter.html#func_Delete_Segment">Delete_Segment()</a>.</p> +<dl> +<dt>reader</dt> +<dd><p>The SegReader containing content to merge, which must +represent a segment which is part of the the current snapshot.</p> +</dd> +<dt>doc_map</dt> +<dd><p>An array of integers mapping old document ids to +new. Deleted documents are mapped to 0, indicating that they should be +skipped.</p> +</dd> +</dl> +</dd> +<dt id="func_Finish">Finish <span class="comment">(abstract)</span></dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>DataWriter_Finish</strong>( + <span class="prefix">lucy_</span>DataWriter *<strong>self</strong> +); +</code></pre> +<p>Complete the segment: close all streams, store metadata, etc.</p> +</dd> +<dt id="func_Metadata">Metadata</dt> +<dd> +<pre><code><span class="prefix">cfish_</span><a href="../../Clownfish/Hash.html">Hash</a>* <span class="comment">// incremented</span> +<span class="prefix">lucy_</span><strong>DataWriter_Metadata</strong>( + <span class="prefix">lucy_</span>DataWriter *<strong>self</strong> +); +</code></pre> +<p>Arbitrary metadata to be serialized and stored by the Segment. The +default implementation supplies a hash with a single key-value pair for +âformatâ.</p> +</dd> +<dt id="func_Format">Format <span class="comment">(abstract)</span></dt> +<dd> +<pre><code>int32_t +<span class="prefix">lucy_</span><strong>DataWriter_Format</strong>( + <span class="prefix">lucy_</span>DataWriter *<strong>self</strong> +); +</code></pre> +<p>Every writer must specify a file format revision number, which should +increment each time the format changes. Responsibility for revision +checking is left to the companion DataReader.</p> +</dd> +<dt id="func_Get_Snapshot">Get_Snapshot</dt> +<dd> +<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Index/Snapshot.html">Snapshot</a>* +<span class="prefix">lucy_</span><strong>DataWriter_Get_Snapshot</strong>( + <span class="prefix">lucy_</span>DataWriter *<strong>self</strong> +); +</code></pre> +<p>Accessor for âsnapshotâ member var.</p> +</dd> +<dt id="func_Get_Segment">Get_Segment</dt> +<dd> +<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Index/Segment.html">Segment</a>* +<span class="prefix">lucy_</span><strong>DataWriter_Get_Segment</strong>( + <span class="prefix">lucy_</span>DataWriter *<strong>self</strong> +); +</code></pre> +<p>Accessor for âsegmentâ member var.</p> +</dd> +<dt id="func_Get_PolyReader">Get_PolyReader</dt> +<dd> +<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Index/PolyReader.html">PolyReader</a>* +<span class="prefix">lucy_</span><strong>DataWriter_Get_PolyReader</strong>( + <span class="prefix">lucy_</span>DataWriter *<strong>self</strong> +); +</code></pre> +<p>Accessor for âpolyreaderâ member var.</p> +</dd> +<dt id="func_Get_Schema">Get_Schema</dt> +<dd> +<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Plan/Schema.html">Schema</a>* +<span class="prefix">lucy_</span><strong>DataWriter_Get_Schema</strong>( + <span class="prefix">lucy_</span>DataWriter *<strong>self</strong> +); +</code></pre> +<p>Accessor for âschemaâ member var.</p> +</dd> +<dt id="func_Get_Folder">Get_Folder</dt> +<dd> +<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Store/Folder.html">Folder</a>* +<span class="prefix">lucy_</span><strong>DataWriter_Get_Folder</strong>( + <span class="prefix">lucy_</span>DataWriter *<strong>self</strong> +); +</code></pre> +<p>Accessor for âfolderâ member var.</p> +</dd> +<dt id="func_Destroy">Destroy</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>DataWriter_Destroy</strong>( + <span class="prefix">lucy_</span>DataWriter *<strong>self</strong> +); +</code></pre> +<p>Generic destructor. Frees the struct itself but not any complex +member elements.</p> +</dd> +</dl> +<h3>Inheritance</h3> +<p>Lucy::Index::DataWriter is a <a href="../../Clownfish/Obj.html">Clownfish::Obj</a>.</p> +</div> + + </div> <!-- lucy-main_content_box --> + <div class="clear"></div> + + </div> <!-- lucy-main_content --> + + <div id="lucy-copyright" class="container_16"> + <p>Copyright © 2010-2015 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0</a>. + <br/> + Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The + Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their + respective owners. + </p> + </div> <!-- lucy-copyright --> + + </div> <!-- lucy-rigid_wrapper --> + + </body> +</html> Added: websites/staging/lucy/trunk/content/docs/c/Lucy/Index/DeletionsWriter.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/Lucy/Index/DeletionsWriter.html (added) +++ websites/staging/lucy/trunk/content/docs/c/Lucy/Index/DeletionsWriter.html Mon Apr 4 12:55:27 2016 @@ -0,0 +1,193 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> + <title>Lucy::Index::DeletionsWriter â C API Documentation</title> + <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css"> + </head> + + <body> + + <div id="lucy-rigid_wrapper"> + + <div id="lucy-top" class="container_16 lucy-white_box_3d"> + + <div id="lucy-logo_box" class="grid_8"> + <a href="/"><img src="/images/lucy_logo_150x100.png" alt="Apache Lucyâ¢"></a> + </div> <!-- lucy-logo_box --> + + <div #id="lucy-top_nav_box" class="grid_8"> + <div id="lucy-top_nav_bar" class="container_8"> + <ul> + <li><a href="http://www.apache.org/"; title="Apache Software Foundation">Apache Software Foundation</a></li> + <li><a href="http://www.apache.org/licenses/"; title="License">License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html"; title="Sponsorship">Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html"; title="Thanks">Thanks</a></li> + <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li> + </ul> + </div> <!-- lucy-top_nav_bar --> + <p><a href="http://www.apache.org/";>Apache</a> » <a href="/">Lucy</a> » <a href="/docs/">Docs</a> » <a href="/docs/c/">C</a> » <a href="/docs/c/Lucy/">Lucy</a> » <a href="/docs/c/Lucy/Index/">Index</a></p> + <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search"; method="get"> + <input value="*.apache.org" name="sitesearch" type="hidden"/> + <input type="text" name="q" id="query" style="width:85%"> + <input type="submit" id="submit" value="Search"> + </form> + </div> <!-- lucy-top_nav_box --> + + <div class="clear"></div> + + </div> <!-- lucy-top --> + + <div id="lucy-main_content" class="container_16 lucy-white_box_3d"> + + <div class="grid_4" id="lucy-left_nav_box"> + <h6>About</h6> + <ul> + <li><a href="/">Welcome</a></li> + <li><a href="/clownfish.html">Clownfish</a></li> + <li><a href="/faq.html">FAQ</a></li> + <li><a href="/people.html">People</a></li> + </ul> + <h6>Resources</h6> + <ul> + <li><a href="/download.html">Download</a></li> + <li><a href="/mailing_lists.html">Mailing Lists</a></li> + <li><a href="/docs/">Documentation</a></li> + <li><a href="http://wiki.apache.org/lucy/";>Wiki</a></li> + <li><a href="https://issues.apache.org/jira/browse/LUCY";>Issue Tracker</a></li> + <li><a href="/version_control.html">Version Control</a></li> + </ul> + <h6>Related Projects</h6> + <ul> + <li><a href="http://lucene.apache.org/core/";>Lucene</a></li> + <li><a href="http://dezi.org/";>Dezi</a></li> + <li><a href="http://lucene.apache.org/solr/";>Solr</a></li> + <li><a href="http://lucenenet.apache.org/";>Lucene.NET</a></li> + <li><a href="http://lucene.apache.org/pylucene/";>PyLucene</a></li> + </ul> + </div> <!-- lucy-left_nav_box --> + + <div id="lucy-main_content_box" class="grid_9"> + <div class="c-api"> +<h2>Lucy::Index::DeletionsWriter</h2> +<table> +<tr> +<td class="label">parcel</td> +<td><a href="../../lucy.html">Lucy</a></td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code><span class="prefix">LUCY_</span>DELETIONSWRITER</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code><span class="prefix">lucy_</span>DeletionsWriter</code></td> +</tr> +<tr> +<td class="label">class nickname</td> +<td><code><span class="prefix">lucy_</span>DelWriter</code></td> +</tr> +<tr> +<td class="label">header file</td> +<td><code>Lucy/Index/DeletionsWriter.h</code></td> +</tr> +</table> +<h3>Name</h3> +<p>Lucy::Index::DeletionsWriter â Abstract base class for marking documents as deleted.</p> +<h3>Description</h3> +<p>Subclasses of DeletionsWriter provide a low-level mechanism for declaring a +document deleted from an index.</p> +<p>Because files in an index are never modified, and because it is not +practical to delete entire segments, a DeletionsWriter does not actually +remove documents from the index. Instead, it communicates to a search-time +companion DeletionsReader which documents are deleted in such a way that it +can create a Matcher iterator.</p> +<p>Documents are truly deleted only when the segments which contain them are +merged into new ones.</p> +<h3>Methods</h3> +<dl> +<dt id="func_Delete_By_Term">Delete_By_Term <span class="comment">(abstract)</span></dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>DelWriter_Delete_By_Term</strong>( + <span class="prefix">lucy_</span>DeletionsWriter *<strong>self</strong>, + <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>field</strong>, + <span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a> *<strong>term</strong> +); +</code></pre> +<p>Delete all documents in the index that index the supplied term.</p> +<dl> +<dt>field</dt> +<dd><p>The name of an indexed field. (If it is not specâd as +<code>indexed</code>, an error will occur.)</p> +</dd> +<dt>term</dt> +<dd><p>The term which identifies docs to be marked as deleted. If +<code>field</code> is associated with an Analyzer, <code>term</code> +will be processed automatically (so donât pre-process it yourself).</p> +</dd> +</dl> +</dd> +<dt id="func_Delete_By_Query">Delete_By_Query <span class="comment">(abstract)</span></dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>DelWriter_Delete_By_Query</strong>( + <span class="prefix">lucy_</span>DeletionsWriter *<strong>self</strong>, + <span class="prefix">lucy_</span><a href="../../Lucy/Search/Query.html">Query</a> *<strong>query</strong> +); +</code></pre> +<p>Delete all documents in the index that match <code>query</code>.</p> +<dl> +<dt>query</dt> +<dd><p>A <a href="../../Lucy/Search/Query.html">Query</a>.</p> +</dd> +</dl> +</dd> +<dt id="func_Updated">Updated <span class="comment">(abstract)</span></dt> +<dd> +<pre><code>bool +<span class="prefix">lucy_</span><strong>DelWriter_Updated</strong>( + <span class="prefix">lucy_</span>DeletionsWriter *<strong>self</strong> +); +</code></pre> +<p>Returns true if there are updates that need to be written.</p> +</dd> +<dt id="func_Seg_Del_Count">Seg_Del_Count <span class="comment">(abstract)</span></dt> +<dd> +<pre><code>int32_t +<span class="prefix">lucy_</span><strong>DelWriter_Seg_Del_Count</strong>( + <span class="prefix">lucy_</span>DeletionsWriter *<strong>self</strong>, + <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>seg_name</strong> +); +</code></pre> +<p>Return the number of deletions for a given segment.</p> +<dl> +<dt>seg_name</dt> +<dd><p>The name of the segment.</p> +</dd> +</dl> +</dd> +</dl> +<h3>Inheritance</h3> +<p>Lucy::Index::DeletionsWriter is a <a href="../../Lucy/Index/DataWriter.html">Lucy::Index::DataWriter</a> is a <a href="../../Clownfish/Obj.html">Clownfish::Obj</a>.</p> +</div> + + </div> <!-- lucy-main_content_box --> + <div class="clear"></div> + + </div> <!-- lucy-main_content --> + + <div id="lucy-copyright" class="container_16"> + <p>Copyright © 2010-2015 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0</a>. + <br/> + Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The + Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their + respective owners. + </p> + </div> <!-- lucy-copyright --> + + </div> <!-- lucy-rigid_wrapper --> + + </body> +</html> Added: websites/staging/lucy/trunk/content/docs/c/Lucy/Index/DocReader.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/Lucy/Index/DocReader.html (added) +++ websites/staging/lucy/trunk/content/docs/c/Lucy/Index/DocReader.html Mon Apr 4 12:55:27 2016 @@ -0,0 +1,157 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> + <title>Lucy::Index::DocReader â C API Documentation</title> + <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css"> + </head> + + <body> + + <div id="lucy-rigid_wrapper"> + + <div id="lucy-top" class="container_16 lucy-white_box_3d"> + + <div id="lucy-logo_box" class="grid_8"> + <a href="/"><img src="/images/lucy_logo_150x100.png" alt="Apache Lucyâ¢"></a> + </div> <!-- lucy-logo_box --> + + <div #id="lucy-top_nav_box" class="grid_8"> + <div id="lucy-top_nav_bar" class="container_8"> + <ul> + <li><a href="http://www.apache.org/"; title="Apache Software Foundation">Apache Software Foundation</a></li> + <li><a href="http://www.apache.org/licenses/"; title="License">License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html"; title="Sponsorship">Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html"; title="Thanks">Thanks</a></li> + <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li> + </ul> + </div> <!-- lucy-top_nav_bar --> + <p><a href="http://www.apache.org/";>Apache</a> » <a href="/">Lucy</a> » <a href="/docs/">Docs</a> » <a href="/docs/c/">C</a> » <a href="/docs/c/Lucy/">Lucy</a> » <a href="/docs/c/Lucy/Index/">Index</a></p> + <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search"; method="get"> + <input value="*.apache.org" name="sitesearch" type="hidden"/> + <input type="text" name="q" id="query" style="width:85%"> + <input type="submit" id="submit" value="Search"> + </form> + </div> <!-- lucy-top_nav_box --> + + <div class="clear"></div> + + </div> <!-- lucy-top --> + + <div id="lucy-main_content" class="container_16 lucy-white_box_3d"> + + <div class="grid_4" id="lucy-left_nav_box"> + <h6>About</h6> + <ul> + <li><a href="/">Welcome</a></li> + <li><a href="/clownfish.html">Clownfish</a></li> + <li><a href="/faq.html">FAQ</a></li> + <li><a href="/people.html">People</a></li> + </ul> + <h6>Resources</h6> + <ul> + <li><a href="/download.html">Download</a></li> + <li><a href="/mailing_lists.html">Mailing Lists</a></li> + <li><a href="/docs/">Documentation</a></li> + <li><a href="http://wiki.apache.org/lucy/";>Wiki</a></li> + <li><a href="https://issues.apache.org/jira/browse/LUCY";>Issue Tracker</a></li> + <li><a href="/version_control.html">Version Control</a></li> + </ul> + <h6>Related Projects</h6> + <ul> + <li><a href="http://lucene.apache.org/core/";>Lucene</a></li> + <li><a href="http://dezi.org/";>Dezi</a></li> + <li><a href="http://lucene.apache.org/solr/";>Solr</a></li> + <li><a href="http://lucenenet.apache.org/";>Lucene.NET</a></li> + <li><a href="http://lucene.apache.org/pylucene/";>PyLucene</a></li> + </ul> + </div> <!-- lucy-left_nav_box --> + + <div id="lucy-main_content_box" class="grid_9"> + <div class="c-api"> +<h2>Lucy::Index::DocReader</h2> +<table> +<tr> +<td class="label">parcel</td> +<td><a href="../../lucy.html">Lucy</a></td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code><span class="prefix">LUCY_</span>DOCREADER</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code><span class="prefix">lucy_</span>DocReader</code></td> +</tr> +<tr> +<td class="label">class nickname</td> +<td><code><span class="prefix">lucy_</span>DocReader</code></td> +</tr> +<tr> +<td class="label">header file</td> +<td><code>Lucy/Index/DocReader.h</code></td> +</tr> +</table> +<h3>Name</h3> +<p>Lucy::Index::DocReader â Retrieve stored documents.</p> +<h3>Description</h3> +<p>DocReader defines the interface by which documents (with all stored fields) +are retrieved from the index. The default implementation returns +<a href="../../Lucy/Document/HitDoc.html">HitDoc</a> objects.</p> +<h3>Methods</h3> +<dl> +<dt id="func_Fetch_Doc">Fetch_Doc <span class="comment">(abstract)</span></dt> +<dd> +<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Document/HitDoc.html">HitDoc</a>* <span class="comment">// incremented</span> +<span class="prefix">lucy_</span><strong>DocReader_Fetch_Doc</strong>( + <span class="prefix">lucy_</span>DocReader *<strong>self</strong>, + int32_t <strong>doc_id</strong> +); +</code></pre> +<p>Retrieve the document identified by <code>doc_id</code>.</p> +<p><strong>Returns:</strong> a HitDoc.</p> +</dd> +<dt id="func_Aggregator">Aggregator</dt> +<dd> +<pre><code><span class="prefix">lucy_</span>DocReader* <span class="comment">// incremented</span> +<span class="prefix">lucy_</span><strong>DocReader_Aggregator</strong>( + <span class="prefix">lucy_</span>DocReader *<strong>self</strong>, + <span class="prefix">cfish_</span><a href="../../Clownfish/Vector.html">Vector</a> *<strong>readers</strong>, + <span class="prefix">lucy_</span><a href="../../Lucy/Object/I32Array.html">I32Array</a> *<strong>offsets</strong> +); +</code></pre> +<p>Returns a DocReader which divvies up requests to its sub-readers +according to the offset range.</p> +<dl> +<dt>readers</dt> +<dd><p>An array of DocReaders.</p> +</dd> +<dt>offsets</dt> +<dd><p>Doc id start offsets for each reader.</p> +</dd> +</dl> +</dd> +</dl> +<h3>Inheritance</h3> +<p>Lucy::Index::DocReader is a <a href="../../Lucy/Index/DataReader.html">Lucy::Index::DataReader</a> is a <a href="../../Clownfish/Obj.html">Clownfish::Obj</a>.</p> +</div> + + </div> <!-- lucy-main_content_box --> + <div class="clear"></div> + + </div> <!-- lucy-main_content --> + + <div id="lucy-copyright" class="container_16"> + <p>Copyright © 2010-2015 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0</a>. + <br/> + Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The + Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their + respective owners. + </p> + </div> <!-- lucy-copyright --> + + </div> <!-- lucy-rigid_wrapper --> + + </body> +</html> Added: websites/staging/lucy/trunk/content/docs/c/Lucy/Index/IndexManager.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/Lucy/Index/IndexManager.html (added) +++ websites/staging/lucy/trunk/content/docs/c/Lucy/Index/IndexManager.html Mon Apr 4 12:55:27 2016 @@ -0,0 +1,289 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> + <title>Lucy::Index::IndexManager â C API Documentation</title> + <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css"> + </head> + + <body> + + <div id="lucy-rigid_wrapper"> + + <div id="lucy-top" class="container_16 lucy-white_box_3d"> + + <div id="lucy-logo_box" class="grid_8"> + <a href="/"><img src="/images/lucy_logo_150x100.png" alt="Apache Lucyâ¢"></a> + </div> <!-- lucy-logo_box --> + + <div #id="lucy-top_nav_box" class="grid_8"> + <div id="lucy-top_nav_bar" class="container_8"> + <ul> + <li><a href="http://www.apache.org/"; title="Apache Software Foundation">Apache Software Foundation</a></li> + <li><a href="http://www.apache.org/licenses/"; title="License">License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html"; title="Sponsorship">Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html"; title="Thanks">Thanks</a></li> + <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li> + </ul> + </div> <!-- lucy-top_nav_bar --> + <p><a href="http://www.apache.org/";>Apache</a> » <a href="/">Lucy</a> » <a href="/docs/">Docs</a> » <a href="/docs/c/">C</a> » <a href="/docs/c/Lucy/">Lucy</a> » <a href="/docs/c/Lucy/Index/">Index</a></p> + <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search"; method="get"> + <input value="*.apache.org" name="sitesearch" type="hidden"/> + <input type="text" name="q" id="query" style="width:85%"> + <input type="submit" id="submit" value="Search"> + </form> + </div> <!-- lucy-top_nav_box --> + + <div class="clear"></div> + + </div> <!-- lucy-top --> + + <div id="lucy-main_content" class="container_16 lucy-white_box_3d"> + + <div class="grid_4" id="lucy-left_nav_box"> + <h6>About</h6> + <ul> + <li><a href="/">Welcome</a></li> + <li><a href="/clownfish.html">Clownfish</a></li> + <li><a href="/faq.html">FAQ</a></li> + <li><a href="/people.html">People</a></li> + </ul> + <h6>Resources</h6> + <ul> + <li><a href="/download.html">Download</a></li> + <li><a href="/mailing_lists.html">Mailing Lists</a></li> + <li><a href="/docs/">Documentation</a></li> + <li><a href="http://wiki.apache.org/lucy/";>Wiki</a></li> + <li><a href="https://issues.apache.org/jira/browse/LUCY";>Issue Tracker</a></li> + <li><a href="/version_control.html">Version Control</a></li> + </ul> + <h6>Related Projects</h6> + <ul> + <li><a href="http://lucene.apache.org/core/";>Lucene</a></li> + <li><a href="http://dezi.org/";>Dezi</a></li> + <li><a href="http://lucene.apache.org/solr/";>Solr</a></li> + <li><a href="http://lucenenet.apache.org/";>Lucene.NET</a></li> + <li><a href="http://lucene.apache.org/pylucene/";>PyLucene</a></li> + </ul> + </div> <!-- lucy-left_nav_box --> + + <div id="lucy-main_content_box" class="grid_9"> + <div class="c-api"> +<h2>Lucy::Index::IndexManager</h2> +<table> +<tr> +<td class="label">parcel</td> +<td><a href="../../lucy.html">Lucy</a></td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code><span class="prefix">LUCY_</span>INDEXMANAGER</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code><span class="prefix">lucy_</span>IndexManager</code></td> +</tr> +<tr> +<td class="label">class nickname</td> +<td><code><span class="prefix">lucy_</span>IxManager</code></td> +</tr> +<tr> +<td class="label">header file</td> +<td><code>Lucy/Index/IndexManager.h</code></td> +</tr> +</table> +<h3>Name</h3> +<p>Lucy::Index::IndexManager â Policies governing index updating, locking, and file deletion.</p> +<h3>Description</h3> +<p>IndexManager is an advanced-use class for controlling index locking, +updating, merging, and deletion behaviors.</p> +<p>IndexManager and <a href="../../Lucy/Plan/Architecture.html">Architecture</a> are +complementary classes: Architecture is used to define traits and behaviors +which cannot change for the life of an index; IndexManager is used for +defining rules which may change from process to process.</p> +<h3>Functions</h3> +<dl> +<dt id="func_new">new</dt> +<dd> +<pre><code><span class="prefix">lucy_</span>IndexManager* <span class="comment">// incremented</span> +<span class="prefix">lucy_</span><strong>IxManager_new</strong>( + <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>host</strong>, + <span class="prefix">lucy_</span><a href="../../Lucy/Store/LockFactory.html">LockFactory</a> *<strong>lock_factory</strong> +); +</code></pre> +<p>Create a new IndexManager.</p> +<dl> +<dt>host</dt> +<dd><p>An identifier which should be unique per-machine.</p> +</dd> +<dt>lock_factory</dt> +<dd><p>A LockFactory.</p> +</dd> +</dl> +</dd> +<dt id="func_init">init</dt> +<dd> +<pre><code><span class="prefix">lucy_</span>IndexManager* +<span class="prefix">lucy_</span><strong>IxManager_init</strong>( + <span class="prefix">lucy_</span>IndexManager *<strong>self</strong>, + <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>host</strong>, + <span class="prefix">lucy_</span><a href="../../Lucy/Store/LockFactory.html">LockFactory</a> *<strong>lock_factory</strong> +); +</code></pre> +<p>Initialize an IndexManager.</p> +<dl> +<dt>host</dt> +<dd><p>An identifier which should be unique per-machine.</p> +</dd> +<dt>lock_factory</dt> +<dd><p>A LockFactory.</p> +</dd> +</dl> +</dd> +</dl> +<h3>Methods</h3> +<dl> +<dt id="func_Destroy">Destroy</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>IxManager_Destroy</strong>( + <span class="prefix">lucy_</span>IndexManager *<strong>self</strong> +); +</code></pre> +<p>Generic destructor. Frees the struct itself but not any complex +member elements.</p> +</dd> +<dt id="func_Set_Folder">Set_Folder</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>IxManager_Set_Folder</strong>( + <span class="prefix">lucy_</span>IndexManager *<strong>self</strong>, + <span class="prefix">lucy_</span><a href="../../Lucy/Store/Folder.html">Folder</a> *<strong>folder</strong> +); +</code></pre> +<p>Setter for <code>folder</code> member. Typical clients (Indexer, +IndexReader) will use this method to install their own Folder instance.</p> +</dd> +<dt id="func_Get_Folder">Get_Folder</dt> +<dd> +<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Store/Folder.html">Folder</a>* +<span class="prefix">lucy_</span><strong>IxManager_Get_Folder</strong>( + <span class="prefix">lucy_</span>IndexManager *<strong>self</strong> +); +</code></pre> +<p>Getter for <code>folder</code> member.</p> +</dd> +<dt id="func_Get_Host">Get_Host</dt> +<dd> +<pre><code><span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a>* +<span class="prefix">lucy_</span><strong>IxManager_Get_Host</strong>( + <span class="prefix">lucy_</span>IndexManager *<strong>self</strong> +); +</code></pre> +<p>Getter for <code>host</code> member.</p> +</dd> +<dt id="func_Recycle">Recycle</dt> +<dd> +<pre><code><span class="prefix">cfish_</span><a href="../../Clownfish/Vector.html">Vector</a>* <span class="comment">// incremented</span> +<span class="prefix">lucy_</span><strong>IxManager_Recycle</strong>( + <span class="prefix">lucy_</span>IndexManager *<strong>self</strong>, + <span class="prefix">lucy_</span><a href="../../Lucy/Index/PolyReader.html">PolyReader</a> *<strong>reader</strong>, + <span class="prefix">lucy_</span><a href="../../Lucy/Index/DeletionsWriter.html">DeletionsWriter</a> *<strong>del_writer</strong>, + int64_t <strong>cutoff</strong>, + bool <strong>optimize</strong> +); +</code></pre> +<p>Return an array of SegReaders representing segments that should be +consolidated. Implementations must balance index-time churn against +search-time degradation due to segment proliferation. The default +implementation prefers small segments or segments with a high +proportion of deletions.</p> +<dl> +<dt>reader</dt> +<dd><p>A PolyReader.</p> +</dd> +<dt>del_writer</dt> +<dd><p>A DeletionsWriter.</p> +</dd> +<dt>cutoff</dt> +<dd><p>A segment number which all returned SegReaders must +exceed.</p> +</dd> +<dt>optimize</dt> +<dd><p>A boolean indicating whether to spend extra time +optimizing the index for search-time performance.</p> +</dd> +</dl> +</dd> +<dt id="func_Make_Write_Lock">Make_Write_Lock</dt> +<dd> +<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Store/Lock.html">Lock</a>* <span class="comment">// incremented</span> +<span class="prefix">lucy_</span><strong>IxManager_Make_Write_Lock</strong>( + <span class="prefix">lucy_</span>IndexManager *<strong>self</strong> +); +</code></pre> +<p>Create the Lock which controls access to modifying the logical content +of the index.</p> +</dd> +<dt id="func_Set_Write_Lock_Timeout">Set_Write_Lock_Timeout</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>IxManager_Set_Write_Lock_Timeout</strong>( + <span class="prefix">lucy_</span>IndexManager *<strong>self</strong>, + uint32_t <strong>timeout</strong> +); +</code></pre> +<p>Setter for write lock timeout. Default: 1000 milliseconds.</p> +</dd> +<dt id="func_Get_Write_Lock_Timeout">Get_Write_Lock_Timeout</dt> +<dd> +<pre><code>uint32_t +<span class="prefix">lucy_</span><strong>IxManager_Get_Write_Lock_Timeout</strong>( + <span class="prefix">lucy_</span>IndexManager *<strong>self</strong> +); +</code></pre> +<p>Getter for write lock timeout.</p> +</dd> +<dt id="func_Set_Write_Lock_Interval">Set_Write_Lock_Interval</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>IxManager_Set_Write_Lock_Interval</strong>( + <span class="prefix">lucy_</span>IndexManager *<strong>self</strong>, + uint32_t <strong>timeout</strong> +); +</code></pre> +<p>Setter for write lock retry interval. Default: 100 milliseconds.</p> +</dd> +<dt id="func_Get_Write_Lock_Interval">Get_Write_Lock_Interval</dt> +<dd> +<pre><code>uint32_t +<span class="prefix">lucy_</span><strong>IxManager_Get_Write_Lock_Interval</strong>( + <span class="prefix">lucy_</span>IndexManager *<strong>self</strong> +); +</code></pre> +<p>Getter for write lock retry interval.</p> +</dd> +</dl> +<h3>Inheritance</h3> +<p>Lucy::Index::IndexManager is a <a href="../../Clownfish/Obj.html">Clownfish::Obj</a>.</p> +</div> + + </div> <!-- lucy-main_content_box --> + <div class="clear"></div> + + </div> <!-- lucy-main_content --> + + <div id="lucy-copyright" class="container_16"> + <p>Copyright © 2010-2015 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0</a>. + <br/> + Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The + Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their + respective owners. + </p> + </div> <!-- lucy-copyright --> + + </div> <!-- lucy-rigid_wrapper --> + + </body> +</html>
