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 [14/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/Search/Span.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Search/Span.html (added)
+++ websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Search/Span.html Wed Sep 28 12:07:48 2016
@@ -0,0 +1,259 @@
+<!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::Search::Span – 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/Search/">Search</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::Search::Span</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>SPAN</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code><span class="prefix">lucy_</span>Span</code></td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td><code><span class="prefix">lucy_</span>Span</code></td>
+</tr>
+<tr>
+<td class="label">header file</td>
+<td><code>Lucy/Search/Span.h</code></td>
+</tr>
+</table>
+<h3>Name</h3>
+<p>Lucy::Search::Span – An offset, a length, and a weight.</p>
+<h3>Description</h3>
+<p>Span objects store information about a span across an array of…
+something. The unit is context-dependent.</p>
+<p>Text is one possibility, in which case offset and length might be measured
+in Unicode code points. However, the Span could also refer to a span
+within an array of tokens, for example – in which case the start and
+offset might be measured in token positions.</p>
+<h3>Functions</h3>
+<dl>
+<dt id="func_new">new</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>Span* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>Span_new</strong>(
+ int32_t <strong>offset</strong>,
+ int32_t <strong>length</strong>,
+ float <strong>weight</strong>
+);
+</code></pre>
+<p>Create a new Span.</p>
+<dl>
+<dt>offset</dt>
+<dd><p>Integer offset, unit is context-dependent.</p>
+</dd>
+<dt>length</dt>
+<dd><p>Integer length, unit is context-dependent.</p>
+</dd>
+<dt>weight</dt>
+<dd><p>A floating point weight.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_init">init</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>Span*
+<span class="prefix">lucy_</span><strong>Span_init</strong>(
+ <span class="prefix">lucy_</span>Span *<strong>self</strong>,
+ int32_t <strong>offset</strong>,
+ int32_t <strong>length</strong>,
+ float <strong>weight</strong>
+);
+</code></pre>
+<p>Initialize a Span. See <a href="../../Lucy/Search/Span.html#func_new">new()</a> for a description of the
+parameters.</p>
+</dd>
+</dl>
+<h3>Methods</h3>
+<dl>
+<dt id="func_Get_Offset">Get_Offset</dt>
+<dd>
+<pre><code>int32_t
+<span class="prefix">lucy_</span><strong>Span_Get_Offset</strong>(
+ <span class="prefix">lucy_</span>Span *<strong>self</strong>
+);
+</code></pre>
+<p>Accessor for <code>offset</code> attribute.</p>
+</dd>
+<dt id="func_Set_Offset">Set_Offset</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>Span_Set_Offset</strong>(
+ <span class="prefix">lucy_</span>Span *<strong>self</strong>,
+ int32_t <strong>offset</strong>
+);
+</code></pre>
+<p>Setter for <code>offset</code> attribute.</p>
+</dd>
+<dt id="func_Get_Length">Get_Length</dt>
+<dd>
+<pre><code>int32_t
+<span class="prefix">lucy_</span><strong>Span_Get_Length</strong>(
+ <span class="prefix">lucy_</span>Span *<strong>self</strong>
+);
+</code></pre>
+<p>Accessor for <code>length</code> attribute.</p>
+</dd>
+<dt id="func_Set_Length">Set_Length</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>Span_Set_Length</strong>(
+ <span class="prefix">lucy_</span>Span *<strong>self</strong>,
+ int32_t <strong>length</strong>
+);
+</code></pre>
+<p>Setter for <code>length</code> attribute.</p>
+</dd>
+<dt id="func_Get_Weight">Get_Weight</dt>
+<dd>
+<pre><code>float
+<span class="prefix">lucy_</span><strong>Span_Get_Weight</strong>(
+ <span class="prefix">lucy_</span>Span *<strong>self</strong>
+);
+</code></pre>
+<p>Accessor for <code>weight</code> attribute.</p>
+</dd>
+<dt id="func_Set_Weight">Set_Weight</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>Span_Set_Weight</strong>(
+ <span class="prefix">lucy_</span>Span *<strong>self</strong>,
+ float <strong>weight</strong>
+);
+</code></pre>
+<p>Setter for <code>weight</code> attribute.</p>
+</dd>
+<dt id="func_Equals">Equals</dt>
+<dd>
+<pre><code>bool
+<span class="prefix">lucy_</span><strong>Span_Equals</strong>(
+ <span class="prefix">lucy_</span>Span *<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>
+<dt id="func_Compare_To">Compare_To</dt>
+<dd>
+<pre><code>int32_t
+<span class="prefix">lucy_</span><strong>Span_Compare_To</strong>(
+ <span class="prefix">lucy_</span>Span *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a> *<strong>other</strong>
+);
+</code></pre>
+<p>Indicate whether one object is less than, equal to, or greater than
+another.</p>
+<dl>
+<dt>other</dt>
+<dd><p>Another Obj.</p>
+</dd>
+</dl>
+<p><strong>Returns:</strong> 0 if the objects are equal, a negative number if
+<code>self</code> is less than <code>other</code>, and a positive
+number if <code>self</code> is greater than <code>other</code>.</p>
+</dd>
+</dl>
+<h3>Inheritance</h3>
+<p>Lucy::Search::Span 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/Search/TermQuery.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Search/TermQuery.html (added)
+++ websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Search/TermQuery.html Wed Sep 28 12:07:48 2016
@@ -0,0 +1,273 @@
+<!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::Search::TermQuery – 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/Search/">Search</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::Search::TermQuery</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>TERMQUERY</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code><span class="prefix">lucy_</span>TermQuery</code></td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td><code><span class="prefix">lucy_</span>TermQuery</code></td>
+</tr>
+<tr>
+<td class="label">header file</td>
+<td><code>Lucy/Search/TermQuery.h</code></td>
+</tr>
+</table>
+<h3>Name</h3>
+<p>Lucy::Search::TermQuery – Query which matches individual terms.</p>
+<h3>Description</h3>
+<p>TermQuery is a subclass of <a href="../../Lucy/Search/Query.html">Query</a> for matching
+individual terms in a specific field.</p>
+<h3>Functions</h3>
+<dl>
+<dt id="func_new">new</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>TermQuery* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>TermQuery_new</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>Create a new TermQuery.</p>
+<dl>
+<dt>field</dt>
+<dd><p>Field name.</p>
+</dd>
+<dt>term</dt>
+<dd><p>Term text.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_init">init</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>TermQuery*
+<span class="prefix">lucy_</span><strong>TermQuery_init</strong>(
+ <span class="prefix">lucy_</span>TermQuery *<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>Initialize a TermQuery.</p>
+<dl>
+<dt>field</dt>
+<dd><p>Field name.</p>
+</dd>
+<dt>term</dt>
+<dd><p>Term text.</p>
+</dd>
+</dl>
+</dd>
+</dl>
+<h3>Methods</h3>
+<dl>
+<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>TermQuery_Get_Field</strong>(
+ <span class="prefix">lucy_</span>TermQuery *<strong>self</strong>
+);
+</code></pre>
+<p>Accessor for object’s <code>field</code> member.</p>
+</dd>
+<dt id="func_Get_Term">Get_Term</dt>
+<dd>
+<pre><code><span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a>*
+<span class="prefix">lucy_</span><strong>TermQuery_Get_Term</strong>(
+ <span class="prefix">lucy_</span>TermQuery *<strong>self</strong>
+);
+</code></pre>
+<p>Accessor for object’s <code>term</code> member.</p>
+</dd>
+<dt id="func_Make_Compiler">Make_Compiler</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Search/Compiler.html">Compiler</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>TermQuery_Make_Compiler</strong>(
+ <span class="prefix">lucy_</span>TermQuery *<strong>self</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Search/Searcher.html">Searcher</a> *<strong>searcher</strong>,
+ float <strong>boost</strong>,
+ bool <strong>subordinate</strong>
+);
+</code></pre>
+<p>Abstract factory method returning a Compiler derived from this Query.</p>
+<dl>
+<dt>searcher</dt>
+<dd><p>A Searcher.</p>
+</dd>
+<dt>boost</dt>
+<dd><p>A scoring multiplier.</p>
+</dd>
+<dt>subordinate</dt>
+<dd><p>Indicates whether the Query is a subquery (as
+opposed to a top-level query). If false, the implementation must
+invoke <a href="../../Lucy/Search/Compiler.html#func_Normalize">Normalize()</a> on the newly minted Compiler object before returning
+it.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_To_String">To_String</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>TermQuery_To_String</strong>(
+ <span class="prefix">lucy_</span>TermQuery *<strong>self</strong>
+);
+</code></pre>
+<p>Generic stringification: “ClassName@hex_mem_address”.</p>
+</dd>
+<dt id="func_Dump">Dump</dt>
+<dd>
+<pre><code><span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>TermQuery_Dump</strong>(
+ <span class="prefix">lucy_</span>TermQuery *<strong>self</strong>
+);
+</code></pre>
+</dd>
+<dt id="func_Load">Load</dt>
+<dd>
+<pre><code><span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>TermQuery_Load</strong>(
+ <span class="prefix">lucy_</span>TermQuery *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a> *<strong>dump</strong>
+);
+</code></pre>
+</dd>
+<dt id="func_Equals">Equals</dt>
+<dd>
+<pre><code>bool
+<span class="prefix">lucy_</span><strong>TermQuery_Equals</strong>(
+ <span class="prefix">lucy_</span>TermQuery *<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>
+<h4>Methods inherited from Lucy::Search::Query</h4>
+<dl>
+<dt id="func_Set_Boost">Set_Boost</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>TermQuery_Set_Boost</strong>(
+ <span class="prefix">lucy_</span>TermQuery *<strong>self</strong>,
+ float <strong>boost</strong>
+);
+</code></pre>
+<p>Set the Query’s boost.</p>
+</dd>
+<dt id="func_Get_Boost">Get_Boost</dt>
+<dd>
+<pre><code>float
+<span class="prefix">lucy_</span><strong>TermQuery_Get_Boost</strong>(
+ <span class="prefix">lucy_</span>TermQuery *<strong>self</strong>
+);
+</code></pre>
+<p>Get the Query’s boost.</p>
+</dd>
+</dl>
+<h3>Inheritance</h3>
+<p>Lucy::Search::TermQuery is a <a href="../../Lucy/Search/Query.html">Lucy::Search::Query</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/Simple.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Simple.html (added)
+++ websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Simple.html Wed Sep 28 12:07:48 2016
@@ -0,0 +1,224 @@
+<!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::Simple – 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></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::Simple</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>SIMPLE</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code><span class="prefix">lucy_</span>Simple</code></td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td><code><span class="prefix">lucy_</span>Simple</code></td>
+</tr>
+<tr>
+<td class="label">header file</td>
+<td><code>Lucy/Simple.h</code></td>
+</tr>
+</table>
+<h3>Name</h3>
+<p>Lucy::Simple – Basic search engine.</p>
+<h3>Description</h3>
+<p>Lucy::Simple is a stripped-down interface for the Apache Lucy search
+engine library.</p>
+<h3>Functions</h3>
+<dl>
+<dt id="func_new">new</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>Simple*
+<span class="prefix">lucy_</span><strong>Simple_new</strong>(
+ <span class="prefix">cfish_</span><a href="../Clownfish/Obj.html">Obj</a> *<strong>path</strong>,
+ <span class="prefix">cfish_</span><a href="../Clownfish/String.html">String</a> *<strong>language</strong>
+);
+</code></pre>
+<p>Create a Lucy::Simple object, which can be used for both indexing and
+searching. Both parameters <code>path</code> and <code>language</code> are required.</p>
+<dl>
+<dt>path</dt>
+<dd><p>Where the index directory should be located. If no index
+is found at the specified location, one will be created.</p>
+</dd>
+<dt>language</dt>
+<dd><p>The language of the documents in your collection,
+indicated by a two-letter ISO code. 12 languages are supported:</p>
+<pre><code>|-----------------------|
+| Language | ISO code |
+|-----------------------|
+| Danish | da |
+| Dutch | nl |
+| English | en |
+| Finnish | fi |
+| French | fr |
+| German | de |
+| Italian | it |
+| Norwegian | no |
+| Portuguese | pt |
+| Spanish | es |
+| Swedish | sv |
+| Russian | ru |
+|-----------------------|
+</code></pre>
+</dd>
+</dl>
+</dd>
+<dt id="func_init">init</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>Simple*
+<span class="prefix">lucy_</span><strong>Simple_init</strong>(
+ <span class="prefix">lucy_</span>Simple *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../Clownfish/Obj.html">Obj</a> *<strong>path</strong>,
+ <span class="prefix">cfish_</span><a href="../Clownfish/String.html">String</a> *<strong>language</strong>
+);
+</code></pre>
+<p>Initialize a Lucy::Simple object.</p>
+</dd>
+</dl>
+<h3>Methods</h3>
+<dl>
+<dt id="func_Add_Doc">Add_Doc</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>Simple_Add_Doc</strong>(
+ <span class="prefix">lucy_</span>Simple *<strong>self</strong>,
+ <span class="prefix">lucy_</span><a href="../Lucy/Document/Doc.html">Doc</a> *<strong>doc</strong>
+);
+</code></pre>
+<p>Add a document to the index.</p>
+</dd>
+<dt id="func_Search">Search</dt>
+<dd>
+<pre><code>uint32_t
+<span class="prefix">lucy_</span><strong>Simple_Search</strong>(
+ <span class="prefix">lucy_</span>Simple *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../Clownfish/String.html">String</a> *<strong>query</strong>,
+ uint32_t <strong>offset</strong>,
+ uint32_t <strong>num_wanted</strong>
+);
+</code></pre>
+<p>Search the index. Returns the total number of documents which match
+the query. (This number is unlikely to match <code>num_wanted</code>.)</p>
+<dl>
+<dt>query</dt>
+<dd><p>A search query string.</p>
+</dd>
+<dt>offset</dt>
+<dd><p>The number of most-relevant hits to discard, typically
+used when “paging” through hits N at a time. Setting offset to 20 and
+num_wanted to 10 retrieves hits 21-30, assuming that 30 hits can be
+found.</p>
+</dd>
+<dt>num_wanted</dt>
+<dd><p>The number of hits you would like to see after
+<code>offset</code> is taken into account.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Next">Next</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>Simple_Next</strong>(
+ <span class="prefix">lucy_</span>Simple *<strong>self</strong>
+);
+</code></pre>
+<p>Return the next hit, or NULL when the iterator is exhausted.</p>
+</dd>
+</dl>
+<h3>Inheritance</h3>
+<p>Lucy::Simple 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/Store/FSFolder.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Store/FSFolder.html (added)
+++ websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Store/FSFolder.html Wed Sep 28 12:07:48 2016
@@ -0,0 +1,153 @@
+<!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::Store::FSFolder – 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/Store/">Store</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::Store::FSFolder</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>FSFOLDER</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code><span class="prefix">lucy_</span>FSFolder</code></td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td><code><span class="prefix">lucy_</span>FSFolder</code></td>
+</tr>
+<tr>
+<td class="label">header file</td>
+<td><code>Lucy/Store/FSFolder.h</code></td>
+</tr>
+</table>
+<h3>Name</h3>
+<p>Lucy::Store::FSFolder – File System implementation of Folder.</p>
+<h3>Description</h3>
+<p>Implementation of <a href="../../Lucy/Store/Folder.html">Folder</a> using a single file system
+directory and multiple files.</p>
+<h3>Functions</h3>
+<dl>
+<dt id="func_new">new</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>FSFolder* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>FSFolder_new</strong>(
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>path</strong>
+);
+</code></pre>
+<p>Create a new Folder.</p>
+<dl>
+<dt>path</dt>
+<dd><p>Location of the index. If the specified directory does
+not exist already, it will NOT be created, in order to prevent
+misconfigured read applications from spawning bogus files – so it may
+be necessary to create the directory yourself.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_init">init</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>FSFolder*
+<span class="prefix">lucy_</span><strong>FSFolder_init</strong>(
+ <span class="prefix">lucy_</span>FSFolder *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>path</strong>
+);
+</code></pre>
+<p>Initialize a Folder. See <a href="../../Lucy/Store/FSFolder.html#func_new">new()</a> for a description of the
+parameters.</p>
+</dd>
+</dl>
+<h3>Inheritance</h3>
+<p>Lucy::Store::FSFolder is a <a href="../../Lucy/Store/Folder.html">Lucy::Store::Folder</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/Store/Folder.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Store/Folder.html (added)
+++ websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Store/Folder.html Wed Sep 28 12:07:48 2016
@@ -0,0 +1,126 @@
+<!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::Store::Folder – 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/Store/">Store</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::Store::Folder</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>FOLDER</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code><span class="prefix">lucy_</span>Folder</code></td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td><code><span class="prefix">lucy_</span>Folder</code></td>
+</tr>
+<tr>
+<td class="label">header file</td>
+<td><code>Lucy/Store/Folder.h</code></td>
+</tr>
+</table>
+<h3>Name</h3>
+<p>Lucy::Store::Folder – Abstract class representing a directory.</p>
+<h3>Description</h3>
+<p>A “file” within a Folder might be a real file on disk – or it might be a
+RAM buffer. Similarly, Delete() might delete a file from the file system, or
+a key-value pair from a hash, or something else.</p>
+<p>The archetypal implementation of Folder,
+<a href="../../Lucy/Store/FSFolder.html">FSFolder</a>, represents a directory on
+the file system holding a collection of files.</p>
+<h3>Inheritance</h3>
+<p>Lucy::Store::Folder 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/Store/Lock.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Store/Lock.html (added)
+++ websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Store/Lock.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::Store::Lock – 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/Store/">Store</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::Store::Lock</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>LOCK</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code><span class="prefix">lucy_</span>Lock</code></td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td><code><span class="prefix">lucy_</span>Lock</code></td>
+</tr>
+<tr>
+<td class="label">header file</td>
+<td><code>Lucy/Store/Lock.h</code></td>
+</tr>
+</table>
+<h3>Name</h3>
+<p>Lucy::Store::Lock – Abstract class representing an interprocess mutex lock.</p>
+<h3>Description</h3>
+<p>The Lock class produces an interprocess mutex lock. The default subclass
+uses dot-lock files, but alternative implementations are possible.</p>
+<p>Each lock must have a name which is unique per resource to be locked. Each
+lock also has a “host” id which should be unique per machine; it is used to
+help clear away stale locks.</p>
+<h3>Functions</h3>
+<dl>
+<dt id="func_init">init</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>Lock*
+<span class="prefix">lucy_</span><strong>Lock_init</strong>(
+ <span class="prefix">lucy_</span>Lock *<strong>self</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Store/Folder.html">Folder</a> *<strong>folder</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>name</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>host</strong>,
+ int32_t <strong>timeout</strong>,
+ int32_t <strong>interval</strong>
+);
+</code></pre>
+<p>Abstract initializer.</p>
+<dl>
+<dt>folder</dt>
+<dd><p>A Folder.</p>
+</dd>
+<dt>name</dt>
+<dd><p>String identifying the resource to be locked, which must
+consist solely of characters matching [-_.A-Za-z0-9].</p>
+</dd>
+<dt>host</dt>
+<dd><p>A unique per-machine identifier.</p>
+</dd>
+<dt>timeout</dt>
+<dd><p>Time in milliseconds to keep retrying before abandoning
+the attempt to <a href="../../Lucy/Store/Lock.html#func_Obtain">Obtain()</a> a lock.</p>
+</dd>
+<dt>interval</dt>
+<dd><p>Time in milliseconds between retries.</p>
+</dd>
+</dl>
+</dd>
+</dl>
+<h3>Methods</h3>
+<dl>
+<dt id="func_Shared">Shared <span class="comment">(abstract)</span></dt>
+<dd>
+<pre><code>bool
+<span class="prefix">lucy_</span><strong>Lock_Shared</strong>(
+ <span class="prefix">lucy_</span>Lock *<strong>self</strong>
+);
+</code></pre>
+<p>Returns true if the Lock is shared, false if the Lock is exclusive.</p>
+</dd>
+<dt id="func_Obtain">Obtain</dt>
+<dd>
+<pre><code>bool
+<span class="prefix">lucy_</span><strong>Lock_Obtain</strong>(
+ <span class="prefix">lucy_</span>Lock *<strong>self</strong>
+);
+</code></pre>
+<p>Call <a href="../../Lucy/Store/Lock.html#func_Request">Request()</a> once per <code>interval</code> until <a href="../../Lucy/Store/Lock.html#func_Request">Request()</a> returns
+success or the <code>timeout</code> has been reached.</p>
+<p><strong>Returns:</strong> true on success, false on failure (sets the global error object
+returned by <a href="../../Clownfish/Err.html#func_get_error">get_error()</a>).</p>
+</dd>
+<dt id="func_Request">Request <span class="comment">(abstract)</span></dt>
+<dd>
+<pre><code>bool
+<span class="prefix">lucy_</span><strong>Lock_Request</strong>(
+ <span class="prefix">lucy_</span>Lock *<strong>self</strong>
+);
+</code></pre>
+<p>Make one attempt to acquire the lock.</p>
+<p>The semantics of <a href="../../Lucy/Store/Lock.html#func_Request">Request()</a> differ depending on whether <a href="../../Lucy/Store/Lock.html#func_Shared">Shared()</a> returns
+true. If the Lock is <a href="../../Lucy/Store/Lock.html#func_Shared">Shared()</a>, then <a href="../../Lucy/Store/Lock.html#func_Request">Request()</a> should not fail if
+another lock is held against the resource identified by
+<code>name</code> (though it might fail for other reasons). If it is
+not <a href="../../Lucy/Store/Lock.html#func_Shared">Shared()</a> – i.e. it’s an exclusive (write) lock – then other locks
+should cause <a href="../../Lucy/Store/Lock.html#func_Request">Request()</a> to fail.</p>
+<p><strong>Returns:</strong> true on success, false on failure (sets the global error object
+returned by <a href="../../Clownfish/Err.html#func_get_error">get_error()</a>).</p>
+</dd>
+<dt id="func_Release">Release <span class="comment">(abstract)</span></dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>Lock_Release</strong>(
+ <span class="prefix">lucy_</span>Lock *<strong>self</strong>
+);
+</code></pre>
+<p>Release the lock.</p>
+</dd>
+<dt id="func_Is_Locked">Is_Locked <span class="comment">(abstract)</span></dt>
+<dd>
+<pre><code>bool
+<span class="prefix">lucy_</span><strong>Lock_Is_Locked</strong>(
+ <span class="prefix">lucy_</span>Lock *<strong>self</strong>
+);
+</code></pre>
+<p>Indicate whether the resource identified by this lock’s name is
+currently locked.</p>
+<p><strong>Returns:</strong> true if the resource is locked, false otherwise.</p>
+</dd>
+<dt id="func_Clear_Stale">Clear_Stale <span class="comment">(abstract)</span></dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>Lock_Clear_Stale</strong>(
+ <span class="prefix">lucy_</span>Lock *<strong>self</strong>
+);
+</code></pre>
+<p>Release all locks that meet the following three conditions: the lock
+name matches, the host id matches, and the process id that the lock
+was created under no longer identifies an active process.</p>
+</dd>
+</dl>
+<h3>Inheritance</h3>
+<p>Lucy::Store::Lock 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/Store/LockErr.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Store/LockErr.html (added)
+++ websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Store/LockErr.html Wed Sep 28 12:07:48 2016
@@ -0,0 +1,154 @@
+<!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::Store::LockErr – 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/Store/">Store</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::Store::LockErr</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>LOCKERR</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code><span class="prefix">lucy_</span>LockErr</code></td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td><code><span class="prefix">lucy_</span>LockErr</code></td>
+</tr>
+<tr>
+<td class="label">header file</td>
+<td><code>Lucy/Store/Lock.h</code></td>
+</tr>
+</table>
+<h3>Name</h3>
+<p>Lucy::Store::LockErr – Lock exception.</p>
+<h3>Description</h3>
+<p>LockErr is a subclass of <a href="../../Clownfish/Err.html">Err</a> which indicates
+that a file locking problem occurred.</p>
+<h3>Methods</h3>
+<h4>Methods inherited from Clownfish::Err</h4>
+<dl>
+<dt id="func_To_String">To_String</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>LockErr_To_String</strong>(
+ <span class="prefix">lucy_</span>LockErr *<strong>self</strong>
+);
+</code></pre>
+<p>Return a copy of the error message.</p>
+</dd>
+<dt id="func_Cat_Mess">Cat_Mess</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>LockErr_Cat_Mess</strong>(
+ <span class="prefix">lucy_</span>LockErr *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>mess</strong>
+);
+</code></pre>
+<p>Concatenate the supplied argument onto the error message.</p>
+</dd>
+<dt id="func_Get_Mess">Get_Mess</dt>
+<dd>
+<pre><code><span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a>*
+<span class="prefix">lucy_</span><strong>LockErr_Get_Mess</strong>(
+ <span class="prefix">lucy_</span>LockErr *<strong>self</strong>
+);
+</code></pre>
+<p>Return the error message.</p>
+</dd>
+</dl>
+<h3>Inheritance</h3>
+<p>Lucy::Store::LockErr is a <a href="../../Clownfish/Err.html">Clownfish::Err</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/Store/LockFactory.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Store/LockFactory.html (added)
+++ websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Store/LockFactory.html Wed Sep 28 12:07:48 2016
@@ -0,0 +1,220 @@
+<!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::Store::LockFactory – 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/Store/">Store</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::Store::LockFactory</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>LOCKFACTORY</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code><span class="prefix">lucy_</span>LockFactory</code></td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td><code><span class="prefix">lucy_</span>LockFact</code></td>
+</tr>
+<tr>
+<td class="label">header file</td>
+<td><code>Lucy/Store/LockFactory.h</code></td>
+</tr>
+</table>
+<h3>Name</h3>
+<p>Lucy::Store::LockFactory – Create Locks.</p>
+<h3>Description</h3>
+<p>LockFactory is used to spin off interprocess mutex locks used by various
+index reading and writing components. The default implementation uses
+lockfiles, but LockFactory subclasses which are implemented using
+alternatives such as flock() are possible.</p>
+<h3>Functions</h3>
+<dl>
+<dt id="func_new">new</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>LockFactory* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>LockFact_new</strong>(
+ <span class="prefix">lucy_</span><a href="../../Lucy/Store/Folder.html">Folder</a> *<strong>folder</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>host</strong>
+);
+</code></pre>
+<p>Create a new LockFactory.</p>
+<dl>
+<dt>folder</dt>
+<dd><p>A <a href="../../Lucy/Store/Folder.html">Folder</a>.</p>
+</dd>
+<dt>host</dt>
+<dd><p>An identifier which should be unique per-machine.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_init">init</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>LockFactory*
+<span class="prefix">lucy_</span><strong>LockFact_init</strong>(
+ <span class="prefix">lucy_</span>LockFactory *<strong>self</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Store/Folder.html">Folder</a> *<strong>folder</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>host</strong>
+);
+</code></pre>
+<p>Initialize a LockFactory.</p>
+<dl>
+<dt>folder</dt>
+<dd><p>A <a href="../../Lucy/Store/Folder.html">Folder</a>.</p>
+</dd>
+<dt>host</dt>
+<dd><p>An identifier which should be unique per-machine.</p>
+</dd>
+</dl>
+</dd>
+</dl>
+<h3>Methods</h3>
+<dl>
+<dt id="func_Make_Lock">Make_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>LockFact_Make_Lock</strong>(
+ <span class="prefix">lucy_</span>LockFactory *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>name</strong>,
+ int32_t <strong>timeout</strong>,
+ int32_t <strong>interval</strong>
+);
+</code></pre>
+<p>Return a Lock object, which, once <a href="../../Lucy/Store/Lock.html#func_Obtain">Obtain()</a> returns successfully,
+maintains an exclusive lock on a resource.</p>
+<dl>
+<dt>name</dt>
+<dd><p>A file-system-friendly id which identifies the
+resource to be locked.</p>
+</dd>
+<dt>timeout</dt>
+<dd><p>Time in milliseconds to keep retrying before abandoning
+the attempt to <a href="../../Lucy/Store/Lock.html#func_Obtain">Obtain()</a> a lock.</p>
+</dd>
+<dt>interval</dt>
+<dd><p>Time in milliseconds between retries.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Make_Shared_Lock">Make_Shared_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>LockFact_Make_Shared_Lock</strong>(
+ <span class="prefix">lucy_</span>LockFactory *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>name</strong>,
+ int32_t <strong>timeout</strong>,
+ int32_t <strong>interval</strong>
+);
+</code></pre>
+<p>Return a Lock object for which <a href="../../Lucy/Store/Lock.html#func_Shared">Shared()</a> returns true, and which
+maintains a non-exclusive lock on a resource once <a href="../../Lucy/Store/Lock.html#func_Obtain">Obtain()</a> returns
+success.</p>
+<dl>
+<dt>name</dt>
+<dd><p>A file-system-friendly id which identifies the
+resource to be locked.</p>
+</dd>
+<dt>timeout</dt>
+<dd><p>Time in milliseconds to keep retrying before abandoning
+the attempt to <a href="../../Lucy/Store/Lock.html#func_Obtain">Obtain()</a> a lock.</p>
+</dd>
+<dt>interval</dt>
+<dd><p>Time in milliseconds between retries.</p>
+</dd>
+</dl>
+</dd>
+</dl>
+<h3>Inheritance</h3>
+<p>Lucy::Store::LockFactory 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/Store/RAMFolder.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Store/RAMFolder.html (added)
+++ websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Store/RAMFolder.html Wed Sep 28 12:07:48 2016
@@ -0,0 +1,154 @@
+<!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::Store::RAMFolder – 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/Store/">Store</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::Store::RAMFolder</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>RAMFOLDER</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code><span class="prefix">lucy_</span>RAMFolder</code></td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td><code><span class="prefix">lucy_</span>RAMFolder</code></td>
+</tr>
+<tr>
+<td class="label">header file</td>
+<td><code>Lucy/Store/RAMFolder.h</code></td>
+</tr>
+</table>
+<h3>Name</h3>
+<p>Lucy::Store::RAMFolder – In-memory Folder implementation.</p>
+<h3>Description</h3>
+<p>RAMFolder is an entirely in-memory implementation of
+<a href="../../Lucy/Store/Folder.html">Folder</a>, primarily used for testing and development.</p>
+<h3>Functions</h3>
+<dl>
+<dt id="func_new">new</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>RAMFolder* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>RAMFolder_new</strong>(
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>path</strong>
+);
+</code></pre>
+<p>Create a new RAMFolder.</p>
+<dl>
+<dt>path</dt>
+<dd><p>Relative path, used for subfolders.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_init">init</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>RAMFolder*
+<span class="prefix">lucy_</span><strong>RAMFolder_init</strong>(
+ <span class="prefix">lucy_</span>RAMFolder *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>path</strong>
+);
+</code></pre>
+<p>Initialize a RAMFolder.</p>
+<dl>
+<dt>path</dt>
+<dd><p>Relative path, used for subfolders.</p>
+</dd>
+</dl>
+</dd>
+</dl>
+<h3>Inheritance</h3>
+<p>Lucy::Store::RAMFolder is a <a href="../../Lucy/Store/Folder.html">Lucy::Store::Folder</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/LucyX/Search/ProximityQuery.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/0.5.0/c/LucyX/Search/ProximityQuery.html (added)
+++ websites/staging/lucy/trunk/content/docs/0.5.0/c/LucyX/Search/ProximityQuery.html Wed Sep 28 12:07:48 2016
@@ -0,0 +1,284 @@
+<!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>LucyX::Search::ProximityQuery – 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/LucyX/">LucyX</a> » <a href="/docs/0.5.0/c/LucyX/Search/">Search</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>LucyX::Search::ProximityQuery</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>PROXIMITYQUERY</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code><span class="prefix">lucy_</span>ProximityQuery</code></td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td><code><span class="prefix">lucy_</span>ProximityQuery</code></td>
+</tr>
+<tr>
+<td class="label">header file</td>
+<td><code>LucyX/Search/ProximityQuery.h</code></td>
+</tr>
+</table>
+<h3>Name</h3>
+<p>LucyX::Search::ProximityQuery – Query matching an ordered list of terms.</p>
+<h3>Description</h3>
+<p>ProximityQuery is a subclass of <a href="../../Lucy/Search/Query.html">Query</a> for matching
+against an ordered sequence of terms.</p>
+<h3>Functions</h3>
+<dl>
+<dt id="func_new">new</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>ProximityQuery* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>ProximityQuery_new</strong>(
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>field</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/Vector.html">Vector</a> *<strong>terms</strong>,
+ uint32_t <strong>within</strong>
+);
+</code></pre>
+<p>Create a new ProximityQuery.</p>
+<dl>
+<dt>field</dt>
+<dd><p>The field that the phrase must occur in.</p>
+</dd>
+<dt>terms</dt>
+<dd><p>The ordered array of terms that must match.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_init">init</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>ProximityQuery*
+<span class="prefix">lucy_</span><strong>ProximityQuery_init</strong>(
+ <span class="prefix">lucy_</span>ProximityQuery *<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/Vector.html">Vector</a> *<strong>terms</strong>,
+ uint32_t <strong>within</strong>
+);
+</code></pre>
+<p>Initialize a ProximityQuery.</p>
+<dl>
+<dt>field</dt>
+<dd><p>The field that the phrase must occur in.</p>
+</dd>
+<dt>terms</dt>
+<dd><p>The ordered array of terms that must match.</p>
+</dd>
+</dl>
+</dd>
+</dl>
+<h3>Methods</h3>
+<dl>
+<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>ProximityQuery_Get_Field</strong>(
+ <span class="prefix">lucy_</span>ProximityQuery *<strong>self</strong>
+);
+</code></pre>
+<p>Accessor for object’s field attribute.</p>
+</dd>
+<dt id="func_Get_Terms">Get_Terms</dt>
+<dd>
+<pre><code><span class="prefix">cfish_</span><a href="../../Clownfish/Vector.html">Vector</a>*
+<span class="prefix">lucy_</span><strong>ProximityQuery_Get_Terms</strong>(
+ <span class="prefix">lucy_</span>ProximityQuery *<strong>self</strong>
+);
+</code></pre>
+<p>Accessor for object’s array of terms.</p>
+</dd>
+<dt id="func_Get_Within">Get_Within</dt>
+<dd>
+<pre><code>uint32_t
+<span class="prefix">lucy_</span><strong>ProximityQuery_Get_Within</strong>(
+ <span class="prefix">lucy_</span>ProximityQuery *<strong>self</strong>
+);
+</code></pre>
+<p>Accessor for object’s within attribute.</p>
+</dd>
+<dt id="func_Make_Compiler">Make_Compiler</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Search/Compiler.html">Compiler</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>ProximityQuery_Make_Compiler</strong>(
+ <span class="prefix">lucy_</span>ProximityQuery *<strong>self</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Search/Searcher.html">Searcher</a> *<strong>searcher</strong>,
+ float <strong>boost</strong>,
+ bool <strong>subordinate</strong>
+);
+</code></pre>
+<p>Abstract factory method returning a Compiler derived from this Query.</p>
+<dl>
+<dt>searcher</dt>
+<dd><p>A Searcher.</p>
+</dd>
+<dt>boost</dt>
+<dd><p>A scoring multiplier.</p>
+</dd>
+<dt>subordinate</dt>
+<dd><p>Indicates whether the Query is a subquery (as
+opposed to a top-level query). If false, the implementation must
+invoke <a href="../../Lucy/Search/Compiler.html#func_Normalize">Normalize()</a> on the newly minted Compiler object before returning
+it.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Equals">Equals</dt>
+<dd>
+<pre><code>bool
+<span class="prefix">lucy_</span><strong>ProximityQuery_Equals</strong>(
+ <span class="prefix">lucy_</span>ProximityQuery *<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>
+<dt id="func_To_String">To_String</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>ProximityQuery_To_String</strong>(
+ <span class="prefix">lucy_</span>ProximityQuery *<strong>self</strong>
+);
+</code></pre>
+<p>Generic stringification: “ClassName@hex_mem_address”.</p>
+</dd>
+<dt id="func_Dump">Dump</dt>
+<dd>
+<pre><code><span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>ProximityQuery_Dump</strong>(
+ <span class="prefix">lucy_</span>ProximityQuery *<strong>self</strong>
+);
+</code></pre>
+</dd>
+<dt id="func_Load">Load</dt>
+<dd>
+<pre><code><span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>ProximityQuery_Load</strong>(
+ <span class="prefix">lucy_</span>ProximityQuery *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a> *<strong>dump</strong>
+);
+</code></pre>
+</dd>
+</dl>
+<h4>Methods inherited from Lucy::Search::Query</h4>
+<dl>
+<dt id="func_Set_Boost">Set_Boost</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>ProximityQuery_Set_Boost</strong>(
+ <span class="prefix">lucy_</span>ProximityQuery *<strong>self</strong>,
+ float <strong>boost</strong>
+);
+</code></pre>
+<p>Set the Query’s boost.</p>
+</dd>
+<dt id="func_Get_Boost">Get_Boost</dt>
+<dd>
+<pre><code>float
+<span class="prefix">lucy_</span><strong>ProximityQuery_Get_Boost</strong>(
+ <span class="prefix">lucy_</span>ProximityQuery *<strong>self</strong>
+);
+</code></pre>
+<p>Get the Query’s boost.</p>
+</dd>
+</dl>
+<h3>Inheritance</h3>
+<p>LucyX::Search::ProximityQuery is a <a href="../../Lucy/Search/Query.html">Lucy::Search::Query</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>