Modified: lucy/site/trunk/content/docs/c/lucy_Highlighter.html URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/c/lucy_Highlighter.html?rev=1642966&r1=1642965&r2=1642966&view=diff ============================================================================== --- lucy/site/trunk/content/docs/c/lucy_Highlighter.html (original) +++ lucy/site/trunk/content/docs/c/lucy_Highlighter.html Tue Dec 2 17:54:02 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::Highlight::Highlighter â 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::Highlight::Highlighter</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::Highlight::Highlighter</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>Highlighter</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_HIGHLIGHTER</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_Highlighter</code></td> +</tr> +</table> <h2>Name</h2> -<p>Lucy::Highlight::Highlighter - Create and highlight excerpts.</p> +<p>Lucy::Highlight::Highlighter â Create and highlight excerpts.</p> <h2>Description</h2> <p>The Highlighter can be used to select relevant snippets from a document, and to surround search terms with highlighting tags. It handles both stems @@ -33,155 +99,155 @@ and phrases correctly and efficiently, u at index-time.</p> <h2>Functions</h2> <dl> -<dt>init</dt> +<dt id="func_init">init</dt> <dd> -<pre><code>lucy_Highlighter* -<strong>lucy_Highlighter_init</strong>( - lucy_Highlighter* <strong>self</strong>, - <a href="lucy_Searcher.html">lucy_Searcher*</a> <strong>searcher</strong>, - <a href="cfish_Obj.html">cfish_Obj*</a> <strong>query</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>field</strong>, +<pre><code><span class="prefix">lucy_</span>Highlighter* +<span class="prefix">lucy_</span><strong>Highlighter_init</strong>( + <span class="prefix">lucy_</span>Highlighter* <strong>self</strong>, + <span class="prefix">lucy_</span><a href="lucy_Searcher.html">Searcher*</a> <strong>searcher</strong>, + <span class="prefix">cfish_</span><a href="cfish_Obj.html">Obj*</a> <strong>query</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>field</strong>, uint32_t <strong>excerpt_length</strong> ); </code></pre> <dl> -<dt><emph>searcher</emph></dt> +<dt>searcher</dt> <dd><p>An object which inherits from <a href="lucy_Searcher.html">Searcher</a>, such as an <a href="lucy_IndexSearcher.html">IndexSearcher</a>.</p> </dd> -<dt><emph>query</emph></dt> +<dt>query</dt> <dd><p>Query object or a query string.</p> </dd> -<dt><emph>field</emph></dt> +<dt>field</dt> <dd><p>The name of the field from which to draw the excerpt. The field must marked as be <code>highlightable</code> (see <a href="lucy_FieldType.html">FieldType</a>).</p> </dd> -<dt><emph>excerpt_length</emph></dt> +<dt>excerpt_length</dt> <dd><p>Maximum length of the excerpt, in characters.</p> </dd> </dl> </dd> </dl> <h2>Methods</h2> -<h3>Novel methods</h3> +<h3>Novel methods</h3 <dl> -<dt>Create_Excerpt</dt> +<dt id="func_Create_Excerpt">Create_Excerpt</dt> <dd> -<pre><code><a href="cfish_String.html">cfish_String*</a> // incremented -<strong>LUCY_Highlighter_Create_Excerpt</strong>( - lucy_Highlighter* <strong>self</strong>, - <a href="lucy_HitDoc.html">lucy_HitDoc*</a> <strong>hit_doc</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Highlighter_Create_Excerpt</strong>( + <span class="prefix">lucy_</span>Highlighter* <strong>self</strong>, + <span class="prefix">lucy_</span><a href="lucy_HitDoc.html">HitDoc*</a> <strong>hit_doc</strong> ); </code></pre> <p>Take a HitDoc object and return a highlighted excerpt as a string if the HitDoc has a value for the specified <code>field</code>.</p> </dd> -<dt>Encode</dt> +<dt id="func_Encode">Encode</dt> <dd> -<pre><code><a href="cfish_String.html">cfish_String*</a> // incremented -<strong>LUCY_Highlighter_Encode</strong>( - lucy_Highlighter* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>text</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Highlighter_Encode</strong>( + <span class="prefix">lucy_</span>Highlighter* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>text</strong> ); </code></pre> <p>Encode text with HTML entities. This method is called internally by -Create_Excerpt() for each text fragment when assembling an excerpt. A +<a href="lucy_Highlighter.html#func_Create_Excerpt">Create_Excerpt()</a> for each text fragment when assembling an excerpt. A subclass can override this if the text should be encoded differently or not at all.</p> </dd> -<dt>Highlight</dt> +<dt id="func_Highlight">Highlight</dt> <dd> -<pre><code><a href="cfish_String.html">cfish_String*</a> // incremented -<strong>LUCY_Highlighter_Highlight</strong>( - lucy_Highlighter* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>text</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Highlighter_Highlight</strong>( + <span class="prefix">lucy_</span>Highlighter* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>text</strong> ); </code></pre> <p>Highlight a small section of text. By default, prepends pre-tag and -appends post-tag. This method is called internally by Create_Excerpt() +appends post-tag. This method is called internally by <a href="lucy_Highlighter.html#func_Create_Excerpt">Create_Excerpt()</a> when assembling an excerpt.</p> </dd> -<dt>Set_Pre_Tag</dt> +<dt id="func_Set_Pre_Tag">Set_Pre_Tag</dt> <dd> <pre><code>void -<strong>LUCY_Highlighter_Set_Pre_Tag</strong>( - lucy_Highlighter* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>pre_tag</strong> +<span class="prefix">LUCY_</span><strong>Highlighter_Set_Pre_Tag</strong>( + <span class="prefix">lucy_</span>Highlighter* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>pre_tag</strong> ); </code></pre> <p>Setter. The default value is "<strong>".</p> </dd> -<dt>Set_Post_Tag</dt> +<dt id="func_Set_Post_Tag">Set_Post_Tag</dt> <dd> <pre><code>void -<strong>LUCY_Highlighter_Set_Post_Tag</strong>( - lucy_Highlighter* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>post_tag</strong> +<span class="prefix">LUCY_</span><strong>Highlighter_Set_Post_Tag</strong>( + <span class="prefix">lucy_</span>Highlighter* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>post_tag</strong> ); </code></pre> <p>Setter. The default value is "</strong>".</p> </dd> -<dt>Get_Pre_Tag</dt> +<dt id="func_Get_Pre_Tag">Get_Pre_Tag</dt> <dd> -<pre><code><a href="cfish_String.html">cfish_String*</a> -<strong>LUCY_Highlighter_Get_Pre_Tag</strong>( - lucy_Highlighter* <strong>self</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> +<span class="prefix">LUCY_</span><strong>Highlighter_Get_Pre_Tag</strong>( + <span class="prefix">lucy_</span>Highlighter* <strong>self</strong> ); </code></pre> <p>Accessor.</p> </dd> -<dt>Get_Post_Tag</dt> +<dt id="func_Get_Post_Tag">Get_Post_Tag</dt> <dd> -<pre><code><a href="cfish_String.html">cfish_String*</a> -<strong>LUCY_Highlighter_Get_Post_Tag</strong>( - lucy_Highlighter* <strong>self</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> +<span class="prefix">LUCY_</span><strong>Highlighter_Get_Post_Tag</strong>( + <span class="prefix">lucy_</span>Highlighter* <strong>self</strong> ); </code></pre> <p>Accessor.</p> </dd> -<dt>Get_Field</dt> +<dt id="func_Get_Field">Get_Field</dt> <dd> -<pre><code><a href="cfish_String.html">cfish_String*</a> -<strong>LUCY_Highlighter_Get_Field</strong>( - lucy_Highlighter* <strong>self</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> +<span class="prefix">LUCY_</span><strong>Highlighter_Get_Field</strong>( + <span class="prefix">lucy_</span>Highlighter* <strong>self</strong> ); </code></pre> <p>Accessor.</p> </dd> -<dt>Get_Excerpt_Length</dt> +<dt id="func_Get_Excerpt_Length">Get_Excerpt_Length</dt> <dd> <pre><code>uint32_t -<strong>LUCY_Highlighter_Get_Excerpt_Length</strong>( - lucy_Highlighter* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>Highlighter_Get_Excerpt_Length</strong>( + <span class="prefix">lucy_</span>Highlighter* <strong>self</strong> ); </code></pre> <p>Accessor.</p> </dd> -<dt>Get_Searcher</dt> +<dt id="func_Get_Searcher">Get_Searcher</dt> <dd> -<pre><code><a href="lucy_Searcher.html">lucy_Searcher*</a> -<strong>LUCY_Highlighter_Get_Searcher</strong>( - lucy_Highlighter* <strong>self</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_Searcher.html">Searcher*</a> +<span class="prefix">LUCY_</span><strong>Highlighter_Get_Searcher</strong>( + <span class="prefix">lucy_</span>Highlighter* <strong>self</strong> ); </code></pre> <p>Accessor.</p> </dd> -<dt>Get_Query</dt> +<dt id="func_Get_Query">Get_Query</dt> <dd> -<pre><code><a href="lucy_Query.html">lucy_Query*</a> -<strong>LUCY_Highlighter_Get_Query</strong>( - lucy_Highlighter* <strong>self</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_Query.html">Query*</a> +<span class="prefix">LUCY_</span><strong>Highlighter_Get_Query</strong>( + <span class="prefix">lucy_</span>Highlighter* <strong>self</strong> ); </code></pre> <p>Accessor.</p> </dd> -<dt>Get_Compiler</dt> +<dt id="func_Get_Compiler">Get_Compiler</dt> <dd> -<pre><code><a href="lucy_Compiler.html">lucy_Compiler*</a> -<strong>LUCY_Highlighter_Get_Compiler</strong>( - lucy_Highlighter* <strong>self</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_Compiler.html">Compiler*</a> +<span class="prefix">LUCY_</span><strong>Highlighter_Get_Compiler</strong>( + <span class="prefix">lucy_</span>Highlighter* <strong>self</strong> ); </code></pre> <p>Accessor for the Lucy::Search::Compiler object derived from
Modified: lucy/site/trunk/content/docs/c/lucy_HitDoc.html URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/c/lucy_HitDoc.html?rev=1642966&r1=1642965&r2=1642966&view=diff ============================================================================== --- lucy/site/trunk/content/docs/c/lucy_HitDoc.html (original) +++ lucy/site/trunk/content/docs/c/lucy_HitDoc.html Tue Dec 2 17:54:02 2014 @@ -1,127 +1,194 @@ <!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::Document::HitDoc â 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::Document::HitDoc</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::Document::HitDoc</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>HitDoc</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_HITDOC</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_HitDoc</code></td> +</tr> +</table> <h2>Name</h2> -<p>Lucy::Document::HitDoc - A document read from an index.</p> +<p>Lucy::Document::HitDoc â A document read from an index.</p> <h2>Description</h2> <p>HitDoc is the search-time relative of the index-time class Doc; it is augmented by a numeric score attribute that Doc doesn't have.</p> <h2>Methods</h2> -<h3>Novel methods</h3> +<h3>Novel methods</h3 <dl> -<dt>Set_Score</dt> +<dt id="func_Set_Score">Set_Score</dt> <dd> <pre><code>void -<strong>LUCY_HitDoc_Set_Score</strong>( - lucy_HitDoc* <strong>self</strong>, +<span class="prefix">LUCY_</span><strong>HitDoc_Set_Score</strong>( + <span class="prefix">lucy_</span>HitDoc* <strong>self</strong>, float <strong>score</strong> ); </code></pre> <p>Set score attribute.</p> </dd> -<dt>Get_Score</dt> +<dt id="func_Get_Score">Get_Score</dt> <dd> <pre><code>float -<strong>LUCY_HitDoc_Get_Score</strong>( - lucy_HitDoc* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>HitDoc_Get_Score</strong>( + <span class="prefix">lucy_</span>HitDoc* <strong>self</strong> ); </code></pre> <p>Get score attribute.</p> </dd> </dl> -<h3>Methods inherited from Lucy::Document::Doc</h3><dl> -<dt>Set_Doc_ID</dt> +<h3>Methods inherited from Lucy::Document::Doc</h3> +<dl> +<dt id="func_Set_Doc_ID">Set_Doc_ID</dt> <dd> <pre><code>void -<strong>LUCY_Doc_Set_Doc_ID</strong>( - lucy_Doc* <strong>self</strong>, +<span class="prefix">LUCY_</span><strong>Doc_Set_Doc_ID</strong>( + <span class="prefix">lucy_</span>Doc* <strong>self</strong>, int32_t <strong>doc_id</strong> ); </code></pre> <p>Set internal Lucy document id.</p> </dd> -<dt>Get_Doc_ID</dt> +<dt id="func_Get_Doc_ID">Get_Doc_ID</dt> <dd> <pre><code>int32_t -<strong>LUCY_Doc_Get_Doc_ID</strong>( - lucy_Doc* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>Doc_Get_Doc_ID</strong>( + <span class="prefix">lucy_</span>Doc* <strong>self</strong> ); </code></pre> <p>Retrieve internal Lucy document id.</p> </dd> -<dt>Get_Fields</dt> +<dt id="func_Get_Fields">Get_Fields</dt> <dd> <pre><code>void* -<strong>LUCY_Doc_Get_Fields</strong>( - lucy_Doc* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>Doc_Get_Fields</strong>( + <span class="prefix">lucy_</span>Doc* <strong>self</strong> ); </code></pre> <p>Return the Doc's backing fields hash.</p> </dd> -<dt>Get_Size</dt> +<dt id="func_Get_Size">Get_Size</dt> <dd> <pre><code>uint32_t -<strong>LUCY_Doc_Get_Size</strong>( - lucy_Doc* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>Doc_Get_Size</strong>( + <span class="prefix">lucy_</span>Doc* <strong>self</strong> ); </code></pre> <p>Return the number of fields in the Doc.</p> </dd> -<dt>Serialize</dt> +<dt id="func_Serialize">Serialize</dt> <dd> <pre><code>void -<strong>LUCY_Doc_Serialize</strong>( - lucy_Doc* <strong>self</strong>, - <a href="lucy_OutStream.html">lucy_OutStream*</a> <strong>outstream</strong> +<span class="prefix">LUCY_</span><strong>Doc_Serialize</strong>( + <span class="prefix">lucy_</span>Doc* <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_Doc* // incremented -<strong>LUCY_Doc_Deserialize</strong>( - lucy_Doc* <strong>self</strong>, // decremented - <a href="lucy_InStream.html">lucy_InStream*</a> <strong>instream</strong> +<pre><code><span class="prefix">lucy_</span>Doc* <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Doc_Deserialize</strong>( + <span class="prefix">lucy_</span>Doc* <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_Hash.html">cfish_Hash*</a> // incremented -<strong>LUCY_Doc_Dump</strong>( - lucy_Doc* <strong>self</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_Hash.html">Hash*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Doc_Dump</strong>( + <span class="prefix">lucy_</span>Doc* <strong>self</strong> ); </code></pre> </dd> -<dt>Load</dt> +<dt id="func_Load">Load</dt> <dd> -<pre><code>lucy_Doc* // incremented -<strong>LUCY_Doc_Load</strong>( - lucy_Doc* <strong>self</strong>, - <a href="cfish_Obj.html">cfish_Obj*</a> <strong>dump</strong> +<pre><code><span class="prefix">lucy_</span>Doc* <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Doc_Load</strong>( + <span class="prefix">lucy_</span>Doc* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_Obj.html">Obj*</a> <strong>dump</strong> ); </code></pre> </dd> Modified: lucy/site/trunk/content/docs/c/lucy_Hits.html URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/c/lucy_Hits.html?rev=1642966&r1=1642965&r2=1642966&view=diff ============================================================================== --- lucy/site/trunk/content/docs/c/lucy_Hits.html (original) +++ lucy/site/trunk/content/docs/c/lucy_Hits.html Tue Dec 2 17:54:02 2014 @@ -1,50 +1,116 @@ <!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::Hits â 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::Hits</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::Hits</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>Hits</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_HITS</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_Hits</code></td> +</tr> +</table> <h2>Name</h2> -<p>Lucy::Search::Hits - Access search results.</p> +<p>Lucy::Search::Hits â Access search results.</p> <h2>Description</h2> <p>Hits objects are iterators used to access the results of a search.</p> <h2>Methods</h2> -<h3>Novel methods</h3> +<h3>Novel methods</h3 <dl> -<dt>Next</dt> +<dt id="func_Next">Next</dt> <dd> -<pre><code><a href="lucy_HitDoc.html">lucy_HitDoc*</a> // incremented -<strong>LUCY_Hits_Next</strong>( - lucy_Hits* <strong>self</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_HitDoc.html">HitDoc*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Hits_Next</strong>( + <span class="prefix">lucy_</span>Hits* <strong>self</strong> ); </code></pre> <p>Return the next hit, or NULL when the iterator is exhausted.</p> </dd> -<dt>Total_Hits</dt> +<dt id="func_Total_Hits">Total_Hits</dt> <dd> <pre><code>uint32_t -<strong>LUCY_Hits_Total_Hits</strong>( - lucy_Hits* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>Hits_Total_Hits</strong>( + <span class="prefix">lucy_</span>Hits* <strong>self</strong> ); </code></pre> <p>Return the total number of documents which matched the Query used to Modified: lucy/site/trunk/content/docs/c/lucy_IndexManager.html URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/c/lucy_IndexManager.html?rev=1642966&r1=1642965&r2=1642966&view=diff ============================================================================== --- lucy/site/trunk/content/docs/c/lucy_IndexManager.html (original) +++ lucy/site/trunk/content/docs/c/lucy_IndexManager.html Tue Dec 2 17:54:02 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::IndexManager â 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::IndexManager</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::IndexManager</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>IxManager</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_INDEXMANAGER</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_IndexManager</code></td> +</tr> +</table> <h2>Name</h2> -<p>Lucy::Index::IndexManager - Policies governing index updating, locking, and file deletion.</p> +<p>Lucy::Index::IndexManager â Policies governing index updating, locking, and file deletion.</p> <h2>Description</h2> <p>IndexManager is an advanced-use class for controlling index locking, updating, merging, and deletion behaviors.</p> @@ -35,73 +101,73 @@ which cannot change for the life of an i defining rules which may change from process to process.</p> <h2>Functions</h2> <dl> -<dt>new</dt> +<dt id="func_new">new</dt> <dd> -<pre><code>lucy_IndexManager* // incremented -<strong>lucy_IxManager_new</strong>( - <a href="cfish_String.html">cfish_String*</a> <strong>host</strong>, - <a href="lucy_LockFactory.html">lucy_LockFactory*</a> <strong>lock_factory</strong> +<pre><code><span class="prefix">lucy_</span>IndexManager* <span class="comment">// incremented</span> +<span class="prefix">lucy_</span><strong>IxManager_new</strong>( + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>host</strong>, + <span class="prefix">lucy_</span><a href="lucy_LockFactory.html">LockFactory*</a> <strong>lock_factory</strong> ); </code></pre> </dd> -<dt>init</dt> +<dt id="func_init">init</dt> <dd> -<pre><code>lucy_IndexManager* -<strong>lucy_IxManager_init</strong>( - lucy_IndexManager* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>host</strong>, - <a href="lucy_LockFactory.html">lucy_LockFactory*</a> <strong>lock_factory</strong> +<pre><code><span class="prefix">lucy_</span>IndexManager* +<span class="prefix">lucy_</span><strong>IxManager_init</strong>( + <span class="prefix">lucy_</span>IndexManager* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>host</strong>, + <span class="prefix">lucy_</span><a href="lucy_LockFactory.html">LockFactory*</a> <strong>lock_factory</strong> ); </code></pre> <dl> -<dt><emph>host</emph></dt> +<dt>host</dt> <dd><p>An identifier which should be unique per-machine.</p> </dd> -<dt><emph>lock_factory</emph></dt> +<dt>lock_factory</dt> <dd><p>A LockFactory.</p> </dd> </dl> </dd> </dl> <h2>Methods</h2> -<h3>Novel methods</h3> +<h3>Novel methods</h3 <dl> -<dt>Set_Folder</dt> +<dt id="func_Set_Folder">Set_Folder</dt> <dd> <pre><code>void -<strong>LUCY_IxManager_Set_Folder</strong>( - lucy_IndexManager* <strong>self</strong>, - <a href="lucy_Folder.html">lucy_Folder*</a> <strong>folder</strong> +<span class="prefix">LUCY_</span><strong>IxManager_Set_Folder</strong>( + <span class="prefix">lucy_</span>IndexManager* <strong>self</strong>, + <span class="prefix">lucy_</span><a href="lucy_Folder.html">Folder*</a> <strong>folder</strong> ); </code></pre> <p>Setter for <code>folder</code> member. Typical clients (Indexer, IndexReader) will use this method to install their own Folder instance.</p> </dd> -<dt>Get_Folder</dt> +<dt id="func_Get_Folder">Get_Folder</dt> <dd> -<pre><code><a href="lucy_Folder.html">lucy_Folder*</a> -<strong>LUCY_IxManager_Get_Folder</strong>( - lucy_IndexManager* <strong>self</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_Folder.html">Folder*</a> +<span class="prefix">LUCY_</span><strong>IxManager_Get_Folder</strong>( + <span class="prefix">lucy_</span>IndexManager* <strong>self</strong> ); </code></pre> <p>Getter for <code>folder</code> member.</p> </dd> -<dt>Get_Host</dt> +<dt id="func_Get_Host">Get_Host</dt> <dd> -<pre><code><a href="cfish_String.html">cfish_String*</a> -<strong>LUCY_IxManager_Get_Host</strong>( - lucy_IndexManager* <strong>self</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> +<span class="prefix">LUCY_</span><strong>IxManager_Get_Host</strong>( + <span class="prefix">lucy_</span>IndexManager* <strong>self</strong> ); </code></pre> <p>Getter for <code>host</code> member.</p> </dd> -<dt>Recycle</dt> +<dt id="func_Recycle">Recycle</dt> <dd> -<pre><code><a href="cfish_VArray.html">cfish_VArray*</a> // incremented -<strong>LUCY_IxManager_Recycle</strong>( - lucy_IndexManager* <strong>self</strong>, - <a href="lucy_PolyReader.html">lucy_PolyReader*</a> <strong>reader</strong>, - <a href="lucy_DeletionsWriter.html">lucy_DeletionsWriter*</a> <strong>del_writer</strong>, +<pre><code><span class="prefix">cfish_</span><a href="cfish_VArray.html">VArray*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>IxManager_Recycle</strong>( + <span class="prefix">lucy_</span>IndexManager* <strong>self</strong>, + <span class="prefix">lucy_</span><a href="lucy_PolyReader.html">PolyReader*</a> <strong>reader</strong>, + <span class="prefix">lucy_</span><a href="lucy_DeletionsWriter.html">DeletionsWriter*</a> <strong>del_writer</strong>, int64_t <strong>cutoff</strong>, bool <strong>optimize</strong> ); @@ -112,223 +178,223 @@ search-time degradation due to segment p implementation prefers small segments or segments with a high proportion of deletions.</p> <dl> -<dt><emph>reader</emph></dt> +<dt>reader</dt> <dd><p>A PolyReader.</p> </dd> -<dt><emph>del_writer</emph></dt> +<dt>del_writer</dt> <dd><p>A DeletionsWriter.</p> </dd> -<dt><emph>cutoff</emph></dt> +<dt>cutoff</dt> <dd><p>A segment number which all returned SegReaders must exceed.</p> </dd> -<dt><emph>optimize</emph></dt> +<dt>optimize</dt> <dd><p>A boolean indicating whether to spend extra time optimizing the index for search-time performance.</p> </dd> </dl> </dd> -<dt>Make_Write_Lock</dt> +<dt id="func_Make_Write_Lock">Make_Write_Lock</dt> <dd> -<pre><code><a href="lucy_Lock.html">lucy_Lock*</a> // incremented -<strong>LUCY_IxManager_Make_Write_Lock</strong>( - lucy_IndexManager* <strong>self</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>IxManager_Make_Write_Lock</strong>( + <span class="prefix">lucy_</span>IndexManager* <strong>self</strong> ); </code></pre> <p>Create the Lock which controls access to modifying the logical content of the index.</p> </dd> -<dt>Make_Deletion_Lock</dt> +<dt id="func_Make_Deletion_Lock">Make_Deletion_Lock</dt> <dd> -<pre><code><a href="lucy_Lock.html">lucy_Lock*</a> // incremented -<strong>LUCY_IxManager_Make_Deletion_Lock</strong>( - lucy_IndexManager* <strong>self</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>IxManager_Make_Deletion_Lock</strong>( + <span class="prefix">lucy_</span>IndexManager* <strong>self</strong> ); </code></pre> <p>Create the Lock which grants permission to delete obsolete snapshot files or any file listed within an existing snapshot file.</p> </dd> -<dt>Make_Merge_Lock</dt> +<dt id="func_Make_Merge_Lock">Make_Merge_Lock</dt> <dd> -<pre><code><a href="lucy_Lock.html">lucy_Lock*</a> // incremented -<strong>LUCY_IxManager_Make_Merge_Lock</strong>( - lucy_IndexManager* <strong>self</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>IxManager_Make_Merge_Lock</strong>( + <span class="prefix">lucy_</span>IndexManager* <strong>self</strong> ); </code></pre> </dd> -<dt>Write_Merge_Data</dt> +<dt id="func_Write_Merge_Data">Write_Merge_Data</dt> <dd> <pre><code>void -<strong>LUCY_IxManager_Write_Merge_Data</strong>( - lucy_IndexManager* <strong>self</strong>, +<span class="prefix">LUCY_</span><strong>IxManager_Write_Merge_Data</strong>( + <span class="prefix">lucy_</span>IndexManager* <strong>self</strong>, int64_t <strong>cutoff</strong> ); </code></pre> <p>Write supplied data to "merge.json". Throw an exception if the write fails.</p> </dd> -<dt>Read_Merge_Data</dt> +<dt id="func_Read_Merge_Data">Read_Merge_Data</dt> <dd> -<pre><code><a href="cfish_Hash.html">cfish_Hash*</a> // incremented -<strong>LUCY_IxManager_Read_Merge_Data</strong>( - lucy_IndexManager* <strong>self</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_Hash.html">Hash*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>IxManager_Read_Merge_Data</strong>( + <span class="prefix">lucy_</span>IndexManager* <strong>self</strong> ); </code></pre> <p>Look for the "merge.json" file dropped by BackgroundMerger. If it's not there, return NULL. If it's there but can't be decoded, return an empty Hash. If successfully decoded, return contents.</p> </dd> -<dt>Remove_Merge_Data</dt> +<dt id="func_Remove_Merge_Data">Remove_Merge_Data</dt> <dd> <pre><code>bool -<strong>LUCY_IxManager_Remove_Merge_Data</strong>( - lucy_IndexManager* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>IxManager_Remove_Merge_Data</strong>( + <span class="prefix">lucy_</span>IndexManager* <strong>self</strong> ); </code></pre> </dd> -<dt>Make_Snapshot_Read_Lock</dt> +<dt id="func_Make_Snapshot_Read_Lock">Make_Snapshot_Read_Lock</dt> <dd> -<pre><code><a href="lucy_Lock.html">lucy_Lock*</a> // incremented -<strong>LUCY_IxManager_Make_Snapshot_Read_Lock</strong>( - lucy_IndexManager* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>filename</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>IxManager_Make_Snapshot_Read_Lock</strong>( + <span class="prefix">lucy_</span>IndexManager* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>filename</strong> ); </code></pre> <p>Create a shared lock on a snapshot file, which serves as a proxy for all the files it lists and indicates that they must not be deleted.</p> </dd> -<dt>Highest_Seg_Num</dt> +<dt id="func_Highest_Seg_Num">Highest_Seg_Num</dt> <dd> <pre><code>int64_t -<strong>LUCY_IxManager_Highest_Seg_Num</strong>( - lucy_IndexManager* <strong>self</strong>, - <a href="lucy_Snapshot.html">lucy_Snapshot*</a> <strong>snapshot</strong> +<span class="prefix">LUCY_</span><strong>IxManager_Highest_Seg_Num</strong>( + <span class="prefix">lucy_</span>IndexManager* <strong>self</strong>, + <span class="prefix">lucy_</span><a href="lucy_Snapshot.html">Snapshot*</a> <strong>snapshot</strong> ); </code></pre> <p>Return the highest number for a segment directory which contains a segmeta file in the snapshot.</p> </dd> -<dt>Make_Snapshot_Filename</dt> +<dt id="func_Make_Snapshot_Filename">Make_Snapshot_Filename</dt> <dd> -<pre><code><a href="cfish_String.html">cfish_String*</a> // incremented -<strong>LUCY_IxManager_Make_Snapshot_Filename</strong>( - lucy_IndexManager* <strong>self</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>IxManager_Make_Snapshot_Filename</strong>( + <span class="prefix">lucy_</span>IndexManager* <strong>self</strong> ); </code></pre> <p>Return the name of a new snapshot file, which shall contain a base-36 "generation" embedded inside it greater than the generation of any snapshot file currently in the index folder.</p> </dd> -<dt>Set_Write_Lock_Timeout</dt> +<dt id="func_Set_Write_Lock_Timeout">Set_Write_Lock_Timeout</dt> <dd> <pre><code>void -<strong>LUCY_IxManager_Set_Write_Lock_Timeout</strong>( - lucy_IndexManager* <strong>self</strong>, +<span class="prefix">LUCY_</span><strong>IxManager_Set_Write_Lock_Timeout</strong>( + <span class="prefix">lucy_</span>IndexManager* <strong>self</strong>, uint32_t <strong>timeout</strong> ); </code></pre> <p>Setter for write lock timeout. Default: 1000 milliseconds.</p> </dd> -<dt>Get_Write_Lock_Timeout</dt> +<dt id="func_Get_Write_Lock_Timeout">Get_Write_Lock_Timeout</dt> <dd> <pre><code>uint32_t -<strong>LUCY_IxManager_Get_Write_Lock_Timeout</strong>( - lucy_IndexManager* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>IxManager_Get_Write_Lock_Timeout</strong>( + <span class="prefix">lucy_</span>IndexManager* <strong>self</strong> ); </code></pre> <p>Getter for write lock timeout.</p> </dd> -<dt>Set_Write_Lock_Interval</dt> +<dt id="func_Set_Write_Lock_Interval">Set_Write_Lock_Interval</dt> <dd> <pre><code>void -<strong>LUCY_IxManager_Set_Write_Lock_Interval</strong>( - lucy_IndexManager* <strong>self</strong>, +<span class="prefix">LUCY_</span><strong>IxManager_Set_Write_Lock_Interval</strong>( + <span class="prefix">lucy_</span>IndexManager* <strong>self</strong>, uint32_t <strong>timeout</strong> ); </code></pre> <p>Setter for write lock retry interval. Default: 100 milliseconds.</p> </dd> -<dt>Get_Write_Lock_Interval</dt> +<dt id="func_Get_Write_Lock_Interval">Get_Write_Lock_Interval</dt> <dd> <pre><code>uint32_t -<strong>LUCY_IxManager_Get_Write_Lock_Interval</strong>( - lucy_IndexManager* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>IxManager_Get_Write_Lock_Interval</strong>( + <span class="prefix">lucy_</span>IndexManager* <strong>self</strong> ); </code></pre> <p>Getter for write lock retry interval.</p> </dd> -<dt>Set_Merge_Lock_Timeout</dt> +<dt id="func_Set_Merge_Lock_Timeout">Set_Merge_Lock_Timeout</dt> <dd> <pre><code>void -<strong>LUCY_IxManager_Set_Merge_Lock_Timeout</strong>( - lucy_IndexManager* <strong>self</strong>, +<span class="prefix">LUCY_</span><strong>IxManager_Set_Merge_Lock_Timeout</strong>( + <span class="prefix">lucy_</span>IndexManager* <strong>self</strong>, uint32_t <strong>timeout</strong> ); </code></pre> <p>Setter for merge lock timeout. Default: 0 milliseconds (no retries).</p> </dd> -<dt>Get_Merge_Lock_Timeout</dt> +<dt id="func_Get_Merge_Lock_Timeout">Get_Merge_Lock_Timeout</dt> <dd> <pre><code>uint32_t -<strong>LUCY_IxManager_Get_Merge_Lock_Timeout</strong>( - lucy_IndexManager* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>IxManager_Get_Merge_Lock_Timeout</strong>( + <span class="prefix">lucy_</span>IndexManager* <strong>self</strong> ); </code></pre> <p>Getter for merge lock timeout.</p> </dd> -<dt>Set_Merge_Lock_Interval</dt> +<dt id="func_Set_Merge_Lock_Interval">Set_Merge_Lock_Interval</dt> <dd> <pre><code>void -<strong>LUCY_IxManager_Set_Merge_Lock_Interval</strong>( - lucy_IndexManager* <strong>self</strong>, +<span class="prefix">LUCY_</span><strong>IxManager_Set_Merge_Lock_Interval</strong>( + <span class="prefix">lucy_</span>IndexManager* <strong>self</strong>, uint32_t <strong>timeout</strong> ); </code></pre> <p>Setter for merge lock retry interval. Default: 1000 milliseconds.</p> </dd> -<dt>Get_Merge_Lock_Interval</dt> +<dt id="func_Get_Merge_Lock_Interval">Get_Merge_Lock_Interval</dt> <dd> <pre><code>uint32_t -<strong>LUCY_IxManager_Get_Merge_Lock_Interval</strong>( - lucy_IndexManager* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>IxManager_Get_Merge_Lock_Interval</strong>( + <span class="prefix">lucy_</span>IndexManager* <strong>self</strong> ); </code></pre> <p>Getter for merge lock retry interval.</p> </dd> -<dt>Set_Deletion_Lock_Timeout</dt> +<dt id="func_Set_Deletion_Lock_Timeout">Set_Deletion_Lock_Timeout</dt> <dd> <pre><code>void -<strong>LUCY_IxManager_Set_Deletion_Lock_Timeout</strong>( - lucy_IndexManager* <strong>self</strong>, +<span class="prefix">LUCY_</span><strong>IxManager_Set_Deletion_Lock_Timeout</strong>( + <span class="prefix">lucy_</span>IndexManager* <strong>self</strong>, uint32_t <strong>timeout</strong> ); </code></pre> <p>Setter for deletion lock timeout. Default: 1000 milliseconds.</p> </dd> -<dt>Get_Deletion_Lock_Timeout</dt> +<dt id="func_Get_Deletion_Lock_Timeout">Get_Deletion_Lock_Timeout</dt> <dd> <pre><code>uint32_t -<strong>LUCY_IxManager_Get_Deletion_Lock_Timeout</strong>( - lucy_IndexManager* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>IxManager_Get_Deletion_Lock_Timeout</strong>( + <span class="prefix">lucy_</span>IndexManager* <strong>self</strong> ); </code></pre> <p>Getter for deletion lock timeout.</p> </dd> -<dt>Set_Deletion_Lock_Interval</dt> +<dt id="func_Set_Deletion_Lock_Interval">Set_Deletion_Lock_Interval</dt> <dd> <pre><code>void -<strong>LUCY_IxManager_Set_Deletion_Lock_Interval</strong>( - lucy_IndexManager* <strong>self</strong>, +<span class="prefix">LUCY_</span><strong>IxManager_Set_Deletion_Lock_Interval</strong>( + <span class="prefix">lucy_</span>IndexManager* <strong>self</strong>, uint32_t <strong>timeout</strong> ); </code></pre> <p>Setter for deletion lock retry interval. Default: 100 milliseconds.</p> </dd> -<dt>Get_Deletion_Lock_Interval</dt> +<dt id="func_Get_Deletion_Lock_Interval">Get_Deletion_Lock_Interval</dt> <dd> <pre><code>uint32_t -<strong>LUCY_IxManager_Get_Deletion_Lock_Interval</strong>( - lucy_IndexManager* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>IxManager_Get_Deletion_Lock_Interval</strong>( + <span class="prefix">lucy_</span>IndexManager* <strong>self</strong> ); </code></pre> <p>Getter for deletion lock retry interval.</p> Modified: lucy/site/trunk/content/docs/c/lucy_IndexReader.html URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/c/lucy_IndexReader.html?rev=1642966&r1=1642965&r2=1642966&view=diff ============================================================================== --- lucy/site/trunk/content/docs/c/lucy_IndexReader.html (original) +++ lucy/site/trunk/content/docs/c/lucy_IndexReader.html Tue Dec 2 17:54:02 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::IndexReader â 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::IndexReader</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::IndexReader</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>IxReader</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_INDEXREADER</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_IndexReader</code></td> +</tr> +</table> <h2>Name</h2> -<p>Lucy::Index::IndexReader - Read from an inverted index.</p> +<p>Lucy::Index::IndexReader â Read from an inverted index.</p> <h2>Description</h2> <p>IndexReader is the interface through which <a href="lucy_IndexSearcher.html">IndexSearcher</a> objects access the @@ -36,56 +102,56 @@ to reflect modifications to an index, yo after the update process completes.</p> <p>IndexReaders are composites; most of the work is done by individual <a href="lucy_DataReader.html">DataReader</a> sub-components, which may be -accessed via Fetch() and Obtain(). The most efficient and powerful access +accessed via <a href="lucy_IndexReader.html#func_Fetch">Fetch()</a> and <a href="lucy_IndexReader.html#func_Obtain">Obtain()</a>. The most efficient and powerful access to index data happens at the segment level via <a href="lucy_SegReader.html">SegReader</a>'s sub-components.</p> <h2>Functions</h2> <dl> -<dt>init</dt> +<dt id="func_init">init</dt> <dd> -<pre><code>lucy_IndexReader* -<strong>lucy_IxReader_init</strong>( - lucy_IndexReader* <strong>self</strong>, - <a href="lucy_Schema.html">lucy_Schema*</a> <strong>schema</strong>, - <a href="lucy_Folder.html">lucy_Folder*</a> <strong>folder</strong>, - <a href="lucy_Snapshot.html">lucy_Snapshot*</a> <strong>snapshot</strong>, - <a href="cfish_VArray.html">cfish_VArray*</a> <strong>segments</strong>, +<pre><code><span class="prefix">lucy_</span>IndexReader* +<span class="prefix">lucy_</span><strong>IxReader_init</strong>( + <span class="prefix">lucy_</span>IndexReader* <strong>self</strong>, + <span class="prefix">lucy_</span><a href="lucy_Schema.html">Schema*</a> <strong>schema</strong>, + <span class="prefix">lucy_</span><a href="lucy_Folder.html">Folder*</a> <strong>folder</strong>, + <span class="prefix">lucy_</span><a href="lucy_Snapshot.html">Snapshot*</a> <strong>snapshot</strong>, + <span class="prefix">cfish_</span><a href="cfish_VArray.html">VArray*</a> <strong>segments</strong>, int32_t <strong>seg_tick</strong>, - <a href="lucy_IndexManager.html">lucy_IndexManager*</a> <strong>manager</strong> + <span class="prefix">lucy_</span><a href="lucy_IndexManager.html">IndexManager*</a> <strong>manager</strong> ); </code></pre> </dd> -<dt>open</dt> +<dt id="func_open">open</dt> <dd> -<pre><code>lucy_IndexReader* // incremented -<strong>lucy_IxReader_open</strong>( - <a href="cfish_Obj.html">cfish_Obj*</a> <strong>index</strong>, - <a href="lucy_Snapshot.html">lucy_Snapshot*</a> <strong>snapshot</strong>, - <a href="lucy_IndexManager.html">lucy_IndexManager*</a> <strong>manager</strong> +<pre><code><span class="prefix">lucy_</span>IndexReader* <span class="comment">// incremented</span> +<span class="prefix">lucy_</span><strong>IxReader_open</strong>( + <span class="prefix">cfish_</span><a href="cfish_Obj.html">Obj*</a> <strong>index</strong>, + <span class="prefix">lucy_</span><a href="lucy_Snapshot.html">Snapshot*</a> <strong>snapshot</strong>, + <span class="prefix">lucy_</span><a href="lucy_IndexManager.html">IndexManager*</a> <strong>manager</strong> ); </code></pre> </dd> -<dt>do_open</dt> +<dt id="func_do_open">do_open</dt> <dd> -<pre><code>lucy_IndexReader* -<strong>lucy_IxReader_do_open</strong>( - lucy_IndexReader* <strong>self</strong>, - <a href="cfish_Obj.html">cfish_Obj*</a> <strong>index</strong>, - <a href="lucy_Snapshot.html">lucy_Snapshot*</a> <strong>snapshot</strong>, - <a href="lucy_IndexManager.html">lucy_IndexManager*</a> <strong>manager</strong> +<pre><code><span class="prefix">lucy_</span>IndexReader* +<span class="prefix">lucy_</span><strong>IxReader_do_open</strong>( + <span class="prefix">lucy_</span>IndexReader* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_Obj.html">Obj*</a> <strong>index</strong>, + <span class="prefix">lucy_</span><a href="lucy_Snapshot.html">Snapshot*</a> <strong>snapshot</strong>, + <span class="prefix">lucy_</span><a href="lucy_IndexManager.html">IndexManager*</a> <strong>manager</strong> ); </code></pre> <p>IndexReader is an abstract base class; open() returns the IndexReader subclass PolyReader, which channels the output of 0 or more SegReaders.</p> <dl> -<dt><emph>index</emph></dt> +<dt>index</dt> <dd><p>Either a string filepath or a Folder.</p> </dd> -<dt><emph>snapshot</emph></dt> +<dt>snapshot</dt> <dd><p>A Snapshot. If not supplied, the most recent snapshot file will be used.</p> </dd> -<dt><emph>manager</emph></dt> +<dt>manager</dt> <dd><p>An <a href="lucy_IndexManager.html">IndexManager</a>. Read-locking is off by default; supplying this argument turns it on.</p> </dd> @@ -93,13 +159,13 @@ Read-locking is off by default; supplyin </dd> </dl> <h2>Methods</h2> -<h3>Abstract methods</h3> +<h3>Novel methods</h3 <dl> -<dt>Doc_Max</dt> +<dt id="func_Doc_Max">Doc_Max <span class="comment">(abstract)</span></dt> <dd> <pre><code>int32_t -<strong>LUCY_IxReader_Doc_Max</strong>( - lucy_IndexReader* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>IxReader_Doc_Max</strong>( + <span class="prefix">lucy_</span>IndexReader* <strong>self</strong> ); </code></pre> <p>Return the maximum number of documents available to the reader, which @@ -107,162 +173,160 @@ is also the highest possible internal do have been marked as deleted but not yet purged from the index are included in this count.</p> </dd> -<dt>Doc_Count</dt> +<dt id="func_Doc_Count">Doc_Count <span class="comment">(abstract)</span></dt> <dd> <pre><code>int32_t -<strong>LUCY_IxReader_Doc_Count</strong>( - lucy_IndexReader* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>IxReader_Doc_Count</strong>( + <span class="prefix">lucy_</span>IndexReader* <strong>self</strong> ); </code></pre> <p>Return the number of documents available to the reader, subtracting any that are marked as deleted.</p> </dd> -<dt>Del_Count</dt> +<dt id="func_Del_Count">Del_Count <span class="comment">(abstract)</span></dt> <dd> <pre><code>int32_t -<strong>LUCY_IxReader_Del_Count</strong>( - lucy_IndexReader* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>IxReader_Del_Count</strong>( + <span class="prefix">lucy_</span>IndexReader* <strong>self</strong> ); </code></pre> <p>Return the number of documents which have been marked as deleted but not yet purged from the index.</p> </dd> -<dt>Offsets</dt> +<dt id="func_Offsets">Offsets <span class="comment">(abstract)</span></dt> <dd> -<pre><code><a href="lucy_I32Array.html">lucy_I32Array*</a> // incremented -<strong>LUCY_IxReader_Offsets</strong>( - lucy_IndexReader* <strong>self</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_I32Array.html">I32Array*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>IxReader_Offsets</strong>( + <span class="prefix">lucy_</span>IndexReader* <strong>self</strong> ); </code></pre> <p>Return an array with one entry for each segment, corresponding to segment doc_id start offset.</p> </dd> -<dt>Seg_Readers</dt> +<dt id="func_Seg_Readers">Seg_Readers <span class="comment">(abstract)</span></dt> <dd> -<pre><code><a href="cfish_VArray.html">cfish_VArray*</a> // incremented -<strong>LUCY_IxReader_Seg_Readers</strong>( - lucy_IndexReader* <strong>self</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_VArray.html">VArray*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>IxReader_Seg_Readers</strong>( + <span class="prefix">lucy_</span>IndexReader* <strong>self</strong> ); </code></pre> <p>Return an array of all the SegReaders represented within the IndexReader.</p> </dd> -</dl> -<h3>Novel methods</h3> -<dl> -<dt>Obtain</dt> +<dt id="func_Obtain">Obtain</dt> <dd> -<pre><code><a href="lucy_DataReader.html">lucy_DataReader*</a> -<strong>LUCY_IxReader_Obtain</strong>( - lucy_IndexReader* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>api</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_DataReader.html">DataReader*</a> +<span class="prefix">LUCY_</span><strong>IxReader_Obtain</strong>( + <span class="prefix">lucy_</span>IndexReader* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>api</strong> ); </code></pre> <p>Fetch a component, or throw an error if the component can't be found.</p> <dl> -<dt><emph>api</emph></dt> +<dt>api</dt> <dd><p>The name of the DataReader subclass that the desired component must implement.</p> </dd> </dl> </dd> -<dt>Fetch</dt> +<dt id="func_Fetch">Fetch</dt> <dd> -<pre><code><a href="lucy_DataReader.html">lucy_DataReader*</a> -<strong>LUCY_IxReader_Fetch</strong>( - lucy_IndexReader* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>api</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_DataReader.html">DataReader*</a> +<span class="prefix">LUCY_</span><strong>IxReader_Fetch</strong>( + <span class="prefix">lucy_</span>IndexReader* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>api</strong> ); </code></pre> <p>Fetch a component, or return NULL if the component can't be found.</p> <dl> -<dt><emph>api</emph></dt> +<dt>api</dt> <dd><p>The name of the DataReader subclass that the desired component must implement.</p> </dd> </dl> </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: lucy/site/trunk/content/docs/c/lucy_IndexSearcher.html URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/c/lucy_IndexSearcher.html?rev=1642966&r1=1642965&r2=1642966&view=diff ============================================================================== --- lucy/site/trunk/content/docs/c/lucy_IndexSearcher.html (original) +++ lucy/site/trunk/content/docs/c/lucy_IndexSearcher.html Tue Dec 2 17:54:02 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::IndexSearcher â 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::IndexSearcher</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::IndexSearcher</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>IxSearcher</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_INDEXSEARCHER</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_IndexSearcher</code></td> +</tr> +</table> <h2>Name</h2> -<p>Lucy::Search::IndexSearcher - Execute searches against a single index.</p> +<p>Lucy::Search::IndexSearcher â Execute searches against a single index.</p> <h2>Description</h2> <p>Use the IndexSearcher class to perform search queries against an index. (For searching multiple indexes at once, see @@ -35,40 +101,41 @@ code { modified, a new IndexSearcher must be opened to access the changes.</p> <h2>Functions</h2> <dl> -<dt>init</dt> +<dt id="func_init">init</dt> <dd> -<pre><code>lucy_IndexSearcher* -<strong>lucy_IxSearcher_init</strong>( - lucy_IndexSearcher* <strong>self</strong>, - <a href="cfish_Obj.html">cfish_Obj*</a> <strong>index</strong> +<pre><code><span class="prefix">lucy_</span>IndexSearcher* +<span class="prefix">lucy_</span><strong>IxSearcher_init</strong>( + <span class="prefix">lucy_</span>IndexSearcher* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_Obj.html">Obj*</a> <strong>index</strong> ); </code></pre> <dl> -<dt><emph>index</emph></dt> +<dt>index</dt> <dd><p>Either a string filepath, a Folder, or an IndexReader.</p> </dd> </dl> </dd> </dl> <h2>Methods</h2> -<h3>Novel methods</h3> +<h3>Novel methods</h3 <dl> -<dt>Get_Reader</dt> +<dt id="func_Get_Reader">Get_Reader</dt> <dd> -<pre><code><a href="lucy_IndexReader.html">lucy_IndexReader*</a> -<strong>LUCY_IxSearcher_Get_Reader</strong>( - lucy_IndexSearcher* <strong>self</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_IndexReader.html">IndexReader*</a> +<span class="prefix">LUCY_</span><strong>IxSearcher_Get_Reader</strong>( + <span class="prefix">lucy_</span>IndexSearcher* <strong>self</strong> ); </code></pre> <p>Accessor for the object's <code>reader</code> member.</p> </dd> </dl> -<h3>Methods inherited from Lucy::Search::Searcher</h3><dl> -<dt>Doc_Max</dt> +<h3>Methods inherited from Lucy::Search::Searcher</h3> +<dl> +<dt id="func_Doc_Max">Doc_Max <span class="comment">(abstract)</span></dt> <dd> <pre><code>int32_t -<strong>LUCY_Searcher_Doc_Max</strong>( - lucy_Searcher* <strong>self</strong> +<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 @@ -76,110 +143,110 @@ Searcher, which is also the highest poss Documents which have been marked as deleted but not yet purged are included in this count.</p> </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_Searcher_Doc_Freq</strong>( - lucy_Searcher* <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>Searcher_Doc_Freq</strong>( + <span class="prefix">lucy_</span>Searcher* <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 which contain the term in the given 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>The term to look up.</p> </dd> </dl> </dd> -<dt>Glean_Query</dt> +<dt id="func_Glean_Query">Glean_Query</dt> <dd> -<pre><code><a href="lucy_Query.html">lucy_Query*</a> // incremented -<strong>LUCY_Searcher_Glean_Query</strong>( - lucy_Searcher* <strong>self</strong>, - <a href="cfish_Obj.html">cfish_Obj*</a> <strong>query</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_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="cfish_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>Hits</dt> +<dt id="func_Hits">Hits</dt> <dd> -<pre><code><a href="lucy_Hits.html">lucy_Hits*</a> // incremented -<strong>LUCY_Searcher_Hits</strong>( - lucy_Searcher* <strong>self</strong>, - <a href="cfish_Obj.html">cfish_Obj*</a> <strong>query</strong>, +<pre><code><span class="prefix">lucy_</span><a href="lucy_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="cfish_Obj.html">Obj*</a> <strong>query</strong>, uint32_t <strong>offset</strong>, uint32_t <strong>num_wanted</strong>, - <a href="lucy_SortSpec.html">lucy_SortSpec*</a> <strong>sort_spec</strong> + <span class="prefix">lucy_</span><a href="lucy_SortSpec.html">SortSpec*</a> <strong>sort_spec</strong> ); </code></pre> <p>Return a Hits object containing the top results.</p> <dl> -<dt><emph>query</emph></dt> +<dt>query</dt> <dd><p>Either a Query object or a query string.</p> </dd> -<dt><emph>offset</emph></dt> +<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><emph>num_wanted</emph></dt> +<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><emph>sort_spec</emph></dt> +<dt>sort_spec</dt> <dd><p>A <a href="lucy_SortSpec.html">SortSpec</a>, which will affect how results are ranked and returned.</p> </dd> </dl> </dd> -<dt>Collect</dt> +<dt id="func_Collect">Collect <span class="comment">(abstract)</span></dt> <dd> <pre><code>void -<strong>LUCY_Searcher_Collect</strong>( - lucy_Searcher* <strong>self</strong>, - <a href="lucy_Query.html">lucy_Query*</a> <strong>query</strong>, - <a href="lucy_Collector.html">lucy_Collector*</a> <strong>collector</strong> +<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_Query.html">Query*</a> <strong>query</strong>, + <span class="prefix">lucy_</span><a href="lucy_Collector.html">Collector*</a> <strong>collector</strong> ); </code></pre> <p>Iterate over hits, feeding them into a <a href="lucy_Collector.html">Collector</a>.</p> <dl> -<dt><emph>query</emph></dt> +<dt>query</dt> <dd><p>A Query.</p> </dd> -<dt><emph>collector</emph></dt> +<dt>collector</dt> <dd><p>A Collector.</p> </dd> </dl> </dd> -<dt>Fetch_Doc</dt> +<dt id="func_Fetch_Doc">Fetch_Doc <span class="comment">(abstract)</span></dt> <dd> -<pre><code><a href="lucy_HitDoc.html">lucy_HitDoc*</a> // incremented -<strong>LUCY_Searcher_Fetch_Doc</strong>( - lucy_Searcher* <strong>self</strong>, +<pre><code><span class="prefix">lucy_</span><a href="lucy_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><emph>doc_id</emph></dt> +<dt>doc_id</dt> <dd><p>A document id.</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_Searcher_Get_Schema</strong>( - lucy_Searcher* <strong>self</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_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> Modified: lucy/site/trunk/content/docs/c/lucy_Indexer.html URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/c/lucy_Indexer.html?rev=1642966&r1=1642965&r2=1642966&view=diff ============================================================================== --- lucy/site/trunk/content/docs/c/lucy_Indexer.html (original) +++ lucy/site/trunk/content/docs/c/lucy_Indexer.html Tue Dec 2 17:54:02 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::Indexer â 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::Indexer</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::Indexer</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>Indexer</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_INDEXER</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_Indexer</code></td> +</tr> +</table> <h2>Name</h2> -<p>Lucy::Index::Indexer - Build inverted indexes.</p> +<p>Lucy::Index::Indexer â Build inverted indexes.</p> <h2>Description</h2> <p>The Indexer class is Apache Lucy's primary tool for managing the content of inverted indexes, which may later be searched using @@ -37,205 +103,205 @@ identify itself by supplying an <a href="lucy_IndexManager.html">IndexManager</a> with a unique <code>host</code> id to Indexer's constructor or index corruption will occur. See L<Lucy::Docs::FileLocking> for a detailed discussion.</p> -<p>Note: at present, Delete_By_Term() and Delete_By_Query() only affect +<p>Note: at present, <a href="lucy_Indexer.html#func_Delete_By_Term">Delete_By_Term()</a> and <a href="lucy_Indexer.html#func_Delete_By_Query">Delete_By_Query()</a> only affect documents which had been previously committed to the index -- and not any documents added this indexing session but not yet committed. This may change in a future update.</p> <h2>Functions</h2> <dl> -<dt>new</dt> +<dt id="func_new">new</dt> <dd> -<pre><code>lucy_Indexer* // incremented -<strong>lucy_Indexer_new</strong>( - <a href="lucy_Schema.html">lucy_Schema*</a> <strong>schema</strong>, - <a href="cfish_Obj.html">cfish_Obj*</a> <strong>index</strong>, - <a href="lucy_IndexManager.html">lucy_IndexManager*</a> <strong>manager</strong>, +<pre><code><span class="prefix">lucy_</span>Indexer* <span class="comment">// incremented</span> +<span class="prefix">lucy_</span><strong>Indexer_new</strong>( + <span class="prefix">lucy_</span><a href="lucy_Schema.html">Schema*</a> <strong>schema</strong>, + <span class="prefix">cfish_</span><a href="cfish_Obj.html">Obj*</a> <strong>index</strong>, + <span class="prefix">lucy_</span><a href="lucy_IndexManager.html">IndexManager*</a> <strong>manager</strong>, int32_t <strong>flags</strong> ); </code></pre> </dd> -<dt>init</dt> +<dt id="func_init">init</dt> <dd> -<pre><code>lucy_Indexer* -<strong>lucy_Indexer_init</strong>( - lucy_Indexer* <strong>self</strong>, - <a href="lucy_Schema.html">lucy_Schema*</a> <strong>schema</strong>, - <a href="cfish_Obj.html">cfish_Obj*</a> <strong>index</strong>, - <a href="lucy_IndexManager.html">lucy_IndexManager*</a> <strong>manager</strong>, +<pre><code><span class="prefix">lucy_</span>Indexer* +<span class="prefix">lucy_</span><strong>Indexer_init</strong>( + <span class="prefix">lucy_</span>Indexer* <strong>self</strong>, + <span class="prefix">lucy_</span><a href="lucy_Schema.html">Schema*</a> <strong>schema</strong>, + <span class="prefix">cfish_</span><a href="cfish_Obj.html">Obj*</a> <strong>index</strong>, + <span class="prefix">lucy_</span><a href="lucy_IndexManager.html">IndexManager*</a> <strong>manager</strong>, int32_t <strong>flags</strong> ); </code></pre> <p>Open a new Indexer. If the index already exists, update it.</p> <dl> -<dt><emph>schema</emph></dt> +<dt>schema</dt> <dd><p>A Schema.</p> </dd> -<dt><emph>index</emph></dt> +<dt>index</dt> <dd><p>Either a string filepath or a Folder.</p> </dd> -<dt><emph>manager</emph></dt> +<dt>manager</dt> <dd><p>An IndexManager.</p> </dd> -<dt><emph>flags</emph></dt> +<dt>flags</dt> <dd><p>Flags governing behavior.</p> </dd> </dl> </dd> </dl> <h2>Methods</h2> -<h3>Novel methods</h3> +<h3>Novel methods</h3 <dl> -<dt>Add_Doc</dt> +<dt id="func_Add_Doc">Add_Doc</dt> <dd> <pre><code>void -<strong>LUCY_Indexer_Add_Doc</strong>( - lucy_Indexer* <strong>self</strong>, - <a href="lucy_Doc.html">lucy_Doc*</a> <strong>doc</strong>, +<span class="prefix">LUCY_</span><strong>Indexer_Add_Doc</strong>( + <span class="prefix">lucy_</span>Indexer* <strong>self</strong>, + <span class="prefix">lucy_</span><a href="lucy_Doc.html">Doc*</a> <strong>doc</strong>, float <strong>boost</strong> ); </code></pre> <p>Add a document to the index.</p> <dl> -<dt><emph>doc</emph></dt> +<dt>doc</dt> <dd><p>A Lucy::Document::Doc object.</p> </dd> -<dt><emph>boost</emph></dt> +<dt>boost</dt> <dd><p>A floating point weight which affects how this document scores.</p> </dd> </dl> </dd> -<dt>Add_Index</dt> +<dt id="func_Add_Index">Add_Index</dt> <dd> <pre><code>void -<strong>LUCY_Indexer_Add_Index</strong>( - lucy_Indexer* <strong>self</strong>, - <a href="cfish_Obj.html">cfish_Obj*</a> <strong>index</strong> +<span class="prefix">LUCY_</span><strong>Indexer_Add_Index</strong>( + <span class="prefix">lucy_</span>Indexer* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_Obj.html">Obj*</a> <strong>index</strong> ); </code></pre> <p>Absorb an existing index into this one. The two indexes must have matching Schemas.</p> <dl> -<dt><emph>index</emph></dt> +<dt>index</dt> <dd><p>Either an index path name or a Folder.</p> </dd> </dl> </dd> -<dt>Delete_By_Term</dt> +<dt id="func_Delete_By_Term">Delete_By_Term</dt> <dd> <pre><code>void -<strong>LUCY_Indexer_Delete_By_Term</strong>( - lucy_Indexer* <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>Indexer_Delete_By_Term</strong>( + <span class="prefix">lucy_</span>Indexer* <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>Mark documents which contain the supplied term as deleted, so that they will be excluded from search results and eventually removed altogether. The change is not apparent to search apps until after -Commit() succeeds.</p> +<a href="lucy_Indexer.html#func_Commit">Commit()</a> succeeds.</p> <dl> -<dt><emph>field</emph></dt> +<dt>field</dt> <dd><p>The name of an indexed field. (If it is not spec'd as <code>indexed</code>, an error will occur.)</p> </dd> -<dt><emph>term</emph></dt> +<dt>term</dt> <dd><p>The term which identifies docs to be marked as deleted. If <code>field</code> is associated with an Analyzer, <code>term</code> will be processed automatically (so don't pre-process it yourself).</p> </dd> </dl> </dd> -<dt>Delete_By_Query</dt> +<dt id="func_Delete_By_Query">Delete_By_Query</dt> <dd> <pre><code>void -<strong>LUCY_Indexer_Delete_By_Query</strong>( - lucy_Indexer* <strong>self</strong>, - <a href="lucy_Query.html">lucy_Query*</a> <strong>query</strong> +<span class="prefix">LUCY_</span><strong>Indexer_Delete_By_Query</strong>( + <span class="prefix">lucy_</span>Indexer* <strong>self</strong>, + <span class="prefix">lucy_</span><a href="lucy_Query.html">Query*</a> <strong>query</strong> ); </code></pre> <p>Mark documents which match the supplied Query as deleted.</p> <dl> -<dt><emph>query</emph></dt> +<dt>query</dt> <dd><p>A <a href="lucy_Query.html">Query</a>.</p> </dd> </dl> </dd> -<dt>Delete_By_Doc_ID</dt> +<dt id="func_Delete_By_Doc_ID">Delete_By_Doc_ID</dt> <dd> <pre><code>void -<strong>LUCY_Indexer_Delete_By_Doc_ID</strong>( - lucy_Indexer* <strong>self</strong>, +<span class="prefix">LUCY_</span><strong>Indexer_Delete_By_Doc_ID</strong>( + <span class="prefix">lucy_</span>Indexer* <strong>self</strong>, int32_t <strong>doc_id</strong> ); </code></pre> <p>Mark the document identified by the supplied document ID as deleted.</p> <dl> -<dt><emph>doc_id</emph></dt> +<dt>doc_id</dt> <dd><p>A L<document id|Lucy::Docs::DocIDs>.</p> </dd> </dl> </dd> -<dt>Optimize</dt> +<dt id="func_Optimize">Optimize</dt> <dd> <pre><code>void -<strong>LUCY_Indexer_Optimize</strong>( - lucy_Indexer* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>Indexer_Optimize</strong>( + <span class="prefix">lucy_</span>Indexer* <strong>self</strong> ); </code></pre> <p>Optimize the index for search-time performance. This may take a while, as it can involve rewriting large amounts of data.</p> <p>Every Indexer session which changes index content and ends in a -Commit() creates a new segment. Once written, segments are never +<a href="lucy_Indexer.html#func_Commit">Commit()</a> creates a new segment. Once written, segments are never modified. However, they are periodically recycled by feeding their content into the segment currently being written.</p> -<p>The Optimize() method causes all existing index content to be fed back -into the Indexer. When Commit() completes after an Optimize(), the -index will consist of one segment. So Optimize() must be called -before Commit(). Also, optimizing a fresh index created from scratch +<p>The <a href="lucy_Indexer.html#func_Optimize">Optimize()</a> method causes all existing index content to be fed back +into the Indexer. When <a href="lucy_Indexer.html#func_Commit">Commit()</a> completes after an <a href="lucy_Indexer.html#func_Optimize">Optimize()</a>, the +index will consist of one segment. So <a href="lucy_Indexer.html#func_Optimize">Optimize()</a> must be called +before <a href="lucy_Indexer.html#func_Commit">Commit()</a>. Also, optimizing a fresh index created from scratch has no effect.</p> <p>Historically, there was a significant search-time performance benefit to collapsing down to a single segment versus even two segments. Now the effect of collapsing is much less significant, and calling -Optimize() is rarely justified.</p> +<a href="lucy_Indexer.html#func_Optimize">Optimize()</a> is rarely justified.</p> </dd> -<dt>Commit</dt> +<dt id="func_Commit">Commit</dt> <dd> <pre><code>void -<strong>LUCY_Indexer_Commit</strong>( - lucy_Indexer* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>Indexer_Commit</strong>( + <span class="prefix">lucy_</span>Indexer* <strong>self</strong> ); </code></pre> <p>Commit any changes made to the index. Until this is called, none of the changes made during an indexing session are permanent.</p> -<p>Calling Commit() invalidates the Indexer, so if you want to make more +<p>Calling <a href="lucy_Indexer.html#func_Commit">Commit()</a> invalidates the Indexer, so if you want to make more changes you'll need a new one.</p> </dd> -<dt>Prepare_Commit</dt> +<dt id="func_Prepare_Commit">Prepare_Commit</dt> <dd> <pre><code>void -<strong>LUCY_Indexer_Prepare_Commit</strong>( - lucy_Indexer* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>Indexer_Prepare_Commit</strong>( + <span class="prefix">lucy_</span>Indexer* <strong>self</strong> ); </code></pre> -<p>Perform the expensive setup for Commit() in advance, so that Commit() -completes quickly. (If Prepare_Commit() is not called explicitly by -the user, Commit() will call it internally.)</p> +<p>Perform the expensive setup for <a href="lucy_Indexer.html#func_Commit">Commit()</a> in advance, so that <a href="lucy_Indexer.html#func_Commit">Commit()</a> +completes quickly. (If <a href="lucy_Indexer.html#func_Prepare_Commit">Prepare_Commit()</a> is not called explicitly by +the user, <a href="lucy_Indexer.html#func_Commit">Commit()</a> will call it internally.)</p> </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_Indexer_Get_Schema</strong>( - lucy_Indexer* <strong>self</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_Schema.html">Schema*</a> +<span class="prefix">LUCY_</span><strong>Indexer_Get_Schema</strong>( + <span class="prefix">lucy_</span>Indexer* <strong>self</strong> ); </code></pre> <p>Accessor for schema.</p> </dd> -<dt>Get_Seg_Writer</dt> +<dt id="func_Get_Seg_Writer">Get_Seg_Writer</dt> <dd> -<pre><code><a href="lucy_SegWriter.html">lucy_SegWriter*</a> -<strong>LUCY_Indexer_Get_Seg_Writer</strong>( - lucy_Indexer* <strong>self</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_SegWriter.html">SegWriter*</a> +<span class="prefix">LUCY_</span><strong>Indexer_Get_Seg_Writer</strong>( + <span class="prefix">lucy_</span>Indexer* <strong>self</strong> ); </code></pre> <p>Accessor for seg_writer member var.</p>
