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 [13/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/Query.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Search/Query.html (added)
+++ websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Search/Query.html Wed Sep 28 12:07:48 2016
@@ -0,0 +1,218 @@
+<!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::Query – 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::Query</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>QUERY</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code><span class="prefix">lucy_</span>Query</code></td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td><code><span class="prefix">lucy_</span>Query</code></td>
+</tr>
+<tr>
+<td class="label">header file</td>
+<td><code>Lucy/Search/Query.h</code></td>
+</tr>
+</table>
+<h3>Name</h3>
+<p>Lucy::Search::Query – A specification for a search query.</p>
+<h3>Description</h3>
+<p>Query objects are simple containers which contain the minimum information
+necessary to define a search query.</p>
+<p>The most common way to generate Query objects is to feed a search string
+such as ‘foo AND bar’ to a <a href="../../Lucy/Search/QueryParser.html">QueryParser’s</a>
+<a href="../../Lucy/Search/QueryParser.html#func_Parse">Parse()</a> method, which outputs an abstract syntax tree built up from various
+Query subclasses such as <a href="../../Lucy/Search/ANDQuery.html">ANDQuery</a> and
+<a href="../../Lucy/Search/TermQuery.html">TermQuery</a>. However, it is also possible
+to use custom Query objects to build a search specification which cannot be
+easily represented using a search string.</p>
+<p>Subclasses of Query must implement <a href="../../Lucy/Search/Query.html#func_Make_Compiler">Make_Compiler()</a>, which is the first step
+in compiling a Query down to a <a href="../../Lucy/Search/Matcher.html">Matcher</a> which
+can actually match and score documents.</p>
+<h3>Functions</h3>
+<dl>
+<dt id="func_init">init</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>Query*
+<span class="prefix">lucy_</span><strong>Query_init</strong>(
+ <span class="prefix">lucy_</span>Query *<strong>self</strong>,
+ float <strong>boost</strong>
+);
+</code></pre>
+<p>Abstract initializer.</p>
+<dl>
+<dt>boost</dt>
+<dd><p>A scoring multiplier, affecting the Query’s relative
+contribution to each document’s score. Typically defaults to 1.0, but
+subclasses which do not contribute to document scores such as NOTQuery
+and MatchAllQuery default to 0.0 instead.</p>
+</dd>
+</dl>
+</dd>
+</dl>
+<h3>Methods</h3>
+<dl>
+<dt id="func_Make_Compiler">Make_Compiler <span class="comment">(abstract)</span></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>Query_Make_Compiler</strong>(
+ <span class="prefix">lucy_</span>Query *<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_Set_Boost">Set_Boost</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>Query_Set_Boost</strong>(
+ <span class="prefix">lucy_</span>Query *<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>Query_Get_Boost</strong>(
+ <span class="prefix">lucy_</span>Query *<strong>self</strong>
+);
+</code></pre>
+<p>Get the Query’s boost.</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>Query_Dump</strong>(
+ <span class="prefix">lucy_</span>Query *<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>Query_Load</strong>(
+ <span class="prefix">lucy_</span>Query *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a> *<strong>dump</strong>
+);
+</code></pre>
+</dd>
+</dl>
+<h3>Inheritance</h3>
+<p>Lucy::Search::Query 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/QueryParser.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Search/QueryParser.html (added)
+++ websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Search/QueryParser.html Wed Sep 28 12:07:48 2016
@@ -0,0 +1,445 @@
+<!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::QueryParser – 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::QueryParser</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>QUERYPARSER</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code><span class="prefix">lucy_</span>QueryParser</code></td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td><code><span class="prefix">lucy_</span>QParser</code></td>
+</tr>
+<tr>
+<td class="label">header file</td>
+<td><code>Lucy/Search/QueryParser.h</code></td>
+</tr>
+</table>
+<h3>Name</h3>
+<p>Lucy::Search::QueryParser – Transform a string into a Query object.</p>
+<h3>Description</h3>
+<p>QueryParser accepts search strings as input and produces
+<a href="../../Lucy/Search/Query.html">Query</a> objects, suitable for feeding into
+<a href="../../Lucy/Search/IndexSearcher.html">IndexSearcher</a> and other
+<a href="../../Lucy/Search/Searcher.html">Searcher</a> subclasses.</p>
+<p>The following syntactical constructs are recognized by QueryParser:</p>
+<ul>
+<li>Boolean operators ‘AND’, ‘OR’, and ‘AND NOT’.</li>
+<li>Prepented +plus and -minus, indicating that the labeled entity
+should be either required or forbidden – be it a single word, a
+phrase, or a parenthetical group.</li>
+<li>Logical groups, delimited by parentheses.</li>
+<li>Phrases, delimited by double quotes.</li>
+</ul>
+<p>Additionally, the following syntax can be enabled via <a href="../../Lucy/Search/QueryParser.html#func_Set_Heed_Colons">Set_Heed_Colons()</a>:</p>
+<ul>
+<li>Field-specific constructs, in the form of ‘fieldname:termtext’ or
+‘fieldname:(foo bar)’. (The field specified by ‘fieldname:’ will be
+used instead of the QueryParser’s default fields).</li>
+</ul>
+<h3>Functions</h3>
+<dl>
+<dt id="func_new">new</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>QueryParser* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>QParser_new</strong>(
+ <span class="prefix">lucy_</span><a href="../../Lucy/Plan/Schema.html">Schema</a> *<strong>schema</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Analysis/Analyzer.html">Analyzer</a> *<strong>analyzer</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>default_boolop</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/Vector.html">Vector</a> *<strong>fields</strong>
+);
+</code></pre>
+<p>Constructor.</p>
+<dl>
+<dt>schema</dt>
+<dd><p>A <a href="../../Lucy/Plan/Schema.html">Schema</a>.</p>
+</dd>
+<dt>analyzer</dt>
+<dd><p>An <a href="../../Lucy/Analysis/Analyzer.html">Analyzer</a>.
+Ordinarily, the analyzers specified by each field’s definition will be
+used, but if <code>analyzer</code> is supplied, it will override and be used for
+all fields. This can lead to mismatches between what is in the index
+and what is being searched for, so use caution.</p>
+</dd>
+<dt>fields</dt>
+<dd><p>The names of the fields which will be searched against.
+Defaults to those fields which are defined as indexed in the supplied
+Schema.</p>
+</dd>
+<dt>default_boolop</dt>
+<dd><p>Two possible values: ‘AND’ and ‘OR’. The default
+is ‘OR’, which means: return documents which match any of the query
+terms. If you want only documents which match all of the query terms,
+set this to ‘AND’.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_init">init</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>QueryParser*
+<span class="prefix">lucy_</span><strong>QParser_init</strong>(
+ <span class="prefix">lucy_</span>QueryParser *<strong>self</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Plan/Schema.html">Schema</a> *<strong>schema</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Analysis/Analyzer.html">Analyzer</a> *<strong>analyzer</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>default_boolop</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/Vector.html">Vector</a> *<strong>fields</strong>
+);
+</code></pre>
+<p>Initialize a QueryParser.</p>
+<dl>
+<dt>schema</dt>
+<dd><p>A <a href="../../Lucy/Plan/Schema.html">Schema</a>.</p>
+</dd>
+<dt>analyzer</dt>
+<dd><p>An <a href="../../Lucy/Analysis/Analyzer.html">Analyzer</a>.
+Ordinarily, the analyzers specified by each field’s definition will be
+used, but if <code>analyzer</code> is supplied, it will override and be used for
+all fields. This can lead to mismatches between what is in the index
+and what is being searched for, so use caution.</p>
+</dd>
+<dt>fields</dt>
+<dd><p>The names of the fields which will be searched against.
+Defaults to those fields which are defined as indexed in the supplied
+Schema.</p>
+</dd>
+<dt>default_boolop</dt>
+<dd><p>Two possible values: ‘AND’ and ‘OR’. The default
+is ‘OR’, which means: return documents which match any of the query
+terms. If you want only documents which match all of the query terms,
+set this to ‘AND’.</p>
+</dd>
+</dl>
+</dd>
+</dl>
+<h3>Methods</h3>
+<dl>
+<dt id="func_Parse">Parse</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Search/Query.html">Query</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>QParser_Parse</strong>(
+ <span class="prefix">lucy_</span>QueryParser *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>query_string</strong>
+);
+</code></pre>
+<p>Build a Query object from the contents of a query string. At present,
+implemented internally by calling <a href="../../Lucy/Search/QueryParser.html#func_Tree">Tree()</a>, <a href="../../Lucy/Search/QueryParser.html#func_Expand">Expand()</a>, and <a href="../../Lucy/Search/QueryParser.html#func_Prune">Prune()</a>.</p>
+<dl>
+<dt>query_string</dt>
+<dd><p>The string to be parsed. May be NULL.</p>
+</dd>
+</dl>
+<p><strong>Returns:</strong> a Query.</p>
+</dd>
+<dt id="func_Tree">Tree</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Search/Query.html">Query</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>QParser_Tree</strong>(
+ <span class="prefix">lucy_</span>QueryParser *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>query_string</strong>
+);
+</code></pre>
+<p>Parse the logical structure of a query string, building a tree
+comprised of Query objects. Leaf nodes in the tree will most often be
+LeafQuery objects but might be MatchAllQuery or NoMatchQuery objects as
+well. Internal nodes will be objects which subclass PolyQuery:
+ANDQuery, ORQuery, NOTQuery, and RequiredOptionalQuery.</p>
+<p>The output of <a href="../../Lucy/Search/QueryParser.html#func_Tree">Tree()</a> is an intermediate form which must be passed
+through <a href="../../Lucy/Search/QueryParser.html#func_Expand">Expand()</a> before being used to feed a search.</p>
+<dl>
+<dt>query_string</dt>
+<dd><p>The string to be parsed.</p>
+</dd>
+</dl>
+<p><strong>Returns:</strong> a Query.</p>
+</dd>
+<dt id="func_Expand">Expand</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Search/Query.html">Query</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>QParser_Expand</strong>(
+ <span class="prefix">lucy_</span>QueryParser *<strong>self</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Search/Query.html">Query</a> *<strong>query</strong>
+);
+</code></pre>
+<p>Walk the hierarchy of a Query tree, descending through all PolyQuery
+nodes and calling <a href="../../Lucy/Search/QueryParser.html#func_Expand_Leaf">Expand_Leaf()</a> on any LeafQuery nodes encountered.</p>
+<dl>
+<dt>query</dt>
+<dd><p>A Query object.</p>
+</dd>
+</dl>
+<p><strong>Returns:</strong> A Query – usually the same one that was supplied after
+in-place modification, but possibly another.</p>
+</dd>
+<dt id="func_Expand_Leaf">Expand_Leaf</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Search/Query.html">Query</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>QParser_Expand_Leaf</strong>(
+ <span class="prefix">lucy_</span>QueryParser *<strong>self</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Search/Query.html">Query</a> *<strong>query</strong>
+);
+</code></pre>
+<p>Convert a LeafQuery into either a TermQuery, a PhraseQuery, or an
+ORQuery joining multiple TermQueries/PhraseQueries to accommodate
+multiple fields. LeafQuery text will be passed through the relevant
+Analyzer for each field. Quoted text will be transformed into
+PhraseQuery objects. Unquoted text will be converted to either a
+TermQuery or a PhraseQuery depending on how many tokens are generated.</p>
+<dl>
+<dt>query</dt>
+<dd><p>A Query. Only LeafQuery objects will be processed; others
+will be passed through.</p>
+</dd>
+</dl>
+<p><strong>Returns:</strong> A Query.</p>
+</dd>
+<dt id="func_Prune">Prune</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Search/Query.html">Query</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>QParser_Prune</strong>(
+ <span class="prefix">lucy_</span>QueryParser *<strong>self</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Search/Query.html">Query</a> *<strong>query</strong>
+);
+</code></pre>
+<p>Prevent certain Query structures from returning too many results.
+Query objects built via <a href="../../Lucy/Search/QueryParser.html#func_Tree">Tree()</a> and <a href="../../Lucy/Search/QueryParser.html#func_Expand">Expand()</a> can generate “return the
+world” result sets, such as in the case of
+<code>NOT a_term_not_in_the_index</code>; <a href="../../Lucy/Search/QueryParser.html#func_Prune">Prune()</a> walks the hierarchy
+and eliminates such branches.</p>
+<pre><code> 'NOT foo' => [NOMATCH]
+ 'foo OR NOT bar' => 'foo'
+ 'foo OR (-bar AND -baz) => 'foo'
+</code></pre>
+<p><a href="../../Lucy/Search/QueryParser.html#func_Prune">Prune()</a> also eliminates some double-negative constructs – even though
+such constructs may not actually return the world:</p>
+<pre><code> 'foo AND -(-bar)' => 'foo'
+</code></pre>
+<p>In this example, safety is taking precedence over logical consistency.
+If you want logical consistency instead, call <a href="../../Lucy/Search/QueryParser.html#func_Tree">Tree()</a> then <a href="../../Lucy/Search/QueryParser.html#func_Expand">Expand()</a>,
+skipping <a href="../../Lucy/Search/QueryParser.html#func_Prune">Prune()</a>.</p>
+<dl>
+<dt>query</dt>
+<dd><p>A Query.</p>
+</dd>
+</dl>
+<p><strong>Returns:</strong> a Query; in most cases, the supplied Query after in-place
+modification.</p>
+</dd>
+<dt id="func_Make_Term_Query">Make_Term_Query</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Search/Query.html">Query</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>QParser_Make_Term_Query</strong>(
+ <span class="prefix">lucy_</span>QueryParser *<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>Factory method creating a TermQuery.</p>
+<dl>
+<dt>field</dt>
+<dd><p>Field name.</p>
+</dd>
+<dt>term</dt>
+<dd><p>Term text.</p>
+</dd>
+</dl>
+<p><strong>Returns:</strong> A Query.</p>
+</dd>
+<dt id="func_Make_Phrase_Query">Make_Phrase_Query</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Search/Query.html">Query</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>QParser_Make_Phrase_Query</strong>(
+ <span class="prefix">lucy_</span>QueryParser *<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>
+);
+</code></pre>
+<p>Factory method creating a PhraseQuery.</p>
+<dl>
+<dt>field</dt>
+<dd><p>Field that the phrase must occur in.</p>
+</dd>
+<dt>terms</dt>
+<dd><p>Ordered array of terms that must match.</p>
+</dd>
+</dl>
+<p><strong>Returns:</strong> A Query.</p>
+</dd>
+<dt id="func_Make_OR_Query">Make_OR_Query</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Search/Query.html">Query</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>QParser_Make_OR_Query</strong>(
+ <span class="prefix">lucy_</span>QueryParser *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/Vector.html">Vector</a> *<strong>children</strong>
+);
+</code></pre>
+<p>Factory method creating an ORQuery.</p>
+<dl>
+<dt>children</dt>
+<dd><p>Array of child Queries.</p>
+</dd>
+</dl>
+<p><strong>Returns:</strong> A Query.</p>
+</dd>
+<dt id="func_Make_AND_Query">Make_AND_Query</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Search/Query.html">Query</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>QParser_Make_AND_Query</strong>(
+ <span class="prefix">lucy_</span>QueryParser *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/Vector.html">Vector</a> *<strong>children</strong>
+);
+</code></pre>
+<p>Factory method creating an ANDQuery.</p>
+<dl>
+<dt>children</dt>
+<dd><p>Array of child Queries.</p>
+</dd>
+</dl>
+<p><strong>Returns:</strong> A Query.</p>
+</dd>
+<dt id="func_Make_NOT_Query">Make_NOT_Query</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Search/Query.html">Query</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>QParser_Make_NOT_Query</strong>(
+ <span class="prefix">lucy_</span>QueryParser *<strong>self</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Search/Query.html">Query</a> *<strong>negated_query</strong>
+);
+</code></pre>
+<p>Factory method creating a NOTQuery.</p>
+<dl>
+<dt>negated_query</dt>
+<dd><p>Query to be inverted.</p>
+</dd>
+</dl>
+<p><strong>Returns:</strong> A Query.</p>
+</dd>
+<dt id="func_Make_Req_Opt_Query">Make_Req_Opt_Query</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Search/Query.html">Query</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>QParser_Make_Req_Opt_Query</strong>(
+ <span class="prefix">lucy_</span>QueryParser *<strong>self</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Search/Query.html">Query</a> *<strong>required_query</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Search/Query.html">Query</a> *<strong>optional_query</strong>
+);
+</code></pre>
+<p>Factory method creating a RequiredOptionalQuery.</p>
+<dl>
+<dt>required_query</dt>
+<dd><p>Query must must match.</p>
+</dd>
+<dt>optional_query</dt>
+<dd><p>Query which should match.</p>
+</dd>
+</dl>
+<p><strong>Returns:</strong> A Query.</p>
+</dd>
+<dt id="func_Set_Heed_Colons">Set_Heed_Colons</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>QParser_Set_Heed_Colons</strong>(
+ <span class="prefix">lucy_</span>QueryParser *<strong>self</strong>,
+ bool <strong>heed_colons</strong>
+);
+</code></pre>
+<p>Enable/disable parsing of <code>fieldname:foo</code> constructs.</p>
+</dd>
+</dl>
+<h3>Inheritance</h3>
+<p>Lucy::Search::QueryParser 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/RangeQuery.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Search/RangeQuery.html (added)
+++ websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Search/RangeQuery.html Wed Sep 28 12:07:48 2016
@@ -0,0 +1,269 @@
+<!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::RangeQuery – 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::RangeQuery</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>RANGEQUERY</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code><span class="prefix">lucy_</span>RangeQuery</code></td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td><code><span class="prefix">lucy_</span>RangeQuery</code></td>
+</tr>
+<tr>
+<td class="label">header file</td>
+<td><code>Lucy/Search/RangeQuery.h</code></td>
+</tr>
+</table>
+<h3>Name</h3>
+<p>Lucy::Search::RangeQuery – Match a range of values.</p>
+<h3>Description</h3>
+<p>RangeQuery matches documents where the value for a particular field falls
+within a given range.</p>
+<h3>Functions</h3>
+<dl>
+<dt id="func_new">new</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>RangeQuery* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>RangeQuery_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>lower_term</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a> *<strong>upper_term</strong>,
+ bool <strong>include_lower</strong>,
+ bool <strong>include_upper</strong>
+);
+</code></pre>
+<p>Create a new RangeQuery.</p>
+<p>Takes 5 parameters; <code>field</code> is required, as is at least one of either
+<code>lower_term</code> or <code>upper_term</code>.</p>
+<dl>
+<dt>field</dt>
+<dd><p>The name of a <code>sortable</code> field.</p>
+</dd>
+<dt>lower_term</dt>
+<dd><p>Lower delimiter. If not supplied, all values
+less than <code>upper_term</code> will pass.</p>
+</dd>
+<dt>upper_term</dt>
+<dd><p>Upper delimiter. If not supplied, all values greater
+than <code>lower_term</code> will pass.</p>
+</dd>
+<dt>include_lower</dt>
+<dd><p>Indicates whether docs which match
+<code>lower_term</code> should be included in the results.</p>
+</dd>
+<dt>include_upper</dt>
+<dd><p>Indicates whether docs which match
+<code>upper_term</code> should be included in the results.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_init">init</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>RangeQuery*
+<span class="prefix">lucy_</span><strong>RangeQuery_init</strong>(
+ <span class="prefix">lucy_</span>RangeQuery *<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>lower_term</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a> *<strong>upper_term</strong>,
+ bool <strong>include_lower</strong>,
+ bool <strong>include_upper</strong>
+);
+</code></pre>
+<p>Initialize a RangeQuery. See <a href="../../Lucy/Search/RangeQuery.html#func_new">new()</a> for a description of the
+parameters.</p>
+</dd>
+</dl>
+<h3>Methods</h3>
+<dl>
+<dt id="func_Equals">Equals</dt>
+<dd>
+<pre><code>bool
+<span class="prefix">lucy_</span><strong>RangeQuery_Equals</strong>(
+ <span class="prefix">lucy_</span>RangeQuery *<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>RangeQuery_To_String</strong>(
+ <span class="prefix">lucy_</span>RangeQuery *<strong>self</strong>
+);
+</code></pre>
+<p>Generic stringification: “ClassName@hex_mem_address”.</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>RangeQuery_Make_Compiler</strong>(
+ <span class="prefix">lucy_</span>RangeQuery *<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_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>RangeQuery_Dump</strong>(
+ <span class="prefix">lucy_</span>RangeQuery *<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>RangeQuery_Load</strong>(
+ <span class="prefix">lucy_</span>RangeQuery *<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>RangeQuery_Set_Boost</strong>(
+ <span class="prefix">lucy_</span>RangeQuery *<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>RangeQuery_Get_Boost</strong>(
+ <span class="prefix">lucy_</span>RangeQuery *<strong>self</strong>
+);
+</code></pre>
+<p>Get the Query’s boost.</p>
+</dd>
+</dl>
+<h3>Inheritance</h3>
+<p>Lucy::Search::RangeQuery 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/Search/RequiredOptionalQuery.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Search/RequiredOptionalQuery.html (added)
+++ websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Search/RequiredOptionalQuery.html Wed Sep 28 12:07:48 2016
@@ -0,0 +1,307 @@
+<!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::RequiredOptionalQuery – 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::RequiredOptionalQuery</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>REQUIREDOPTIONALQUERY</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code><span class="prefix">lucy_</span>RequiredOptionalQuery</code></td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td><code><span class="prefix">lucy_</span>ReqOptQuery</code></td>
+</tr>
+<tr>
+<td class="label">header file</td>
+<td><code>Lucy/Search/RequiredOptionalQuery.h</code></td>
+</tr>
+</table>
+<h3>Name</h3>
+<p>Lucy::Search::RequiredOptionalQuery – Join results for two Queries, one required, one optional.</p>
+<h3>Description</h3>
+<p>RequiredOptionalQuery joins the result sets of one Query which MUST match,
+and one Query which SHOULD match. When only the required Query matches,
+its score is passed along; when both match, the scores are summed.</p>
+<h3>Functions</h3>
+<dl>
+<dt id="func_new">new</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>RequiredOptionalQuery* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>ReqOptQuery_new</strong>(
+ <span class="prefix">lucy_</span><a href="../../Lucy/Search/Query.html">Query</a> *<strong>required_query</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Search/Query.html">Query</a> *<strong>optional_query</strong>
+);
+</code></pre>
+<p>Create a new RequiredOptionalQuery.</p>
+<dl>
+<dt>required_query</dt>
+<dd><p>Query must must match.</p>
+</dd>
+<dt>optional_query</dt>
+<dd><p>Query which should match.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_init">init</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>RequiredOptionalQuery*
+<span class="prefix">lucy_</span><strong>ReqOptQuery_init</strong>(
+ <span class="prefix">lucy_</span>RequiredOptionalQuery *<strong>self</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Search/Query.html">Query</a> *<strong>required_query</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Search/Query.html">Query</a> *<strong>optional_query</strong>
+);
+</code></pre>
+<p>Initialize a RequiredOptionalQuery.</p>
+<dl>
+<dt>required_query</dt>
+<dd><p>Query must must match.</p>
+</dd>
+<dt>optional_query</dt>
+<dd><p>Query which should match.</p>
+</dd>
+</dl>
+</dd>
+</dl>
+<h3>Methods</h3>
+<dl>
+<dt id="func_Get_Required_Query">Get_Required_Query</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Search/Query.html">Query</a>*
+<span class="prefix">lucy_</span><strong>ReqOptQuery_Get_Required_Query</strong>(
+ <span class="prefix">lucy_</span>RequiredOptionalQuery *<strong>self</strong>
+);
+</code></pre>
+<p>Getter for the required Query.</p>
+</dd>
+<dt id="func_Set_Required_Query">Set_Required_Query</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>ReqOptQuery_Set_Required_Query</strong>(
+ <span class="prefix">lucy_</span>RequiredOptionalQuery *<strong>self</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Search/Query.html">Query</a> *<strong>required_query</strong>
+);
+</code></pre>
+<p>Setter for the required Query.</p>
+</dd>
+<dt id="func_Get_Optional_Query">Get_Optional_Query</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Search/Query.html">Query</a>*
+<span class="prefix">lucy_</span><strong>ReqOptQuery_Get_Optional_Query</strong>(
+ <span class="prefix">lucy_</span>RequiredOptionalQuery *<strong>self</strong>
+);
+</code></pre>
+<p>Getter for the optional Query.</p>
+</dd>
+<dt id="func_Set_Optional_Query">Set_Optional_Query</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>ReqOptQuery_Set_Optional_Query</strong>(
+ <span class="prefix">lucy_</span>RequiredOptionalQuery *<strong>self</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Search/Query.html">Query</a> *<strong>optional_query</strong>
+);
+</code></pre>
+<p>Setter for the optional Query.</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>ReqOptQuery_Make_Compiler</strong>(
+ <span class="prefix">lucy_</span>RequiredOptionalQuery *<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>ReqOptQuery_To_String</strong>(
+ <span class="prefix">lucy_</span>RequiredOptionalQuery *<strong>self</strong>
+);
+</code></pre>
+<p>Generic stringification: “ClassName@hex_mem_address”.</p>
+</dd>
+<dt id="func_Equals">Equals</dt>
+<dd>
+<pre><code>bool
+<span class="prefix">lucy_</span><strong>ReqOptQuery_Equals</strong>(
+ <span class="prefix">lucy_</span>RequiredOptionalQuery *<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::PolyQuery</h4>
+<dl>
+<dt id="func_Add_Child">Add_Child</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>ReqOptQuery_Add_Child</strong>(
+ <span class="prefix">lucy_</span>RequiredOptionalQuery *<strong>self</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Search/Query.html">Query</a> *<strong>query</strong>
+);
+</code></pre>
+<p>Add a child Query node.</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>ReqOptQuery_Dump</strong>(
+ <span class="prefix">lucy_</span>RequiredOptionalQuery *<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>ReqOptQuery_Load</strong>(
+ <span class="prefix">lucy_</span>RequiredOptionalQuery *<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>ReqOptQuery_Set_Boost</strong>(
+ <span class="prefix">lucy_</span>RequiredOptionalQuery *<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>ReqOptQuery_Get_Boost</strong>(
+ <span class="prefix">lucy_</span>RequiredOptionalQuery *<strong>self</strong>
+);
+</code></pre>
+<p>Get the Query’s boost.</p>
+</dd>
+</dl>
+<h3>Inheritance</h3>
+<p>Lucy::Search::RequiredOptionalQuery is a <a href="../../Lucy/Search/PolyQuery.html">Lucy::Search::PolyQuery</a> 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/Search/Searcher.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Search/Searcher.html (added)
+++ websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Search/Searcher.html Wed Sep 28 12:07:48 2016
@@ -0,0 +1,264 @@
+<!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::Searcher – 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::Searcher</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>SEARCHER</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code><span class="prefix">lucy_</span>Searcher</code></td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td><code><span class="prefix">lucy_</span>Searcher</code></td>
+</tr>
+<tr>
+<td class="label">header file</td>
+<td><code>Lucy/Search/Searcher.h</code></td>
+</tr>
+</table>
+<h3>Name</h3>
+<p>Lucy::Search::Searcher – Base class for searching collections of documents.</p>
+<h3>Description</h3>
+<p>Abstract base class for objects which search. Core subclasses include
+<a href="../../Lucy/Search/IndexSearcher.html">IndexSearcher</a> and
+<a href="../../Lucy/Search/PolySearcher.html">PolySearcher</a>.</p>
+<h3>Functions</h3>
+<dl>
+<dt id="func_init">init</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>Searcher*
+<span class="prefix">lucy_</span><strong>Searcher_init</strong>(
+ <span class="prefix">lucy_</span>Searcher *<strong>self</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Plan/Schema.html">Schema</a> *<strong>schema</strong>
+);
+</code></pre>
+<p>Abstract initializer.</p>
+<dl>
+<dt>schema</dt>
+<dd><p>A Schema.</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>Searcher_Doc_Max</strong>(
+ <span class="prefix">lucy_</span>Searcher *<strong>self</strong>
+);
+</code></pre>
+<p>Return the maximum number of docs in the collection represented by the
+Searcher, which is also the highest possible internal doc id.
+Documents which have been marked as deleted but not yet purged are
+included in this count.</p>
+</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>Searcher_Doc_Freq</strong>(
+ <span class="prefix">lucy_</span>Searcher *<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 which contain the term in the given
+field.</p>
+<dl>
+<dt>field</dt>
+<dd><p>Field name.</p>
+</dd>
+<dt>term</dt>
+<dd><p>The term to look up.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Glean_Query">Glean_Query</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Search/Query.html">Query</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>Searcher_Glean_Query</strong>(
+ <span class="prefix">lucy_</span>Searcher *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a> *<strong>query</strong>
+);
+</code></pre>
+<p>If the supplied object is a Query, return it; if it’s a query string,
+create a QueryParser and parse it to produce a query against all
+indexed fields.</p>
+</dd>
+<dt id="func_Hits">Hits</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Search/Hits.html">Hits</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>Searcher_Hits</strong>(
+ <span class="prefix">lucy_</span>Searcher *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a> *<strong>query</strong>,
+ uint32_t <strong>offset</strong>,
+ uint32_t <strong>num_wanted</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Search/SortSpec.html">SortSpec</a> *<strong>sort_spec</strong>
+);
+</code></pre>
+<p>Return a Hits object containing the top results.</p>
+<dl>
+<dt>query</dt>
+<dd><p>Either a Query object or a 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
+<code>offset</code> to 20 and <code>num_wanted</code> 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>
+<dt>sort_spec</dt>
+<dd><p>A <a href="../../Lucy/Search/SortSpec.html">SortSpec</a>, which will affect
+how results are ranked and returned.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Collect">Collect <span class="comment">(abstract)</span></dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>Searcher_Collect</strong>(
+ <span class="prefix">lucy_</span>Searcher *<strong>self</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Search/Query.html">Query</a> *<strong>query</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Search/Collector.html">Collector</a> *<strong>collector</strong>
+);
+</code></pre>
+<p>Iterate over hits, feeding them into a
+<a href="../../Lucy/Search/Collector.html">Collector</a>.</p>
+<dl>
+<dt>query</dt>
+<dd><p>A Query.</p>
+</dd>
+<dt>collector</dt>
+<dd><p>A Collector.</p>
+</dd>
+</dl>
+</dd>
+<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>Searcher_Fetch_Doc</strong>(
+ <span class="prefix">lucy_</span>Searcher *<strong>self</strong>,
+ int32_t <strong>doc_id</strong>
+);
+</code></pre>
+<p>Retrieve a document. Throws an error if the doc id is out of range.</p>
+<dl>
+<dt>doc_id</dt>
+<dd><p>A document id.</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>Searcher_Get_Schema</strong>(
+ <span class="prefix">lucy_</span>Searcher *<strong>self</strong>
+);
+</code></pre>
+<p>Accessor for the object’s <code>schema</code> member.</p>
+</dd>
+</dl>
+<h3>Inheritance</h3>
+<p>Lucy::Search::Searcher 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/SortRule.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Search/SortRule.html (added)
+++ websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Search/SortRule.html Wed Sep 28 12:07:48 2016
@@ -0,0 +1,193 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html lang="en">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+ <title>Lucy::Search::SortRule – 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::SortRule</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>SORTRULE</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code><span class="prefix">lucy_</span>SortRule</code></td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td><code><span class="prefix">lucy_</span>SortRule</code></td>
+</tr>
+<tr>
+<td class="label">header file</td>
+<td><code>Lucy/Search/SortRule.h</code></td>
+</tr>
+</table>
+<h3>Name</h3>
+<p>Lucy::Search::SortRule – Element of a SortSpec.</p>
+<h3>Description</h3>
+<p>SortRules are the building blocks used to assemble
+<a href="../../Lucy/Search/SortSpec.html">SortSpecs</a>; each SortRule defines a single
+level of sorting. For example, sorting first by “category” then by score
+requires a SortSpec with two SortRule elements.</p>
+<h3>Functions</h3>
+<dl>
+<dt id="func_new">new</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>SortRule* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>SortRule_new</strong>(
+ int32_t <strong>type</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>field</strong>,
+ bool <strong>reverse</strong>
+);
+</code></pre>
+<p>Create a new SortRule.</p>
+<dl>
+<dt>type</dt>
+<dd><p>Indicate whether to sort by score, field, etc. (The
+default is to sort by a field.)</p>
+</dd>
+<dt>field</dt>
+<dd><p>The name of a <code>sortable</code> field.</p>
+</dd>
+<dt>reverse</dt>
+<dd><p>If true, reverse the order of the sort for this rule.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_init">init</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>SortRule* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>SortRule_init</strong>(
+ <span class="prefix">lucy_</span>SortRule *<strong>self</strong>,
+ int32_t <strong>type</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>field</strong>,
+ bool <strong>reverse</strong>
+);
+</code></pre>
+<p>Initialize a SortRule. See <a href="../../Lucy/Search/SortRule.html#func_new">new()</a> for a description of the
+parameters.</p>
+</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>SortRule_Get_Field</strong>(
+ <span class="prefix">lucy_</span>SortRule *<strong>self</strong>
+);
+</code></pre>
+<p>Accessor for “field” member.</p>
+</dd>
+<dt id="func_Get_Type">Get_Type</dt>
+<dd>
+<pre><code>int32_t
+<span class="prefix">lucy_</span><strong>SortRule_Get_Type</strong>(
+ <span class="prefix">lucy_</span>SortRule *<strong>self</strong>
+);
+</code></pre>
+<p>Accessor for “type” member.</p>
+</dd>
+<dt id="func_Get_Reverse">Get_Reverse</dt>
+<dd>
+<pre><code>bool
+<span class="prefix">lucy_</span><strong>SortRule_Get_Reverse</strong>(
+ <span class="prefix">lucy_</span>SortRule *<strong>self</strong>
+);
+</code></pre>
+<p>Accessor for “reverse” member.</p>
+</dd>
+</dl>
+<h3>Inheritance</h3>
+<p>Lucy::Search::SortRule 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/SortSpec.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Search/SortSpec.html (added)
+++ websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Search/SortSpec.html Wed Sep 28 12:07:48 2016
@@ -0,0 +1,158 @@
+<!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::SortSpec – 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::SortSpec</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>SORTSPEC</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code><span class="prefix">lucy_</span>SortSpec</code></td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td><code><span class="prefix">lucy_</span>SortSpec</code></td>
+</tr>
+<tr>
+<td class="label">header file</td>
+<td><code>Lucy/Search/SortSpec.h</code></td>
+</tr>
+</table>
+<h3>Name</h3>
+<p>Lucy::Search::SortSpec – Specify a custom sort order for search results.</p>
+<h3>Description</h3>
+<p>By default, searches return results in order of relevance; SortSpec allows
+you to indicate an alternate order via an array of
+<a href="../../Lucy/Search/SortRule.html">SortRules</a>.</p>
+<p>Fields you wish to sort against must be <code>sortable</code>.</p>
+<p>For a stable sort (important when paging through results), add a
+sort-by-doc rule as the last SortRule.</p>
+<h3>Functions</h3>
+<dl>
+<dt id="func_new">new</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>SortSpec*
+<span class="prefix">lucy_</span><strong>SortSpec_new</strong>(
+ <span class="prefix">cfish_</span><a href="../../Clownfish/Vector.html">Vector</a> *<strong>rules</strong>
+);
+</code></pre>
+<p>Create a new SortSpec.</p>
+<dl>
+<dt>rules</dt>
+<dd><p>An array of SortRules.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_init">init</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>SortSpec*
+<span class="prefix">lucy_</span><strong>SortSpec_init</strong>(
+ <span class="prefix">lucy_</span>SortSpec *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/Vector.html">Vector</a> *<strong>rules</strong>
+);
+</code></pre>
+<p>Initialize a SortSpec.</p>
+<dl>
+<dt>rules</dt>
+<dd><p>An array of SortRules.</p>
+</dd>
+</dl>
+</dd>
+</dl>
+<h3>Inheritance</h3>
+<p>Lucy::Search::SortSpec 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>