You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucy.apache.org by bu...@apache.org on 2016/09/28 12:07:52 UTC
svn commit: r998475 [8/26] - in /websites/staging/lucy/trunk/content: ./
docs/ docs/0.5.0/ docs/0.5.0/c/ docs/0.5.0/c/Clownfish/
docs/0.5.0/c/Clownfish/Docs/ docs/0.5.0/c/Lucy/ docs/0.5.0/c/Lucy/Analysis/
docs/0.5.0/c/Lucy/Docs/ docs/0.5.0/c/Lucy/Docs/...
Added: websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Index/DeletionsWriter.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Index/DeletionsWriter.html (added)
+++ websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Index/DeletionsWriter.html Wed Sep 28 12:07:48 2016
@@ -0,0 +1,338 @@
+<!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/0.5.0/">0.5.0</a> » <a href="/docs/0.5.0/c/">C</a> » <a href="/docs/0.5.0/c/Lucy/">Lucy</a> » <a href="/docs/0.5.0/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>
+<h4>Methods inherited from Lucy::Index::DataWriter</h4>
+<dl>
+<dt id="func_Add_Segment">Add_Segment <span class="comment">(abstract)</span></dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>DelWriter_Add_Segment</strong>(
+ <span class="prefix">lucy_</span>DeletionsWriter *<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>DelWriter_Delete_Segment</strong>(
+ <span class="prefix">lucy_</span>DeletionsWriter *<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>DelWriter_Merge_Segment</strong>(
+ <span class="prefix">lucy_</span>DeletionsWriter *<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/DeletionsWriter.html#func_Add_Segment">Add_Segment()</a> then <a href="../../Lucy/Index/DeletionsWriter.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>DelWriter_Finish</strong>(
+ <span class="prefix">lucy_</span>DeletionsWriter *<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>DelWriter_Metadata</strong>(
+ <span class="prefix">lucy_</span>DeletionsWriter *<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>DelWriter_Format</strong>(
+ <span class="prefix">lucy_</span>DeletionsWriter *<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>DelWriter_Get_Snapshot</strong>(
+ <span class="prefix">lucy_</span>DeletionsWriter *<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>DelWriter_Get_Segment</strong>(
+ <span class="prefix">lucy_</span>DeletionsWriter *<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>DelWriter_Get_PolyReader</strong>(
+ <span class="prefix">lucy_</span>DeletionsWriter *<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>DelWriter_Get_Schema</strong>(
+ <span class="prefix">lucy_</span>DeletionsWriter *<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>DelWriter_Get_Folder</strong>(
+ <span class="prefix">lucy_</span>DeletionsWriter *<strong>self</strong>
+);
+</code></pre>
+<p>Accessor for “folder” member var.</p>
+</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/0.5.0/c/Lucy/Index/DocReader.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Index/DocReader.html (added)
+++ websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Index/DocReader.html Wed Sep 28 12:07:48 2016
@@ -0,0 +1,214 @@
+<!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/0.5.0/">0.5.0</a> » <a href="/docs/0.5.0/c/">C</a> » <a href="/docs/0.5.0/c/Lucy/">Lucy</a> » <a href="/docs/0.5.0/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>
+<h4>Methods inherited from Lucy::Index::DataReader</h4>
+<dl>
+<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>DocReader_Get_Schema</strong>(
+ <span class="prefix">lucy_</span>DocReader *<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>DocReader_Get_Folder</strong>(
+ <span class="prefix">lucy_</span>DocReader *<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>DocReader_Get_Snapshot</strong>(
+ <span class="prefix">lucy_</span>DocReader *<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>DocReader_Get_Segments</strong>(
+ <span class="prefix">lucy_</span>DocReader *<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>DocReader_Get_Segment</strong>(
+ <span class="prefix">lucy_</span>DocReader *<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>DocReader_Get_Seg_Tick</strong>(
+ <span class="prefix">lucy_</span>DocReader *<strong>self</strong>
+);
+</code></pre>
+<p>Accessor for “seg_tick” member var.</p>
+</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/0.5.0/c/Lucy/Index/IndexManager.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Index/IndexManager.html (added)
+++ websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Index/IndexManager.html Wed Sep 28 12:07:48 2016
@@ -0,0 +1,279 @@
+<!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/0.5.0/">0.5.0</a> » <a href="/docs/0.5.0/c/">C</a> » <a href="/docs/0.5.0/c/Lucy/">Lucy</a> » <a href="/docs/0.5.0/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_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>
Added: websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Index/IndexReader.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Index/IndexReader.html (added)
+++ websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Index/IndexReader.html Wed Sep 28 12:07:48 2016
@@ -0,0 +1,350 @@
+<!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::IndexReader – 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/0.5.0/">0.5.0</a> » <a href="/docs/0.5.0/c/">C</a> » <a href="/docs/0.5.0/c/Lucy/">Lucy</a> » <a href="/docs/0.5.0/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::IndexReader</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>INDEXREADER</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code><span class="prefix">lucy_</span>IndexReader</code></td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td><code><span class="prefix">lucy_</span>IxReader</code></td>
+</tr>
+<tr>
+<td class="label">header file</td>
+<td><code>Lucy/Index/IndexReader.h</code></td>
+</tr>
+</table>
+<h3>Name</h3>
+<p>Lucy::Index::IndexReader – Read from an inverted index.</p>
+<h3>Description</h3>
+<p>IndexReader is the interface through which
+<a href="../../Lucy/Search/IndexSearcher.html">IndexSearcher</a> objects access the
+content of an index.</p>
+<p>IndexReader objects always represent a point-in-time view of an index as it
+existed at the moment the reader was created. If you want search results
+to reflect modifications to an index, you must create a new IndexReader
+after the update process completes.</p>
+<p>IndexReaders are composites; most of the work is done by individual
+<a href="../../Lucy/Index/DataReader.html">DataReader</a> sub-components, which may be
+accessed via <a href="../../Lucy/Index/IndexReader.html#func_Fetch">Fetch()</a> and <a href="../../Lucy/Index/IndexReader.html#func_Obtain">Obtain()</a>. The most efficient and powerful access
+to index data happens at the segment level via
+<a href="../../Lucy/Index/SegReader.html">SegReader</a>’s sub-components.</p>
+<h3>Functions</h3>
+<dl>
+<dt id="func_open">open</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>IndexReader* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>IxReader_open</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/Snapshot.html">Snapshot</a> *<strong>snapshot</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Index/IndexManager.html">IndexManager</a> *<strong>manager</strong>
+);
+</code></pre>
+<p>IndexReader is an abstract base class; open() returns the IndexReader
+subclass PolyReader, which channels the output of 0 or more SegReaders.</p>
+<dl>
+<dt>index</dt>
+<dd><p>Either a string filepath or a Folder.</p>
+</dd>
+<dt>snapshot</dt>
+<dd><p>A Snapshot. If not supplied, the most recent snapshot
+file will be used.</p>
+</dd>
+<dt>manager</dt>
+<dd><p>An <a href="../../Lucy/Index/IndexManager.html">IndexManager</a>.
+Read-locking is off by default; supplying this argument turns it on.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_do_open">do_open</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>IndexReader*
+<span class="prefix">lucy_</span><strong>IxReader_do_open</strong>(
+ <span class="prefix">lucy_</span>IndexReader *<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/Snapshot.html">Snapshot</a> *<strong>snapshot</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Index/IndexManager.html">IndexManager</a> *<strong>manager</strong>
+);
+</code></pre>
+<p>Initialize and open an IndexReader.</p>
+<dl>
+<dt>index</dt>
+<dd><p>Either a string filepath or a Folder.</p>
+</dd>
+<dt>snapshot</dt>
+<dd><p>A Snapshot. If not supplied, the most recent snapshot
+file will be used.</p>
+</dd>
+<dt>manager</dt>
+<dd><p>An <a href="../../Lucy/Index/IndexManager.html">IndexManager</a>.
+Read-locking is off by default; supplying this argument turns it on.</p>
+</dd>
+</dl>
+</dd>
+</dl>
+<h3>Methods</h3>
+<dl>
+<dt id="func_Doc_Max">Doc_Max <span class="comment">(abstract)</span></dt>
+<dd>
+<pre><code>int32_t
+<span class="prefix">lucy_</span><strong>IxReader_Doc_Max</strong>(
+ <span class="prefix">lucy_</span>IndexReader *<strong>self</strong>
+);
+</code></pre>
+<p>Return the maximum number of documents available to the reader, which
+is also the highest possible internal document id. Documents which
+have been marked as deleted but not yet purged from the index are
+included in this count.</p>
+</dd>
+<dt id="func_Doc_Count">Doc_Count <span class="comment">(abstract)</span></dt>
+<dd>
+<pre><code>int32_t
+<span class="prefix">lucy_</span><strong>IxReader_Doc_Count</strong>(
+ <span class="prefix">lucy_</span>IndexReader *<strong>self</strong>
+);
+</code></pre>
+<p>Return the number of documents available to the reader, subtracting
+any that are marked as deleted.</p>
+</dd>
+<dt id="func_Del_Count">Del_Count <span class="comment">(abstract)</span></dt>
+<dd>
+<pre><code>int32_t
+<span class="prefix">lucy_</span><strong>IxReader_Del_Count</strong>(
+ <span class="prefix">lucy_</span>IndexReader *<strong>self</strong>
+);
+</code></pre>
+<p>Return the number of documents which have been marked as deleted but
+not yet purged from the index.</p>
+</dd>
+<dt id="func_Offsets">Offsets <span class="comment">(abstract)</span></dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Object/I32Array.html">I32Array</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>IxReader_Offsets</strong>(
+ <span class="prefix">lucy_</span>IndexReader *<strong>self</strong>
+);
+</code></pre>
+<p>Return an array with one entry for each segment, corresponding to
+segment doc_id start offset.</p>
+</dd>
+<dt id="func_Seg_Readers">Seg_Readers <span class="comment">(abstract)</span></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>IxReader_Seg_Readers</strong>(
+ <span class="prefix">lucy_</span>IndexReader *<strong>self</strong>
+);
+</code></pre>
+<p>Return an array of all the SegReaders represented within the
+IndexReader.</p>
+</dd>
+<dt id="func_Obtain">Obtain</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Index/DataReader.html">DataReader</a>*
+<span class="prefix">lucy_</span><strong>IxReader_Obtain</strong>(
+ <span class="prefix">lucy_</span>IndexReader *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>api</strong>
+);
+</code></pre>
+<p>Fetch a component, or throw an error if the component can’t be found.</p>
+<dl>
+<dt>api</dt>
+<dd><p>The name of the DataReader subclass that the desired
+component must implement.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Fetch">Fetch</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Index/DataReader.html">DataReader</a>*
+<span class="prefix">lucy_</span><strong>IxReader_Fetch</strong>(
+ <span class="prefix">lucy_</span>IndexReader *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>api</strong>
+);
+</code></pre>
+<p>Fetch a component, or return NULL if the component can’t be
+found.</p>
+<dl>
+<dt>api</dt>
+<dd><p>The name of the DataReader subclass that the desired
+component must implement.</p>
+</dd>
+</dl>
+</dd>
+</dl>
+<h4>Methods inherited from Lucy::Index::DataReader</h4>
+<dl>
+<dt id="func_Aggregator">Aggregator <span class="comment">(abstract)</span></dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Index/DataReader.html">DataReader</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>IxReader_Aggregator</strong>(
+ <span class="prefix">lucy_</span>IndexReader *<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>IxReader_Get_Schema</strong>(
+ <span class="prefix">lucy_</span>IndexReader *<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>IxReader_Get_Folder</strong>(
+ <span class="prefix">lucy_</span>IndexReader *<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>IxReader_Get_Snapshot</strong>(
+ <span class="prefix">lucy_</span>IndexReader *<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>IxReader_Get_Segments</strong>(
+ <span class="prefix">lucy_</span>IndexReader *<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>IxReader_Get_Segment</strong>(
+ <span class="prefix">lucy_</span>IndexReader *<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>IxReader_Get_Seg_Tick</strong>(
+ <span class="prefix">lucy_</span>IndexReader *<strong>self</strong>
+);
+</code></pre>
+<p>Accessor for “seg_tick” member var.</p>
+</dd>
+</dl>
+<h3>Inheritance</h3>
+<p>Lucy::Index::IndexReader 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/0.5.0/c/Lucy/Index/Indexer.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Index/Indexer.html (added)
+++ websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Index/Indexer.html Wed Sep 28 12:07:48 2016
@@ -0,0 +1,340 @@
+<!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::Indexer – 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/0.5.0/">0.5.0</a> » <a href="/docs/0.5.0/c/">C</a> » <a href="/docs/0.5.0/c/Lucy/">Lucy</a> » <a href="/docs/0.5.0/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::Indexer</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>INDEXER</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code><span class="prefix">lucy_</span>Indexer</code></td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td><code><span class="prefix">lucy_</span>Indexer</code></td>
+</tr>
+<tr>
+<td class="label">header file</td>
+<td><code>Lucy/Index/Indexer.h</code></td>
+</tr>
+</table>
+<h3>Name</h3>
+<p>Lucy::Index::Indexer – Build inverted indexes.</p>
+<h3>Description</h3>
+<p>The Indexer class is Apache Lucy’s primary tool for managing the content of
+inverted indexes, which may later be searched using
+<a href="../../Lucy/Search/IndexSearcher.html">IndexSearcher</a>.</p>
+<p>In general, only one Indexer at a time may write to an index safely. If a
+write lock cannot be secured, new() will throw an exception.</p>
+<p>If an index is located on a shared volume, each writer application must
+identify itself by supplying an
+<a href="../../Lucy/Index/IndexManager.html">IndexManager</a> with a unique
+<code>host</code> id to Indexer’s constructor or index corruption will
+occur. See <a href="../../Lucy/Docs/FileLocking.html">FileLocking</a> for a detailed
+discussion.</p>
+<p>Note: at present, <a href="../../Lucy/Index/Indexer.html#func_Delete_By_Term">Delete_By_Term()</a> and <a href="../../Lucy/Index/Indexer.html#func_Delete_By_Query">Delete_By_Query()</a> only affect
+documents which had been previously committed to the index – and not any
+documents added this indexing session but not yet committed. This may
+change in a future update.</p>
+<h3>Functions</h3>
+<dl>
+<dt id="func_new">new</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>Indexer* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>Indexer_new</strong>(
+ <span class="prefix">lucy_</span><a href="../../Lucy/Plan/Schema.html">Schema</a> *<strong>schema</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>,
+ int32_t <strong>flags</strong>
+);
+</code></pre>
+<p>Open a new Indexer. If the index already exists, update it.</p>
+<dl>
+<dt>schema</dt>
+<dd><p>A Schema.</p>
+</dd>
+<dt>index</dt>
+<dd><p>Either a string filepath or a Folder.</p>
+</dd>
+<dt>manager</dt>
+<dd><p>An IndexManager.</p>
+</dd>
+<dt>flags</dt>
+<dd><p>Flags governing behavior.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_init">init</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>Indexer*
+<span class="prefix">lucy_</span><strong>Indexer_init</strong>(
+ <span class="prefix">lucy_</span>Indexer *<strong>self</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Plan/Schema.html">Schema</a> *<strong>schema</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>,
+ int32_t <strong>flags</strong>
+);
+</code></pre>
+<p>Initialize an Indexer.</p>
+<dl>
+<dt>schema</dt>
+<dd><p>A Schema.</p>
+</dd>
+<dt>index</dt>
+<dd><p>Either a string filepath or a Folder.</p>
+</dd>
+<dt>manager</dt>
+<dd><p>An IndexManager.</p>
+</dd>
+<dt>flags</dt>
+<dd><p>Flags governing behavior.</p>
+</dd>
+</dl>
+</dd>
+</dl>
+<h3>Methods</h3>
+<dl>
+<dt id="func_Add_Doc">Add_Doc</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>Indexer_Add_Doc</strong>(
+ <span class="prefix">lucy_</span>Indexer *<strong>self</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Document/Doc.html">Doc</a> *<strong>doc</strong>,
+ float <strong>boost</strong>
+);
+</code></pre>
+<p>Add a document to the index.</p>
+<dl>
+<dt>doc</dt>
+<dd><p>A Lucy::Document::Doc object.</p>
+</dd>
+<dt>boost</dt>
+<dd><p>A floating point weight which affects how this document
+scores.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Add_Index">Add_Index</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>Indexer_Add_Index</strong>(
+ <span class="prefix">lucy_</span>Indexer *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a> *<strong>index</strong>
+);
+</code></pre>
+<p>Absorb an existing index into this one. The two indexes must
+have matching Schemas.</p>
+<dl>
+<dt>index</dt>
+<dd><p>Either an index path name or a Folder.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Delete_By_Term">Delete_By_Term</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>Indexer_Delete_By_Term</strong>(
+ <span class="prefix">lucy_</span>Indexer *<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>Mark documents which contain the supplied term as deleted, so that
+they will be excluded from search results and eventually removed
+altogether. The change is not apparent to search apps until after
+<a href="../../Lucy/Index/Indexer.html#func_Commit">Commit()</a> succeeds.</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</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>Indexer_Delete_By_Query</strong>(
+ <span class="prefix">lucy_</span>Indexer *<strong>self</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Search/Query.html">Query</a> *<strong>query</strong>
+);
+</code></pre>
+<p>Mark documents which match the supplied Query as deleted.</p>
+<dl>
+<dt>query</dt>
+<dd><p>A <a href="../../Lucy/Search/Query.html">Query</a>.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Delete_By_Doc_ID">Delete_By_Doc_ID</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>Indexer_Delete_By_Doc_ID</strong>(
+ <span class="prefix">lucy_</span>Indexer *<strong>self</strong>,
+ int32_t <strong>doc_id</strong>
+);
+</code></pre>
+<p>Mark the document identified by the supplied document ID as deleted.</p>
+<dl>
+<dt>doc_id</dt>
+<dd><p>A <a href="../../Lucy/Docs/DocIDs.html">document id</a>.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Optimize">Optimize</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>Indexer_Optimize</strong>(
+ <span class="prefix">lucy_</span>Indexer *<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>
+<p>Every Indexer session which changes index content and ends in a
+<a href="../../Lucy/Index/Indexer.html#func_Commit">Commit()</a> creates a new segment. Once written, segments are never
+modified. However, they are periodically recycled by feeding their
+content into the segment currently being written.</p>
+<p>The <a href="../../Lucy/Index/Indexer.html#func_Optimize">Optimize()</a> method causes all existing index content to be fed back
+into the Indexer. When <a href="../../Lucy/Index/Indexer.html#func_Commit">Commit()</a> completes after an <a href="../../Lucy/Index/Indexer.html#func_Optimize">Optimize()</a>, the
+index will consist of one segment. So <a href="../../Lucy/Index/Indexer.html#func_Optimize">Optimize()</a> must be called
+before <a href="../../Lucy/Index/Indexer.html#func_Commit">Commit()</a>. Also, optimizing a fresh index created from scratch
+has no effect.</p>
+<p>Historically, there was a significant search-time performance benefit
+to collapsing down to a single segment versus even two segments. Now
+the effect of collapsing is much less significant, and calling
+<a href="../../Lucy/Index/Indexer.html#func_Optimize">Optimize()</a> is rarely justified.</p>
+</dd>
+<dt id="func_Commit">Commit</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>Indexer_Commit</strong>(
+ <span class="prefix">lucy_</span>Indexer *<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>Calling <a href="../../Lucy/Index/Indexer.html#func_Commit">Commit()</a> invalidates the Indexer, so if you want to make more
+changes you’ll need a new one.</p>
+</dd>
+<dt id="func_Prepare_Commit">Prepare_Commit</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>Indexer_Prepare_Commit</strong>(
+ <span class="prefix">lucy_</span>Indexer *<strong>self</strong>
+);
+</code></pre>
+<p>Perform the expensive setup for <a href="../../Lucy/Index/Indexer.html#func_Commit">Commit()</a> in advance, so that <a href="../../Lucy/Index/Indexer.html#func_Commit">Commit()</a>
+completes quickly. (If <a href="../../Lucy/Index/Indexer.html#func_Prepare_Commit">Prepare_Commit()</a> is not called explicitly by
+the user, <a href="../../Lucy/Index/Indexer.html#func_Commit">Commit()</a> will call it internally.)</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>Indexer_Get_Schema</strong>(
+ <span class="prefix">lucy_</span>Indexer *<strong>self</strong>
+);
+</code></pre>
+<p>Accessor for schema.</p>
+</dd>
+</dl>
+<h3>Inheritance</h3>
+<p>Lucy::Index::Indexer 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/0.5.0/c/Lucy/Index/Lexicon.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Index/Lexicon.html (added)
+++ websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Index/Lexicon.html Wed Sep 28 12:07:48 2016
@@ -0,0 +1,175 @@
+<!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::Lexicon – 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/0.5.0/">0.5.0</a> » <a href="/docs/0.5.0/c/">C</a> » <a href="/docs/0.5.0/c/Lucy/">Lucy</a> » <a href="/docs/0.5.0/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::Lexicon</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>LEXICON</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code><span class="prefix">lucy_</span>Lexicon</code></td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td><code><span class="prefix">lucy_</span>Lex</code></td>
+</tr>
+<tr>
+<td class="label">header file</td>
+<td><code>Lucy/Index/Lexicon.h</code></td>
+</tr>
+</table>
+<h3>Name</h3>
+<p>Lucy::Index::Lexicon – Iterator for a field’s terms.</p>
+<h3>Description</h3>
+<p>A Lexicon is an iterator which provides access to all the unique terms for
+a given field in sorted order.</p>
+<p>If an index consists of two documents with a ‘content’ field holding “three
+blind mice” and “three musketeers” respectively, then iterating through the
+‘content’ field’s lexicon would produce this list:</p>
+<pre><code>blind
+mice
+musketeers
+three
+</code></pre>
+<h3>Methods</h3>
+<dl>
+<dt id="func_Seek">Seek <span class="comment">(abstract)</span></dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>Lex_Seek</strong>(
+ <span class="prefix">lucy_</span>Lexicon *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a> *<strong>target</strong>
+);
+</code></pre>
+<p>Seek the Lexicon to the first iterator state which is greater than or
+equal to <code>target</code>. If <code>target</code> is NULL,
+reset the iterator.</p>
+</dd>
+<dt id="func_Next">Next <span class="comment">(abstract)</span></dt>
+<dd>
+<pre><code>bool
+<span class="prefix">lucy_</span><strong>Lex_Next</strong>(
+ <span class="prefix">lucy_</span>Lexicon *<strong>self</strong>
+);
+</code></pre>
+<p>Proceed to the next term.</p>
+<p><strong>Returns:</strong> true until the iterator is exhausted, then false.</p>
+</dd>
+<dt id="func_Reset">Reset <span class="comment">(abstract)</span></dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>Lex_Reset</strong>(
+ <span class="prefix">lucy_</span>Lexicon *<strong>self</strong>
+);
+</code></pre>
+<p>Reset the iterator. <a href="../../Lucy/Index/Lexicon.html#func_Next">Next()</a> must be called to proceed to the first
+element.</p>
+</dd>
+<dt id="func_Get_Term">Get_Term <span class="comment">(abstract)</span></dt>
+<dd>
+<pre><code><span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a>*
+<span class="prefix">lucy_</span><strong>Lex_Get_Term</strong>(
+ <span class="prefix">lucy_</span>Lexicon *<strong>self</strong>
+);
+</code></pre>
+<p>Return the current term, or NULL if the iterator is not in a
+valid state.</p>
+</dd>
+</dl>
+<h3>Inheritance</h3>
+<p>Lucy::Index::Lexicon 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/0.5.0/c/Lucy/Index/LexiconReader.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Index/LexiconReader.html (added)
+++ websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Index/LexiconReader.html Wed Sep 28 12:07:48 2016
@@ -0,0 +1,233 @@
+<!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::LexiconReader – 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/0.5.0/">0.5.0</a> » <a href="/docs/0.5.0/c/">C</a> » <a href="/docs/0.5.0/c/Lucy/">Lucy</a> » <a href="/docs/0.5.0/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::LexiconReader</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>LEXICONREADER</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code><span class="prefix">lucy_</span>LexiconReader</code></td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td><code><span class="prefix">lucy_</span>LexReader</code></td>
+</tr>
+<tr>
+<td class="label">header file</td>
+<td><code>Lucy/Index/LexiconReader.h</code></td>
+</tr>
+</table>
+<h3>Name</h3>
+<p>Lucy::Index::LexiconReader – Read Lexicon data.</p>
+<h3>Description</h3>
+<p>LexiconReader reads term dictionary information.</p>
+<h3>Methods</h3>
+<dl>
+<dt id="func_Lexicon">Lexicon <span class="comment">(abstract)</span></dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Index/Lexicon.html">Lexicon</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>LexReader_Lexicon</strong>(
+ <span class="prefix">lucy_</span>LexiconReader *<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>Return a new Lexicon for the given <code>field</code>. Will return
+NULL if either the field is not indexed, or if no documents
+contain a value for the field.</p>
+<dl>
+<dt>field</dt>
+<dd><p>Field name.</p>
+</dd>
+<dt>term</dt>
+<dd><p>Pre-locate the Lexicon to this term.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Doc_Freq">Doc_Freq <span class="comment">(abstract)</span></dt>
+<dd>
+<pre><code>uint32_t
+<span class="prefix">lucy_</span><strong>LexReader_Doc_Freq</strong>(
+ <span class="prefix">lucy_</span>LexiconReader *<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>Return the number of documents where the specified term is present.</p>
+</dd>
+<dt id="func_Aggregator">Aggregator</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>LexiconReader* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>LexReader_Aggregator</strong>(
+ <span class="prefix">lucy_</span>LexiconReader *<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>Return a LexiconReader which merges the output of other
+LexiconReaders.</p>
+<dl>
+<dt>readers</dt>
+<dd><p>An array of LexiconReaders.</p>
+</dd>
+<dt>offsets</dt>
+<dd><p>Doc id start offsets for each reader.</p>
+</dd>
+</dl>
+</dd>
+</dl>
+<h4>Methods inherited from Lucy::Index::DataReader</h4>
+<dl>
+<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>LexReader_Get_Schema</strong>(
+ <span class="prefix">lucy_</span>LexiconReader *<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>LexReader_Get_Folder</strong>(
+ <span class="prefix">lucy_</span>LexiconReader *<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>LexReader_Get_Snapshot</strong>(
+ <span class="prefix">lucy_</span>LexiconReader *<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>LexReader_Get_Segments</strong>(
+ <span class="prefix">lucy_</span>LexiconReader *<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>LexReader_Get_Segment</strong>(
+ <span class="prefix">lucy_</span>LexiconReader *<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>LexReader_Get_Seg_Tick</strong>(
+ <span class="prefix">lucy_</span>LexiconReader *<strong>self</strong>
+);
+</code></pre>
+<p>Accessor for “seg_tick” member var.</p>
+</dd>
+</dl>
+<h3>Inheritance</h3>
+<p>Lucy::Index::LexiconReader 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>