Modified: lucy/site/trunk/content/docs/c/lucy_PostingListReader.html URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/c/lucy_PostingListReader.html?rev=1642966&r1=1642965&r2=1642966&view=diff ============================================================================== --- lucy/site/trunk/content/docs/c/lucy_PostingListReader.html (original) +++ lucy/site/trunk/content/docs/c/lucy_PostingListReader.html Tue Dec 2 17:54:02 2014 @@ -1,139 +1,206 @@ <!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::PostingListReader â 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::PostingListReader</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::PostingListReader</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>PListReader</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_POSTINGLISTREADER</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_PostingListReader</code></td> +</tr> +</table> <h2>Name</h2> -<p>Lucy::Index::PostingListReader - Read postings data.</p> +<p>Lucy::Index::PostingListReader â Read postings data.</p> <h2>Description</h2> <p>PostingListReaders produce <a href="lucy_PostingList.html">PostingList</a> objects which convey document matching information.</p> <h2>Methods</h2> -<h3>Abstract methods</h3> +<h3>Novel methods</h3 <dl> -<dt>Posting_List</dt> +<dt id="func_Posting_List">Posting_List <span class="comment">(abstract)</span></dt> <dd> -<pre><code><a href="lucy_PostingList.html">lucy_PostingList*</a> // incremented -<strong>LUCY_PListReader_Posting_List</strong>( - lucy_PostingListReader* <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_PostingList.html">PostingList*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>PListReader_Posting_List</strong>( + <span class="prefix">lucy_</span>PostingListReader* <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>Returns a PostingList, or NULL if either <code>field</code> is NULL or <code>field</code> is not present in any documents.</p> <dl> -<dt><emph>field</emph></dt> +<dt>field</dt> <dd><p>A field name.</p> </dd> -<dt><emph>term</emph></dt> +<dt>term</dt> <dd><p>If supplied, the PostingList will be pre-located to this -term using Seek().</p> +term using <a href="lucy_PostingList.html#func_Seek">Seek()</a>.</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_ProximityQuery.html URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/c/lucy_ProximityQuery.html?rev=1642966&r1=1642965&r2=1642966&view=diff ============================================================================== --- lucy/site/trunk/content/docs/c/lucy_ProximityQuery.html (original) +++ lucy/site/trunk/content/docs/c/lucy_ProximityQuery.html Tue Dec 2 17:54:02 2014 @@ -1,165 +1,232 @@ <!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>LucyX::Search::ProximityQuery â 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>LucyX::Search::ProximityQuery</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>LucyX::Search::ProximityQuery</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>ProximityQuery</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_PROXIMITYQUERY</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_ProximityQuery</code></td> +</tr> +</table> <h2>Name</h2> -<p>LucyX::Search::ProximityQuery - Query matching an ordered list of terms.</p> +<p>LucyX::Search::ProximityQuery â Query matching an ordered list of terms.</p> <h2>Description</h2> <p>ProximityQuery is a subclass of <a href="lucy_Query.html">Query</a> for matching against an ordered sequence of terms.</p> <h2>Functions</h2> <dl> -<dt>init</dt> +<dt id="func_init">init</dt> <dd> -<pre><code>lucy_ProximityQuery* -<strong>lucy_ProximityQuery_init</strong>( - lucy_ProximityQuery* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>field</strong>, - <a href="cfish_VArray.html">cfish_VArray*</a> <strong>terms</strong>, +<pre><code><span class="prefix">lucy_</span>ProximityQuery* +<span class="prefix">lucy_</span><strong>ProximityQuery_init</strong>( + <span class="prefix">lucy_</span>ProximityQuery* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>field</strong>, + <span class="prefix">cfish_</span><a href="cfish_VArray.html">VArray*</a> <strong>terms</strong>, uint32_t <strong>within</strong> ); </code></pre> <dl> -<dt><emph>field</emph></dt> +<dt>field</dt> <dd><p>The field that the phrase must occur in.</p> </dd> -<dt><emph>terms</emph></dt> +<dt>terms</dt> <dd><p>The ordered array of terms that must match.</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_ProximityQuery_Get_Field</strong>( - lucy_ProximityQuery* <strong>self</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> +<span class="prefix">LUCY_</span><strong>ProximityQuery_Get_Field</strong>( + <span class="prefix">lucy_</span>ProximityQuery* <strong>self</strong> ); </code></pre> <p>Accessor for object's field attribute.</p> </dd> -<dt>Get_Terms</dt> +<dt id="func_Get_Terms">Get_Terms</dt> <dd> -<pre><code><a href="cfish_VArray.html">cfish_VArray*</a> -<strong>LUCY_ProximityQuery_Get_Terms</strong>( - lucy_ProximityQuery* <strong>self</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_VArray.html">VArray*</a> +<span class="prefix">LUCY_</span><strong>ProximityQuery_Get_Terms</strong>( + <span class="prefix">lucy_</span>ProximityQuery* <strong>self</strong> ); </code></pre> <p>Accessor for object's array of terms.</p> </dd> -<dt>Get_Within</dt> +<dt id="func_Get_Within">Get_Within</dt> <dd> <pre><code>uint32_t -<strong>LUCY_ProximityQuery_Get_Within</strong>( - lucy_ProximityQuery* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>ProximityQuery_Get_Within</strong>( + <span class="prefix">lucy_</span>ProximityQuery* <strong>self</strong> ); </code></pre> <p>Accessor for object's within attribute.</p> </dd> </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: lucy/site/trunk/content/docs/c/lucy_Query.html URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/c/lucy_Query.html?rev=1642966&r1=1642965&r2=1642966&view=diff ============================================================================== --- lucy/site/trunk/content/docs/c/lucy_Query.html (original) +++ lucy/site/trunk/content/docs/c/lucy_Query.html Tue Dec 2 17:54:02 2014 @@ -1,57 +1,123 @@ <!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::Query â 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::Query</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::Query</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>Query</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_QUERY</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_Query</code></td> +</tr> +</table> <h2>Name</h2> -<p>Lucy::Search::Query - A specification for a search query.</p> +<p>Lucy::Search::Query â A specification for a search query.</p> <h2>Description</h2> <p>Query objects are simple containers which contain the minimum information necessary to define a search query.</p> <p>The most common way to generate Query objects is to feed a search string such as 'foo AND bar' to a <a href="lucy_QueryParser.html">QueryParser's</a> -Parse() method, which outputs an abstract syntax tree built up from various +<a href="lucy_QueryParser.html#func_Parse">Parse()</a> method, which outputs an abstract syntax tree built up from various Query subclasses such as <a href="lucy_ANDQuery.html">ANDQuery</a> and <a href="lucy_TermQuery.html">TermQuery</a>. However, it is also possible to use custom Query objects to build a search specification which cannot be easily represented using a search string.</p> -<p>Subclasses of Query must implement Make_Compiler(), which is the first step +<p>Subclasses of Query must implement <a href="lucy_Query.html#func_Make_Compiler">Make_Compiler()</a>, which is the first step in compiling a Query down to a <a href="lucy_Matcher.html">Matcher</a> which can actually match and score documents.</p> <h2>Functions</h2> <dl> -<dt>init</dt> +<dt id="func_init">init</dt> <dd> -<pre><code>lucy_Query* -<strong>lucy_Query_init</strong>( - lucy_Query* <strong>self</strong>, +<pre><code><span class="prefix">lucy_</span>Query* +<span class="prefix">lucy_</span><strong>Query_init</strong>( + <span class="prefix">lucy_</span>Query* <strong>self</strong>, float <strong>boost</strong> ); </code></pre> <p>Abstract constructor.</p> <dl> -<dt><emph>boost</emph></dt> +<dt>boost</dt> <dd><p>A scoring multiplier, affecting the Query's relative contribution to each document's score. Typically defaults to 1.0, but subclasses which do not contribute to document scores such as NOTQuery @@ -61,88 +127,85 @@ and MatchAllQuery default to 0.0 instead </dd> </dl> <h2>Methods</h2> -<h3>Abstract methods</h3> +<h3>Novel methods</h3 <dl> -<dt>Make_Compiler</dt> +<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> -</dl> -<h3>Novel methods</h3> -<dl> -<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: lucy/site/trunk/content/docs/c/lucy_QueryParser.html URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/c/lucy_QueryParser.html?rev=1642966&r1=1642965&r2=1642966&view=diff ============================================================================== --- lucy/site/trunk/content/docs/c/lucy_QueryParser.html (original) +++ lucy/site/trunk/content/docs/c/lucy_QueryParser.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::QueryParser â 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::QueryParser</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::QueryParser</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>QParser</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_QUERYPARSER</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_QueryParser</code></td> +</tr> +</table> <h2>Name</h2> -<p>Lucy::Search::QueryParser - Transform a string into a Query object.</p> +<p>Lucy::Search::QueryParser â Transform a string into a Query object.</p> <h2>Description</h2> <p>QueryParser accepts search strings as input and produces <a href="lucy_Query.html">Query</a> objects, suitable for feeding into @@ -40,7 +106,7 @@ phrase, or a parenthetical group.</li> <li>Logical groups, delimited by parentheses.</li> <li>Phrases, delimited by double quotes.</li> </ul> -<p>Additionally, the following syntax can be enabled via Set_Heed_Colons():</p> +<p>Additionally, the following syntax can be enabled via <a href="lucy_QueryParser.html#func_Set_Heed_Colons">Set_Heed_Colons()</a>:</p> <ul> <li>Field-specific constructs, in the form of 'fieldname:termtext' or 'fieldname:(foo bar)'. (The field specified by 'fieldname:' will be @@ -48,35 +114,35 @@ used instead of the QueryParser's defaul </ul> <h2>Functions</h2> <dl> -<dt>init</dt> +<dt id="func_init">init</dt> <dd> -<pre><code>lucy_QueryParser* -<strong>lucy_QParser_init</strong>( - lucy_QueryParser* <strong>self</strong>, - <a href="lucy_Schema.html">lucy_Schema*</a> <strong>schema</strong>, - <a href="lucy_Analyzer.html">lucy_Analyzer*</a> <strong>analyzer</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>default_boolop</strong>, - <a href="cfish_VArray.html">cfish_VArray*</a> <strong>fields</strong> +<pre><code><span class="prefix">lucy_</span>QueryParser* +<span class="prefix">lucy_</span><strong>QParser_init</strong>( + <span class="prefix">lucy_</span>QueryParser* <strong>self</strong>, + <span class="prefix">lucy_</span><a href="lucy_Schema.html">Schema*</a> <strong>schema</strong>, + <span class="prefix">lucy_</span><a href="lucy_Analyzer.html">Analyzer*</a> <strong>analyzer</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>default_boolop</strong>, + <span class="prefix">cfish_</span><a href="cfish_VArray.html">VArray*</a> <strong>fields</strong> ); </code></pre> <p>Constructor.</p> <dl> -<dt><emph>schema</emph></dt> +<dt>schema</dt> <dd><p>A <a href="lucy_Schema.html">Schema</a>.</p> </dd> -<dt><emph>analyzer</emph></dt> +<dt>analyzer</dt> <dd><p>An <a href="lucy_Analyzer.html">Analyzer</a>. Ordinarily, the analyzers specified by each field's definition will be used, but if <code>analyzer</code> is supplied, it will override and be used for all fields. This can lead to mismatches between what is in the index and what is being searched for, so use caution.</p> </dd> -<dt><emph>fields</emph></dt> +<dt>fields</dt> <dd><p>The names of the fields which will be searched against. Defaults to those fields which are defined as indexed in the supplied Schema.</p> </dd> -<dt><emph>default_boolop</emph></dt> +<dt>default_boolop</dt> <dd><p>Two possible values: 'AND' and 'OR'. The default is 'OR', which means: return documents which match any of the query terms. If you want only documents which match all of the query terms, @@ -86,31 +152,31 @@ set this to 'AND'.</p> </dd> </dl> <h2>Methods</h2> -<h3>Novel methods</h3> +<h3>Novel methods</h3 <dl> -<dt>Parse</dt> +<dt id="func_Parse">Parse</dt> <dd> -<pre><code><a href="lucy_Query.html">lucy_Query*</a> // incremented -<strong>LUCY_QParser_Parse</strong>( - lucy_QueryParser* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>query_string</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>QParser_Parse</strong>( + <span class="prefix">lucy_</span>QueryParser* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>query_string</strong> ); </code></pre> <p>Build a Query object from the contents of a query string. At present, -implemented internally by calling Tree(), Expand(), and Prune().</p> +implemented internally by calling <a href="lucy_QueryParser.html#func_Tree">Tree()</a>, <a href="lucy_QueryParser.html#func_Expand">Expand()</a>, and <a href="lucy_QueryParser.html#func_Prune">Prune()</a>.</p> <dl> -<dt><emph>query_string</emph></dt> +<dt>query_string</dt> <dd><p>The string to be parsed. May be NULL.</p> </dd> </dl> <p><strong>Returns:</strong> a Query.</p> </dd> -<dt>Tree</dt> +<dt id="func_Tree">Tree</dt> <dd> -<pre><code><a href="lucy_Query.html">lucy_Query*</a> // incremented -<strong>LUCY_QParser_Tree</strong>( - lucy_QueryParser* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>query_string</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>QParser_Tree</strong>( + <span class="prefix">lucy_</span>QueryParser* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>query_string</strong> ); </code></pre> <p>Parse the logical structure of a query string, building a tree @@ -118,39 +184,39 @@ comprised of Query objects. Leaf nodes LeafQuery objects but might be MatchAllQuery or NoMatchQuery objects as well. Internal nodes will be objects which subclass PolyQuery: ANDQuery, ORQuery, NOTQuery, and RequiredOptionalQuery.</p> -<p>The output of Tree() is an intermediate form which must be passed -through Expand() before being used to feed a search.</p> +<p>The output of <a href="lucy_QueryParser.html#func_Tree">Tree()</a> is an intermediate form which must be passed +through <a href="lucy_QueryParser.html#func_Expand">Expand()</a> before being used to feed a search.</p> <dl> -<dt><emph>query_string</emph></dt> +<dt>query_string</dt> <dd><p>The string to be parsed.</p> </dd> </dl> <p><strong>Returns:</strong> a Query.</p> </dd> -<dt>Expand</dt> +<dt id="func_Expand">Expand</dt> <dd> -<pre><code><a href="lucy_Query.html">lucy_Query*</a> // incremented -<strong>LUCY_QParser_Expand</strong>( - lucy_QueryParser* <strong>self</strong>, - <a href="lucy_Query.html">lucy_Query*</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>QParser_Expand</strong>( + <span class="prefix">lucy_</span>QueryParser* <strong>self</strong>, + <span class="prefix">lucy_</span><a href="lucy_Query.html">Query*</a> <strong>query</strong> ); </code></pre> <p>Walk the hierarchy of a Query tree, descending through all PolyQuery -nodes and calling Expand_Leaf() on any LeafQuery nodes encountered.</p> +nodes and calling <a href="lucy_QueryParser.html#func_Expand_Leaf">Expand_Leaf()</a> on any LeafQuery nodes encountered.</p> <dl> -<dt><emph>query</emph></dt> +<dt>query</dt> <dd><p>A Query object.</p> </dd> </dl> <p><strong>Returns:</strong> A Query -- usually the same one that was supplied after in-place modification, but possibly another.</p> </dd> -<dt>Expand_Leaf</dt> +<dt id="func_Expand_Leaf">Expand_Leaf</dt> <dd> -<pre><code><a href="lucy_Query.html">lucy_Query*</a> // incremented -<strong>LUCY_QParser_Expand_Leaf</strong>( - lucy_QueryParser* <strong>self</strong>, - <a href="lucy_Query.html">lucy_Query*</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>QParser_Expand_Leaf</strong>( + <span class="prefix">lucy_</span>QueryParser* <strong>self</strong>, + <span class="prefix">lucy_</span><a href="lucy_Query.html">Query*</a> <strong>query</strong> ); </code></pre> <p>Convert a LeafQuery into either a TermQuery, a PhraseQuery, or an @@ -160,158 +226,158 @@ Analyzer for each field. Quoted text wi PhraseQuery objects. Unquoted text will be converted to either a TermQuery or a PhraseQuery depending on how many tokens are generated.</p> <dl> -<dt><emph>query</emph></dt> +<dt>query</dt> <dd><p>A Query. Only LeafQuery objects will be processed; others will be passed through.</p> </dd> </dl> <p><strong>Returns:</strong> A Query.</p> </dd> -<dt>Prune</dt> +<dt id="func_Prune">Prune</dt> <dd> -<pre><code><a href="lucy_Query.html">lucy_Query*</a> // incremented -<strong>LUCY_QParser_Prune</strong>( - lucy_QueryParser* <strong>self</strong>, - <a href="lucy_Query.html">lucy_Query*</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>QParser_Prune</strong>( + <span class="prefix">lucy_</span>QueryParser* <strong>self</strong>, + <span class="prefix">lucy_</span><a href="lucy_Query.html">Query*</a> <strong>query</strong> ); </code></pre> <p>Prevent certain Query structures from returning too many results. -Query objects built via Tree() and Expand() can generate "return the +Query objects built via <a href="lucy_QueryParser.html#func_Tree">Tree()</a> and <a href="lucy_QueryParser.html#func_Expand">Expand()</a> can generate "return the world" result sets, such as in the case of -<code>NOT a_term_not_in_the_index</code>; Prune() walks the hierarchy +<code>NOT a_term_not_in_the_index</code>; <a href="lucy_QueryParser.html#func_Prune">Prune()</a> walks the hierarchy and eliminates such branches.</p> <pre><code> 'NOT foo' => [NOMATCH] 'foo OR NOT bar' => 'foo' 'foo OR (-bar AND -baz) => 'foo' </code></pre> -<p>Prune() also eliminates some double-negative constructs -- even though +<p><a href="lucy_QueryParser.html#func_Prune">Prune()</a> also eliminates some double-negative constructs -- even though such constructs may not actually return the world:</p> <pre><code> 'foo AND -(-bar)' => 'foo' </code></pre> <p>In this example, safety is taking precedence over logical consistency. -If you want logical consistency instead, call Tree() then Expand(), -skipping Prune().</p> +If you want logical consistency instead, call <a href="lucy_QueryParser.html#func_Tree">Tree()</a> then <a href="lucy_QueryParser.html#func_Expand">Expand()</a>, +skipping <a href="lucy_QueryParser.html#func_Prune">Prune()</a>.</p> <dl> -<dt><emph>query</emph></dt> +<dt>query</dt> <dd><p>A Query.</p> </dd> </dl> <p><strong>Returns:</strong> a Query; in most cases, the supplied Query after in-place modification.</p> </dd> -<dt>Make_Term_Query</dt> +<dt id="func_Make_Term_Query">Make_Term_Query</dt> <dd> -<pre><code><a href="lucy_Query.html">lucy_Query*</a> // incremented -<strong>LUCY_QParser_Make_Term_Query</strong>( - lucy_QueryParser* <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_Query.html">Query*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>QParser_Make_Term_Query</strong>( + <span class="prefix">lucy_</span>QueryParser* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="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>Factory method creating a TermQuery.</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>Term text.</p> </dd> </dl> <p><strong>Returns:</strong> A Query.</p> </dd> -<dt>Make_Phrase_Query</dt> +<dt id="func_Make_Phrase_Query">Make_Phrase_Query</dt> <dd> -<pre><code><a href="lucy_Query.html">lucy_Query*</a> // incremented -<strong>LUCY_QParser_Make_Phrase_Query</strong>( - lucy_QueryParser* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>field</strong>, - <a href="cfish_VArray.html">cfish_VArray*</a> <strong>terms</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>QParser_Make_Phrase_Query</strong>( + <span class="prefix">lucy_</span>QueryParser* <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_VArray.html">VArray*</a> <strong>terms</strong> ); </code></pre> <p>Factory method creating a PhraseQuery.</p> <dl> -<dt><emph>field</emph></dt> +<dt>field</dt> <dd><p>Field that the phrase must occur in.</p> </dd> -<dt><emph>terms</emph></dt> +<dt>terms</dt> <dd><p>Ordered array of terms that must match.</p> </dd> </dl> <p><strong>Returns:</strong> A Query.</p> </dd> -<dt>Make_OR_Query</dt> +<dt id="func_Make_OR_Query">Make_OR_Query</dt> <dd> -<pre><code><a href="lucy_Query.html">lucy_Query*</a> // incremented -<strong>LUCY_QParser_Make_OR_Query</strong>( - lucy_QueryParser* <strong>self</strong>, - <a href="cfish_VArray.html">cfish_VArray*</a> <strong>children</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>QParser_Make_OR_Query</strong>( + <span class="prefix">lucy_</span>QueryParser* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_VArray.html">VArray*</a> <strong>children</strong> ); </code></pre> <p>Factory method creating an ORQuery.</p> <dl> -<dt><emph>children</emph></dt> +<dt>children</dt> <dd><p>Array of child Queries.</p> </dd> </dl> <p><strong>Returns:</strong> A Query.</p> </dd> -<dt>Make_AND_Query</dt> +<dt id="func_Make_AND_Query">Make_AND_Query</dt> <dd> -<pre><code><a href="lucy_Query.html">lucy_Query*</a> // incremented -<strong>LUCY_QParser_Make_AND_Query</strong>( - lucy_QueryParser* <strong>self</strong>, - <a href="cfish_VArray.html">cfish_VArray*</a> <strong>children</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>QParser_Make_AND_Query</strong>( + <span class="prefix">lucy_</span>QueryParser* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_VArray.html">VArray*</a> <strong>children</strong> ); </code></pre> <p>Factory method creating an ANDQuery.</p> <dl> -<dt><emph>children</emph></dt> +<dt>children</dt> <dd><p>Array of child Queries.</p> </dd> </dl> <p><strong>Returns:</strong> A Query.</p> </dd> -<dt>Make_NOT_Query</dt> +<dt id="func_Make_NOT_Query">Make_NOT_Query</dt> <dd> -<pre><code><a href="lucy_Query.html">lucy_Query*</a> // incremented -<strong>LUCY_QParser_Make_NOT_Query</strong>( - lucy_QueryParser* <strong>self</strong>, - <a href="lucy_Query.html">lucy_Query*</a> <strong>negated_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>QParser_Make_NOT_Query</strong>( + <span class="prefix">lucy_</span>QueryParser* <strong>self</strong>, + <span class="prefix">lucy_</span><a href="lucy_Query.html">Query*</a> <strong>negated_query</strong> ); </code></pre> <p>Factory method creating a NOTQuery.</p> <dl> -<dt><emph>negated_query</emph></dt> +<dt>negated_query</dt> <dd><p>Query to be inverted.</p> </dd> </dl> <p><strong>Returns:</strong> A Query.</p> </dd> -<dt>Make_Req_Opt_Query</dt> +<dt id="func_Make_Req_Opt_Query">Make_Req_Opt_Query</dt> <dd> -<pre><code><a href="lucy_Query.html">lucy_Query*</a> // incremented -<strong>LUCY_QParser_Make_Req_Opt_Query</strong>( - lucy_QueryParser* <strong>self</strong>, - <a href="lucy_Query.html">lucy_Query*</a> <strong>required_query</strong>, - <a href="lucy_Query.html">lucy_Query*</a> <strong>optional_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>QParser_Make_Req_Opt_Query</strong>( + <span class="prefix">lucy_</span>QueryParser* <strong>self</strong>, + <span class="prefix">lucy_</span><a href="lucy_Query.html">Query*</a> <strong>required_query</strong>, + <span class="prefix">lucy_</span><a href="lucy_Query.html">Query*</a> <strong>optional_query</strong> ); </code></pre> <p>Factory method creating a RequiredOptionalQuery.</p> <dl> -<dt><emph>required_query</emph></dt> +<dt>required_query</dt> <dd><p>Query must must match.</p> </dd> -<dt><emph>optional_query</emph></dt> +<dt>optional_query</dt> <dd><p>Query which should match.</p> </dd> </dl> <p><strong>Returns:</strong> A Query.</p> </dd> -<dt>Set_Heed_Colons</dt> +<dt id="func_Set_Heed_Colons">Set_Heed_Colons</dt> <dd> <pre><code>void -<strong>LUCY_QParser_Set_Heed_Colons</strong>( - lucy_QueryParser* <strong>self</strong>, +<span class="prefix">LUCY_</span><strong>QParser_Set_Heed_Colons</strong>( + <span class="prefix">lucy_</span>QueryParser* <strong>self</strong>, bool <strong>heed_colons</strong> ); </code></pre> Modified: lucy/site/trunk/content/docs/c/lucy_RAMFolder.html URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/c/lucy_RAMFolder.html?rev=1642966&r1=1642965&r2=1642966&view=diff ============================================================================== --- lucy/site/trunk/content/docs/c/lucy_RAMFolder.html (original) +++ lucy/site/trunk/content/docs/c/lucy_RAMFolder.html Tue Dec 2 17:54:02 2014 @@ -1,274 +1,341 @@ <!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::RAMFolder â 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::RAMFolder</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::RAMFolder</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>RAMFolder</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_RAMFOLDER</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_RAMFolder</code></td> +</tr> +</table> <h2>Name</h2> -<p>Lucy::Store::RAMFolder - In-memory Folder implementation.</p> +<p>Lucy::Store::RAMFolder â In-memory Folder implementation.</p> <h2>Description</h2> <p>RAMFolder is an entirely in-memory implementation of <a href="lucy_Folder.html">Folder</a>, primarily used for testing and development.</p> <h2>Functions</h2> <dl> -<dt>init</dt> +<dt id="func_init">init</dt> <dd> -<pre><code>lucy_RAMFolder* -<strong>lucy_RAMFolder_init</strong>( - lucy_RAMFolder* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>path</strong> +<pre><code><span class="prefix">lucy_</span>RAMFolder* +<span class="prefix">lucy_</span><strong>RAMFolder_init</strong>( + <span class="prefix">lucy_</span>RAMFolder* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>path</strong> ); </code></pre> <dl> -<dt><emph>path</emph></dt> +<dt>path</dt> <dd><p>Relative path, used for subfolders.</p> </dd> </dl> </dd> </dl> <h2>Methods</h2> -<h3>Methods inherited from Lucy::Store::Folder</h3><dl> -<dt>Get_Path</dt> +<h3>Methods inherited from Lucy::Store::Folder</h3> +<dl> +<dt id="func_Get_Path">Get_Path</dt> <dd> -<pre><code><a href="cfish_String.html">cfish_String*</a> -<strong>LUCY_Folder_Get_Path</strong>( - lucy_Folder* <strong>self</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> +<span class="prefix">LUCY_</span><strong>Folder_Get_Path</strong>( + <span class="prefix">lucy_</span>Folder* <strong>self</strong> ); </code></pre> <p>Getter for <code>path</code> member var.</p> </dd> -<dt>Open_Out</dt> +<dt id="func_Open_Out">Open_Out</dt> <dd> -<pre><code><a href="lucy_OutStream.html">lucy_OutStream*</a> // incremented -<strong>LUCY_Folder_Open_Out</strong>( - lucy_Folder* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>path</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_OutStream.html">OutStream*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Folder_Open_Out</strong>( + <span class="prefix">lucy_</span>Folder* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>path</strong> ); </code></pre> <p>Open an OutStream, or set Err_error and return NULL on failure.</p> <dl> -<dt><emph>path</emph></dt> +<dt>path</dt> <dd><p>A relative filepath.</p> </dd> </dl> <p><strong>Returns:</strong> an OutStream.</p> </dd> -<dt>Open_In</dt> +<dt id="func_Open_In">Open_In</dt> <dd> -<pre><code><a href="lucy_InStream.html">lucy_InStream*</a> // incremented -<strong>LUCY_Folder_Open_In</strong>( - lucy_Folder* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>path</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_InStream.html">InStream*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Folder_Open_In</strong>( + <span class="prefix">lucy_</span>Folder* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>path</strong> ); </code></pre> <p>Open an InStream, or set Err_error and return NULL on failure.</p> <dl> -<dt><emph>path</emph></dt> +<dt>path</dt> <dd><p>A relative filepath.</p> </dd> </dl> <p><strong>Returns:</strong> an InStream.</p> </dd> -<dt>Open_FileHandle</dt> +<dt id="func_Open_FileHandle">Open_FileHandle</dt> <dd> -<pre><code><a href="lucy_FileHandle.html">lucy_FileHandle*</a> // incremented -<strong>LUCY_Folder_Open_FileHandle</strong>( - lucy_Folder* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>path</strong>, +<pre><code><span class="prefix">lucy_</span><a href="lucy_FileHandle.html">FileHandle*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Folder_Open_FileHandle</strong>( + <span class="prefix">lucy_</span>Folder* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>path</strong>, uint32_t <strong>flags</strong> ); </code></pre> <p>Open a FileHandle, or set Err_error and return NULL on failure.</p> <dl> -<dt><emph>path</emph></dt> +<dt>path</dt> <dd><p>A relative filepath.</p> </dd> -<dt><emph>flags</emph></dt> +<dt>flags</dt> <dd><p>FileHandle flags.</p> </dd> </dl> <p><strong>Returns:</strong> a FileHandle.</p> </dd> -<dt>Open_Dir</dt> +<dt id="func_Open_Dir">Open_Dir</dt> <dd> -<pre><code><a href="lucy_DirHandle.html">lucy_DirHandle*</a> // incremented -<strong>LUCY_Folder_Open_Dir</strong>( - lucy_Folder* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>path</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_DirHandle.html">DirHandle*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Folder_Open_Dir</strong>( + <span class="prefix">lucy_</span>Folder* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>path</strong> ); </code></pre> <p>Open a DirHandle or set Err_error and return NULL on failure.</p> <dl> -<dt><emph>path</emph></dt> +<dt>path</dt> <dd><p>Path to a subdirectory, relative to the Folder's path. If empty or NULL, returns a DirHandle for this Folder.</p> </dd> </dl> <p><strong>Returns:</strong> a DirHandle.</p> </dd> -<dt>MkDir</dt> +<dt id="func_MkDir">MkDir</dt> <dd> <pre><code>bool -<strong>LUCY_Folder_MkDir</strong>( - lucy_Folder* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>path</strong> +<span class="prefix">LUCY_</span><strong>Folder_MkDir</strong>( + <span class="prefix">lucy_</span>Folder* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>path</strong> ); </code></pre> <p>Create a subdirectory.</p> <dl> -<dt><emph>path</emph></dt> +<dt>path</dt> <dd><p>A relative filepath.</p> </dd> </dl> <p><strong>Returns:</strong> true on success, false on failure (sets Err_error).</p> </dd> -<dt>Exists</dt> +<dt id="func_Exists">Exists</dt> <dd> <pre><code>bool -<strong>LUCY_Folder_Exists</strong>( - lucy_Folder* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>path</strong> +<span class="prefix">LUCY_</span><strong>Folder_Exists</strong>( + <span class="prefix">lucy_</span>Folder* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>path</strong> ); </code></pre> <p>Indicate whether an entity exists at <code>path</code>.</p> <dl> -<dt><emph>path</emph></dt> +<dt>path</dt> <dd><p>A relative filepath.</p> </dd> </dl> <p><strong>Returns:</strong> true if <code>path</code> exists.</p> </dd> -<dt>Delete</dt> +<dt id="func_Delete">Delete</dt> <dd> <pre><code>bool -<strong>LUCY_Folder_Delete</strong>( - lucy_Folder* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>path</strong> +<span class="prefix">LUCY_</span><strong>Folder_Delete</strong>( + <span class="prefix">lucy_</span>Folder* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>path</strong> ); </code></pre> <p>Delete an entry from the folder.</p> <dl> -<dt><emph>path</emph></dt> +<dt>path</dt> <dd><p>A relative filepath.</p> </dd> </dl> <p><strong>Returns:</strong> true if the deletion was successful.</p> </dd> -<dt>Delete_Tree</dt> +<dt id="func_Delete_Tree">Delete_Tree</dt> <dd> <pre><code>bool -<strong>LUCY_Folder_Delete_Tree</strong>( - lucy_Folder* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>path</strong> +<span class="prefix">LUCY_</span><strong>Folder_Delete_Tree</strong>( + <span class="prefix">lucy_</span>Folder* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>path</strong> ); </code></pre> <p>Delete recursively, starting at <code>path</code></p> <dl> -<dt><emph>path</emph></dt> +<dt>path</dt> <dd><p>A relative filepath specifying a file or subdirectory.</p> </dd> </dl> <p><strong>Returns:</strong> true if the whole tree is deleted successfully, false if any part remains.</p> </dd> -<dt>Rename</dt> +<dt id="func_Rename">Rename <span class="comment">(abstract)</span></dt> <dd> <pre><code>bool -<strong>LUCY_Folder_Rename</strong>( - lucy_Folder* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>from</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>to</strong> +<span class="prefix">LUCY_</span><strong>Folder_Rename</strong>( + <span class="prefix">lucy_</span>Folder* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>from</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>to</strong> ); </code></pre> <p>Rename a file or directory, or set Err_error and return false on failure. If an entry exists at <code>to</code>, the results are undefined.</p> <dl> -<dt><emph>from</emph></dt> +<dt>from</dt> <dd><p>The filepath prior to renaming.</p> </dd> -<dt><emph>to</emph></dt> +<dt>to</dt> <dd><p>The filepath after renaming.</p> </dd> </dl> <p><strong>Returns:</strong> true on success, false on failure.</p> </dd> -<dt>Hard_Link</dt> +<dt id="func_Hard_Link">Hard_Link <span class="comment">(abstract)</span></dt> <dd> <pre><code>bool -<strong>LUCY_Folder_Hard_Link</strong>( - lucy_Folder* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>from</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>to</strong> +<span class="prefix">LUCY_</span><strong>Folder_Hard_Link</strong>( + <span class="prefix">lucy_</span>Folder* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>from</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>to</strong> ); </code></pre> <p>Create a hard link at path <code>to</code> pointing at the existing file <code>from</code>, or set Err_error and return false on failure.</p> <p><strong>Returns:</strong> true on success, false on failure.</p> </dd> -<dt>Slurp_File</dt> +<dt id="func_Slurp_File">Slurp_File</dt> <dd> -<pre><code><a href="cfish_ByteBuf.html">cfish_ByteBuf*</a> // incremented -<strong>LUCY_Folder_Slurp_File</strong>( - lucy_Folder* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>path</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_ByteBuf.html">ByteBuf*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Folder_Slurp_File</strong>( + <span class="prefix">lucy_</span>Folder* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>path</strong> ); </code></pre> <p>Read a file and return its contents.</p> <dl> -<dt><emph>path</emph></dt> +<dt>path</dt> <dd><p>A relative filepath.</p> </dd> -<dt><emph>return</emph></dt> +<dt>return</dt> <dd><p>the file's contents.</p> </dd> </dl> </dd> -<dt>Initialize</dt> +<dt id="func_Initialize">Initialize <span class="comment">(abstract)</span></dt> <dd> <pre><code>void -<strong>LUCY_Folder_Initialize</strong>( - lucy_Folder* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>Folder_Initialize</strong>( + <span class="prefix">lucy_</span>Folder* <strong>self</strong> ); </code></pre> <p>Perform implementation-specific initialization. For example: FSFolder creates its own directory.</p> </dd> -<dt>Check</dt> +<dt id="func_Check">Check <span class="comment">(abstract)</span></dt> <dd> <pre><code>bool -<strong>LUCY_Folder_Check</strong>( - lucy_Folder* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>Folder_Check</strong>( + <span class="prefix">lucy_</span>Folder* <strong>self</strong> ); </code></pre> <p>Verify that operations may be performed on this Folder.</p> <p><strong>Returns:</strong> true on success.</p> </dd> -<dt>Close</dt> +<dt id="func_Close">Close <span class="comment">(abstract)</span></dt> <dd> <pre><code>void -<strong>LUCY_Folder_Close</strong>( - lucy_Folder* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>Folder_Close</strong>( + <span class="prefix">lucy_</span>Folder* <strong>self</strong> ); </code></pre> <p>Close the folder and release implementation-specific resources.</p> Modified: lucy/site/trunk/content/docs/c/lucy_RangeQuery.html URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/c/lucy_RangeQuery.html?rev=1642966&r1=1642965&r2=1642966&view=diff ============================================================================== --- lucy/site/trunk/content/docs/c/lucy_RangeQuery.html (original) +++ lucy/site/trunk/content/docs/c/lucy_RangeQuery.html Tue Dec 2 17:54:02 2014 @@ -1,44 +1,110 @@ <!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::RangeQuery â 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::RangeQuery</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::RangeQuery</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>RangeQuery</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_RANGEQUERY</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_RangeQuery</code></td> +</tr> +</table> <h2>Name</h2> -<p>Lucy::Search::RangeQuery - Match a range of values.</p> +<p>Lucy::Search::RangeQuery â Match a range of values.</p> <h2>Description</h2> <p>RangeQuery matches documents where the value for a particular field falls within a given range.</p> <h2>Functions</h2> <dl> -<dt>init</dt> +<dt id="func_init">init</dt> <dd> -<pre><code>lucy_RangeQuery* -<strong>lucy_RangeQuery_init</strong>( - lucy_RangeQuery* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>field</strong>, - <a href="cfish_Obj.html">cfish_Obj*</a> <strong>lower_term</strong>, - <a href="cfish_Obj.html">cfish_Obj*</a> <strong>upper_term</strong>, +<pre><code><span class="prefix">lucy_</span>RangeQuery* +<span class="prefix">lucy_</span><strong>RangeQuery_init</strong>( + <span class="prefix">lucy_</span>RangeQuery* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>field</strong>, + <span class="prefix">cfish_</span><a href="cfish_Obj.html">Obj*</a> <strong>lower_term</strong>, + <span class="prefix">cfish_</span><a href="cfish_Obj.html">Obj*</a> <strong>upper_term</strong>, bool <strong>include_lower</strong>, bool <strong>include_upper</strong> ); @@ -47,22 +113,22 @@ within a given range.</p> is at least one of either <code>lower_term</code> or <code>upper_term</code>.</p> <dl> -<dt><emph>field</emph></dt> +<dt>field</dt> <dd><p>The name of a <code>sortable</code> field.</p> </dd> -<dt><emph>lower_term</emph></dt> +<dt>lower_term</dt> <dd><p>Lower delimiter. If not supplied, all values less than <code>upper_term</code> will pass.</p> </dd> -<dt><emph>upper_term</emph></dt> +<dt>upper_term</dt> <dd><p>Upper delimiter. If not supplied, all values greater than <code>lower_term</code> will pass.</p> </dd> -<dt><emph>include_lower</emph></dt> +<dt>include_lower</dt> <dd><p>Indicates whether docs which match <code>lower_term</code> should be included in the results.</p> </dd> -<dt><emph>include_upper</emph></dt> +<dt>include_upper</dt> <dd><p>Indicates whether docs which match <code>upper_term</code> should be included in the results.</p> </dd> @@ -70,84 +136,85 @@ than <code>lower_term</code> will pass.< </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: lucy/site/trunk/content/docs/c/lucy_RegexTokenizer.html URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/c/lucy_RegexTokenizer.html?rev=1642966&r1=1642965&r2=1642966&view=diff ============================================================================== --- lucy/site/trunk/content/docs/c/lucy_RegexTokenizer.html (original) +++ lucy/site/trunk/content/docs/c/lucy_RegexTokenizer.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::Analysis::RegexTokenizer â 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::Analysis::RegexTokenizer</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::Analysis::RegexTokenizer</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>RegexTokenizer</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_REGEXTOKENIZER</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_RegexTokenizer</code></td> +</tr> +</table> <h2>Name</h2> -<p>Lucy::Analysis::RegexTokenizer - Split a string into tokens.</p> +<p>Lucy::Analysis::RegexTokenizer â Split a string into tokens.</p> <h2>Description</h2> <p>Generically, "tokenizing" is a process of breaking up a string into an array of "tokens". For instance, the string "three blind mice" might be @@ -53,16 +119,16 @@ Leaves punctuation as well as whitespace when determining token boundaries.</p> <h2>Functions</h2> <dl> -<dt>init</dt> +<dt id="func_init">init</dt> <dd> -<pre><code>lucy_RegexTokenizer* -<strong>lucy_RegexTokenizer_init</strong>( - lucy_RegexTokenizer* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>pattern</strong> +<pre><code><span class="prefix">lucy_</span>RegexTokenizer* +<span class="prefix">lucy_</span><strong>RegexTokenizer_init</strong>( + <span class="prefix">lucy_</span>RegexTokenizer* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>pattern</strong> ); </code></pre> <dl> -<dt><emph>pattern</emph></dt> +<dt>pattern</dt> <dd><p>A string specifying a Perl-syntax regular expression which should match one token. The default value is <code>\w+(?:[\x{2019}']\w+)*</code>, which matches "it's" as well as @@ -72,56 +138,57 @@ which should match one token. The defau </dd> </dl> <h2>Methods</h2> -<h3>Methods inherited from Lucy::Analysis::Analyzer</h3><dl> -<dt>Transform</dt> +<h3>Methods inherited from Lucy::Analysis::Analyzer</h3> +<dl> +<dt id="func_Transform">Transform <span class="comment">(abstract)</span></dt> <dd> -<pre><code><a href="lucy_Inversion.html">lucy_Inversion*</a> // incremented -<strong>LUCY_Analyzer_Transform</strong>( - lucy_Analyzer* <strong>self</strong>, - <a href="lucy_Inversion.html">lucy_Inversion*</a> <strong>inversion</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_Inversion.html">Inversion*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Analyzer_Transform</strong>( + <span class="prefix">lucy_</span>Analyzer* <strong>self</strong>, + <span class="prefix">lucy_</span><a href="lucy_Inversion.html">Inversion*</a> <strong>inversion</strong> ); </code></pre> <p>Take a single <a href="lucy_Inversion.html">Inversion</a> as input and returns an Inversion, either the same one (presumably transformed in some way), or a new one.</p> </dd> -<dt>Transform_Text</dt> +<dt id="func_Transform_Text">Transform_Text</dt> <dd> -<pre><code><a href="lucy_Inversion.html">lucy_Inversion*</a> // incremented -<strong>LUCY_Analyzer_Transform_Text</strong>( - lucy_Analyzer* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>text</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_Inversion.html">Inversion*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Analyzer_Transform_Text</strong>( + <span class="prefix">lucy_</span>Analyzer* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>text</strong> ); </code></pre> <p>Kick off an analysis chain, creating an Inversion from string input. The default implementation simply creates an initial Inversion with a -single Token, then calls Transform(), but occasionally subclasses will +single Token, then calls <a href="lucy_Analyzer.html#func_Transform">Transform()</a>, but occasionally subclasses will provide an optimized implementation which minimizes string copies.</p> </dd> -<dt>Split</dt> +<dt id="func_Split">Split</dt> <dd> -<pre><code><a href="cfish_VArray.html">cfish_VArray*</a> // incremented -<strong>LUCY_Analyzer_Split</strong>( - lucy_Analyzer* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>text</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>Analyzer_Split</strong>( + <span class="prefix">lucy_</span>Analyzer* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>text</strong> ); </code></pre> <p>Analyze text and return an array of token texts.</p> </dd> -<dt>Dump</dt> +<dt id="func_Dump">Dump</dt> <dd> -<pre><code><a href="cfish_Obj.html">cfish_Obj*</a> // incremented -<strong>LUCY_Analyzer_Dump</strong>( - lucy_Analyzer* <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>Analyzer_Dump</strong>( + <span class="prefix">lucy_</span>Analyzer* <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_Analyzer_Load</strong>( - lucy_Analyzer* <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>Analyzer_Load</strong>( + <span class="prefix">lucy_</span>Analyzer* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_Obj.html">Obj*</a> <strong>dump</strong> ); </code></pre> </dd>
