Added: websites/staging/lucy/trunk/content/docs/0.5.0/perl/LucyX/Remote/SearchClient.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/0.5.0/perl/LucyX/Remote/SearchClient.html (added) +++ websites/staging/lucy/trunk/content/docs/0.5.0/perl/LucyX/Remote/SearchClient.html Wed Sep 28 12:07:48 2016 @@ -0,0 +1,136 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> + <title>LucyX::Remote::SearchClient â Apache Lucy Documentation</title> + <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css"> + </head> + + <body> + + <div id="lucy-rigid_wrapper"> + + <div id="lucy-top" class="container_16 lucy-white_box_3d"> + + <div id="lucy-logo_box" class="grid_8"> + <a href="/"><img src="/images/lucy_logo_150x100.png" alt="Apache Lucyâ¢"></a> + </div> <!-- lucy-logo_box --> + + <div #id="lucy-top_nav_box" class="grid_8"> + <div id="lucy-top_nav_bar" class="container_8"> + <ul> + <li><a href="http://www.apache.org/"; title="Apache Software Foundation">Apache Software Foundation</a></li> + <li><a href="http://www.apache.org/licenses/"; title="License">License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html"; title="Sponsorship">Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html"; title="Thanks">Thanks</a></li> + <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li> + </ul> + </div> <!-- lucy-top_nav_bar --> + <p><a href="http://www.apache.org/";>Apache</a> » <a href="/">Lucy</a> » <a href="/docs/">Docs</a> » <a href="/docs/0.5.0/">0.5.0</a> » <a href="/docs/0.5.0/perl/">Perl</a> » <a href="/docs/0.5.0/perl/LucyX/">LucyX</a> » <a href="/docs/0.5.0/perl/LucyX/Remote/">Remote</a></p> + <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search"; method="get"> + <input value="*.apache.org" name="sitesearch" type="hidden"/> + <input type="text" name="q" id="query" style="width:85%"> + <input type="submit" id="submit" value="Search"> + </form> + </div> <!-- lucy-top_nav_box --> + + <div class="clear"></div> + + </div> <!-- lucy-top --> + + <div id="lucy-main_content" class="container_16 lucy-white_box_3d"> + + <div class="grid_4" id="lucy-left_nav_box"> + <h6>About</h6> + <ul> + <li><a href="/">Welcome</a></li> + <li><a href="/clownfish.html">Clownfish</a></li> + <li><a href="/faq.html">FAQ</a></li> + <li><a href="/people.html">People</a></li> + </ul> + <h6>Resources</h6> + <ul> + <li><a href="/download.html">Download</a></li> + <li><a href="/mailing_lists.html">Mailing Lists</a></li> + <li><a href="/docs/">Documentation</a></li> + <li><a href="http://wiki.apache.org/lucy/";>Wiki</a></li> + <li><a href="https://issues.apache.org/jira/browse/LUCY";>Issue Tracker</a></li> + <li><a href="/version_control.html">Version Control</a></li> + </ul> + <h6>Related Projects</h6> + <ul> + <li><a href="http://lucene.apache.org/core/";>Lucene</a></li> + <li><a href="http://dezi.org/";>Dezi</a></li> + <li><a href="http://lucene.apache.org/solr/";>Solr</a></li> + <li><a href="http://lucenenet.apache.org/";>Lucene.NET</a></li> + <li><a href="http://lucene.apache.org/pylucene/";>PyLucene</a></li> + </ul> + </div> <!-- lucy-left_nav_box --> + + <div id="lucy-main_content_box" class="grid_9"> + <div> +<a name='___top' class='dummyTopAnchor' ></a> + +<p>Make a remote procedure call. +For every call that does not close/terminate the socket connection, +expect a response back that's been serialized using Storable.</p> + +<h2><a class='u' +name="NAME" +>NAME</a></h2> + +<p>LucyX::Remote::SearchClient - Connect to a remote SearchServer.</p> + +<h2><a class='u' +name="SYNOPSIS" +>SYNOPSIS</a></h2> + +<pre>my $client = LucyX::Remote::SearchClient->new( + peer_address => 'searchserver1:7890', +); +my $hits = $client->hits( query => $query );</pre> + +<h2><a class='u' +name="DESCRIPTION" +>DESCRIPTION</a></h2> + +<p>SearchClient is a subclass of <a href="../../Lucy/Search/Searcher.html" class="podlinkpod" +>Lucy::Search::Searcher</a> which can be used to search an index on a remote machine made accessible via <a href="../../LucyX/Remote/SearchServer.html" class="podlinkpod" +>SearchServer</a>.</p> + +<h2><a class='u' +name="METHODS" +>METHODS</a></h2> + +<h3><a class='u' +name="new" +>new</a></h3> + +<p>Constructor. +Takes hash-style params.</p> + +<ul> +<li><b>peer_address</b> - The name/IP and the port number which the client should attempt to connect to.</li> +</ul> + +</div> + + </div> <!-- lucy-main_content_box --> + <div class="clear"></div> + + </div> <!-- lucy-main_content --> + + <div id="lucy-copyright" class="container_16"> + <p>Copyright © 2010-2015 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0</a>. + <br/> + Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The + Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their + respective owners. + </p> + </div> <!-- lucy-copyright --> + + </div> <!-- lucy-rigid_wrapper --> + + </body> +</html>
Added: websites/staging/lucy/trunk/content/docs/0.5.0/perl/LucyX/Remote/SearchServer.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/0.5.0/perl/LucyX/Remote/SearchServer.html (added) +++ websites/staging/lucy/trunk/content/docs/0.5.0/perl/LucyX/Remote/SearchServer.html Wed Sep 28 12:07:48 2016 @@ -0,0 +1,174 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> + <title>LucyX::Remote::SearchServer â Apache Lucy Documentation</title> + <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css"> + </head> + + <body> + + <div id="lucy-rigid_wrapper"> + + <div id="lucy-top" class="container_16 lucy-white_box_3d"> + + <div id="lucy-logo_box" class="grid_8"> + <a href="/"><img src="/images/lucy_logo_150x100.png" alt="Apache Lucyâ¢"></a> + </div> <!-- lucy-logo_box --> + + <div #id="lucy-top_nav_box" class="grid_8"> + <div id="lucy-top_nav_bar" class="container_8"> + <ul> + <li><a href="http://www.apache.org/"; title="Apache Software Foundation">Apache Software Foundation</a></li> + <li><a href="http://www.apache.org/licenses/"; title="License">License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html"; title="Sponsorship">Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html"; title="Thanks">Thanks</a></li> + <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li> + </ul> + </div> <!-- lucy-top_nav_bar --> + <p><a href="http://www.apache.org/";>Apache</a> » <a href="/">Lucy</a> » <a href="/docs/">Docs</a> » <a href="/docs/0.5.0/">0.5.0</a> » <a href="/docs/0.5.0/perl/">Perl</a> » <a href="/docs/0.5.0/perl/LucyX/">LucyX</a> » <a href="/docs/0.5.0/perl/LucyX/Remote/">Remote</a></p> + <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search"; method="get"> + <input value="*.apache.org" name="sitesearch" type="hidden"/> + <input type="text" name="q" id="query" style="width:85%"> + <input type="submit" id="submit" value="Search"> + </form> + </div> <!-- lucy-top_nav_box --> + + <div class="clear"></div> + + </div> <!-- lucy-top --> + + <div id="lucy-main_content" class="container_16 lucy-white_box_3d"> + + <div class="grid_4" id="lucy-left_nav_box"> + <h6>About</h6> + <ul> + <li><a href="/">Welcome</a></li> + <li><a href="/clownfish.html">Clownfish</a></li> + <li><a href="/faq.html">FAQ</a></li> + <li><a href="/people.html">People</a></li> + </ul> + <h6>Resources</h6> + <ul> + <li><a href="/download.html">Download</a></li> + <li><a href="/mailing_lists.html">Mailing Lists</a></li> + <li><a href="/docs/">Documentation</a></li> + <li><a href="http://wiki.apache.org/lucy/";>Wiki</a></li> + <li><a href="https://issues.apache.org/jira/browse/LUCY";>Issue Tracker</a></li> + <li><a href="/version_control.html">Version Control</a></li> + </ul> + <h6>Related Projects</h6> + <ul> + <li><a href="http://lucene.apache.org/core/";>Lucene</a></li> + <li><a href="http://dezi.org/";>Dezi</a></li> + <li><a href="http://lucene.apache.org/solr/";>Solr</a></li> + <li><a href="http://lucenenet.apache.org/";>Lucene.NET</a></li> + <li><a href="http://lucene.apache.org/pylucene/";>PyLucene</a></li> + </ul> + </div> <!-- lucy-left_nav_box --> + + <div id="lucy-main_content_box" class="grid_9"> + <div> +<a name='___top' class='dummyTopAnchor' ></a> + +<h2><a class='u' +name="NAME" +>NAME</a></h2> + +<p>LucyX::Remote::SearchServer - Make a Searcher remotely accessible.</p> + +<h2><a class='u' +name="SYNOPSIS" +>SYNOPSIS</a></h2> + +<pre>my $searcher = Lucy::Search::IndexSearcher->new( + index => '/path/to/index' +); +my $search_server = LucyX::Remote::SearchServer->new( + searcher => $searcher +); +$search_server->serve( + port => 7890 +);</pre> + +<h2><a class='u' +name="DESCRIPTION" +>DESCRIPTION</a></h2> + +<p>The SearchServer class, +in conjunction with either <a href="../../LucyX/Remote/SearchClient.html" class="podlinkpod" +>SearchClient</a> or <a href="../../LucyX/Remote/ClusterSearcher.html" class="podlinkpod" +>ClusterSearcher</a>, +makes it possible to run a search on one machine and report results on another.</p> + +<p>By aggregating several SearchClients under a ClusterSearcher, +the cost of searching what might have been a prohibitively large monolithic index can be distributed across multiple nodes, +each with its own, +smaller index.</p> + +<h2><a class='u' +name="METHODS" +>METHODS</a></h2> + +<h3><a class='u' +name="new" +>new</a></h3> + +<pre>my $search_server = LucyX::Remote::SearchServer->new( + searcher => $searcher, # required +);</pre> + +<p>Constructor. +Takes hash-style parameters.</p> + +<ul> +<li><b>searcher</b> - the <a href="../../Lucy/Search/IndexSearcher.html" class="podlinkpod" +>Searcher</a> that the SearchServer will wrap.</li> +</ul> + +<h3><a class='u' +name="serve" +>serve</a></h3> + +<pre>$search_server->serve( + port => 7890, # required +);</pre> + +<p>Open a listening socket on localhost and wait for SearchClients to connect.</p> + +<ul> +<li><b>port</b> - the port on localhost that the server should open and listen on.</li> +</ul> + +<h3><a class='u' +name="serve_rpc" +>serve_rpc</a></h3> + +<pre>my $status = $search_server->serve_rpc($sock);</pre> + +<p>Handle a single RPC from socket $sock. +Returns 'done' if the connection should be closed. +Returns 'terminate' if the server should shut down. +Returns 'continue' if the server should continue to handle requests from this client.</p> + +</div> + + </div> <!-- lucy-main_content_box --> + <div class="clear"></div> + + </div> <!-- lucy-main_content --> + + <div id="lucy-copyright" class="container_16"> + <p>Copyright © 2010-2015 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0</a>. + <br/> + Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The + Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their + respective owners. + </p> + </div> <!-- lucy-copyright --> + + </div> <!-- lucy-rigid_wrapper --> + + </body> +</html> Added: websites/staging/lucy/trunk/content/docs/0.5.0/perl/LucyX/Search/Filter.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/0.5.0/perl/LucyX/Search/Filter.html (added) +++ websites/staging/lucy/trunk/content/docs/0.5.0/perl/LucyX/Search/Filter.html Wed Sep 28 12:07:48 2016 @@ -0,0 +1,167 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> + <title>LucyX::Search::Filter â Apache Lucy Documentation</title> + <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css"> + </head> + + <body> + + <div id="lucy-rigid_wrapper"> + + <div id="lucy-top" class="container_16 lucy-white_box_3d"> + + <div id="lucy-logo_box" class="grid_8"> + <a href="/"><img src="/images/lucy_logo_150x100.png" alt="Apache Lucyâ¢"></a> + </div> <!-- lucy-logo_box --> + + <div #id="lucy-top_nav_box" class="grid_8"> + <div id="lucy-top_nav_bar" class="container_8"> + <ul> + <li><a href="http://www.apache.org/"; title="Apache Software Foundation">Apache Software Foundation</a></li> + <li><a href="http://www.apache.org/licenses/"; title="License">License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html"; title="Sponsorship">Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html"; title="Thanks">Thanks</a></li> + <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li> + </ul> + </div> <!-- lucy-top_nav_bar --> + <p><a href="http://www.apache.org/";>Apache</a> » <a href="/">Lucy</a> » <a href="/docs/">Docs</a> » <a href="/docs/0.5.0/">0.5.0</a> » <a href="/docs/0.5.0/perl/">Perl</a> » <a href="/docs/0.5.0/perl/LucyX/">LucyX</a> » <a href="/docs/0.5.0/perl/LucyX/Search/">Search</a></p> + <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search"; method="get"> + <input value="*.apache.org" name="sitesearch" type="hidden"/> + <input type="text" name="q" id="query" style="width:85%"> + <input type="submit" id="submit" value="Search"> + </form> + </div> <!-- lucy-top_nav_box --> + + <div class="clear"></div> + + </div> <!-- lucy-top --> + + <div id="lucy-main_content" class="container_16 lucy-white_box_3d"> + + <div class="grid_4" id="lucy-left_nav_box"> + <h6>About</h6> + <ul> + <li><a href="/">Welcome</a></li> + <li><a href="/clownfish.html">Clownfish</a></li> + <li><a href="/faq.html">FAQ</a></li> + <li><a href="/people.html">People</a></li> + </ul> + <h6>Resources</h6> + <ul> + <li><a href="/download.html">Download</a></li> + <li><a href="/mailing_lists.html">Mailing Lists</a></li> + <li><a href="/docs/">Documentation</a></li> + <li><a href="http://wiki.apache.org/lucy/";>Wiki</a></li> + <li><a href="https://issues.apache.org/jira/browse/LUCY";>Issue Tracker</a></li> + <li><a href="/version_control.html">Version Control</a></li> + </ul> + <h6>Related Projects</h6> + <ul> + <li><a href="http://lucene.apache.org/core/";>Lucene</a></li> + <li><a href="http://dezi.org/";>Dezi</a></li> + <li><a href="http://lucene.apache.org/solr/";>Solr</a></li> + <li><a href="http://lucenenet.apache.org/";>Lucene.NET</a></li> + <li><a href="http://lucene.apache.org/pylucene/";>PyLucene</a></li> + </ul> + </div> <!-- lucy-left_nav_box --> + + <div id="lucy-main_content_box" class="grid_9"> + <div> +<a name='___top' class='dummyTopAnchor' ></a> + +<h2><a class='u' +name="NAME" +>NAME</a></h2> + +<p>LucyX::Search::Filter - Build a caching filter based on results of a Query.</p> + +<h2><a class='u' +name="SYNOPSIS" +>SYNOPSIS</a></h2> + +<pre>my %category_filters; +for my $category (qw( sweet sour salty bitter )) { + my $cat_query = Lucy::Search::TermQuery->new( + field => 'category', + term => $category, + ); + $category_filters{$category} = LucyX::Search::Filter->new( + query => $cat_query, + ); +} + +while ( my $cgi = CGI::Fast->new ) { + my $user_query = $cgi->param('q'); + my $filter = $category_filters{ $cgi->param('category') }; + my $and_query = Lucy::Search::ANDQuery->new; + $and_query->add_child($user_query); + $and_query->add_child($filter); + my $hits = $searcher->hits( query => $and_query ); + ...</pre> + +<h2><a class='u' +name="DESCRIPTION" +>DESCRIPTION</a></h2> + +<p>A Filter is a <a href="../../Lucy/Search/Query.html" class="podlinkpod" +>Lucy::Search::Query</a> subclass that can be used to filter the results of another Query. +The effect is very similar to simply using the wrapped inner query, +but there are two important differences:</p> + +<ul> +<li>A Filter does not contribute to the score of the documents it matches.</li> + +<li>A Filter caches its results, +so it is more efficient if you use it more than once.</li> +</ul> + +<p>To obtain logically equivalent results to the Filter but avoid the caching, +substitute the wrapped query but use set_boost() to set its <code>boost</code> to 0.</p> + +<h2><a class='u' +name="METHODS" +>METHODS</a></h2> + +<h3><a class='u' +name="new" +>new</a></h3> + +<pre>my $filter = LucyX::Search::Filter->new( + query => $query; +);</pre> + +<p>Constructor. +Takes one hash-style parameter, +<code>query</code>, +which must be an object belonging to a subclass of <a href="../../Lucy/Search/Query.html" class="podlinkpod" +>Lucy::Search::Query</a>.</p> + +<h2><a class='u' +name="BUGS" +>BUGS</a></h2> + +<p>Filters do not cache when used in a search cluster with LucyX::Remote's SearchServer and SearchClient.</p> + +</div> + + </div> <!-- lucy-main_content_box --> + <div class="clear"></div> + + </div> <!-- lucy-main_content --> + + <div id="lucy-copyright" class="container_16"> + <p>Copyright © 2010-2015 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0</a>. + <br/> + Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The + Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their + respective owners. + </p> + </div> <!-- lucy-copyright --> + + </div> <!-- lucy-rigid_wrapper --> + + </body> +</html> Added: websites/staging/lucy/trunk/content/docs/0.5.0/perl/LucyX/Search/MockMatcher.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/0.5.0/perl/LucyX/Search/MockMatcher.html (added) +++ websites/staging/lucy/trunk/content/docs/0.5.0/perl/LucyX/Search/MockMatcher.html Wed Sep 28 12:07:48 2016 @@ -0,0 +1,127 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> + <title>LucyX::Search::MockMatcher â Apache Lucy Documentation</title> + <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css"> + </head> + + <body> + + <div id="lucy-rigid_wrapper"> + + <div id="lucy-top" class="container_16 lucy-white_box_3d"> + + <div id="lucy-logo_box" class="grid_8"> + <a href="/"><img src="/images/lucy_logo_150x100.png" alt="Apache Lucyâ¢"></a> + </div> <!-- lucy-logo_box --> + + <div #id="lucy-top_nav_box" class="grid_8"> + <div id="lucy-top_nav_bar" class="container_8"> + <ul> + <li><a href="http://www.apache.org/"; title="Apache Software Foundation">Apache Software Foundation</a></li> + <li><a href="http://www.apache.org/licenses/"; title="License">License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html"; title="Sponsorship">Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html"; title="Thanks">Thanks</a></li> + <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li> + </ul> + </div> <!-- lucy-top_nav_bar --> + <p><a href="http://www.apache.org/";>Apache</a> » <a href="/">Lucy</a> » <a href="/docs/">Docs</a> » <a href="/docs/0.5.0/">0.5.0</a> » <a href="/docs/0.5.0/perl/">Perl</a> » <a href="/docs/0.5.0/perl/LucyX/">LucyX</a> » <a href="/docs/0.5.0/perl/LucyX/Search/">Search</a></p> + <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search"; method="get"> + <input value="*.apache.org" name="sitesearch" type="hidden"/> + <input type="text" name="q" id="query" style="width:85%"> + <input type="submit" id="submit" value="Search"> + </form> + </div> <!-- lucy-top_nav_box --> + + <div class="clear"></div> + + </div> <!-- lucy-top --> + + <div id="lucy-main_content" class="container_16 lucy-white_box_3d"> + + <div class="grid_4" id="lucy-left_nav_box"> + <h6>About</h6> + <ul> + <li><a href="/">Welcome</a></li> + <li><a href="/clownfish.html">Clownfish</a></li> + <li><a href="/faq.html">FAQ</a></li> + <li><a href="/people.html">People</a></li> + </ul> + <h6>Resources</h6> + <ul> + <li><a href="/download.html">Download</a></li> + <li><a href="/mailing_lists.html">Mailing Lists</a></li> + <li><a href="/docs/">Documentation</a></li> + <li><a href="http://wiki.apache.org/lucy/";>Wiki</a></li> + <li><a href="https://issues.apache.org/jira/browse/LUCY";>Issue Tracker</a></li> + <li><a href="/version_control.html">Version Control</a></li> + </ul> + <h6>Related Projects</h6> + <ul> + <li><a href="http://lucene.apache.org/core/";>Lucene</a></li> + <li><a href="http://dezi.org/";>Dezi</a></li> + <li><a href="http://lucene.apache.org/solr/";>Solr</a></li> + <li><a href="http://lucenenet.apache.org/";>Lucene.NET</a></li> + <li><a href="http://lucene.apache.org/pylucene/";>PyLucene</a></li> + </ul> + </div> <!-- lucy-left_nav_box --> + + <div id="lucy-main_content_box" class="grid_9"> + <div> +<a name='___top' class='dummyTopAnchor' ></a> + +<h2><a class='u' +name="NAME" +>NAME</a></h2> + +<p>LucyX::Search::MockMatcher - Matcher with arbitrary docs and scores.</p> + +<h2><a class='u' +name="DESCRIPTION" +>DESCRIPTION</a></h2> + +<p>Used for testing combining <a href="../../Lucy/Search/Matcher.html" class="podlinkpod" +>Matchers</a> such as ANDMatcher, +MockMatcher allows arbitrary match criteria to be supplied, +obviating the need for clever index construction to cover corner cases.</p> + +<p>MockMatcher is a testing and demonstration class; it is unsupported.</p> + +<h2><a class='u' +name="CONSTRUCTORS" +>CONSTRUCTORS</a></h2> + +<h3><a class='u' +name="new(_[labeled_params]_)" +>new( [<i>labeled params</i>] )</a></h3> + +<ul> +<li><b>doc_ids</b> - A sorted array of <a href="../../Lucy/Docs/DocIDs.html" class="podlinkpod" +>doc_ids</a>.</li> + +<li><b>scores</b> - An array of scores, +one for each doc_id.</li> +</ul> + +</div> + + </div> <!-- lucy-main_content_box --> + <div class="clear"></div> + + </div> <!-- lucy-main_content --> + + <div id="lucy-copyright" class="container_16"> + <p>Copyright © 2010-2015 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0</a>. + <br/> + Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The + Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their + respective owners. + </p> + </div> <!-- lucy-copyright --> + + </div> <!-- lucy-rigid_wrapper --> + + </body> +</html> Added: websites/staging/lucy/trunk/content/docs/0.5.0/perl/LucyX/Search/ProximityQuery.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/0.5.0/perl/LucyX/Search/ProximityQuery.html (added) +++ websites/staging/lucy/trunk/content/docs/0.5.0/perl/LucyX/Search/ProximityQuery.html Wed Sep 28 12:07:48 2016 @@ -0,0 +1,198 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> + <title>LucyX::Search::ProximityQuery â Apache Lucy Documentation</title> + <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css"> + </head> + + <body> + + <div id="lucy-rigid_wrapper"> + + <div id="lucy-top" class="container_16 lucy-white_box_3d"> + + <div id="lucy-logo_box" class="grid_8"> + <a href="/"><img src="/images/lucy_logo_150x100.png" alt="Apache Lucyâ¢"></a> + </div> <!-- lucy-logo_box --> + + <div #id="lucy-top_nav_box" class="grid_8"> + <div id="lucy-top_nav_bar" class="container_8"> + <ul> + <li><a href="http://www.apache.org/"; title="Apache Software Foundation">Apache Software Foundation</a></li> + <li><a href="http://www.apache.org/licenses/"; title="License">License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html"; title="Sponsorship">Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html"; title="Thanks">Thanks</a></li> + <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li> + </ul> + </div> <!-- lucy-top_nav_bar --> + <p><a href="http://www.apache.org/";>Apache</a> » <a href="/">Lucy</a> » <a href="/docs/">Docs</a> » <a href="/docs/0.5.0/">0.5.0</a> » <a href="/docs/0.5.0/perl/">Perl</a> » <a href="/docs/0.5.0/perl/LucyX/">LucyX</a> » <a href="/docs/0.5.0/perl/LucyX/Search/">Search</a></p> + <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search"; method="get"> + <input value="*.apache.org" name="sitesearch" type="hidden"/> + <input type="text" name="q" id="query" style="width:85%"> + <input type="submit" id="submit" value="Search"> + </form> + </div> <!-- lucy-top_nav_box --> + + <div class="clear"></div> + + </div> <!-- lucy-top --> + + <div id="lucy-main_content" class="container_16 lucy-white_box_3d"> + + <div class="grid_4" id="lucy-left_nav_box"> + <h6>About</h6> + <ul> + <li><a href="/">Welcome</a></li> + <li><a href="/clownfish.html">Clownfish</a></li> + <li><a href="/faq.html">FAQ</a></li> + <li><a href="/people.html">People</a></li> + </ul> + <h6>Resources</h6> + <ul> + <li><a href="/download.html">Download</a></li> + <li><a href="/mailing_lists.html">Mailing Lists</a></li> + <li><a href="/docs/">Documentation</a></li> + <li><a href="http://wiki.apache.org/lucy/";>Wiki</a></li> + <li><a href="https://issues.apache.org/jira/browse/LUCY";>Issue Tracker</a></li> + <li><a href="/version_control.html">Version Control</a></li> + </ul> + <h6>Related Projects</h6> + <ul> + <li><a href="http://lucene.apache.org/core/";>Lucene</a></li> + <li><a href="http://dezi.org/";>Dezi</a></li> + <li><a href="http://lucene.apache.org/solr/";>Solr</a></li> + <li><a href="http://lucenenet.apache.org/";>Lucene.NET</a></li> + <li><a href="http://lucene.apache.org/pylucene/";>PyLucene</a></li> + </ul> + </div> <!-- lucy-left_nav_box --> + + <div id="lucy-main_content_box" class="grid_9"> + <div> +<a name='___top' class='dummyTopAnchor' ></a> + +<h2><a class='u' +name="NAME" +>NAME</a></h2> + +<p>LucyX::Search::ProximityQuery - Query matching an ordered list of terms.</p> + +<h2><a class='u' +name="SYNOPSIS" +>SYNOPSIS</a></h2> + +<pre>my $proximity_query = LucyX::Search::ProximityQuery->new( + field => 'content', + terms => [qw( the who )], + within => 10, # match within 10 positions +); +my $hits = $searcher->hits( query => $proximity_query );</pre> + +<h2><a class='u' +name="DESCRIPTION" +>DESCRIPTION</a></h2> + +<p>ProximityQuery is a subclass of <a href="../../Lucy/Search/Query.html" class="podlinkpod" +>Query</a> for matching against an ordered sequence of terms.</p> + +<h2><a class='u' +name="CONSTRUCTORS" +>CONSTRUCTORS</a></h2> + +<h3><a class='u' +name="new" +>new</a></h3> + +<pre>my $proximity_query = LucyX::Search::ProximityQuery->new( + field => $field # required + terms => $terms # required + within => $within # required +);</pre> + +<p>Create a new ProximityQuery.</p> + +<ul> +<li><b>field</b> - The field that the phrase must occur in.</li> + +<li><b>terms</b> - The ordered array of terms that must match.</li> +</ul> + +<h2><a class='u' +name="METHODS" +>METHODS</a></h2> + +<h3><a class='u' +name="get_field" +>get_field</a></h3> + +<pre>my $string = $proximity_query->get_field();</pre> + +<p>Accessor for object’s field attribute.</p> + +<h3><a class='u' +name="get_terms" +>get_terms</a></h3> + +<pre>my $arrayref = $proximity_query->get_terms();</pre> + +<p>Accessor for object’s array of terms.</p> + +<h3><a class='u' +name="get_within" +>get_within</a></h3> + +<pre>my $int = $proximity_query->get_within();</pre> + +<p>Accessor for object’s within attribute.</p> + +<h3><a class='u' +name="make_compiler" +>make_compiler</a></h3> + +<pre>my $compiler = $proximity_query->make_compiler( + searcher => $searcher # required + boost => $boost # required + subordinate => $subordinate # default: false +);</pre> + +<p>Abstract factory method returning a Compiler derived from this Query.</p> + +<ul> +<li><b>searcher</b> - A Searcher.</li> + +<li><b>boost</b> - A scoring multiplier.</li> + +<li><b>subordinate</b> - Indicates whether the Query is a subquery (as opposed to a top-level query). +If false, +the implementation must invoke <a href="../../Lucy/Search/Compiler.html#normalize" class="podlinkpod" +>normalize()</a> on the newly minted Compiler object before returning it.</li> +</ul> + +<h2><a class='u' +name="INHERITANCE" +>INHERITANCE</a></h2> + +<p>LucyX::Search::ProximityQuery isa <a href="../../Lucy/Search/Query.html" class="podlinkpod" +>Lucy::Search::Query</a> isa Clownfish::Obj.</p> + +</div> + + </div> <!-- lucy-main_content_box --> + <div class="clear"></div> + + </div> <!-- lucy-main_content --> + + <div id="lucy-copyright" class="container_16"> + <p>Copyright © 2010-2015 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0</a>. + <br/> + Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The + Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their + respective owners. + </p> + </div> <!-- lucy-copyright --> + + </div> <!-- lucy-rigid_wrapper --> + + </body> +</html> Added: websites/staging/lucy/trunk/content/docs/0.5.0/perl/clownfish-index.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/0.5.0/perl/clownfish-index.html (added) +++ websites/staging/lucy/trunk/content/docs/0.5.0/perl/clownfish-index.html Wed Sep 28 12:07:48 2016 @@ -0,0 +1,112 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> + <title>Perl API documentation for Apache Clownfish 0.5.0</title> + <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css"> + </head> + + <body> + + <div id="lucy-rigid_wrapper"> + + <div id="lucy-top" class="container_16 lucy-white_box_3d"> + + <div id="lucy-logo_box" class="grid_8"> + <a href="/"><img src="/images/lucy_logo_150x100.png" alt="Apache Lucyâ¢"></a> + </div> <!-- lucy-logo_box --> + + <div #id="lucy-top_nav_box" class="grid_8"> + <div id="lucy-top_nav_bar" class="container_8"> + <ul> + <li><a href="http://www.apache.org/"; title="Apache Software Foundation">Apache Software Foundation</a></li> + <li><a href="http://www.apache.org/licenses/"; title="License">License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html"; title="Sponsorship">Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html"; title="Thanks">Thanks</a></li> + <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li> + </ul> + </div> <!-- lucy-top_nav_bar --> + <p><a href="http://www.apache.org/";>Apache</a> » <a href="/">Lucy</a> » <a href="/docs/">Docs</a> » <a href="/docs/0.5.0/">0.5.0</a> » <a href="/docs/0.5.0/perl/">Perl</a></p> + <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search"; method="get"> + <input value="*.apache.org" name="sitesearch" type="hidden"/> + <input type="text" name="q" id="query" style="width:85%"> + <input type="submit" id="submit" value="Search"> + </form> + </div> <!-- lucy-top_nav_box --> + + <div class="clear"></div> + + </div> <!-- lucy-top --> + + <div id="lucy-main_content" class="container_16 lucy-white_box_3d"> + + <div class="grid_4" id="lucy-left_nav_box"> + <h6>About</h6> + <ul> + <li><a href="/">Welcome</a></li> + <li><a href="/clownfish.html">Clownfish</a></li> + <li><a href="/faq.html">FAQ</a></li> + <li><a href="/people.html">People</a></li> + </ul> + <h6>Resources</h6> + <ul> + <li><a href="/download.html">Download</a></li> + <li><a href="/mailing_lists.html">Mailing Lists</a></li> + <li><a href="/docs/">Documentation</a></li> + <li><a href="http://wiki.apache.org/lucy/";>Wiki</a></li> + <li><a href="https://issues.apache.org/jira/browse/LUCY";>Issue Tracker</a></li> + <li><a href="/version_control.html">Version Control</a></li> + </ul> + <h6>Related Projects</h6> + <ul> + <li><a href="http://lucene.apache.org/core/";>Lucene</a></li> + <li><a href="http://dezi.org/";>Dezi</a></li> + <li><a href="http://lucene.apache.org/solr/";>Solr</a></li> + <li><a href="http://lucenenet.apache.org/";>Lucene.NET</a></li> + <li><a href="http://lucene.apache.org/pylucene/";>PyLucene</a></li> + </ul> + </div> <!-- lucy-left_nav_box --> + + <div id="lucy-main_content_box" class="grid_9"> + <h2>Perl API documentation for Apache Clownfish 0.5.0</h2> + +<ul> +<li><a href="Clownfish.html">Clownfish</a> â Apache Clownfish symbiotic object system</li> +<li><a href="Clownfish/Blob.html">Clownfish::Blob</a> â Immutable buffer holding arbitrary bytes.</li> +<li><a href="Clownfish/Boolean.html">Clownfish::Boolean</a> â Boolean type.</li> +<li><a href="Clownfish/ByteBuf.html">Clownfish::ByteBuf</a> â Growable buffer holding arbitrary bytes.</li> +<li><a href="Clownfish/CharBuf.html">Clownfish::CharBuf</a> â Growable buffer holding Unicode characters.</li> +<li><a href="Clownfish/Class.html">Clownfish::Class</a> â Class.</li> +<li><a href="Clownfish/Docs/BuildingProjects.html">Clownfish::Docs::BuildingProjects</a> â Building Apache Clownfish projects in C environments</li> +<li><a href="Clownfish/Docs/ClassIntro.html">Clownfish::Docs::ClassIntro</a> â Working with Apache Clownfish classes in C</li> +<li><a href="Clownfish/Docs/WritingClasses.html">Clownfish::Docs::WritingClasses</a> â Writing Apache Clownfish classes</li> +<li><a href="Clownfish/Err.html">Clownfish::Err</a> â Exception.</li> +<li><a href="Clownfish/Float.html">Clownfish::Float</a> â Immutable double precision floating point number.</li> +<li><a href="Clownfish/Hash.html">Clownfish::Hash</a> â Hashtable.</li> +<li><a href="Clownfish/HashIterator.html">Clownfish::HashIterator</a> â Hashtable Iterator.</li> +<li><a href="Clownfish/Integer.html">Clownfish::Integer</a> â Immutable 64-bit signed integer.</li> +<li><a href="Clownfish/Obj.html">Clownfish::Obj</a> â Base class for all objects.</li> +<li><a href="Clownfish/String.html">Clownfish::String</a> â Immutable string holding Unicode characters.</li> +<li><a href="Clownfish/StringIterator.html">Clownfish::StringIterator</a> â Iterate Unicode code points in a String.</li> +<li><a href="Clownfish/Vector.html">Clownfish::Vector</a> â Variable-sized array.</li> +</ul> + + </div> <!-- lucy-main_content_box --> + <div class="clear"></div> + + </div> <!-- lucy-main_content --> + + <div id="lucy-copyright" class="container_16"> + <p>Copyright © 2010-2015 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0</a>. + <br/> + Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The + Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their + respective owners. + </p> + </div> <!-- lucy-copyright --> + + </div> <!-- lucy-rigid_wrapper --> + + </body> +</html> Added: websites/staging/lucy/trunk/content/docs/0.5.0/perl/index.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/0.5.0/perl/index.html (added) +++ websites/staging/lucy/trunk/content/docs/0.5.0/perl/index.html Wed Sep 28 12:07:48 2016 @@ -0,0 +1,193 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> + <title>Perl API documentation for Apache Lucy 0.5.0</title> + <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css"> + </head> + + <body> + + <div id="lucy-rigid_wrapper"> + + <div id="lucy-top" class="container_16 lucy-white_box_3d"> + + <div id="lucy-logo_box" class="grid_8"> + <a href="/"><img src="/images/lucy_logo_150x100.png" alt="Apache Lucyâ¢"></a> + </div> <!-- lucy-logo_box --> + + <div #id="lucy-top_nav_box" class="grid_8"> + <div id="lucy-top_nav_bar" class="container_8"> + <ul> + <li><a href="http://www.apache.org/"; title="Apache Software Foundation">Apache Software Foundation</a></li> + <li><a href="http://www.apache.org/licenses/"; title="License">License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html"; title="Sponsorship">Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html"; title="Thanks">Thanks</a></li> + <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li> + </ul> + </div> <!-- lucy-top_nav_bar --> + <p><a href="http://www.apache.org/";>Apache</a> » <a href="/">Lucy</a> » <a href="/docs/">Docs</a> » <a href="/docs/0.5.0/">0.5.0</a> » <a href="/docs/0.5.0/perl/">Perl</a></p> + <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search"; method="get"> + <input value="*.apache.org" name="sitesearch" type="hidden"/> + <input type="text" name="q" id="query" style="width:85%"> + <input type="submit" id="submit" value="Search"> + </form> + </div> <!-- lucy-top_nav_box --> + + <div class="clear"></div> + + </div> <!-- lucy-top --> + + <div id="lucy-main_content" class="container_16 lucy-white_box_3d"> + + <div class="grid_4" id="lucy-left_nav_box"> + <h6>About</h6> + <ul> + <li><a href="/">Welcome</a></li> + <li><a href="/clownfish.html">Clownfish</a></li> + <li><a href="/faq.html">FAQ</a></li> + <li><a href="/people.html">People</a></li> + </ul> + <h6>Resources</h6> + <ul> + <li><a href="/download.html">Download</a></li> + <li><a href="/mailing_lists.html">Mailing Lists</a></li> + <li><a href="/docs/">Documentation</a></li> + <li><a href="http://wiki.apache.org/lucy/";>Wiki</a></li> + <li><a href="https://issues.apache.org/jira/browse/LUCY";>Issue Tracker</a></li> + <li><a href="/version_control.html">Version Control</a></li> + </ul> + <h6>Related Projects</h6> + <ul> + <li><a href="http://lucene.apache.org/core/";>Lucene</a></li> + <li><a href="http://dezi.org/";>Dezi</a></li> + <li><a href="http://lucene.apache.org/solr/";>Solr</a></li> + <li><a href="http://lucenenet.apache.org/";>Lucene.NET</a></li> + <li><a href="http://lucene.apache.org/pylucene/";>PyLucene</a></li> + </ul> + </div> <!-- lucy-left_nav_box --> + + <div id="lucy-main_content_box" class="grid_9"> + <h2>Perl API documentation for Apache Lucy 0.5.0</h2> + +<ul> +<li><a href="Lucy.html">Lucy</a> â Apache Lucy search engine library.</li> +<li><a href="Lucy/Analysis/Analyzer.html">Lucy::Analysis::Analyzer</a> â Tokenize/modify/filter text.</li> +<li><a href="Lucy/Analysis/CaseFolder.html">Lucy::Analysis::CaseFolder</a> â Normalize case, facilitating case-insensitive search.</li> +<li><a href="Lucy/Analysis/EasyAnalyzer.html">Lucy::Analysis::EasyAnalyzer</a> â A simple analyzer chain.</li> +<li><a href="Lucy/Analysis/Inversion.html">Lucy::Analysis::Inversion</a> â A collection of Tokens.</li> +<li><a href="Lucy/Analysis/Normalizer.html">Lucy::Analysis::Normalizer</a> â Unicode normalization, case folding and accent stripping.</li> +<li><a href="Lucy/Analysis/PolyAnalyzer.html">Lucy::Analysis::PolyAnalyzer</a> â Multiple Analyzers in series.</li> +<li><a href="Lucy/Analysis/RegexTokenizer.html">Lucy::Analysis::RegexTokenizer</a> â Split a string into tokens.</li> +<li><a href="Lucy/Analysis/SnowballStemmer.html">Lucy::Analysis::SnowballStemmer</a> â Reduce related words to a shared root.</li> +<li><a href="Lucy/Analysis/SnowballStopFilter.html">Lucy::Analysis::SnowballStopFilter</a> â Suppress a âstoplistâ of common words.</li> +<li><a href="Lucy/Analysis/StandardTokenizer.html">Lucy::Analysis::StandardTokenizer</a> â Split a string into tokens.</li> +<li><a href="Lucy/Analysis/Token.html">Lucy::Analysis::Token</a> â Unit of text.</li> +<li><a href="Lucy/Docs/Cookbook.html">Lucy::Docs::Cookbook</a> â Apache Lucy recipes</li> +<li><a href="Lucy/Docs/Cookbook/CustomQuery.html">Lucy::Docs::Cookbook::CustomQuery</a> â Sample subclass of Query</li> +<li><a href="Lucy/Docs/Cookbook/CustomQueryParser.html">Lucy::Docs::Cookbook::CustomQueryParser</a> â Sample subclass of QueryParser.</li> +<li><a href="Lucy/Docs/Cookbook/FastUpdates.html">Lucy::Docs::Cookbook::FastUpdates</a> â Near real-time index updates</li> +<li><a href="Lucy/Docs/DevGuide.html">Lucy::Docs::DevGuide</a> â Quick-start guide to hacking on Apache Lucy.</li> +<li><a href="Lucy/Docs/DocIDs.html">Lucy::Docs::DocIDs</a> â Characteristics of Apache Lucy document ids.</li> +<li><a href="Lucy/Docs/FileFormat.html">Lucy::Docs::FileFormat</a> â Overview of index file format</li> +<li><a href="Lucy/Docs/FileLocking.html">Lucy::Docs::FileLocking</a> â Manage indexes on shared volumes.</li> +<li><a href="Lucy/Docs/IRTheory.html">Lucy::Docs::IRTheory</a> â Crash course in information retrieval</li> +<li><a href="Lucy/Docs/Tutorial.html">Lucy::Docs::Tutorial</a> â Step-by-step introduction to Apache Lucy.</li> +<li><a href="Lucy/Docs/Tutorial/AnalysisTutorial.html">Lucy::Docs::Tutorial::AnalysisTutorial</a> â How to choose and use Analyzers.</li> +<li><a href="Lucy/Docs/Tutorial/BeyondSimpleTutorial.html">Lucy::Docs::Tutorial::BeyondSimpleTutorial</a> â A more flexible app structure.</li> +<li><a href="Lucy/Docs/Tutorial/FieldTypeTutorial.html">Lucy::Docs::Tutorial::FieldTypeTutorial</a> â Specify per-field properties and behaviors.</li> +<li><a href="Lucy/Docs/Tutorial/HighlighterTutorial.html">Lucy::Docs::Tutorial::HighlighterTutorial</a> â Augment search results with highlighted excerpts.</li> +<li><a href="Lucy/Docs/Tutorial/QueryObjectsTutorial.html">Lucy::Docs::Tutorial::QueryObjectsTutorial</a> â Use Query objects instead of query strings.</li> +<li><a href="Lucy/Docs/Tutorial/SimpleTutorial.html">Lucy::Docs::Tutorial::SimpleTutorial</a> â Bare-bones search app.</li> +<li><a href="Lucy/Document/Doc.html">Lucy::Document::Doc</a> â A document.</li> +<li><a href="Lucy/Document/HitDoc.html">Lucy::Document::HitDoc</a> â A document read from an index.</li> +<li><a href="Lucy/Highlight/Highlighter.html">Lucy::Highlight::Highlighter</a> â Create and highlight excerpts.</li> +<li><a href="Lucy/Index/BackgroundMerger.html">Lucy::Index::BackgroundMerger</a> â Consolidate index segments in the background.</li> +<li><a href="Lucy/Index/DataReader.html">Lucy::Index::DataReader</a> â Abstract base class for reading index data.</li> +<li><a href="Lucy/Index/DataWriter.html">Lucy::Index::DataWriter</a> â Write data to an index.</li> +<li><a href="Lucy/Index/DeletionsWriter.html">Lucy::Index::DeletionsWriter</a> â Abstract base class for marking documents as deleted.</li> +<li><a href="Lucy/Index/DocReader.html">Lucy::Index::DocReader</a> â Retrieve stored documents.</li> +<li><a href="Lucy/Index/IndexManager.html">Lucy::Index::IndexManager</a> â Policies governing index updating, locking, and file deletion.</li> +<li><a href="Lucy/Index/IndexReader.html">Lucy::Index::IndexReader</a> â Read from an inverted index.</li> +<li><a href="Lucy/Index/Indexer.html">Lucy::Index::Indexer</a> â Build inverted indexes.</li> +<li><a href="Lucy/Index/Lexicon.html">Lucy::Index::Lexicon</a> â Iterator for a fieldâs terms.</li> +<li><a href="Lucy/Index/LexiconReader.html">Lucy::Index::LexiconReader</a> â Read Lexicon data.</li> +<li><a href="Lucy/Index/PolyReader.html">Lucy::Index::PolyReader</a> â Multi-segment implementation of IndexReader.</li> +<li><a href="Lucy/Index/PostingList.html">Lucy::Index::PostingList</a> â Term-Document pairings.</li> +<li><a href="Lucy/Index/PostingListReader.html">Lucy::Index::PostingListReader</a> â Read postings data.</li> +<li><a href="Lucy/Index/SegReader.html">Lucy::Index::SegReader</a> â Single-segment IndexReader.</li> +<li><a href="Lucy/Index/SegWriter.html">Lucy::Index::SegWriter</a> â Write one segment of an index.</li> +<li><a href="Lucy/Index/Segment.html">Lucy::Index::Segment</a> â Warehouse for information about one segment of an inverted index.</li> +<li><a href="Lucy/Index/Similarity.html">Lucy::Index::Similarity</a> â Judge how well a document matches a query.</li> +<li><a href="Lucy/Index/Snapshot.html">Lucy::Index::Snapshot</a> â Point-in-time index file list.</li> +<li><a href="Lucy/Object/BitVector.html">Lucy::Object::BitVector</a> â An array of bits.</li> +<li><a href="Lucy/Object/Obj.html">Lucy::Object::Obj</a> â Moved.</li> +<li><a href="Lucy/Plan/Architecture.html">Lucy::Plan::Architecture</a> â Configure major components of an index.</li> +<li><a href="Lucy/Plan/BlobType.html">Lucy::Plan::BlobType</a> â Default behaviors for binary fields.</li> +<li><a href="Lucy/Plan/FieldType.html">Lucy::Plan::FieldType</a> â Define a fieldâs behavior.</li> +<li><a href="Lucy/Plan/FullTextType.html">Lucy::Plan::FullTextType</a> â Full-text search field type.</li> +<li><a href="Lucy/Plan/Schema.html">Lucy::Plan::Schema</a> â User-created specification for an inverted index.</li> +<li><a href="Lucy/Plan/StringType.html">Lucy::Plan::StringType</a> â Non-tokenized text type.</li> +<li><a href="Lucy/Search/ANDQuery.html">Lucy::Search::ANDQuery</a> â Intersect multiple result sets.</li> +<li><a href="Lucy/Search/Collector.html">Lucy::Search::Collector</a> â Process hits.</li> +<li><a href="Lucy/Search/Collector/BitCollector.html">Lucy::Search::Collector::BitCollector</a> â Collector which records doc nums in a BitVector.</li> +<li><a href="Lucy/Search/Compiler.html">Lucy::Search::Compiler</a> â Query-to-Matcher compiler.</li> +<li><a href="Lucy/Search/Hits.html">Lucy::Search::Hits</a> â Access search results.</li> +<li><a href="Lucy/Search/IndexSearcher.html">Lucy::Search::IndexSearcher</a> â Execute searches against a single index.</li> +<li><a href="Lucy/Search/LeafQuery.html">Lucy::Search::LeafQuery</a> â Leaf node in a tree created by QueryParser.</li> +<li><a href="Lucy/Search/MatchAllQuery.html">Lucy::Search::MatchAllQuery</a> â Query which matches all documents.</li> +<li><a href="Lucy/Search/Matcher.html">Lucy::Search::Matcher</a> â Match a set of document ids.</li> +<li><a href="Lucy/Search/NOTQuery.html">Lucy::Search::NOTQuery</a> â Invert the result set of another Query.</li> +<li><a href="Lucy/Search/NoMatchQuery.html">Lucy::Search::NoMatchQuery</a> â Query which matches no documents.</li> +<li><a href="Lucy/Search/ORQuery.html">Lucy::Search::ORQuery</a> â Union multiple result sets.</li> +<li><a href="Lucy/Search/PhraseQuery.html">Lucy::Search::PhraseQuery</a> â Query matching an ordered list of terms.</li> +<li><a href="Lucy/Search/PolyQuery.html">Lucy::Search::PolyQuery</a> â Base class for composite Query objects.</li> +<li><a href="Lucy/Search/PolySearcher.html">Lucy::Search::PolySearcher</a> â Aggregate results from multiple Searchers.</li> +<li><a href="Lucy/Search/Query.html">Lucy::Search::Query</a> â A specification for a search query.</li> +<li><a href="Lucy/Search/QueryParser.html">Lucy::Search::QueryParser</a> â Transform a string into a Query object.</li> +<li><a href="Lucy/Search/RangeQuery.html">Lucy::Search::RangeQuery</a> â Match a range of values.</li> +<li><a href="Lucy/Search/RequiredOptionalQuery.html">Lucy::Search::RequiredOptionalQuery</a> â Join results for two Queries, one required, one optional.</li> +<li><a href="Lucy/Search/Searcher.html">Lucy::Search::Searcher</a> â Base class for searching collections of documents.</li> +<li><a href="Lucy/Search/SortRule.html">Lucy::Search::SortRule</a> â Element of a SortSpec.</li> +<li><a href="Lucy/Search/SortSpec.html">Lucy::Search::SortSpec</a> â Specify a custom sort order for search results.</li> +<li><a href="Lucy/Search/Span.html">Lucy::Search::Span</a> â An offset, a length, and a weight.</li> +<li><a href="Lucy/Search/TermQuery.html">Lucy::Search::TermQuery</a> â Query which matches individual terms.</li> +<li><a href="Lucy/Simple.html">Lucy::Simple</a> â Basic search engine.</li> +<li><a href="Lucy/Store/FSFolder.html">Lucy::Store::FSFolder</a> â File System implementation of Folder.</li> +<li><a href="Lucy/Store/Folder.html">Lucy::Store::Folder</a> â Abstract class representing a directory.</li> +<li><a href="Lucy/Store/Lock.html">Lucy::Store::Lock</a> â Abstract class representing an interprocess mutex lock.</li> +<li><a href="Lucy/Store/LockErr.html">Lucy::Store::LockErr</a> â Lock exception.</li> +<li><a href="Lucy/Store/LockFactory.html">Lucy::Store::LockFactory</a> â Create Locks.</li> +<li><a href="Lucy/Store/RAMFolder.html">Lucy::Store::RAMFolder</a> â In-memory Folder implementation.</li> +<li><a href="LucyX/Index/ByteBufDocReader.html">LucyX::Index::ByteBufDocReader</a> â Read a Doc as a fixed-width byte array.</li> +<li><a href="LucyX/Index/ByteBufDocWriter.html">LucyX::Index::ByteBufDocWriter</a> â Write a Doc as a fixed-width byte array.</li> +<li><a href="LucyX/Index/LongFieldSim.html">LucyX::Index::LongFieldSim</a> â Similarity optimized for long fields.</li> +<li><a href="LucyX/Index/ZlibDocReader.html">LucyX::Index::ZlibDocReader</a> â Compressed doc storage.</li> +<li><a href="LucyX/Index/ZlibDocWriter.html">LucyX::Index::ZlibDocWriter</a> â Compressed doc storage.</li> +<li><a href="LucyX/Remote/ClusterSearcher.html">LucyX::Remote::ClusterSearcher</a> â Search multiple remote indexes.</li> +<li><a href="LucyX/Remote/SearchClient.html">LucyX::Remote::SearchClient</a> â Connect to a remote SearchServer.</li> +<li><a href="LucyX/Remote/SearchServer.html">LucyX::Remote::SearchServer</a> â Make a Searcher remotely accessible.</li> +<li><a href="LucyX/Search/Filter.html">LucyX::Search::Filter</a> â Build a caching filter based on results of a Query.</li> +<li><a href="LucyX/Search/MockMatcher.html">LucyX::Search::MockMatcher</a> â Matcher with arbitrary docs and scores.</li> +<li><a href="LucyX/Search/ProximityQuery.html">LucyX::Search::ProximityQuery</a> â Query matching an ordered list of terms.</li> +</ul> + + </div> <!-- lucy-main_content_box --> + <div class="clear"></div> + + </div> <!-- lucy-main_content --> + + <div id="lucy-copyright" class="container_16"> + <p>Copyright © 2010-2015 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0</a>. + <br/> + Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The + Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their + respective owners. + </p> + </div> <!-- lucy-copyright --> + + </div> <!-- lucy-rigid_wrapper --> + + </body> +</html> Modified: websites/staging/lucy/trunk/content/docs/c/Clownfish/Blob.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/Clownfish/Blob.html (original) +++ websites/staging/lucy/trunk/content/docs/c/Clownfish/Blob.html Wed Sep 28 12:07:48 2016 @@ -283,16 +283,6 @@ than <code>other</code>, and a positive </code></pre> <p>Return a clone of the object.</p> </dd> -<dt id="func_Destroy">Destroy</dt> -<dd> -<pre><code>void -<span class="prefix">cfish_</span><strong>Blob_Destroy</strong>( - <span class="prefix">cfish_</span>Blob *<strong>self</strong> -); -</code></pre> -<p>Generic destructor. Frees the struct itself but not any complex -member elements.</p> -</dd> </dl> <h3>Inheritance</h3> <p>Clownfish::Blob is a <a href="../Clownfish/Obj.html">Clownfish::Obj</a>.</p> Modified: websites/staging/lucy/trunk/content/docs/c/Clownfish/Boolean.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/Clownfish/Boolean.html (original) +++ websites/staging/lucy/trunk/content/docs/c/Clownfish/Boolean.html Wed Sep 28 12:07:48 2016 @@ -150,16 +150,6 @@ value.</p> </code></pre> <p>Return âtrueâ for true values and âfalseâ for false values.</p> </dd> -<dt id="func_Destroy">Destroy</dt> -<dd> -<pre><code>void -<span class="prefix">cfish_</span><strong>Bool_Destroy</strong>( - <span class="prefix">cfish_</span>Boolean *<strong>self</strong> -); -</code></pre> -<p>Generic destructor. Frees the struct itself but not any complex -member elements.</p> -</dd> </dl> <h3>Inheritance</h3> <p>Clownfish::Boolean is a <a href="../Clownfish/Obj.html">Clownfish::Obj</a>.</p> Modified: websites/staging/lucy/trunk/content/docs/c/Clownfish/ByteBuf.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/Clownfish/ByteBuf.html (original) +++ websites/staging/lucy/trunk/content/docs/c/Clownfish/ByteBuf.html Wed Sep 28 12:07:48 2016 @@ -379,16 +379,6 @@ less than <code>other</code>, and a posi </code></pre> <p>Return a clone of the object.</p> </dd> -<dt id="func_Destroy">Destroy</dt> -<dd> -<pre><code>void -<span class="prefix">cfish_</span><strong>BB_Destroy</strong>( - <span class="prefix">cfish_</span>ByteBuf *<strong>self</strong> -); -</code></pre> -<p>Generic destructor. Frees the struct itself but not any complex -member elements.</p> -</dd> </dl> <h3>Inheritance</h3> <p>Clownfish::ByteBuf is a <a href="../Clownfish/Obj.html">Clownfish::Obj</a>.</p> Modified: websites/staging/lucy/trunk/content/docs/c/Clownfish/CharBuf.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/Clownfish/CharBuf.html (original) +++ websites/staging/lucy/trunk/content/docs/c/Clownfish/CharBuf.html Wed Sep 28 12:07:48 2016 @@ -305,16 +305,6 @@ allocation.</p> <p>Return the content of the CharBuf as <a href="../Clownfish/String.html">String</a> and clear the CharBuf. This is more efficient than <a href="../Clownfish/CharBuf.html#func_To_String">To_String()</a>.</p> </dd> -<dt id="func_Destroy">Destroy</dt> -<dd> -<pre><code>void -<span class="prefix">cfish_</span><strong>CB_Destroy</strong>( - <span class="prefix">cfish_</span>CharBuf *<strong>self</strong> -); -</code></pre> -<p>Generic destructor. Frees the struct itself but not any complex -member elements.</p> -</dd> </dl> <h3>Inheritance</h3> <p>Clownfish::CharBuf is a <a href="../Clownfish/Obj.html">Clownfish::Obj</a>.</p> Modified: websites/staging/lucy/trunk/content/docs/c/Clownfish/Class.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/Clownfish/Class.html (original) +++ websites/staging/lucy/trunk/content/docs/c/Clownfish/Class.html Wed Sep 28 12:07:48 2016 @@ -187,16 +187,6 @@ hierarchy.</p> </code></pre> <p>Return the number of bytes needed to hold an instance of the class.</p> </dd> -<dt id="func_Destroy">Destroy</dt> -<dd> -<pre><code>void -<span class="prefix">cfish_</span><strong>Class_Destroy</strong>( - <span class="prefix">cfish_</span>Class *<strong>self</strong> -); -</code></pre> -<p>Generic destructor. Frees the struct itself but not any complex -member elements.</p> -</dd> </dl> <h3>Inheritance</h3> <p>Clownfish::Class is a <a href="../Clownfish/Obj.html">Clownfish::Obj</a>.</p> Modified: websites/staging/lucy/trunk/content/docs/c/Clownfish/Docs/BuildingProjects.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/Clownfish/Docs/BuildingProjects.html (original) +++ websites/staging/lucy/trunk/content/docs/c/Clownfish/Docs/BuildingProjects.html Wed Sep 28 12:07:48 2016 @@ -153,7 +153,7 @@ compiled with <code>autogen/include</cod <h3>Linking</h3> <p>When linking, add the object files of the CFC-generated code created in the previous step. You must also link the shared library of the -Clownfish runtime (<code>-lcfish</code> under GCC).</p> +Clownfish runtime (<code>-lclownfish</code> under GCC).</p> </div> </div> <!-- lucy-main_content_box --> Modified: websites/staging/lucy/trunk/content/docs/c/Clownfish/Docs/WritingClasses.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/Clownfish/Docs/WritingClasses.html (original) +++ websites/staging/lucy/trunk/content/docs/c/Clownfish/Docs/WritingClasses.html Wed Sep 28 12:07:48 2016 @@ -101,7 +101,7 @@ are the parcel names. The values contain "nickname": "Pfind", "version": "v2.3.8", "prerequisites": { - "Clownfish": "v0.5.0" + "Clownfish": "v0.6.0" } } </code></pre> Modified: websites/staging/lucy/trunk/content/docs/c/Clownfish/Err.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/Clownfish/Err.html (original) +++ websites/staging/lucy/trunk/content/docs/c/Clownfish/Err.html Wed Sep 28 12:07:48 2016 @@ -164,16 +164,6 @@ Err so that it can be handled by Clownfi </code></pre> <p>Return the error message.</p> </dd> -<dt id="func_Destroy">Destroy</dt> -<dd> -<pre><code>void -<span class="prefix">cfish_</span><strong>Err_Destroy</strong>( - <span class="prefix">cfish_</span>Err *<strong>self</strong> -); -</code></pre> -<p>Generic destructor. Frees the struct itself but not any complex -member elements.</p> -</dd> </dl> <h3>Inheritance</h3> <p>Clownfish::Err is a <a href="../Clownfish/Obj.html">Clownfish::Obj</a>.</p> Modified: websites/staging/lucy/trunk/content/docs/c/Clownfish/Hash.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/Clownfish/Hash.html (original) +++ websites/staging/lucy/trunk/content/docs/c/Clownfish/Hash.html Wed Sep 28 12:07:48 2016 @@ -289,16 +289,6 @@ succeeds; otherwise NULL.</p> <code>self</code>. Keys and values are compared using their respective <code>Equals</code> methods.</p> </dd> -<dt id="func_Destroy">Destroy</dt> -<dd> -<pre><code>void -<span class="prefix">cfish_</span><strong>Hash_Destroy</strong>( - <span class="prefix">cfish_</span>Hash *<strong>self</strong> -); -</code></pre> -<p>Generic destructor. Frees the struct itself but not any complex -member elements.</p> -</dd> </dl> <h3>Inheritance</h3> <p>Clownfish::Hash is a <a href="../Clownfish/Obj.html">Clownfish::Obj</a>.</p> Modified: websites/staging/lucy/trunk/content/docs/c/Clownfish/HashIterator.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/Clownfish/HashIterator.html (original) +++ websites/staging/lucy/trunk/content/docs/c/Clownfish/HashIterator.html Wed Sep 28 12:07:48 2016 @@ -151,16 +151,6 @@ after the iterator was exhausted.</p> call this method before <a href="../Clownfish/HashIterator.html#func_Next">Next()</a> was called for the first time or after the iterator was exhausted.</p> </dd> -<dt id="func_Destroy">Destroy</dt> -<dd> -<pre><code>void -<span class="prefix">cfish_</span><strong>HashIter_Destroy</strong>( - <span class="prefix">cfish_</span>HashIterator *<strong>self</strong> -); -</code></pre> -<p>Generic destructor. Frees the struct itself but not any complex -member elements.</p> -</dd> </dl> <h3>Inheritance</h3> <p>Clownfish::HashIterator is a <a href="../Clownfish/Obj.html">Clownfish::Obj</a>.</p> Modified: websites/staging/lucy/trunk/content/docs/c/Clownfish/Obj.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/Clownfish/Obj.html (original) +++ websites/staging/lucy/trunk/content/docs/c/Clownfish/Obj.html Wed Sep 28 12:07:48 2016 @@ -180,16 +180,6 @@ another.</p> <code>self</code> is less than <code>other</code>, and a positive number if <code>self</code> is greater than <code>other</code>.</p> </dd> -<dt id="func_Destroy">Destroy</dt> -<dd> -<pre><code>void -<span class="prefix">cfish_</span><strong>Obj_Destroy</strong>( - <span class="prefix">cfish_</span>Obj *<strong>self</strong> -); -</code></pre> -<p>Generic destructor. Frees the struct itself but not any complex -member elements.</p> -</dd> <dt id="func_To_String">To_String</dt> <dd> <pre><code><span class="prefix">cfish_</span><a href="../Clownfish/String.html">String</a>* <span class="comment">// incremented</span> Modified: websites/staging/lucy/trunk/content/docs/c/Clownfish/String.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/Clownfish/String.html (original) +++ websites/staging/lucy/trunk/content/docs/c/Clownfish/String.html Wed Sep 28 12:07:48 2016 @@ -96,6 +96,38 @@ <p>Clownfish::String â Immutable string holding Unicode characters.</p> <h3>Functions</h3> <dl> +<dt id="func_utf8_valid">utf8_valid</dt> +<dd> +<pre><code>bool +<span class="prefix">cfish_</span><strong>Str_utf8_valid</strong>( + char *<strong>ptr</strong>, + size_t <strong>len</strong> +); +</code></pre> +<p>Return true if the string is valid UTF-8, false otherwise.</p> +</dd> +<dt id="func_validate_utf8">validate_utf8</dt> +<dd> +<pre><code>void +<span class="prefix">cfish_</span><strong>Str_validate_utf8</strong>( + char *<strong>text</strong>, + size_t <strong>size</strong>, + char *<strong>file</strong>, + int <strong>line</strong>, + char *<strong>func</strong> +); +</code></pre> +<p>Throws an error if the string isnât valid UTF-8.</p> +</dd> +<dt id="func_is_whitespace">is_whitespace</dt> +<dd> +<pre><code>bool +<span class="prefix">cfish_</span><strong>Str_is_whitespace</strong>( + int32_t <strong>code_point</strong> +); +</code></pre> +<p>Returns true if the code point qualifies as Unicode whitespace.</p> +</dd> <dt id="func_new_from_utf8">new_from_utf8</dt> <dd> <pre><code><span class="prefix">cfish_</span>String* <span class="comment">// incremented</span> @@ -709,16 +741,6 @@ backwards from the end. Return <code>CF </code></pre> <p>Return an iterator initialized to the end of the string.</p> </dd> -<dt id="func_Destroy">Destroy</dt> -<dd> -<pre><code>void -<span class="prefix">cfish_</span><strong>Str_Destroy</strong>( - <span class="prefix">cfish_</span>String *<strong>self</strong> -); -</code></pre> -<p>Generic destructor. Frees the struct itself but not any complex -member elements.</p> -</dd> </dl> <h3>Inheritance</h3> <p>Clownfish::String is a <a href="../Clownfish/Obj.html">Clownfish::Obj</a>.</p> Modified: websites/staging/lucy/trunk/content/docs/c/Clownfish/StringIterator.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/Clownfish/StringIterator.html (original) +++ websites/staging/lucy/trunk/content/docs/c/Clownfish/StringIterator.html Wed Sep 28 12:07:48 2016 @@ -318,16 +318,6 @@ supplied as raw UTF-8.</p> </dd> </dl> </dd> -<dt id="func_Destroy">Destroy</dt> -<dd> -<pre><code>void -<span class="prefix">cfish_</span><strong>StrIter_Destroy</strong>( - <span class="prefix">cfish_</span>StringIterator *<strong>self</strong> -); -</code></pre> -<p>Generic destructor. Frees the struct itself but not any complex -member elements.</p> -</dd> </dl> <h3>Inheritance</h3> <p>Clownfish::StringIterator is a <a href="../Clownfish/Obj.html">Clownfish::Obj</a>.</p> Modified: websites/staging/lucy/trunk/content/docs/c/Clownfish/Vector.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/Clownfish/Vector.html (original) +++ websites/staging/lucy/trunk/content/docs/c/Clownfish/Vector.html Wed Sep 28 12:07:48 2016 @@ -313,16 +313,6 @@ fewer elements â potentially none.< <p><strong>Returns:</strong> true if <code>other</code> is a Vector with the same values as <code>self</code>. Values are compared using their respective <code>Equals</code> methods.</p> </dd> -<dt id="func_Destroy">Destroy</dt> -<dd> -<pre><code>void -<span class="prefix">cfish_</span><strong>Vec_Destroy</strong>( - <span class="prefix">cfish_</span>Vector *<strong>self</strong> -); -</code></pre> -<p>Generic destructor. Frees the struct itself but not any complex -member elements.</p> -</dd> </dl> <h3>Inheritance</h3> <p>Clownfish::Vector is a <a href="../Clownfish/Obj.html">Clownfish::Obj</a>.</p> Modified: websites/staging/lucy/trunk/content/docs/c/Lucy/Object/BitVector.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/Lucy/Object/BitVector.html (original) +++ websites/staging/lucy/trunk/content/docs/c/Lucy/Object/BitVector.html Wed Sep 28 12:07:48 2016 @@ -102,7 +102,7 @@ <dd> <pre><code><span class="prefix">lucy_</span>BitVector* <span class="comment">// incremented</span> <span class="prefix">lucy_</span><strong>BitVec_new</strong>( - uint32_t <strong>capacity</strong> + size_t <strong>capacity</strong> ); </code></pre> <p>Create a new BitVector.</p> @@ -118,7 +118,7 @@ able to hold.</p> <pre><code><span class="prefix">lucy_</span>BitVector* <span class="prefix">lucy_</span><strong>BitVec_init</strong>( <span class="prefix">lucy_</span>BitVector *<strong>self</strong>, - uint32_t <strong>capacity</strong> + size_t <strong>capacity</strong> ); </code></pre> <p>Initialize a BitVector.</p> @@ -137,7 +137,7 @@ able to hold.</p> <pre><code>bool <span class="prefix">lucy_</span><strong>BitVec_Get</strong>( <span class="prefix">lucy_</span>BitVector *<strong>self</strong>, - uint32_t <strong>tick</strong> + size_t <strong>tick</strong> ); </code></pre> <p>Return true if the bit at <code>tick</code> has been set, false if it @@ -154,7 +154,7 @@ objectâs capacity).</p> <pre><code>void <span class="prefix">lucy_</span><strong>BitVec_Set</strong>( <span class="prefix">lucy_</span>BitVector *<strong>self</strong>, - uint32_t <strong>tick</strong> + size_t <strong>tick</strong> ); </code></pre> <p>Set the bit at <code>tick</code> to 1.</p> @@ -169,7 +169,7 @@ objectâs capacity).</p> <pre><code>int32_t <span class="prefix">lucy_</span><strong>BitVec_Next_Hit</strong>( <span class="prefix">lucy_</span>BitVector *<strong>self</strong>, - uint32_t <strong>tick</strong> + size_t <strong>tick</strong> ); </code></pre> <p>Returns the next set bit equal to or greater than <code>tick</code>, @@ -180,7 +180,7 @@ or -1 if no such bit exists.</p> <pre><code>void <span class="prefix">lucy_</span><strong>BitVec_Clear</strong>( <span class="prefix">lucy_</span>BitVector *<strong>self</strong>, - uint32_t <strong>tick</strong> + size_t <strong>tick</strong> ); </code></pre> <p>Clear the indicated bit. (i.e. set it to 0).</p> @@ -204,7 +204,7 @@ or -1 if no such bit exists.</p> <pre><code>void <span class="prefix">lucy_</span><strong>BitVec_Grow</strong>( <span class="prefix">lucy_</span>BitVector *<strong>self</strong>, - uint32_t <strong>capacity</strong> + size_t <strong>capacity</strong> ); </code></pre> <p>If the BitVector does not already have enough room to hold the @@ -283,7 +283,7 @@ BitVector if they were not already set.< <pre><code>void <span class="prefix">lucy_</span><strong>BitVec_Flip</strong>( <span class="prefix">lucy_</span>BitVector *<strong>self</strong>, - uint32_t <strong>tick</strong> + size_t <strong>tick</strong> ); </code></pre> <p>Invert the value of a bit.</p> @@ -298,8 +298,8 @@ BitVector if they were not already set.< <pre><code>void <span class="prefix">lucy_</span><strong>BitVec_Flip_Block</strong>( <span class="prefix">lucy_</span>BitVector *<strong>self</strong>, - uint32_t <strong>offset</strong>, - uint32_t <strong>length</strong> + size_t <strong>offset</strong>, + size_t <strong>length</strong> ); </code></pre> <p>Invert each bit within a contiguous block.</p> @@ -314,7 +314,7 @@ BitVector if they were not already set.< </dd> <dt id="func_Count">Count</dt> <dd> -<pre><code>uint32_t +<pre><code>size_t <span class="prefix">lucy_</span><strong>BitVec_Count</strong>( <span class="prefix">lucy_</span>BitVector *<strong>self</strong> ); Modified: websites/staging/lucy/trunk/content/docs/c/Lucy/Object/I32Array.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/Lucy/Object/I32Array.html (original) +++ websites/staging/lucy/trunk/content/docs/c/Lucy/Object/I32Array.html Wed Sep 28 12:07:48 2016 @@ -101,7 +101,7 @@ <pre><code><span class="prefix">lucy_</span>I32Array* <span class="comment">// incremented</span> <span class="prefix">lucy_</span><strong>I32Arr_new</strong>( int32_t *<strong>ints</strong>, - uint32_t <strong>size</strong> + size_t <strong>size</strong> ); </code></pre> </dd> @@ -109,7 +109,7 @@ <dd> <pre><code><span class="prefix">lucy_</span>I32Array* <span class="comment">// incremented</span> <span class="prefix">lucy_</span><strong>I32Arr_new_blank</strong>( - uint32_t <strong>size</strong> + size_t <strong>size</strong> ); </code></pre> </dd> @@ -119,7 +119,7 @@ <span class="prefix">lucy_</span><strong>I32Arr_init</strong>( <span class="prefix">lucy_</span>I32Array *<strong>self</strong>, int32_t *<strong>ints</strong>, - uint32_t <strong>size</strong> + size_t <strong>size</strong> ); </code></pre> </dd> @@ -131,7 +131,7 @@ <pre><code>void <span class="prefix">lucy_</span><strong>I32Arr_Set</strong>( <span class="prefix">lucy_</span>I32Array *<strong>self</strong>, - uint32_t <strong>tick</strong>, + size_t <strong>tick</strong>, int32_t <strong>value</strong> ); </code></pre> @@ -143,7 +143,7 @@ <pre><code>int32_t <span class="prefix">lucy_</span><strong>I32Arr_Get</strong>( <span class="prefix">lucy_</span>I32Array *<strong>self</strong>, - uint32_t <strong>tick</strong> + size_t <strong>tick</strong> ); </code></pre> <p>Return the value at <code>tick</code>, or throw an error if @@ -151,7 +151,7 @@ </dd> <dt id="func_Get_Size">Get_Size</dt> <dd> -<pre><code>uint32_t +<pre><code>size_t <span class="prefix">lucy_</span><strong>I32Arr_Get_Size</strong>( <span class="prefix">lucy_</span>I32Array *<strong>self</strong> ); Modified: websites/staging/lucy/trunk/content/docs/c/Lucy/Simple.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/Lucy/Simple.html (original) +++ websites/staging/lucy/trunk/content/docs/c/Lucy/Simple.html Wed Sep 28 12:07:48 2016 @@ -168,7 +168,8 @@ indicated by a two-letter ISO code. 12 <span class="prefix">lucy_</span>Simple *<strong>self</strong>, <span class="prefix">cfish_</span><a href="../Clownfish/String.html">String</a> *<strong>query</strong>, uint32_t <strong>offset</strong>, - uint32_t <strong>num_wanted</strong> + uint32_t <strong>num_wanted</strong>, + <span class="prefix">lucy_</span><a href="../Lucy/Search/SortSpec.html">SortSpec</a> *<strong>sort_spec</strong> ); </code></pre> <p>Search the index. Returns the total number of documents which match @@ -187,6 +188,10 @@ found.</p> <dd><p>The number of hits you would like to see after <code>offset</code> is taken into account.</p> </dd> +<dt>sort_spec</dt> +<dd><p>A <a href="../Lucy/Search/SortSpec.html">SortSpec</a>, which will affect how results are +ranked and returned.</p> +</dd> </dl> </dd> <dt id="func_Next">Next</dt> Modified: websites/staging/lucy/trunk/content/docs/index.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/index.html (original) +++ websites/staging/lucy/trunk/content/docs/index.html Wed Sep 28 12:07:48 2016 @@ -71,15 +71,15 @@ <h2>Perl API</h2> <ul> -<li><a href="perl/">Apache Lucy 0.5.0</a></li> -<li><a href="perl/clownfish-index.html">Apache Clownfish 0.5.0</a></li> +<li><a href="perl/">Apache Lucy 0.6.0</a></li> +<li><a href="perl/clownfish-index.html">Apache Clownfish 0.6.0</a></li> </ul> <h2>C API</h2> <ul> -<li><a href="c/lucy.html">Apache Lucy 0.5.0</a></li> -<li><a href="c/cfish.html">Apache Clownfish 0.5.0</a></li> +<li><a href="c/lucy.html">Apache Lucy 0.6.0</a></li> +<li><a href="c/cfish.html">Apache Clownfish 0.6.0</a></li> </ul> </div> <!-- lucy-main_content_box --> Modified: websites/staging/lucy/trunk/content/docs/perl/Clownfish/Docs/BuildingProjects.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/perl/Clownfish/Docs/BuildingProjects.html (original) +++ websites/staging/lucy/trunk/content/docs/perl/Clownfish/Docs/BuildingProjects.html Wed Sep 28 12:07:48 2016 @@ -217,7 +217,7 @@ name="Linking" <p>When linking, add the object files of the CFC-generated code created in the previous step. -You must also link the shared library of the Clownfish runtime (<code>-lcfish</code> under GCC).</p> +You must also link the shared library of the Clownfish runtime (<code>-lclownfish</code> under GCC).</p> </div> Modified: websites/staging/lucy/trunk/content/docs/perl/Clownfish/Docs/WritingClasses.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/perl/Clownfish/Docs/WritingClasses.html (original) +++ websites/staging/lucy/trunk/content/docs/perl/Clownfish/Docs/WritingClasses.html Wed Sep 28 12:07:48 2016 @@ -118,7 +118,7 @@ The values contain the minimum required "nickname": "Pfind", "version": "v2.3.8", "prerequisites": { - "Clownfish": "v0.5.0" + "Clownfish": "v0.6.0" } }</pre> Modified: websites/staging/lucy/trunk/content/docs/perl/Lucy.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/perl/Lucy.html (original) +++ websites/staging/lucy/trunk/content/docs/perl/Lucy.html Wed Sep 28 12:07:48 2016 @@ -81,7 +81,7 @@ name="NAME" name="VERSION" >VERSION</a></h2> -<p>0.5.0</p> +<p>0.6.0</p> <h2><a class='u' name="SYNOPSIS" Modified: websites/staging/lucy/trunk/content/docs/perl/Lucy/Simple.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/perl/Lucy/Simple.html (original) +++ websites/staging/lucy/trunk/content/docs/perl/Lucy/Simple.html Wed Sep 28 12:07:48 2016 @@ -186,6 +186,7 @@ name="search" query => $query # required offset => $offset # default: 0 num_wanted => $num_wanted # default: 10 + sort_spec => $sort_spec # default: undef );</pre> <p>Search the index. @@ -201,6 +202,10 @@ Setting offset to 20 and num_wanted to 1 assuming that 30 hits can be found.</li> <li><b>num_wanted</b> - The number of hits you would like to see after <code>offset</code> is taken into account.</li> + +<li><b>sort_spec</b> - A <a href="../Lucy/Search/SortSpec.html" class="podlinkpod" +>SortSpec</a>, +which will affect how results are ranked and returned.</li> </ul> <h3><a class='u' Modified: websites/staging/lucy/trunk/content/docs/perl/clownfish-index.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/perl/clownfish-index.html (original) +++ websites/staging/lucy/trunk/content/docs/perl/clownfish-index.html Wed Sep 28 12:07:48 2016 @@ -2,7 +2,7 @@ <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> - <title>Perl API documentation for Apache Clownfish 0.5.0</title> + <title>Perl API documentation for Apache Clownfish 0.6.0</title> <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css"> </head> @@ -68,7 +68,7 @@ </div> <!-- lucy-left_nav_box --> <div id="lucy-main_content_box" class="grid_9"> - <h2>Perl API documentation for Apache Clownfish 0.5.0</h2> + <h2>Perl API documentation for Apache Clownfish 0.6.0</h2> <ul> <li><a href="Clownfish.html">Clownfish</a> â Apache Clownfish symbiotic object system</li> Modified: websites/staging/lucy/trunk/content/docs/perl/index.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/perl/index.html (original) +++ websites/staging/lucy/trunk/content/docs/perl/index.html Wed Sep 28 12:07:48 2016 @@ -2,7 +2,7 @@ <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> - <title>Perl API documentation for Apache Lucy 0.5.0</title> + <title>Perl API documentation for Apache Lucy 0.6.0</title> <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css"> </head> @@ -68,7 +68,7 @@ </div> <!-- lucy-left_nav_box --> <div id="lucy-main_content_box" class="grid_9"> - <h2>Perl API documentation for Apache Lucy 0.5.0</h2> + <h2>Perl API documentation for Apache Lucy 0.6.0</h2> <ul> <li><a href="Lucy.html">Lucy</a> â Apache Lucy search engine library.</li>
