You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucy.apache.org by bu...@apache.org on 2016/04/04 11:23:30 UTC
svn commit: r984656 [9/9] - in /websites/staging/lucy/trunk/content: ./
docs/perl/ docs/perl/Lucy/ docs/perl/Lucy/Analysis/ docs/perl/Lucy/Docs/
docs/perl/Lucy/Docs/Cookbook/ docs/perl/Lucy/Document/
docs/perl/Lucy/Highlight/ docs/perl/Lucy/Index/ docs...
Added: websites/staging/lucy/trunk/content/docs/perl/LucyX/Remote/SearchServer.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/perl/LucyX/Remote/SearchServer.html (added)
+++ websites/staging/lucy/trunk/content/docs/perl/LucyX/Remote/SearchServer.html Mon Apr 4 09:23:29 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/perl/">Perl</a> » <a href="/docs/perl/LucyX/">LucyX</a> » <a href="/docs/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/perl/">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/perl/LucyX/Search/Filter.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/perl/LucyX/Search/Filter.html (added)
+++ websites/staging/lucy/trunk/content/docs/perl/LucyX/Search/Filter.html Mon Apr 4 09:23:29 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/perl/">Perl</a> » <a href="/docs/perl/LucyX/">LucyX</a> » <a href="/docs/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/perl/">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/perl/LucyX/Search/MockMatcher.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/perl/LucyX/Search/MockMatcher.html (added)
+++ websites/staging/lucy/trunk/content/docs/perl/LucyX/Search/MockMatcher.html Mon Apr 4 09:23:29 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/perl/">Perl</a> » <a href="/docs/perl/LucyX/">LucyX</a> » <a href="/docs/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/perl/">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/perl/LucyX/Search/ProximityQuery.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/perl/LucyX/Search/ProximityQuery.html (added)
+++ websites/staging/lucy/trunk/content/docs/perl/LucyX/Search/ProximityQuery.html Mon Apr 4 09:23:29 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/perl/">Perl</a> » <a href="/docs/perl/LucyX/">LucyX</a> » <a href="/docs/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/perl/">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>