Modified: websites/staging/lucy/trunk/content/docs/c/lucy_LeafQuery.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/lucy_LeafQuery.html (original) +++ websites/staging/lucy/trunk/content/docs/c/lucy_LeafQuery.html Tue Dec 2 17:54:11 2014 @@ -1,159 +1,226 @@ <!DOCTYPE html> <html> <head> +<meta charset="utf-8"> +<!-- +*********************************************** + +!!!! DO NOT EDIT !!!! + +This file was auto-generated by cfc. + +*********************************************** + +Licensed to the Apache Software Foundation (ASF) under one or more +contributor license agreements. See the NOTICE file distributed with +this work for additional information regarding copyright ownership. +The ASF licenses this file to You under the Apache License, Version 2.0 +(the "License"); you may not use this file except in compliance with +the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> <meta name="viewport" content="width=device-width" /> +<title>Lucy::Search::LeafQuery â C API Documentation</title> <style type="text/css"> body { - font-family: sans-serif; - font-size: 0.85em; - max-width: 640px; + max-width: 48em; + font: 0.85em/1.4 sans-serif; +} +a { + color: #23b; +} +table { + border-collapse: collapse; +} +td { + padding: 0; +} +td.label { + padding-right: 2em; + font-weight: bold; } dt { font-weight: bold; } pre { - border: 1px solid #000; + border: 1px solid #ccc; padding: 0.2em 0.4em; background: #f6f6f6; - font-size: 1.2em; + font-size: 0.92em; +} +pre a { + text-decoration: none; } -code { +pre, code { font-family: "Consolas", "Menlo", monospace; } +span.prefix, span.comment { + color: #888; +} </style> </head> <body> <h1>Lucy::Search::LeafQuery</h1> +<table> +<tr> +<td class="label">parcel</td> +<td><a href="lucy.html">Lucy</a></td> +</tr> +<tr> +<td class="label">class name</td> +<td>Lucy::Search::LeafQuery</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>LeafQuery</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_LEAFQUERY</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_LeafQuery</code></td> +</tr> +</table> <h2>Name</h2> -<p>Lucy::Search::LeafQuery - Leaf node in a tree created by QueryParser.</p> +<p>Lucy::Search::LeafQuery â Leaf node in a tree created by QueryParser.</p> <h2>Description</h2> <p>LeafQuery objects serve as leaf nodes in the tree structure generated by -<a href="lucy_QueryParser.html">QueryParser</a>'s Tree() method. +<a href="lucy_QueryParser.html">QueryParser</a>'s <a href="lucy_QueryParser.html#func_Tree">Tree()</a> method. Ultimately, they must be transformed, typically into either <a href="lucy_TermQuery.html">TermQuery</a> or <a href="lucy_PhraseQuery.html">PhraseQuery</a> objects, as attempting to search a LeafQuery causes an error.</p> <h2>Functions</h2> <dl> -<dt>init</dt> +<dt id="func_init">init</dt> <dd> -<pre><code>lucy_LeafQuery* -<strong>lucy_LeafQuery_init</strong>( - lucy_LeafQuery* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>field</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>text</strong> +<pre><code><span class="prefix">lucy_</span>LeafQuery* +<span class="prefix">lucy_</span><strong>LeafQuery_init</strong>( + <span class="prefix">lucy_</span>LeafQuery* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>field</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>text</strong> ); </code></pre> <dl> -<dt><emph>field</emph></dt> +<dt>field</dt> <dd><p>Optional field name.</p> </dd> -<dt><emph>text</emph></dt> +<dt>text</dt> <dd><p>Raw query text.</p> </dd> </dl> </dd> </dl> <h2>Methods</h2> -<h3>Novel methods</h3> +<h3>Novel methods</h3 <dl> -<dt>Get_Field</dt> +<dt id="func_Get_Field">Get_Field</dt> <dd> -<pre><code><a href="cfish_String.html">cfish_String*</a> -<strong>LUCY_LeafQuery_Get_Field</strong>( - lucy_LeafQuery* <strong>self</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> +<span class="prefix">LUCY_</span><strong>LeafQuery_Get_Field</strong>( + <span class="prefix">lucy_</span>LeafQuery* <strong>self</strong> ); </code></pre> <p>Accessor for object's <code>field</code> attribute.</p> </dd> -<dt>Get_Text</dt> +<dt id="func_Get_Text">Get_Text</dt> <dd> -<pre><code><a href="cfish_String.html">cfish_String*</a> -<strong>LUCY_LeafQuery_Get_Text</strong>( - lucy_LeafQuery* <strong>self</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> +<span class="prefix">LUCY_</span><strong>LeafQuery_Get_Text</strong>( + <span class="prefix">lucy_</span>LeafQuery* <strong>self</strong> ); </code></pre> <p>Accessor for object's <code>text</code> attribute.</p> </dd> </dl> -<h3>Methods inherited from Lucy::Search::Query</h3><dl> -<dt>Make_Compiler</dt> +<h3>Methods inherited from Lucy::Search::Query</h3> +<dl> +<dt id="func_Make_Compiler">Make_Compiler <span class="comment">(abstract)</span></dt> <dd> -<pre><code><a href="lucy_Compiler.html">lucy_Compiler*</a> // incremented -<strong>LUCY_Query_Make_Compiler</strong>( - lucy_Query* <strong>self</strong>, - <a href="lucy_Searcher.html">lucy_Searcher*</a> <strong>searcher</strong>, +<pre><code><span class="prefix">lucy_</span><a href="lucy_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_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><emph>searcher</emph></dt> +<dt>searcher</dt> <dd><p>A Searcher.</p> </dd> -<dt><emph>boost</emph></dt> +<dt>boost</dt> <dd><p>A scoring multiplier.</p> </dd> -<dt><emph>subordinate</emph></dt> +<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 Normalize() on the newly minted Compiler object before returning +invoke <a href="lucy_Compiler.html#func_Normalize">Normalize()</a> on the newly minted Compiler object before returning it.</p> </dd> </dl> </dd> -<dt>Set_Boost</dt> +<dt id="func_Set_Boost">Set_Boost</dt> <dd> <pre><code>void -<strong>LUCY_Query_Set_Boost</strong>( - lucy_Query* <strong>self</strong>, +<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>Get_Boost</dt> +<dt id="func_Get_Boost">Get_Boost</dt> <dd> <pre><code>float -<strong>LUCY_Query_Get_Boost</strong>( - lucy_Query* <strong>self</strong> +<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>Serialize</dt> +<dt id="func_Serialize">Serialize</dt> <dd> <pre><code>void -<strong>LUCY_Query_Serialize</strong>( - lucy_Query* <strong>self</strong>, - <a href="lucy_OutStream.html">lucy_OutStream*</a> <strong>outstream</strong> +<span class="prefix">LUCY_</span><strong>Query_Serialize</strong>( + <span class="prefix">lucy_</span>Query* <strong>self</strong>, + <span class="prefix">lucy_</span><a href="lucy_OutStream.html">OutStream*</a> <strong>outstream</strong> ); </code></pre> </dd> -<dt>Deserialize</dt> +<dt id="func_Deserialize">Deserialize</dt> <dd> -<pre><code>lucy_Query* // incremented -<strong>LUCY_Query_Deserialize</strong>( - lucy_Query* <strong>self</strong>, // decremented - <a href="lucy_InStream.html">lucy_InStream*</a> <strong>instream</strong> +<pre><code><span class="prefix">lucy_</span>Query* <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Query_Deserialize</strong>( + <span class="prefix">lucy_</span>Query* <strong>self</strong>, <span class="comment">// decremented</span> + <span class="prefix">lucy_</span><a href="lucy_InStream.html">InStream*</a> <strong>instream</strong> ); </code></pre> </dd> -<dt>Dump</dt> +<dt id="func_Dump">Dump</dt> <dd> -<pre><code><a href="cfish_Obj.html">cfish_Obj*</a> // incremented -<strong>LUCY_Query_Dump</strong>( - lucy_Query* <strong>self</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_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>Load</dt> +<dt id="func_Load">Load</dt> <dd> -<pre><code><a href="cfish_Obj.html">cfish_Obj*</a> // incremented -<strong>LUCY_Query_Load</strong>( - lucy_Query* <strong>self</strong>, - <a href="cfish_Obj.html">cfish_Obj*</a> <strong>dump</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_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="cfish_Obj.html">Obj*</a> <strong>dump</strong> ); </code></pre> </dd>
Modified: websites/staging/lucy/trunk/content/docs/c/lucy_Lexicon.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/lucy_Lexicon.html (original) +++ websites/staging/lucy/trunk/content/docs/c/lucy_Lexicon.html Tue Dec 2 17:54:11 2014 @@ -1,31 +1,97 @@ <!DOCTYPE html> <html> <head> +<meta charset="utf-8"> +<!-- +*********************************************** + +!!!! DO NOT EDIT !!!! + +This file was auto-generated by cfc. + +*********************************************** + +Licensed to the Apache Software Foundation (ASF) under one or more +contributor license agreements. See the NOTICE file distributed with +this work for additional information regarding copyright ownership. +The ASF licenses this file to You under the Apache License, Version 2.0 +(the "License"); you may not use this file except in compliance with +the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> <meta name="viewport" content="width=device-width" /> +<title>Lucy::Index::Lexicon â C API Documentation</title> <style type="text/css"> body { - font-family: sans-serif; - font-size: 0.85em; - max-width: 640px; + max-width: 48em; + font: 0.85em/1.4 sans-serif; +} +a { + color: #23b; +} +table { + border-collapse: collapse; +} +td { + padding: 0; +} +td.label { + padding-right: 2em; + font-weight: bold; } dt { font-weight: bold; } pre { - border: 1px solid #000; + border: 1px solid #ccc; padding: 0.2em 0.4em; background: #f6f6f6; - font-size: 1.2em; + font-size: 0.92em; } -code { +pre a { + text-decoration: none; +} +pre, code { font-family: "Consolas", "Menlo", monospace; } +span.prefix, span.comment { + color: #888; +} </style> </head> <body> <h1>Lucy::Index::Lexicon</h1> +<table> +<tr> +<td class="label">parcel</td> +<td><a href="lucy.html">Lucy</a></td> +</tr> +<tr> +<td class="label">class name</td> +<td>Lucy::Index::Lexicon</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>Lex</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_LEXICON</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_Lexicon</code></td> +</tr> +</table> <h2>Name</h2> -<p>Lucy::Index::Lexicon - Iterator for a field's terms.</p> +<p>Lucy::Index::Lexicon â Iterator for a field's terms.</p> <h2>Description</h2> <p>A Lexicon is an iterator which provides access to all the unique terms for a given field in sorted order.</p> @@ -39,79 +105,76 @@ three </code></pre> <h2>Functions</h2> <dl> -<dt>init</dt> +<dt id="func_init">init</dt> <dd> -<pre><code>lucy_Lexicon* -<strong>lucy_Lex_init</strong>( - lucy_Lexicon* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>field</strong> +<pre><code><span class="prefix">lucy_</span>Lexicon* +<span class="prefix">lucy_</span><strong>Lex_init</strong>( + <span class="prefix">lucy_</span>Lexicon* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>field</strong> ); </code></pre> </dd> </dl> <h2>Methods</h2> -<h3>Abstract methods</h3> +<h3>Novel methods</h3 <dl> -<dt>Seek</dt> +<dt id="func_Seek">Seek <span class="comment">(abstract)</span></dt> <dd> <pre><code>void -<strong>LUCY_Lex_Seek</strong>( - lucy_Lexicon* <strong>self</strong>, - <a href="cfish_Obj.html">cfish_Obj*</a> <strong>target</strong> +<span class="prefix">LUCY_</span><strong>Lex_Seek</strong>( + <span class="prefix">lucy_</span>Lexicon* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_Obj.html">Obj*</a> <strong>target</strong> ); </code></pre> <p>Seek the Lexicon to the first iterator state which is greater than or equal to <code>target</code>. If <code>target</code> is NULL, reset the iterator.</p> </dd> -<dt>Next</dt> +<dt id="func_Next">Next <span class="comment">(abstract)</span></dt> <dd> <pre><code>bool -<strong>LUCY_Lex_Next</strong>( - lucy_Lexicon* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>Lex_Next</strong>( + <span class="prefix">lucy_</span>Lexicon* <strong>self</strong> ); </code></pre> <p>Proceed to the next term.</p> <p><strong>Returns:</strong> true until the iterator is exhausted, then false.</p> </dd> -<dt>Reset</dt> +<dt id="func_Reset">Reset <span class="comment">(abstract)</span></dt> <dd> <pre><code>void -<strong>LUCY_Lex_Reset</strong>( - lucy_Lexicon* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>Lex_Reset</strong>( + <span class="prefix">lucy_</span>Lexicon* <strong>self</strong> ); </code></pre> -<p>Reset the iterator. Next() must be called to proceed to the first +<p>Reset the iterator. <a href="lucy_Lexicon.html#func_Next">Next()</a> must be called to proceed to the first element.</p> </dd> -<dt>Doc_Freq</dt> +<dt id="func_Doc_Freq">Doc_Freq <span class="comment">(abstract)</span></dt> <dd> <pre><code>int32_t -<strong>LUCY_Lex_Doc_Freq</strong>( - lucy_Lexicon* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>Lex_Doc_Freq</strong>( + <span class="prefix">lucy_</span>Lexicon* <strong>self</strong> ); </code></pre> <p>Return the number of documents that the current term appears in at least once. Deleted documents may be included in the count.</p> </dd> -<dt>Get_Term</dt> +<dt id="func_Get_Term">Get_Term <span class="comment">(abstract)</span></dt> <dd> -<pre><code><a href="cfish_Obj.html">cfish_Obj*</a> -<strong>LUCY_Lex_Get_Term</strong>( - lucy_Lexicon* <strong>self</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_Obj.html">Obj*</a> +<span class="prefix">LUCY_</span><strong>Lex_Get_Term</strong>( + <span class="prefix">lucy_</span>Lexicon* <strong>self</strong> ); </code></pre> <p>Return the current term, or NULL if the iterator is not in a valid state.</p> </dd> -</dl> -<h3>Novel methods</h3> -<dl> -<dt>Get_Field</dt> +<dt id="func_Get_Field">Get_Field</dt> <dd> -<pre><code><a href="cfish_String.html">cfish_String*</a> -<strong>LUCY_Lex_Get_Field</strong>( - lucy_Lexicon* <strong>self</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> +<span class="prefix">LUCY_</span><strong>Lex_Get_Field</strong>( + <span class="prefix">lucy_</span>Lexicon* <strong>self</strong> ); </code></pre> </dd> Modified: websites/staging/lucy/trunk/content/docs/c/lucy_LexiconReader.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/lucy_LexiconReader.html (original) +++ websites/staging/lucy/trunk/content/docs/c/lucy_LexiconReader.html Tue Dec 2 17:54:11 2014 @@ -1,149 +1,216 @@ <!DOCTYPE html> <html> <head> +<meta charset="utf-8"> +<!-- +*********************************************** + +!!!! DO NOT EDIT !!!! + +This file was auto-generated by cfc. + +*********************************************** + +Licensed to the Apache Software Foundation (ASF) under one or more +contributor license agreements. See the NOTICE file distributed with +this work for additional information regarding copyright ownership. +The ASF licenses this file to You under the Apache License, Version 2.0 +(the "License"); you may not use this file except in compliance with +the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> <meta name="viewport" content="width=device-width" /> +<title>Lucy::Index::LexiconReader â C API Documentation</title> <style type="text/css"> body { - font-family: sans-serif; - font-size: 0.85em; - max-width: 640px; + max-width: 48em; + font: 0.85em/1.4 sans-serif; +} +a { + color: #23b; +} +table { + border-collapse: collapse; +} +td { + padding: 0; +} +td.label { + padding-right: 2em; + font-weight: bold; } dt { font-weight: bold; } pre { - border: 1px solid #000; + border: 1px solid #ccc; padding: 0.2em 0.4em; background: #f6f6f6; - font-size: 1.2em; + font-size: 0.92em; +} +pre a { + text-decoration: none; } -code { +pre, code { font-family: "Consolas", "Menlo", monospace; } +span.prefix, span.comment { + color: #888; +} </style> </head> <body> <h1>Lucy::Index::LexiconReader</h1> +<table> +<tr> +<td class="label">parcel</td> +<td><a href="lucy.html">Lucy</a></td> +</tr> +<tr> +<td class="label">class name</td> +<td>Lucy::Index::LexiconReader</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>LexReader</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_LEXICONREADER</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_LexiconReader</code></td> +</tr> +</table> <h2>Name</h2> -<p>Lucy::Index::LexiconReader - Read Lexicon data.</p> +<p>Lucy::Index::LexiconReader â Read Lexicon data.</p> <h2>Description</h2> <p>LexiconReader reads term dictionary information.</p> <h2>Methods</h2> -<h3>Abstract methods</h3> +<h3>Novel methods</h3 <dl> -<dt>Lexicon</dt> +<dt id="func_Lexicon">Lexicon <span class="comment">(abstract)</span></dt> <dd> -<pre><code><a href="lucy_Lexicon.html">lucy_Lexicon*</a> // incremented -<strong>LUCY_LexReader_Lexicon</strong>( - lucy_LexiconReader* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>field</strong>, - <a href="cfish_Obj.html">cfish_Obj*</a> <strong>term</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_Lexicon.html">Lexicon*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>LexReader_Lexicon</strong>( + <span class="prefix">lucy_</span>LexiconReader* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>field</strong>, + <span class="prefix">cfish_</span><a href="cfish_Obj.html">Obj*</a> <strong>term</strong> ); </code></pre> <p>Return a new Lexicon for the given <code>field</code>. Will return NULL if either the field is not indexed, or if no documents contain a value for the field.</p> <dl> -<dt><emph>field</emph></dt> +<dt>field</dt> <dd><p>Field name.</p> </dd> -<dt><emph>term</emph></dt> +<dt>term</dt> <dd><p>Pre-locate the Lexicon to this term.</p> </dd> </dl> </dd> -<dt>Doc_Freq</dt> +<dt id="func_Doc_Freq">Doc_Freq <span class="comment">(abstract)</span></dt> <dd> <pre><code>uint32_t -<strong>LUCY_LexReader_Doc_Freq</strong>( - lucy_LexiconReader* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>field</strong>, - <a href="cfish_Obj.html">cfish_Obj*</a> <strong>term</strong> +<span class="prefix">LUCY_</span><strong>LexReader_Doc_Freq</strong>( + <span class="prefix">lucy_</span>LexiconReader* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>field</strong>, + <span class="prefix">cfish_</span><a href="cfish_Obj.html">Obj*</a> <strong>term</strong> ); </code></pre> <p>Return the number of documents where the specified term is present.</p> </dd> </dl> -<h3>Methods inherited from Lucy::Index::DataReader</h3><dl> -<dt>Aggregator</dt> +<h3>Methods inherited from Lucy::Index::DataReader</h3> +<dl> +<dt id="func_Aggregator">Aggregator <span class="comment">(abstract)</span></dt> <dd> -<pre><code>lucy_DataReader* // incremented -<strong>LUCY_DataReader_Aggregator</strong>( - lucy_DataReader* <strong>self</strong>, - <a href="cfish_VArray.html">cfish_VArray*</a> <strong>readers</strong>, - <a href="lucy_I32Array.html">lucy_I32Array*</a> <strong>offsets</strong> +<pre><code><span class="prefix">lucy_</span>DataReader* <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>DataReader_Aggregator</strong>( + <span class="prefix">lucy_</span>DataReader* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_VArray.html">VArray*</a> <strong>readers</strong>, + <span class="prefix">lucy_</span><a href="lucy_I32Array.html">I32Array*</a> <strong>offsets</strong> ); </code></pre> <p>Create a reader which aggregates the output of several lower level readers. Return NULL if such a reader is not valid.</p> <dl> -<dt><emph>readers</emph></dt> +<dt>readers</dt> <dd><p>An array of DataReaders.</p> </dd> -<dt><emph>offsets</emph></dt> +<dt>offsets</dt> <dd><p>Doc id start offsets for each reader.</p> </dd> </dl> </dd> -<dt>Get_Schema</dt> +<dt id="func_Get_Schema">Get_Schema</dt> <dd> -<pre><code><a href="lucy_Schema.html">lucy_Schema*</a> -<strong>LUCY_DataReader_Get_Schema</strong>( - lucy_DataReader* <strong>self</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_Schema.html">Schema*</a> +<span class="prefix">LUCY_</span><strong>DataReader_Get_Schema</strong>( + <span class="prefix">lucy_</span>DataReader* <strong>self</strong> ); </code></pre> <p>Accessor for "schema" member var.</p> </dd> -<dt>Get_Folder</dt> +<dt id="func_Get_Folder">Get_Folder</dt> <dd> -<pre><code><a href="lucy_Folder.html">lucy_Folder*</a> -<strong>LUCY_DataReader_Get_Folder</strong>( - lucy_DataReader* <strong>self</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_Folder.html">Folder*</a> +<span class="prefix">LUCY_</span><strong>DataReader_Get_Folder</strong>( + <span class="prefix">lucy_</span>DataReader* <strong>self</strong> ); </code></pre> <p>Accessor for "folder" member var.</p> </dd> -<dt>Get_Snapshot</dt> +<dt id="func_Get_Snapshot">Get_Snapshot</dt> <dd> -<pre><code><a href="lucy_Snapshot.html">lucy_Snapshot*</a> -<strong>LUCY_DataReader_Get_Snapshot</strong>( - lucy_DataReader* <strong>self</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_Snapshot.html">Snapshot*</a> +<span class="prefix">LUCY_</span><strong>DataReader_Get_Snapshot</strong>( + <span class="prefix">lucy_</span>DataReader* <strong>self</strong> ); </code></pre> <p>Accessor for "snapshot" member var.</p> </dd> -<dt>Get_Segments</dt> +<dt id="func_Get_Segments">Get_Segments</dt> <dd> -<pre><code><a href="cfish_VArray.html">cfish_VArray*</a> -<strong>LUCY_DataReader_Get_Segments</strong>( - lucy_DataReader* <strong>self</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_VArray.html">VArray*</a> +<span class="prefix">LUCY_</span><strong>DataReader_Get_Segments</strong>( + <span class="prefix">lucy_</span>DataReader* <strong>self</strong> ); </code></pre> <p>Accessor for "segments" member var.</p> </dd> -<dt>Get_Segment</dt> +<dt id="func_Get_Segment">Get_Segment</dt> <dd> -<pre><code><a href="lucy_Segment.html">lucy_Segment*</a> -<strong>LUCY_DataReader_Get_Segment</strong>( - lucy_DataReader* <strong>self</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_Segment.html">Segment*</a> +<span class="prefix">LUCY_</span><strong>DataReader_Get_Segment</strong>( + <span class="prefix">lucy_</span>DataReader* <strong>self</strong> ); </code></pre> <p>Accessor for "segment" member var.</p> </dd> -<dt>Get_Seg_Tick</dt> +<dt id="func_Get_Seg_Tick">Get_Seg_Tick</dt> <dd> <pre><code>int32_t -<strong>LUCY_DataReader_Get_Seg_Tick</strong>( - lucy_DataReader* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>DataReader_Get_Seg_Tick</strong>( + <span class="prefix">lucy_</span>DataReader* <strong>self</strong> ); </code></pre> <p>Accessor for "seg_tick" member var.</p> </dd> -<dt>Close</dt> +<dt id="func_Close">Close <span class="comment">(abstract)</span></dt> <dd> <pre><code>void -<strong>LUCY_DataReader_Close</strong>( - lucy_DataReader* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>DataReader_Close</strong>( + <span class="prefix">lucy_</span>DataReader* <strong>self</strong> ); </code></pre> <p>Release external resources, e.g. streams. Implementations must be Modified: websites/staging/lucy/trunk/content/docs/c/lucy_Lock.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/lucy_Lock.html (original) +++ websites/staging/lucy/trunk/content/docs/c/lucy_Lock.html Tue Dec 2 17:54:11 2014 @@ -1,31 +1,97 @@ <!DOCTYPE html> <html> <head> +<meta charset="utf-8"> +<!-- +*********************************************** + +!!!! DO NOT EDIT !!!! + +This file was auto-generated by cfc. + +*********************************************** + +Licensed to the Apache Software Foundation (ASF) under one or more +contributor license agreements. See the NOTICE file distributed with +this work for additional information regarding copyright ownership. +The ASF licenses this file to You under the Apache License, Version 2.0 +(the "License"); you may not use this file except in compliance with +the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> <meta name="viewport" content="width=device-width" /> +<title>Lucy::Store::Lock â C API Documentation</title> <style type="text/css"> body { - font-family: sans-serif; - font-size: 0.85em; - max-width: 640px; + max-width: 48em; + font: 0.85em/1.4 sans-serif; +} +a { + color: #23b; +} +table { + border-collapse: collapse; +} +td { + padding: 0; +} +td.label { + padding-right: 2em; + font-weight: bold; } dt { font-weight: bold; } pre { - border: 1px solid #000; + border: 1px solid #ccc; padding: 0.2em 0.4em; background: #f6f6f6; - font-size: 1.2em; + font-size: 0.92em; +} +pre a { + text-decoration: none; } -code { +pre, code { font-family: "Consolas", "Menlo", monospace; } +span.prefix, span.comment { + color: #888; +} </style> </head> <body> <h1>Lucy::Store::Lock</h1> +<table> +<tr> +<td class="label">parcel</td> +<td><a href="lucy.html">Lucy</a></td> +</tr> +<tr> +<td class="label">class name</td> +<td>Lucy::Store::Lock</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>Lock</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_LOCK</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_Lock</code></td> +</tr> +</table> <h2>Name</h2> -<p>Lucy::Store::Lock - Abstract class representing an interprocess mutex lock.</p> +<p>Lucy::Store::Lock â Abstract class representing an interprocess mutex lock.</p> <h2>Description</h2> <p>The Lock class produces an interprocess mutex lock. The default subclass uses dot-lock files, but alternative implementations are possible.</p> @@ -34,93 +100,104 @@ lock also has a "host" id whic help clear away stale locks.</p> <h2>Functions</h2> <dl> -<dt>init</dt> +<dt id="func_init">init</dt> <dd> -<pre><code>lucy_Lock* -<strong>lucy_Lock_init</strong>( - lucy_Lock* <strong>self</strong>, - <a href="lucy_Folder.html">lucy_Folder*</a> <strong>folder</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>name</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>host</strong>, +<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_Folder.html">Folder*</a> <strong>folder</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>name</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>host</strong>, int32_t <strong>timeout</strong>, int32_t <strong>interval</strong> ); </code></pre> <p>Abstract constructor.</p> <dl> -<dt><emph>folder</emph></dt> +<dt>folder</dt> <dd><p>A Folder.</p> </dd> -<dt><emph>name</emph></dt> +<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><emph>host</emph></dt> +<dt>host</dt> <dd><p>A unique per-machine identifier.</p> </dd> -<dt><emph>timeout</emph></dt> +<dt>timeout</dt> <dd><p>Time in milliseconds to keep retrying before abandoning -the attempt to Obtain() a lock.</p> +the attempt to <a href="lucy_Lock.html#func_Obtain">Obtain()</a> a lock.</p> </dd> -<dt><emph>interval</emph></dt> +<dt>interval</dt> <dd><p>Time in milliseconds between retries.</p> </dd> </dl> </dd> </dl> <h2>Methods</h2> -<h3>Abstract methods</h3> +<h3>Novel methods</h3 <dl> -<dt>Shared</dt> +<dt id="func_Shared">Shared <span class="comment">(abstract)</span></dt> <dd> <pre><code>bool -<strong>LUCY_Lock_Shared</strong>( - lucy_Lock* <strong>self</strong> +<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>Request</dt> +<dt id="func_Obtain">Obtain</dt> <dd> <pre><code>bool -<strong>LUCY_Lock_Request</strong>( - lucy_Lock* <strong>self</strong> +<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_Lock.html#func_Request">Request()</a> once per <code>interval</code> until <a href="lucy_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 Err_error).</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 Request() differ depending on whether Shared() returns -true. If the Lock is Shared(), then Request() should not fail if +<p>The semantics of <a href="lucy_Lock.html#func_Request">Request()</a> differ depending on whether <a href="lucy_Lock.html#func_Shared">Shared()</a> returns +true. If the Lock is <a href="lucy_Lock.html#func_Shared">Shared()</a>, then <a href="lucy_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 Shared() -- i.e. it's an exclusive (write) lock -- then other locks -should cause Request() to fail.</p> +not <a href="lucy_Lock.html#func_Shared">Shared()</a> -- i.e. it's an exclusive (write) lock -- then other locks +should cause <a href="lucy_Lock.html#func_Request">Request()</a> to fail.</p> <p><strong>Returns:</strong> true on success, false on failure (sets Err_error).</p> </dd> -<dt>Release</dt> +<dt id="func_Release">Release <span class="comment">(abstract)</span></dt> <dd> <pre><code>void -<strong>LUCY_Lock_Release</strong>( - lucy_Lock* <strong>self</strong> +<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>Is_Locked</dt> +<dt id="func_Is_Locked">Is_Locked <span class="comment">(abstract)</span></dt> <dd> <pre><code>bool -<strong>LUCY_Lock_Is_Locked</strong>( - lucy_Lock* <strong>self</strong> +<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>Clear_Stale</dt> +<dt id="func_Clear_Stale">Clear_Stale <span class="comment">(abstract)</span></dt> <dd> <pre><code>void -<strong>LUCY_Lock_Clear_Stale</strong>( - lucy_Lock* <strong>self</strong> +<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 @@ -128,20 +205,6 @@ name matches, the host id matches, and t was created under no longer identifies an active process.</p> </dd> </dl> -<h3>Novel methods</h3> -<dl> -<dt>Obtain</dt> -<dd> -<pre><code>bool -<strong>LUCY_Lock_Obtain</strong>( - lucy_Lock* <strong>self</strong> -); -</code></pre> -<p>Call Request() once per <code>interval</code> until Request() returns -success or the <code>timeout</code> has been reached.</p> -<p><strong>Returns:</strong> true on success, false on failure (sets Err_error).</p> -</dd> -</dl> <h2>Inheritance</h2> <p>Lucy::Store::Lock is a <a href="cfish_Obj.html">Clownfish::Obj</a>.</p> </body> Modified: websites/staging/lucy/trunk/content/docs/c/lucy_LockErr.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/lucy_LockErr.html (original) +++ websites/staging/lucy/trunk/content/docs/c/lucy_LockErr.html Tue Dec 2 17:54:11 2014 @@ -1,71 +1,138 @@ <!DOCTYPE html> <html> <head> +<meta charset="utf-8"> +<!-- +*********************************************** + +!!!! DO NOT EDIT !!!! + +This file was auto-generated by cfc. + +*********************************************** + +Licensed to the Apache Software Foundation (ASF) under one or more +contributor license agreements. See the NOTICE file distributed with +this work for additional information regarding copyright ownership. +The ASF licenses this file to You under the Apache License, Version 2.0 +(the "License"); you may not use this file except in compliance with +the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> <meta name="viewport" content="width=device-width" /> +<title>Lucy::Store::LockErr â C API Documentation</title> <style type="text/css"> body { - font-family: sans-serif; - font-size: 0.85em; - max-width: 640px; + max-width: 48em; + font: 0.85em/1.4 sans-serif; +} +a { + color: #23b; +} +table { + border-collapse: collapse; +} +td { + padding: 0; +} +td.label { + padding-right: 2em; + font-weight: bold; } dt { font-weight: bold; } pre { - border: 1px solid #000; + border: 1px solid #ccc; padding: 0.2em 0.4em; background: #f6f6f6; - font-size: 1.2em; + font-size: 0.92em; +} +pre a { + text-decoration: none; } -code { +pre, code { font-family: "Consolas", "Menlo", monospace; } +span.prefix, span.comment { + color: #888; +} </style> </head> <body> <h1>Lucy::Store::LockErr</h1> +<table> +<tr> +<td class="label">parcel</td> +<td><a href="lucy.html">Lucy</a></td> +</tr> +<tr> +<td class="label">class name</td> +<td>Lucy::Store::LockErr</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>LockErr</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_LOCKERR</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_LockErr</code></td> +</tr> +</table> <h2>Name</h2> -<p>Lucy::Store::LockErr - Lock exception.</p> +<p>Lucy::Store::LockErr â Lock exception.</p> <h2>Description</h2> <p>LockErr is a subclass of <a href="cfish_Err.html">Err</a> which indicates that a file locking problem occurred.</p> <h2>Functions</h2> <dl> -<dt>new</dt> +<dt id="func_new">new</dt> <dd> -<pre><code>lucy_LockErr* // incremented -<strong>lucy_LockErr_new</strong>( - <a href="cfish_String.html">cfish_String*</a> <strong>message</strong> +<pre><code><span class="prefix">lucy_</span>LockErr* <span class="comment">// incremented</span> +<span class="prefix">lucy_</span><strong>LockErr_new</strong>( + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>message</strong> ); </code></pre> </dd> -<dt>init</dt> +<dt id="func_init">init</dt> <dd> -<pre><code>lucy_LockErr* -<strong>lucy_LockErr_init</strong>( - lucy_LockErr* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>message</strong> +<pre><code><span class="prefix">lucy_</span>LockErr* +<span class="prefix">lucy_</span><strong>LockErr_init</strong>( + <span class="prefix">lucy_</span>LockErr* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>message</strong> ); </code></pre> </dd> </dl> <h2>Methods</h2> -<h3>Methods inherited from Clownfish::Err</h3><dl> -<dt>Cat_Mess</dt> +<h3>Methods inherited from Clownfish::Err</h3> +<dl> +<dt id="func_Cat_Mess">Cat_Mess</dt> <dd> <pre><code>void -<strong>CFISH_Err_Cat_Mess</strong>( - cfish_Err* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>mess</strong> +<span class="prefix">CFISH_</span><strong>Err_Cat_Mess</strong>( + <span class="prefix">cfish_</span>Err* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>mess</strong> ); </code></pre> <p>Concatenate the supplied argument onto the internal "mess".</p> </dd> -<dt>Get_Mess</dt> +<dt id="func_Get_Mess">Get_Mess</dt> <dd> -<pre><code><a href="cfish_String.html">cfish_String*</a> -<strong>CFISH_Err_Get_Mess</strong>( - cfish_Err* <strong>self</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> +<span class="prefix">CFISH_</span><strong>Err_Get_Mess</strong>( + <span class="prefix">cfish_</span>Err* <strong>self</strong> ); </code></pre> </dd> Modified: websites/staging/lucy/trunk/content/docs/c/lucy_LockFactory.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/lucy_LockFactory.html (original) +++ websites/staging/lucy/trunk/content/docs/c/lucy_LockFactory.html Tue Dec 2 17:54:11 2014 @@ -1,31 +1,97 @@ <!DOCTYPE html> <html> <head> +<meta charset="utf-8"> +<!-- +*********************************************** + +!!!! DO NOT EDIT !!!! + +This file was auto-generated by cfc. + +*********************************************** + +Licensed to the Apache Software Foundation (ASF) under one or more +contributor license agreements. See the NOTICE file distributed with +this work for additional information regarding copyright ownership. +The ASF licenses this file to You under the Apache License, Version 2.0 +(the "License"); you may not use this file except in compliance with +the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> <meta name="viewport" content="width=device-width" /> +<title>Lucy::Store::LockFactory â C API Documentation</title> <style type="text/css"> body { - font-family: sans-serif; - font-size: 0.85em; - max-width: 640px; + max-width: 48em; + font: 0.85em/1.4 sans-serif; +} +a { + color: #23b; +} +table { + border-collapse: collapse; +} +td { + padding: 0; +} +td.label { + padding-right: 2em; + font-weight: bold; } dt { font-weight: bold; } pre { - border: 1px solid #000; + border: 1px solid #ccc; padding: 0.2em 0.4em; background: #f6f6f6; - font-size: 1.2em; + font-size: 0.92em; +} +pre a { + text-decoration: none; } -code { +pre, code { font-family: "Consolas", "Menlo", monospace; } +span.prefix, span.comment { + color: #888; +} </style> </head> <body> <h1>Lucy::Store::LockFactory</h1> +<table> +<tr> +<td class="label">parcel</td> +<td><a href="lucy.html">Lucy</a></td> +</tr> +<tr> +<td class="label">class name</td> +<td>Lucy::Store::LockFactory</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>LockFact</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_LOCKFACTORY</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_LockFactory</code></td> +</tr> +</table> <h2>Name</h2> -<p>Lucy::Store::LockFactory - Create Locks.</p> +<p>Lucy::Store::LockFactory â Create Locks.</p> <h2>Description</h2> <p>LockFactory is used to spin off interprocess mutex locks used by various index reading and writing components. The default implementation uses @@ -33,77 +99,77 @@ lockfiles, but LockFactory subclasses wh alternatives such as flock() are possible.</p> <h2>Functions</h2> <dl> -<dt>init</dt> +<dt id="func_init">init</dt> <dd> -<pre><code>lucy_LockFactory* -<strong>lucy_LockFact_init</strong>( - lucy_LockFactory* <strong>self</strong>, - <a href="lucy_Folder.html">lucy_Folder*</a> <strong>folder</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>host</strong> +<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_Folder.html">Folder*</a> <strong>folder</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>host</strong> ); </code></pre> <dl> -<dt><emph>folder</emph></dt> +<dt>folder</dt> <dd><p>A <a href="lucy_Folder.html">Folder</a>.</p> </dd> -<dt><emph>host</emph></dt> +<dt>host</dt> <dd><p>An identifier which should be unique per-machine.</p> </dd> </dl> </dd> </dl> <h2>Methods</h2> -<h3>Novel methods</h3> +<h3>Novel methods</h3 <dl> -<dt>Make_Lock</dt> +<dt id="func_Make_Lock">Make_Lock</dt> <dd> -<pre><code><a href="lucy_Lock.html">lucy_Lock*</a> // incremented -<strong>LUCY_LockFact_Make_Lock</strong>( - lucy_LockFactory* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>name</strong>, +<pre><code><span class="prefix">lucy_</span><a href="lucy_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="cfish_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 Obtain() returns successfully, +<p>Return a Lock object, which, once <a href="lucy_Lock.html#func_Obtain">Obtain()</a> returns successfully, maintains an exclusive lock on a resource.</p> <dl> -<dt><emph>name</emph></dt> +<dt>name</dt> <dd><p>A file-system-friendly id which identifies the resource to be locked.</p> </dd> -<dt><emph>timeout</emph></dt> +<dt>timeout</dt> <dd><p>Time in milliseconds to keep retrying before abandoning -the attempt to Obtain() a lock.</p> +the attempt to <a href="lucy_Lock.html#func_Obtain">Obtain()</a> a lock.</p> </dd> -<dt><emph>interval</emph></dt> +<dt>interval</dt> <dd><p>Time in milliseconds between retries.</p> </dd> </dl> </dd> -<dt>Make_Shared_Lock</dt> +<dt id="func_Make_Shared_Lock">Make_Shared_Lock</dt> <dd> -<pre><code><a href="lucy_Lock.html">lucy_Lock*</a> // incremented -<strong>LUCY_LockFact_Make_Shared_Lock</strong>( - lucy_LockFactory* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>name</strong>, +<pre><code><span class="prefix">lucy_</span><a href="lucy_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="cfish_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 Shared() returns true, and which -maintains a non-exclusive lock on a resource once Obtain() returns +<p>Return a Lock object for which <a href="lucy_Lock.html#func_Shared">Shared()</a> returns true, and which +maintains a non-exclusive lock on a resource once <a href="lucy_Lock.html#func_Obtain">Obtain()</a> returns success.</p> <dl> -<dt><emph>name</emph></dt> +<dt>name</dt> <dd><p>A file-system-friendly id which identifies the resource to be locked.</p> </dd> -<dt><emph>timeout</emph></dt> +<dt>timeout</dt> <dd><p>Time in milliseconds to keep retrying before abandoning -the attempt to Obtain() a lock.</p> +the attempt to <a href="lucy_Lock.html#func_Obtain">Obtain()</a> a lock.</p> </dd> -<dt><emph>interval</emph></dt> +<dt>interval</dt> <dd><p>Time in milliseconds between retries.</p> </dd> </dl> Modified: websites/staging/lucy/trunk/content/docs/c/lucy_MatchAllQuery.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/lucy_MatchAllQuery.html (original) +++ websites/staging/lucy/trunk/content/docs/c/lucy_MatchAllQuery.html Tue Dec 2 17:54:11 2014 @@ -1,31 +1,97 @@ <!DOCTYPE html> <html> <head> +<meta charset="utf-8"> +<!-- +*********************************************** + +!!!! DO NOT EDIT !!!! + +This file was auto-generated by cfc. + +*********************************************** + +Licensed to the Apache Software Foundation (ASF) under one or more +contributor license agreements. See the NOTICE file distributed with +this work for additional information regarding copyright ownership. +The ASF licenses this file to You under the Apache License, Version 2.0 +(the "License"); you may not use this file except in compliance with +the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> <meta name="viewport" content="width=device-width" /> +<title>Lucy::Search::MatchAllQuery â C API Documentation</title> <style type="text/css"> body { - font-family: sans-serif; - font-size: 0.85em; - max-width: 640px; + max-width: 48em; + font: 0.85em/1.4 sans-serif; +} +a { + color: #23b; +} +table { + border-collapse: collapse; +} +td { + padding: 0; +} +td.label { + padding-right: 2em; + font-weight: bold; } dt { font-weight: bold; } pre { - border: 1px solid #000; + border: 1px solid #ccc; padding: 0.2em 0.4em; background: #f6f6f6; - font-size: 1.2em; + font-size: 0.92em; +} +pre a { + text-decoration: none; } -code { +pre, code { font-family: "Consolas", "Menlo", monospace; } +span.prefix, span.comment { + color: #888; +} </style> </head> <body> <h1>Lucy::Search::MatchAllQuery</h1> +<table> +<tr> +<td class="label">parcel</td> +<td><a href="lucy.html">Lucy</a></td> +</tr> +<tr> +<td class="label">class name</td> +<td>Lucy::Search::MatchAllQuery</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>MatchAllQuery</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_MATCHALLQUERY</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_MatchAllQuery</code></td> +</tr> +</table> <h2>Name</h2> -<p>Lucy::Search::MatchAllQuery - Query which matches all documents.</p> +<p>Lucy::Search::MatchAllQuery â Query which matches all documents.</p> <h2>Description</h2> <p>MatchAllQuery is a utility class which matches all documents. Each match is assigned a score of 0.0, so that in composite queries, any document @@ -33,95 +99,96 @@ which matches against another part of th a document which matches only via the MatchAllQuery.</p> <h2>Functions</h2> <dl> -<dt>init</dt> +<dt id="func_init">init</dt> <dd> -<pre><code>lucy_MatchAllQuery* -<strong>lucy_MatchAllQuery_init</strong>( - lucy_MatchAllQuery* <strong>self</strong> +<pre><code><span class="prefix">lucy_</span>MatchAllQuery* +<span class="prefix">lucy_</span><strong>MatchAllQuery_init</strong>( + <span class="prefix">lucy_</span>MatchAllQuery* <strong>self</strong> ); </code></pre> <p>Constructor. Takes no arguments.</p> </dd> </dl> <h2>Methods</h2> -<h3>Methods inherited from Lucy::Search::Query</h3><dl> -<dt>Make_Compiler</dt> +<h3>Methods inherited from Lucy::Search::Query</h3> +<dl> +<dt id="func_Make_Compiler">Make_Compiler <span class="comment">(abstract)</span></dt> <dd> -<pre><code><a href="lucy_Compiler.html">lucy_Compiler*</a> // incremented -<strong>LUCY_Query_Make_Compiler</strong>( - lucy_Query* <strong>self</strong>, - <a href="lucy_Searcher.html">lucy_Searcher*</a> <strong>searcher</strong>, +<pre><code><span class="prefix">lucy_</span><a href="lucy_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_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><emph>searcher</emph></dt> +<dt>searcher</dt> <dd><p>A Searcher.</p> </dd> -<dt><emph>boost</emph></dt> +<dt>boost</dt> <dd><p>A scoring multiplier.</p> </dd> -<dt><emph>subordinate</emph></dt> +<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 Normalize() on the newly minted Compiler object before returning +invoke <a href="lucy_Compiler.html#func_Normalize">Normalize()</a> on the newly minted Compiler object before returning it.</p> </dd> </dl> </dd> -<dt>Set_Boost</dt> +<dt id="func_Set_Boost">Set_Boost</dt> <dd> <pre><code>void -<strong>LUCY_Query_Set_Boost</strong>( - lucy_Query* <strong>self</strong>, +<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>Get_Boost</dt> +<dt id="func_Get_Boost">Get_Boost</dt> <dd> <pre><code>float -<strong>LUCY_Query_Get_Boost</strong>( - lucy_Query* <strong>self</strong> +<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>Serialize</dt> +<dt id="func_Serialize">Serialize</dt> <dd> <pre><code>void -<strong>LUCY_Query_Serialize</strong>( - lucy_Query* <strong>self</strong>, - <a href="lucy_OutStream.html">lucy_OutStream*</a> <strong>outstream</strong> +<span class="prefix">LUCY_</span><strong>Query_Serialize</strong>( + <span class="prefix">lucy_</span>Query* <strong>self</strong>, + <span class="prefix">lucy_</span><a href="lucy_OutStream.html">OutStream*</a> <strong>outstream</strong> ); </code></pre> </dd> -<dt>Deserialize</dt> +<dt id="func_Deserialize">Deserialize</dt> <dd> -<pre><code>lucy_Query* // incremented -<strong>LUCY_Query_Deserialize</strong>( - lucy_Query* <strong>self</strong>, // decremented - <a href="lucy_InStream.html">lucy_InStream*</a> <strong>instream</strong> +<pre><code><span class="prefix">lucy_</span>Query* <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Query_Deserialize</strong>( + <span class="prefix">lucy_</span>Query* <strong>self</strong>, <span class="comment">// decremented</span> + <span class="prefix">lucy_</span><a href="lucy_InStream.html">InStream*</a> <strong>instream</strong> ); </code></pre> </dd> -<dt>Dump</dt> +<dt id="func_Dump">Dump</dt> <dd> -<pre><code><a href="cfish_Obj.html">cfish_Obj*</a> // incremented -<strong>LUCY_Query_Dump</strong>( - lucy_Query* <strong>self</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_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>Load</dt> +<dt id="func_Load">Load</dt> <dd> -<pre><code><a href="cfish_Obj.html">cfish_Obj*</a> // incremented -<strong>LUCY_Query_Load</strong>( - lucy_Query* <strong>self</strong>, - <a href="cfish_Obj.html">cfish_Obj*</a> <strong>dump</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_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="cfish_Obj.html">Obj*</a> <strong>dump</strong> ); </code></pre> </dd> Modified: websites/staging/lucy/trunk/content/docs/c/lucy_Matcher.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/lucy_Matcher.html (original) +++ websites/staging/lucy/trunk/content/docs/c/lucy_Matcher.html Tue Dec 2 17:54:11 2014 @@ -1,103 +1,166 @@ <!DOCTYPE html> <html> <head> +<meta charset="utf-8"> +<!-- +*********************************************** + +!!!! DO NOT EDIT !!!! + +This file was auto-generated by cfc. + +*********************************************** + +Licensed to the Apache Software Foundation (ASF) under one or more +contributor license agreements. See the NOTICE file distributed with +this work for additional information regarding copyright ownership. +The ASF licenses this file to You under the Apache License, Version 2.0 +(the "License"); you may not use this file except in compliance with +the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> <meta name="viewport" content="width=device-width" /> +<title>Lucy::Search::Matcher â C API Documentation</title> <style type="text/css"> body { - font-family: sans-serif; - font-size: 0.85em; - max-width: 640px; + max-width: 48em; + font: 0.85em/1.4 sans-serif; +} +a { + color: #23b; +} +table { + border-collapse: collapse; +} +td { + padding: 0; +} +td.label { + padding-right: 2em; + font-weight: bold; } dt { font-weight: bold; } pre { - border: 1px solid #000; + border: 1px solid #ccc; padding: 0.2em 0.4em; background: #f6f6f6; - font-size: 1.2em; + font-size: 0.92em; } -code { +pre a { + text-decoration: none; +} +pre, code { font-family: "Consolas", "Menlo", monospace; } +span.prefix, span.comment { + color: #888; +} </style> </head> <body> <h1>Lucy::Search::Matcher</h1> +<table> +<tr> +<td class="label">parcel</td> +<td><a href="lucy.html">Lucy</a></td> +</tr> +<tr> +<td class="label">class name</td> +<td>Lucy::Search::Matcher</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>Matcher</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_MATCHER</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_Matcher</code></td> +</tr> +</table> <h2>Name</h2> -<p>Lucy::Search::Matcher - Match a set of document ids.</p> +<p>Lucy::Search::Matcher â Match a set of document ids.</p> <h2>Description</h2> <p>A Matcher iterates over a set of ascending document ids. Some Matchers -implement Score() and can assign relevance scores to the docs that they +implement <a href="lucy_Matcher.html#func_Score">Score()</a> and can assign relevance scores to the docs that they match. Other implementations may be match-only.</p> <h2>Functions</h2> <dl> -<dt>init</dt> +<dt id="func_init">init</dt> <dd> -<pre><code>lucy_Matcher* -<strong>lucy_Matcher_init</strong>( - lucy_Matcher* <strong>self</strong> +<pre><code><span class="prefix">lucy_</span>Matcher* +<span class="prefix">lucy_</span><strong>Matcher_init</strong>( + <span class="prefix">lucy_</span>Matcher* <strong>self</strong> ); </code></pre> <p>Abstract constructor.</p> </dd> </dl> <h2>Methods</h2> -<h3>Abstract methods</h3> +<h3>Novel methods</h3 <dl> -<dt>Next</dt> +<dt id="func_Next">Next <span class="comment">(abstract)</span></dt> <dd> <pre><code>int32_t -<strong>LUCY_Matcher_Next</strong>( - lucy_Matcher* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>Matcher_Next</strong>( + <span class="prefix">lucy_</span>Matcher* <strong>self</strong> ); </code></pre> <p>Proceed to the next doc id.</p> <p><strong>Returns:</strong> A positive doc id, or 0 once the iterator is exhausted.</p> </dd> -<dt>Get_Doc_ID</dt> +<dt id="func_Advance">Advance</dt> <dd> <pre><code>int32_t -<strong>LUCY_Matcher_Get_Doc_ID</strong>( - lucy_Matcher* <strong>self</strong> -); -</code></pre> -<p>Return the current doc id. Valid only after a successful call to -Next() or Advance() and must not be called otherwise.</p> -</dd> -<dt>Score</dt> -<dd> -<pre><code>float -<strong>LUCY_Matcher_Score</strong>( - lucy_Matcher* <strong>self</strong> -); -</code></pre> -<p>Return the score of the current document.</p> -<p>Only Matchers which are used for scored search need implement Score().</p> -</dd> -</dl> -<h3>Novel methods</h3> -<dl> -<dt>Advance</dt> -<dd> -<pre><code>int32_t -<strong>LUCY_Matcher_Advance</strong>( - lucy_Matcher* <strong>self</strong>, +<span class="prefix">LUCY_</span><strong>Matcher_Advance</strong>( + <span class="prefix">lucy_</span>Matcher* <strong>self</strong>, int32_t <strong>target</strong> ); </code></pre> <p>Advance the iterator to the first doc id greater than or equal to -<code>target</code>. The default implementation simply calls Next() +<code>target</code>. The default implementation simply calls <a href="lucy_Matcher.html#func_Next">Next()</a> over and over, but subclasses have the option of doing something more efficient.</p> <dl> -<dt><emph>target</emph></dt> +<dt>target</dt> <dd><p>A positive doc id, which must be greater than the current doc id once the iterator has been initialized.</p> </dd> </dl> <p><strong>Returns:</strong> A positive doc id, or 0 once the iterator is exhausted.</p> </dd> +<dt id="func_Get_Doc_ID">Get_Doc_ID <span class="comment">(abstract)</span></dt> +<dd> +<pre><code>int32_t +<span class="prefix">LUCY_</span><strong>Matcher_Get_Doc_ID</strong>( + <span class="prefix">lucy_</span>Matcher* <strong>self</strong> +); +</code></pre> +<p>Return the current doc id. Valid only after a successful call to +<a href="lucy_Matcher.html#func_Next">Next()</a> or <a href="lucy_Matcher.html#func_Advance">Advance()</a> and must not be called otherwise.</p> +</dd> +<dt id="func_Score">Score <span class="comment">(abstract)</span></dt> +<dd> +<pre><code>float +<span class="prefix">LUCY_</span><strong>Matcher_Score</strong>( + <span class="prefix">lucy_</span>Matcher* <strong>self</strong> +); +</code></pre> +<p>Return the score of the current document.</p> +<p>Only Matchers which are used for scored search need implement <a href="lucy_Matcher.html#func_Score">Score()</a>.</p> +</dd> </dl> <h2>Inheritance</h2> <p>Lucy::Search::Matcher is a <a href="cfish_Obj.html">Clownfish::Obj</a>.</p> Modified: websites/staging/lucy/trunk/content/docs/c/lucy_NOTQuery.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/lucy_NOTQuery.html (original) +++ websites/staging/lucy/trunk/content/docs/c/lucy_NOTQuery.html Tue Dec 2 17:54:11 2014 @@ -1,31 +1,97 @@ <!DOCTYPE html> <html> <head> +<meta charset="utf-8"> +<!-- +*********************************************** + +!!!! DO NOT EDIT !!!! + +This file was auto-generated by cfc. + +*********************************************** + +Licensed to the Apache Software Foundation (ASF) under one or more +contributor license agreements. See the NOTICE file distributed with +this work for additional information regarding copyright ownership. +The ASF licenses this file to You under the Apache License, Version 2.0 +(the "License"); you may not use this file except in compliance with +the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> <meta name="viewport" content="width=device-width" /> +<title>Lucy::Search::NOTQuery â C API Documentation</title> <style type="text/css"> body { - font-family: sans-serif; - font-size: 0.85em; - max-width: 640px; + max-width: 48em; + font: 0.85em/1.4 sans-serif; +} +a { + color: #23b; +} +table { + border-collapse: collapse; +} +td { + padding: 0; +} +td.label { + padding-right: 2em; + font-weight: bold; } dt { font-weight: bold; } pre { - border: 1px solid #000; + border: 1px solid #ccc; padding: 0.2em 0.4em; background: #f6f6f6; - font-size: 1.2em; + font-size: 0.92em; } -code { +pre a { + text-decoration: none; +} +pre, code { font-family: "Consolas", "Menlo", monospace; } +span.prefix, span.comment { + color: #888; +} </style> </head> <body> <h1>Lucy::Search::NOTQuery</h1> +<table> +<tr> +<td class="label">parcel</td> +<td><a href="lucy.html">Lucy</a></td> +</tr> +<tr> +<td class="label">class name</td> +<td>Lucy::Search::NOTQuery</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>NOTQuery</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_NOTQUERY</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_NOTQuery</code></td> +</tr> +</table> <h2>Name</h2> -<p>Lucy::Search::NOTQuery - Invert the result set of another Query.</p> +<p>Lucy::Search::NOTQuery â Invert the result set of another Query.</p> <h2>Description</h2> <p>A NOTQuery wraps another <a href="lucy_Query.html">Query</a> and matches against its inverse document set. All matching docs recieve a score of @@ -35,134 +101,136 @@ against its inverse document set. All m semantics.</p> <h2>Functions</h2> <dl> -<dt>init</dt> +<dt id="func_init">init</dt> <dd> -<pre><code>lucy_NOTQuery* -<strong>lucy_NOTQuery_init</strong>( - lucy_NOTQuery* <strong>self</strong>, - <a href="lucy_Query.html">lucy_Query*</a> <strong>negated_query</strong> +<pre><code><span class="prefix">lucy_</span>NOTQuery* +<span class="prefix">lucy_</span><strong>NOTQuery_init</strong>( + <span class="prefix">lucy_</span>NOTQuery* <strong>self</strong>, + <span class="prefix">lucy_</span><a href="lucy_Query.html">Query*</a> <strong>negated_query</strong> ); </code></pre> <dl> -<dt><emph>negated_query</emph></dt> +<dt>negated_query</dt> <dd><p>The Query whose result set should be inverted.</p> </dd> </dl> </dd> </dl> <h2>Methods</h2> -<h3>Novel methods</h3> +<h3>Novel methods</h3 <dl> -<dt>Get_Negated_Query</dt> +<dt id="func_Get_Negated_Query">Get_Negated_Query</dt> <dd> -<pre><code><a href="lucy_Query.html">lucy_Query*</a> -<strong>LUCY_NOTQuery_Get_Negated_Query</strong>( - lucy_NOTQuery* <strong>self</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_Query.html">Query*</a> +<span class="prefix">LUCY_</span><strong>NOTQuery_Get_Negated_Query</strong>( + <span class="prefix">lucy_</span>NOTQuery* <strong>self</strong> ); </code></pre> <p>Accessor for the object's negated query.</p> </dd> -<dt>Set_Negated_Query</dt> +<dt id="func_Set_Negated_Query">Set_Negated_Query</dt> <dd> <pre><code>void -<strong>LUCY_NOTQuery_Set_Negated_Query</strong>( - lucy_NOTQuery* <strong>self</strong>, - <a href="lucy_Query.html">lucy_Query*</a> <strong>negated_query</strong> +<span class="prefix">LUCY_</span><strong>NOTQuery_Set_Negated_Query</strong>( + <span class="prefix">lucy_</span>NOTQuery* <strong>self</strong>, + <span class="prefix">lucy_</span><a href="lucy_Query.html">Query*</a> <strong>negated_query</strong> ); </code></pre> <p>Setter for the object's negated query.</p> </dd> </dl> -<h3>Methods inherited from Lucy::Search::PolyQuery</h3><dl> -<dt>Add_Child</dt> +<h3>Methods inherited from Lucy::Search::PolyQuery</h3> +<dl> +<dt id="func_Add_Child">Add_Child</dt> <dd> <pre><code>void -<strong>LUCY_PolyQuery_Add_Child</strong>( - lucy_PolyQuery* <strong>self</strong>, - <a href="lucy_Query.html">lucy_Query*</a> <strong>query</strong> +<span class="prefix">LUCY_</span><strong>PolyQuery_Add_Child</strong>( + <span class="prefix">lucy_</span>PolyQuery* <strong>self</strong>, + <span class="prefix">lucy_</span><a href="lucy_Query.html">Query*</a> <strong>query</strong> ); </code></pre> <p>Add a child Query node.</p> </dd> </dl> -<h3>Methods inherited from Lucy::Search::Query</h3><dl> -<dt>Make_Compiler</dt> +<h3>Methods inherited from Lucy::Search::Query</h3> +<dl> +<dt id="func_Make_Compiler">Make_Compiler <span class="comment">(abstract)</span></dt> <dd> -<pre><code><a href="lucy_Compiler.html">lucy_Compiler*</a> // incremented -<strong>LUCY_Query_Make_Compiler</strong>( - lucy_Query* <strong>self</strong>, - <a href="lucy_Searcher.html">lucy_Searcher*</a> <strong>searcher</strong>, +<pre><code><span class="prefix">lucy_</span><a href="lucy_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_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><emph>searcher</emph></dt> +<dt>searcher</dt> <dd><p>A Searcher.</p> </dd> -<dt><emph>boost</emph></dt> +<dt>boost</dt> <dd><p>A scoring multiplier.</p> </dd> -<dt><emph>subordinate</emph></dt> +<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 Normalize() on the newly minted Compiler object before returning +invoke <a href="lucy_Compiler.html#func_Normalize">Normalize()</a> on the newly minted Compiler object before returning it.</p> </dd> </dl> </dd> -<dt>Set_Boost</dt> +<dt id="func_Set_Boost">Set_Boost</dt> <dd> <pre><code>void -<strong>LUCY_Query_Set_Boost</strong>( - lucy_Query* <strong>self</strong>, +<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>Get_Boost</dt> +<dt id="func_Get_Boost">Get_Boost</dt> <dd> <pre><code>float -<strong>LUCY_Query_Get_Boost</strong>( - lucy_Query* <strong>self</strong> +<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>Serialize</dt> +<dt id="func_Serialize">Serialize</dt> <dd> <pre><code>void -<strong>LUCY_Query_Serialize</strong>( - lucy_Query* <strong>self</strong>, - <a href="lucy_OutStream.html">lucy_OutStream*</a> <strong>outstream</strong> +<span class="prefix">LUCY_</span><strong>Query_Serialize</strong>( + <span class="prefix">lucy_</span>Query* <strong>self</strong>, + <span class="prefix">lucy_</span><a href="lucy_OutStream.html">OutStream*</a> <strong>outstream</strong> ); </code></pre> </dd> -<dt>Deserialize</dt> +<dt id="func_Deserialize">Deserialize</dt> <dd> -<pre><code>lucy_Query* // incremented -<strong>LUCY_Query_Deserialize</strong>( - lucy_Query* <strong>self</strong>, // decremented - <a href="lucy_InStream.html">lucy_InStream*</a> <strong>instream</strong> +<pre><code><span class="prefix">lucy_</span>Query* <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Query_Deserialize</strong>( + <span class="prefix">lucy_</span>Query* <strong>self</strong>, <span class="comment">// decremented</span> + <span class="prefix">lucy_</span><a href="lucy_InStream.html">InStream*</a> <strong>instream</strong> ); </code></pre> </dd> -<dt>Dump</dt> +<dt id="func_Dump">Dump</dt> <dd> -<pre><code><a href="cfish_Obj.html">cfish_Obj*</a> // incremented -<strong>LUCY_Query_Dump</strong>( - lucy_Query* <strong>self</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_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>Load</dt> +<dt id="func_Load">Load</dt> <dd> -<pre><code><a href="cfish_Obj.html">cfish_Obj*</a> // incremented -<strong>LUCY_Query_Load</strong>( - lucy_Query* <strong>self</strong>, - <a href="cfish_Obj.html">cfish_Obj*</a> <strong>dump</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_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="cfish_Obj.html">Obj*</a> <strong>dump</strong> ); </code></pre> </dd> Modified: websites/staging/lucy/trunk/content/docs/c/lucy_NoMatchQuery.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/lucy_NoMatchQuery.html (original) +++ websites/staging/lucy/trunk/content/docs/c/lucy_NoMatchQuery.html Tue Dec 2 17:54:11 2014 @@ -1,31 +1,97 @@ <!DOCTYPE html> <html> <head> +<meta charset="utf-8"> +<!-- +*********************************************** + +!!!! DO NOT EDIT !!!! + +This file was auto-generated by cfc. + +*********************************************** + +Licensed to the Apache Software Foundation (ASF) under one or more +contributor license agreements. See the NOTICE file distributed with +this work for additional information regarding copyright ownership. +The ASF licenses this file to You under the Apache License, Version 2.0 +(the "License"); you may not use this file except in compliance with +the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> <meta name="viewport" content="width=device-width" /> +<title>Lucy::Search::NoMatchQuery â C API Documentation</title> <style type="text/css"> body { - font-family: sans-serif; - font-size: 0.85em; - max-width: 640px; + max-width: 48em; + font: 0.85em/1.4 sans-serif; +} +a { + color: #23b; +} +table { + border-collapse: collapse; +} +td { + padding: 0; +} +td.label { + padding-right: 2em; + font-weight: bold; } dt { font-weight: bold; } pre { - border: 1px solid #000; + border: 1px solid #ccc; padding: 0.2em 0.4em; background: #f6f6f6; - font-size: 1.2em; + font-size: 0.92em; +} +pre a { + text-decoration: none; } -code { +pre, code { font-family: "Consolas", "Menlo", monospace; } +span.prefix, span.comment { + color: #888; +} </style> </head> <body> <h1>Lucy::Search::NoMatchQuery</h1> +<table> +<tr> +<td class="label">parcel</td> +<td><a href="lucy.html">Lucy</a></td> +</tr> +<tr> +<td class="label">class name</td> +<td>Lucy::Search::NoMatchQuery</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>NoMatchQuery</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_NOMATCHQUERY</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_NoMatchQuery</code></td> +</tr> +</table> <h2>Name</h2> -<p>Lucy::Search::NoMatchQuery - Query which matches no documents.</p> +<p>Lucy::Search::NoMatchQuery â Query which matches no documents.</p> <h2>Description</h2> <p>NoMatchQuery is a utility class representing a query which matches nothing. Typical usage might include e.g. returning a NoMatchQuery when a @@ -33,95 +99,96 @@ Typical usage might include e.g. returni string.</p> <h2>Functions</h2> <dl> -<dt>init</dt> +<dt id="func_init">init</dt> <dd> -<pre><code>lucy_NoMatchQuery* -<strong>lucy_NoMatchQuery_init</strong>( - lucy_NoMatchQuery* <strong>self</strong> +<pre><code><span class="prefix">lucy_</span>NoMatchQuery* +<span class="prefix">lucy_</span><strong>NoMatchQuery_init</strong>( + <span class="prefix">lucy_</span>NoMatchQuery* <strong>self</strong> ); </code></pre> <p>Constructor. Takes no arguments.</p> </dd> </dl> <h2>Methods</h2> -<h3>Methods inherited from Lucy::Search::Query</h3><dl> -<dt>Make_Compiler</dt> +<h3>Methods inherited from Lucy::Search::Query</h3> +<dl> +<dt id="func_Make_Compiler">Make_Compiler <span class="comment">(abstract)</span></dt> <dd> -<pre><code><a href="lucy_Compiler.html">lucy_Compiler*</a> // incremented -<strong>LUCY_Query_Make_Compiler</strong>( - lucy_Query* <strong>self</strong>, - <a href="lucy_Searcher.html">lucy_Searcher*</a> <strong>searcher</strong>, +<pre><code><span class="prefix">lucy_</span><a href="lucy_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_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><emph>searcher</emph></dt> +<dt>searcher</dt> <dd><p>A Searcher.</p> </dd> -<dt><emph>boost</emph></dt> +<dt>boost</dt> <dd><p>A scoring multiplier.</p> </dd> -<dt><emph>subordinate</emph></dt> +<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 Normalize() on the newly minted Compiler object before returning +invoke <a href="lucy_Compiler.html#func_Normalize">Normalize()</a> on the newly minted Compiler object before returning it.</p> </dd> </dl> </dd> -<dt>Set_Boost</dt> +<dt id="func_Set_Boost">Set_Boost</dt> <dd> <pre><code>void -<strong>LUCY_Query_Set_Boost</strong>( - lucy_Query* <strong>self</strong>, +<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>Get_Boost</dt> +<dt id="func_Get_Boost">Get_Boost</dt> <dd> <pre><code>float -<strong>LUCY_Query_Get_Boost</strong>( - lucy_Query* <strong>self</strong> +<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>Serialize</dt> +<dt id="func_Serialize">Serialize</dt> <dd> <pre><code>void -<strong>LUCY_Query_Serialize</strong>( - lucy_Query* <strong>self</strong>, - <a href="lucy_OutStream.html">lucy_OutStream*</a> <strong>outstream</strong> +<span class="prefix">LUCY_</span><strong>Query_Serialize</strong>( + <span class="prefix">lucy_</span>Query* <strong>self</strong>, + <span class="prefix">lucy_</span><a href="lucy_OutStream.html">OutStream*</a> <strong>outstream</strong> ); </code></pre> </dd> -<dt>Deserialize</dt> +<dt id="func_Deserialize">Deserialize</dt> <dd> -<pre><code>lucy_Query* // incremented -<strong>LUCY_Query_Deserialize</strong>( - lucy_Query* <strong>self</strong>, // decremented - <a href="lucy_InStream.html">lucy_InStream*</a> <strong>instream</strong> +<pre><code><span class="prefix">lucy_</span>Query* <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Query_Deserialize</strong>( + <span class="prefix">lucy_</span>Query* <strong>self</strong>, <span class="comment">// decremented</span> + <span class="prefix">lucy_</span><a href="lucy_InStream.html">InStream*</a> <strong>instream</strong> ); </code></pre> </dd> -<dt>Dump</dt> +<dt id="func_Dump">Dump</dt> <dd> -<pre><code><a href="cfish_Obj.html">cfish_Obj*</a> // incremented -<strong>LUCY_Query_Dump</strong>( - lucy_Query* <strong>self</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_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>Load</dt> +<dt id="func_Load">Load</dt> <dd> -<pre><code><a href="cfish_Obj.html">cfish_Obj*</a> // incremented -<strong>LUCY_Query_Load</strong>( - lucy_Query* <strong>self</strong>, - <a href="cfish_Obj.html">cfish_Obj*</a> <strong>dump</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_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="cfish_Obj.html">Obj*</a> <strong>dump</strong> ); </code></pre> </dd>
