Modified:
websites/staging/lucy/trunk/content/docs/test/Lucy/Search/ANDQuery.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Search/ANDQuery.html
(original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Search/ANDQuery.html Fri
Feb 26 12:52:42 2016
@@ -71,15 +71,15 @@
<div>
<a name='___top' class='dummyTopAnchor' ></a>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="NAME"
->NAME</a></h1>
+>NAME</a></h2>
<p>Lucy::Search::ANDQuery - Intersect multiple result sets.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="SYNOPSIS"
->SYNOPSIS</a></h1>
+>SYNOPSIS</a></h2>
<pre> my $foo_and_bar_query = Lucy::Search::ANDQuery->new(
children => [ $foo_query, $bar_query ],
@@ -87,42 +87,59 @@ name="SYNOPSIS"
my $hits = $searcher->hits( query => $foo_and_bar_query );
...</pre>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="DESCRIPTION"
->DESCRIPTION</a></h1>
+>DESCRIPTION</a></h2>
<p>ANDQuery is a composite <a href="../../Lucy/Search/Query.html"
class="podlinkpod"
>Query</a> which matches only when all of its children match, so its result
>set is the intersection of their result sets. Documents which match receive a
>summed score.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="CONSTRUCTORS"
->CONSTRUCTORS</a></h1>
+>CONSTRUCTORS</a></h2>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="new(_[labeled_params]_)"
->new( <i>[labeled params]</i> )</a></h2>
+<h3><a class='u'
+name="new"
+>new</a></h3>
<pre> my $foo_and_bar_query = Lucy::Search::ANDQuery->new(
children => [ $foo_query, $bar_query ],
);</pre>
+<p>Create a new ANDQuery.</p>
+
<ul>
<li><b>children</b> - An array of child Queries.</li>
</ul>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="METHODS"
->METHODS</a></h1>
+>METHODS</a></h2>
+
+<h3><a class='u'
+name="make_compiler"
+>make_compiler</a></h3>
+
+<pre> my $retval = $and_query->make_compiler(
+ searcher => $searcher # required
+ boost => $boost # required
+ subordinate => $subordinate # default: false
+ );</pre>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="add_child(query)"
->add_child(query)</a></h2>
+<p>Abstract factory method returning a Compiler derived from this Query.</p>
-<p>Add a child Query node.</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>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="INHERITANCE"
->INHERITANCE</a></h1>
+>INHERITANCE</a></h2>
<p>Lucy::Search::ANDQuery isa <a href="../../Lucy/Search/PolyQuery.html"
class="podlinkpod"
>Lucy::Search::PolyQuery</a> isa <a href="../../Lucy/Search/Query.html"
>class="podlinkpod"
Modified:
websites/staging/lucy/trunk/content/docs/test/Lucy/Search/Collector.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Search/Collector.html
(original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Search/Collector.html
Fri Feb 26 12:52:42 2016
@@ -71,34 +71,35 @@
<div>
<a name='___top' class='dummyTopAnchor' ></a>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="NAME"
->NAME</a></h1>
+>NAME</a></h2>
<p>Lucy::Search::Collector - Process hits.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="SYNOPSIS"
->SYNOPSIS</a></h1>
+>SYNOPSIS</a></h2>
<pre> # Abstract base class.</pre>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="DESCRIPTION"
->DESCRIPTION</a></h1>
+>DESCRIPTION</a></h2>
<p>A Collector decides what to do with the hits that a <a
href="../../Lucy/Search/Matcher.html" class="podlinkpod"
->Matcher</a> iterates through, based on how the abstract collect() method is
implemented.</p>
+>Matcher</a> iterates through, based on how the abstract <a href="#collect"
class="podlinkpod"
+>collect()</a> method is implemented.</p>
-<p>Collectors operate on individual segments, but must operate within the
context of a larger collection. Each time the collector moves to a new segment,
set_reader(), set_base() and set_matcher() will be called, and the collector
must take the updated information into account.</p>
+<p>Collectors operate on individual segments, but must operate within the
context of a larger collection. Each time the collector moves to a new segment,
Set_Reader(), Set_Base() and Set_Matcher() will be called, and the collector
must take the updated information into account.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="CONSTRUCTORS"
->CONSTRUCTORS</a></h1>
+>CONSTRUCTORS</a></h2>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="new()"
->new()</a></h2>
+<h3><a class='u'
+name="new"
+>new</a></h3>
<pre> package MyCollector;
use base qw( Lucy::Search::Collector );
@@ -112,13 +113,15 @@ name="new()"
<p>Abstract constructor. Takes no arguments.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="ABSTRACT_METHODS"
->ABSTRACT METHODS</a></h1>
+>ABSTRACT METHODS</a></h2>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="collect(doc_id)"
->collect(doc_id)</a></h2>
+<h3><a class='u'
+name="collect"
+>collect</a></h3>
+
+<pre> $collector->collect($doc_id);</pre>
<p>Do something with a doc id. (For instance, keep track of the docs with the
ten highest scores.)</p>
@@ -126,9 +129,9 @@ name="collect(doc_id)"
<li><b>doc_id</b> - A segment document id.</li>
</ul>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="INHERITANCE"
->INHERITANCE</a></h1>
+>INHERITANCE</a></h2>
<p>Lucy::Search::Collector isa Clownfish::Obj.</p>
Modified:
websites/staging/lucy/trunk/content/docs/test/Lucy/Search/Collector/BitCollector.html
==============================================================================
---
websites/staging/lucy/trunk/content/docs/test/Lucy/Search/Collector/BitCollector.html
(original)
+++
websites/staging/lucy/trunk/content/docs/test/Lucy/Search/Collector/BitCollector.html
Fri Feb 26 12:52:42 2016
@@ -71,15 +71,15 @@
<div>
<a name='___top' class='dummyTopAnchor' ></a>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="NAME"
->NAME</a></h1>
+>NAME</a></h2>
<p>Lucy::Search::Collector::BitCollector - Collector which records doc nums in
a BitVector.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="SYNOPSIS"
->SYNOPSIS</a></h1>
+>SYNOPSIS</a></h2>
<pre> my $bit_vec = Lucy::Object::BitVector->new(
capacity => $searcher->doc_max + 1,
@@ -92,42 +92,46 @@ name="SYNOPSIS"
query => $query,
);</pre>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="DESCRIPTION"
->DESCRIPTION</a></h1>
+>DESCRIPTION</a></h2>
<p>BitCollector is a Collector which saves matching document ids in a <a
href="../../../Lucy/Object/BitVector.html" class="podlinkpod"
>BitVector</a>. It is useful for recording the entire set of documents which
>matches a query.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="CONSTRUCTORS"
->CONSTRUCTORS</a></h1>
+>CONSTRUCTORS</a></h2>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="new(_[labeled_params]_)"
->new( <i>[labeled params]</i> )</a></h2>
+<h3><a class='u'
+name="new"
+>new</a></h3>
<pre> my $bit_collector = Lucy::Search::Collector::BitCollector->new(
bit_vector => $bit_vec, # required
);</pre>
+<p>Create a new BitCollector.</p>
+
<ul>
<li><b>bit_vector</b> - A Lucy::Object::BitVector.</li>
</ul>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="METHODS"
->METHODS</a></h1>
+>METHODS</a></h2>
+
+<h3><a class='u'
+name="collect"
+>collect</a></h3>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="collect(doc_id)"
->collect(doc_id)</a></h2>
+<pre> $bit_collector->collect($doc_id);</pre>
-<p>Set bit in the object's BitVector for the supplied doc id.</p>
+<p>Set bit in the object’s BitVector for the supplied doc id.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="INHERITANCE"
->INHERITANCE</a></h1>
+>INHERITANCE</a></h2>
<p>Lucy::Search::Collector::BitCollector isa <a
href="../../../Lucy/Search/Collector.html" class="podlinkpod"
>Lucy::Search::Collector</a> isa Clownfish::Obj.</p>
Modified:
websites/staging/lucy/trunk/content/docs/test/Lucy/Search/Compiler.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Search/Compiler.html
(original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Search/Compiler.html Fri
Feb 26 12:52:42 2016
@@ -71,15 +71,15 @@
<div>
<a name='___top' class='dummyTopAnchor' ></a>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="NAME"
->NAME</a></h1>
+>NAME</a></h2>
<p>Lucy::Search::Compiler - Query-to-Matcher compiler.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="SYNOPSIS"
->SYNOPSIS</a></h1>
+>SYNOPSIS</a></h2>
<pre> # (Compiler is an abstract base class.)
package MyCompiler;
@@ -90,33 +90,39 @@ name="SYNOPSIS"
return MyMatcher->new( @_, compiler => $self );
}</pre>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="DESCRIPTION"
->DESCRIPTION</a></h1>
+>DESCRIPTION</a></h2>
<p>The purpose of the Compiler class is to take a specification in the form of
a <a href="../../Lucy/Search/Query.html" class="podlinkpod"
>Query</a> object and compile a <a href="../../Lucy/Search/Matcher.html"
>class="podlinkpod"
>Matcher</a> object that can do real work.</p>
-<p>The simplest Compiler subclasses -- such as those associated with
constant-scoring Query types -- might simply implement a make_matcher() method
which passes along information verbatim from the Query to the Matcher's
constructor.</p>
+<p>The simplest Compiler subclasses – such as those associated with
constant-scoring Query types – might simply implement a <a
href="#make_matcher" class="podlinkpod"
+>make_matcher()</a> method which passes along information verbatim from the
Query to the Matcher’s constructor.</p>
-<p>However it is common for the Compiler to perform some calculations which
affect it's "weight" -- a floating point multiplier that the
Matcher will factor into each document's score. If that is the case, then
the Compiler subclass may wish to override get_weight(),
sum_of_squared_weights(), and apply_norm_factor().</p>
+<p>However it is common for the Compiler to perform some calculations which
affect it’s “weight” – a floating point multiplier that
the Matcher will factor into each document’s score. If that is the case,
then the Compiler subclass may wish to override <a href="#get_weight"
class="podlinkpod"
+>get_weight()</a>, <a href="#sum_of_squared_weights" class="podlinkpod"
+>sum_of_squared_weights()</a>, and <a href="#apply_norm_factor"
class="podlinkpod"
+>apply_norm_factor()</a>.</p>
<p>Compiling a Matcher is a two stage process.</p>
-<p>The first stage takes place during the Compiler's construction, which
is where the Query object meets a <a href="../../Lucy/Search/Searcher.html"
class="podlinkpod"
->Searcher</a> object for the first time. Searchers operate on a specific
document collection and they can tell you certain statistical information about
the collection -- such as how many total documents are in the collection, or
how many documents in the collection a particular term is present in.
Lucy's core Compiler classes plug this information into the classic TF/IDF
weighting algorithm to adjust the Compiler's weight; custom subclasses
might do something similar.</p>
+<p>The first stage takes place during the Compiler’s construction, which
is where the Query object meets a <a href="../../Lucy/Search/Searcher.html"
class="podlinkpod"
+>Searcher</a> object for the first time. Searchers operate on a specific
document collection and they can tell you certain statistical information about
the collection – such as how many total documents are in the collection,
or how many documents in the collection a particular term is present in.
Lucy’s core Compiler classes plug this information into the classic
TF/IDF weighting algorithm to adjust the Compiler’s weight; custom
subclasses might do something similar.</p>
-<p>The second stage of compilation is make_matcher(), method, which is where
the Compiler meets a <a href="../../Lucy/Index/SegReader.html"
class="podlinkpod"
->SegReader</a> object. SegReaders are associated with a single segment within
a single index on a single machine, and are thus lower-level than Searchers,
which may represent a document collection spread out over a search cluster
(comprising several indexes and many segments). The Compiler object can use new
information supplied by the SegReader -- such as whether a term is missing from
the local index even though it is present within the larger collection
represented by the Searcher -- when figuring out what to feed to the
Matchers's constructor, or whether make_matcher() should return a Matcher
at all.</p>
+<p>The second stage of compilation is <a href="#make_matcher"
class="podlinkpod"
+>make_matcher()</a>, method, which is where the Compiler meets a <a
href="../../Lucy/Index/SegReader.html" class="podlinkpod"
+>SegReader</a> object. SegReaders are associated with a single segment within
a single index on a single machine, and are thus lower-level than Searchers,
which may represent a document collection spread out over a search cluster
(comprising several indexes and many segments). The Compiler object can use new
information supplied by the SegReader – such as whether a term is missing
from the local index even though it is present within the larger collection
represented by the Searcher – when figuring out what to feed to the
Matchers’s constructor, or whether <a href="#make_matcher"
class="podlinkpod"
+>make_matcher()</a> should return a Matcher at all.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="CONSTRUCTORS"
->CONSTRUCTORS</a></h1>
+>CONSTRUCTORS</a></h2>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="new(_[labeled_params]_)"
->new( <i>[labeled params]</i> )</a></h2>
+<h3><a class='u'
+name="new"
+>new</a></h3>
<pre> my $compiler = MyCompiler->SUPER::new(
parent => $my_query,
@@ -137,95 +143,100 @@ name="new(_[labeled_params]_)"
<li><b>boost</b> - An arbitrary scoring multiplier. Defaults to the boost of
the parent Query.</li>
</ul>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="ABSTRACT_METHODS"
->ABSTRACT METHODS</a></h1>
+>ABSTRACT METHODS</a></h2>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="make_matcher(_[labeled_params]_)"
->make_matcher( <i>[labeled params]</i> )</a></h2>
+<h3><a class='u'
+name="make_matcher"
+>make_matcher</a></h3>
+
+<pre> my $retval = $compiler->make_matcher(
+ reader => $reader # required
+ need_score => $need_score # required
+ );</pre>
<p>Factory method returning a Matcher.</p>
<ul>
<li><b>reader</b> - A SegReader.</li>
-<li><b>need_score</b> - Indicate whether the Matcher must implement
score().</li>
+<li><b>need_score</b> - Indicate whether the Matcher must implement <a
href="../../Lucy/Search/Matcher.html#score" class="podlinkpod"
+>score()</a>.</li>
</ul>
<p>Returns: a Matcher, or undef if the Matcher would have matched no
documents.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="METHODS"
->METHODS</a></h1>
+>METHODS</a></h2>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_weight()"
->get_weight()</a></h2>
+<h3><a class='u'
+name="get_weight"
+>get_weight</a></h3>
-<p>Return the Compiler's numerical weight, a scoring multiplier. By
default, returns the object's boost.</p>
+<pre> my $retval = $compiler->get_weight();</pre>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="sum_of_squared_weights()"
->sum_of_squared_weights()</a></h2>
+<p>Return the Compiler’s numerical weight, a scoring multiplier. By
default, returns the object’s boost.</p>
-<p>Compute and return a raw weighting factor. (This quantity is used by
normalize()). By default, simply returns 1.0.</p>
+<h3><a class='u'
+name="get_similarity"
+>get_similarity</a></h3>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="apply_norm_factor(factor)"
->apply_norm_factor(factor)</a></h2>
+<pre> my $retval = $compiler->get_similarity();</pre>
-<p>Apply a floating point normalization multiplier. For a TermCompiler, this
involves multiplying its own weight by the supplied factor; combining classes
such as ORCompiler would apply the factor recursively to their children.</p>
+<p>Accessor for the Compiler’s Similarity object.</p>
-<p>The default implementation is a no-op; subclasses may wish to multiply
their internal weight by the supplied factor.</p>
+<h3><a class='u'
+name="get_parent"
+>get_parent</a></h3>
-<ul>
-<li><b>factor</b> - The multiplier.</li>
-</ul>
+<pre> my $retval = $compiler->get_parent();</pre>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="normalize()"
->normalize()</a></h2>
+<p>Accessor for the Compiler’s parent Query object.</p>
-<p>Take a newly minted Compiler object and apply query-specific normalization
factors. Should be invoked by Query subclasses during make_compiler() for
top-level nodes.</p>
+<h3><a class='u'
+name="sum_of_squared_weights"
+>sum_of_squared_weights</a></h3>
-<p>For a TermQuery, the scoring formula is approximately:</p>
+<pre> my $retval = $compiler->sum_of_squared_weights();</pre>
-<pre> (tf_d * idf_t / norm_d) * (tf_q * idf_t / norm_q)</pre>
+<p>Compute and return a raw weighting factor. (This quantity is used by <a
href="#normalize" class="podlinkpod"
+>normalize()</a>). By default, simply returns 1.0.</p>
-<p>normalize() is theoretically concerned with applying the second half of
that formula to a the Compiler's weight. What actually happens depends on
how the Compiler and Similarity methods called internally are implemented.</p>
+<h3><a class='u'
+name="apply_norm_factor"
+>apply_norm_factor</a></h3>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_parent()"
->get_parent()</a></h2>
+<pre> $compiler->apply_norm_factor($factor);</pre>
-<p>Accessor for the Compiler's parent Query object.</p>
+<p>Apply a floating point normalization multiplier. For a TermCompiler, this
involves multiplying its own weight by the supplied factor; combining classes
such as ORCompiler would apply the factor recursively to their children.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_similarity()"
->get_similarity()</a></h2>
+<p>The default implementation is a no-op; subclasses may wish to multiply
their internal weight by the supplied factor.</p>
-<p>Accessor for the Compiler's Similarity object.</p>
+<ul>
+<li><b>factor</b> - The multiplier.</li>
+</ul>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="highlight_spans(_[labeled_params]_)"
->highlight_spans( <i>[labeled params]</i> )</a></h2>
+<h3><a class='u'
+name="normalize"
+>normalize</a></h3>
-<p>Return an array of Span objects, indicating where in the given field the
text that matches the parent Query occurs and how well each snippet matches.
The Span's offset and length are measured in Unicode code points.</p>
+<pre> $compiler->normalize();</pre>
-<p>The default implementation returns an empty array.</p>
+<p>Take a newly minted Compiler object and apply query-specific normalization
factors. Should be invoked by Query subclasses during <a
href="../../Lucy/Search/Query.html#make_compiler" class="podlinkpod"
+>make_compiler()</a> for top-level nodes.</p>
-<ul>
-<li><b>searcher</b> - A Searcher.</li>
+<p>For a TermQuery, the scoring formula is approximately:</p>
-<li><b>doc_vec</b> - A DocVector.</li>
+<pre> (tf_d * idf_t / norm_d) * (tf_q * idf_t / norm_q)</pre>
-<li><b>field</b> - The name of the field.</li>
-</ul>
+<p><a href="#normalize" class="podlinkpod"
+>normalize()</a> is theoretically concerned with applying the second half of
that formula to a the Compiler’s weight. What actually happens depends on
how the Compiler and Similarity methods called internally are implemented.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="INHERITANCE"
->INHERITANCE</a></h1>
+>INHERITANCE</a></h2>
<p>Lucy::Search::Compiler isa <a href="../../Lucy/Search/Query.html"
class="podlinkpod"
>Lucy::Search::Query</a> isa Clownfish::Obj.</p>
Modified: websites/staging/lucy/trunk/content/docs/test/Lucy/Search/Hits.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Search/Hits.html
(original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Search/Hits.html Fri Feb
26 12:52:42 2016
@@ -71,15 +71,15 @@
<div>
<a name='___top' class='dummyTopAnchor' ></a>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="NAME"
->NAME</a></h1>
+>NAME</a></h2>
<p>Lucy::Search::Hits - Access search results.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="SYNOPSIS"
->SYNOPSIS</a></h1>
+>SYNOPSIS</a></h2>
<pre> my $hits = $searcher->hits(
query => $query,
@@ -90,31 +90,35 @@ name="SYNOPSIS"
print "<p>$hit->{title} <em>" .
$hit->get_score . "</em></p>\n";
}</pre>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="DESCRIPTION"
->DESCRIPTION</a></h1>
+>DESCRIPTION</a></h2>
<p>Hits objects are iterators used to access the results of a search.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="METHODS"
->METHODS</a></h1>
+>METHODS</a></h2>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="next()"
->next()</a></h2>
+<h3><a class='u'
+name="next"
+>next</a></h3>
+
+<pre> my $retval = $hits->next();</pre>
<p>Return the next hit, or undef when the iterator is exhausted.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="total_hits()"
->total_hits()</a></h2>
+<h3><a class='u'
+name="total_hits"
+>total_hits</a></h3>
+
+<pre> my $retval = $hits->total_hits();</pre>
<p>Return the total number of documents which matched the Query used to
produce the Hits object. Note that this is the total number of matches, not
just the number of matches represented by the Hits iterator.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="INHERITANCE"
->INHERITANCE</a></h1>
+>INHERITANCE</a></h2>
<p>Lucy::Search::Hits isa Clownfish::Obj.</p>
Modified:
websites/staging/lucy/trunk/content/docs/test/Lucy/Search/IndexSearcher.html
==============================================================================
---
websites/staging/lucy/trunk/content/docs/test/Lucy/Search/IndexSearcher.html
(original)
+++
websites/staging/lucy/trunk/content/docs/test/Lucy/Search/IndexSearcher.html
Fri Feb 26 12:52:42 2016
@@ -71,15 +71,15 @@
<div>
<a name='___top' class='dummyTopAnchor' ></a>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="NAME"
->NAME</a></h1>
+>NAME</a></h2>
<p>Lucy::Search::IndexSearcher - Execute searches against a single index.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="SYNOPSIS"
->SYNOPSIS</a></h1>
+>SYNOPSIS</a></h2>
<pre> my $searcher = Lucy::Search::IndexSearcher->new(
index => '/path/to/index'
@@ -90,9 +90,9 @@ name="SYNOPSIS"
num_wanted => 100,
);</pre>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="DESCRIPTION"
->DESCRIPTION</a></h1>
+>DESCRIPTION</a></h2>
<p>Use the IndexSearcher class to perform search queries against an index.
(For searching multiple indexes at once, see <a
href="../../Lucy/Search/PolySearcher.html" class="podlinkpod"
>PolySearcher</a>).</p>
@@ -100,46 +100,61 @@ name="DESCRIPTION"
<p>IndexSearchers operate against a single point-in-time view or <a
href="../../Lucy/Index/Snapshot.html" class="podlinkpod"
>Snapshot</a> of the index. If an index is modified, a new IndexSearcher must
>be opened to access the changes.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="CONSTRUCTORS"
->CONSTRUCTORS</a></h1>
+>CONSTRUCTORS</a></h2>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="new(_[labeled_params]_)"
->new( <i>[labeled params]</i> )</a></h2>
+<h3><a class='u'
+name="new"
+>new</a></h3>
<pre> my $searcher = Lucy::Search::IndexSearcher->new(
index => '/path/to/index'
);</pre>
+<p>Create a new IndexSearcher.</p>
+
<ul>
<li><b>index</b> - Either a string filepath, a Folder, or an IndexReader.</li>
</ul>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="METHODS"
->METHODS</a></h1>
+>METHODS</a></h2>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="hits(_[labeled_params]_)"
->hits( <i>[labeled params]</i> )</a></h2>
+<h3><a class='u'
+name="doc_max"
+>doc_max</a></h3>
-<p>Return a Hits object containing the top results.</p>
+<pre> my $retval = $index_searcher->doc_max();</pre>
-<ul>
-<li><b>query</b> - Either a Query object or a query string.</li>
+<p>Return the maximum number of docs in the collection represented by the
Searcher, which is also the highest possible internal doc id. Documents which
have been marked as deleted but not yet purged are included in this count.</p>
-<li><b>offset</b> - The number of most-relevant hits to discard, typically
used when "paging" through hits N at a time. Setting
<code>offset</code> to 20 and <code>num_wanted</code> to 10 retrieves hits
21-30, assuming that 30 hits can be found.</li>
+<h3><a class='u'
+name="doc_freq"
+>doc_freq</a></h3>
+
+<pre> my $retval = $index_searcher->doc_freq(
+ field => $field # required
+ term => $term # required
+ );</pre>
-<li><b>num_wanted</b> - The number of hits you would like to see after
<code>offset</code> is taken into account.</li>
+<p>Return the number of documents which contain the term in the given
field.</p>
-<li><b>sort_spec</b> - A <a href="../../Lucy/Search/SortSpec.html"
class="podlinkpod"
->Lucy::Search::SortSpec</a>, which will affect how results are ranked and
returned.</li>
+<ul>
+<li><b>field</b> - Field name.</li>
+
+<li><b>term</b> - The term to look up.</li>
</ul>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="collect(_[labeled_params]_)"
->collect( <i>[labeled params]</i> )</a></h2>
+<h3><a class='u'
+name="collect"
+>collect</a></h3>
+
+<pre> $index_searcher->collect(
+ query => $query # required
+ collector => $collector # required
+ );</pre>
<p>Iterate over hits, feeding them into a <a
href="../../Lucy/Search/Collector.html" class="podlinkpod"
>Collector</a>.</p>
@@ -150,27 +165,11 @@ name="collect(_[labeled_params]_)"
<li><b>collector</b> - A Collector.</li>
</ul>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="doc_max()"
->doc_max()</a></h2>
-
-<p>Return the maximum number of docs in the collection represented by the
Searcher, which is also the highest possible internal doc id. Documents which
have been marked as deleted but not yet purged are included in this count.</p>
-
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="doc_freq(_[labeled_params]_)"
->doc_freq( <i>[labeled params]</i> )</a></h2>
-
-<p>Return the number of documents which contain the term in the given
field.</p>
+<h3><a class='u'
+name="fetch_doc"
+>fetch_doc</a></h3>
-<ul>
-<li><b>field</b> - Field name.</li>
-
-<li><b>term</b> - The term to look up.</li>
-</ul>
-
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="fetch_doc(doc_id)"
->fetch_doc(doc_id)</a></h2>
+<pre> my $retval = $index_searcher->fetch_doc($doc_id);</pre>
<p>Retrieve a document. Throws an error if the doc id is out of range.</p>
@@ -178,21 +177,17 @@ name="fetch_doc(doc_id)"
<li><b>doc_id</b> - A document id.</li>
</ul>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_schema()"
->get_schema()</a></h2>
-
-<p>Accessor for the object's <code>schema</code> member.</p>
+<h3><a class='u'
+name="get_reader"
+>get_reader</a></h3>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_reader()"
->get_reader()</a></h2>
+<pre> my $retval = $index_searcher->get_reader();</pre>
-<p>Accessor for the object's <code>reader</code> member.</p>
+<p>Accessor for the object’s <code>reader</code> member.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="INHERITANCE"
->INHERITANCE</a></h1>
+>INHERITANCE</a></h2>
<p>Lucy::Search::IndexSearcher isa <a href="../../Lucy/Search/Searcher.html"
class="podlinkpod"
>Lucy::Search::Searcher</a> isa Clownfish::Obj.</p>
Modified:
websites/staging/lucy/trunk/content/docs/test/Lucy/Search/LeafQuery.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Search/LeafQuery.html
(original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Search/LeafQuery.html
Fri Feb 26 12:52:42 2016
@@ -71,15 +71,15 @@
<div>
<a name='___top' class='dummyTopAnchor' ></a>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="NAME"
->NAME</a></h1>
+>NAME</a></h2>
<p>Lucy::Search::LeafQuery - Leaf node in a tree created by QueryParser.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="SYNOPSIS"
->SYNOPSIS</a></h1>
+>SYNOPSIS</a></h2>
<pre> package MyQueryParser;
use base qw( Lucy::Search::QueryParser );
@@ -97,53 +97,72 @@ name="SYNOPSIS"
}
}</pre>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="DESCRIPTION"
->DESCRIPTION</a></h1>
+>DESCRIPTION</a></h2>
<p>LeafQuery objects serve as leaf nodes in the tree structure generated by <a
href="../../Lucy/Search/QueryParser.html" class="podlinkpod"
->QueryParser</a>'s tree() method. Ultimately, they must be transformed,
typically into either <a href="../../Lucy/Search/TermQuery.html"
class="podlinkpod"
+>QueryParser</a>’s <a href="../../Lucy/Search/QueryParser.html#tree"
class="podlinkpod"
+>tree()</a> method. Ultimately, they must be transformed, typically into
either <a href="../../Lucy/Search/TermQuery.html" class="podlinkpod"
>TermQuery</a> or <a href="../../Lucy/Search/PhraseQuery.html"
>class="podlinkpod"
>PhraseQuery</a> objects, as attempting to search a LeafQuery causes an
>error.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="CONSTRUCTORS"
->CONSTRUCTORS</a></h1>
+>CONSTRUCTORS</a></h2>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="new(_[labeled_params]_)"
->new( <i>[labeled params]</i> )</a></h2>
+<h3><a class='u'
+name="new"
+>new</a></h3>
<pre> my $leaf_query = Lucy::Search::LeafQuery->new(
text => '"three blind mice"', # required
field => 'content', # default: undef
);</pre>
+<p>Create a new LeafQuery.</p>
+
<ul>
<li><b>field</b> - Optional field name.</li>
<li><b>text</b> - Raw query text.</li>
</ul>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="METHODS"
->METHODS</a></h1>
+>METHODS</a></h2>
+
+<h3><a class='u'
+name="get_field"
+>get_field</a></h3>
+
+<pre> my $retval = $leaf_query->get_field();</pre>
+
+<p>Accessor for object’s <code>field</code> attribute.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_field()"
->get_field()</a></h2>
+<h3><a class='u'
+name="get_text"
+>get_text</a></h3>
-<p>Accessor for object's <code>field</code> attribute.</p>
+<pre> my $retval = $leaf_query->get_text();</pre>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_text()"
->get_text()</a></h2>
+<p>Accessor for object’s <code>text</code> attribute.</p>
+
+<h3><a class='u'
+name="make_compiler"
+>make_compiler</a></h3>
+
+<pre> my $retval = $leaf_query->make_compiler(
+ searcher => $searcher # required
+ boost => $boost # required
+ subordinate => $subordinate # default: false
+ );</pre>
-<p>Accessor for object's <code>text</code> attribute.</p>
+<p>Throws an error.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="INHERITANCE"
->INHERITANCE</a></h1>
+>INHERITANCE</a></h2>
<p>Lucy::Search::LeafQuery isa <a href="../../Lucy/Search/Query.html"
class="podlinkpod"
>Lucy::Search::Query</a> isa Clownfish::Obj.</p>
Modified:
websites/staging/lucy/trunk/content/docs/test/Lucy/Search/MatchAllQuery.html
==============================================================================
---
websites/staging/lucy/trunk/content/docs/test/Lucy/Search/MatchAllQuery.html
(original)
+++
websites/staging/lucy/trunk/content/docs/test/Lucy/Search/MatchAllQuery.html
Fri Feb 26 12:52:42 2016
@@ -71,36 +71,61 @@
<div>
<a name='___top' class='dummyTopAnchor' ></a>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="NAME"
->NAME</a></h1>
+>NAME</a></h2>
<p>Lucy::Search::MatchAllQuery - Query which matches all documents.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="DESCRIPTION"
->DESCRIPTION</a></h1>
+>DESCRIPTION</a></h2>
<p>MatchAllQuery is a utility class which matches all documents.
Each match is assigned a score of 0.0,
so that in composite queries,
any document which matches against another part of the query will be ranked
higher than a document which matches only via the MatchAllQuery.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="CONSTRUCTORS"
->CONSTRUCTORS</a></h1>
+>CONSTRUCTORS</a></h2>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="new()"
->new()</a></h2>
+<h3><a class='u'
+name="new"
+>new</a></h3>
<pre> my $match_all_query = Lucy::Search::MatchAllQuery->new;</pre>
<p>Constructor. Takes no arguments.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
+name="METHODS"
+>METHODS</a></h2>
+
+<h3><a class='u'
+name="make_compiler"
+>make_compiler</a></h3>
+
+<pre> my $retval = $match_all_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></h1>
+>INHERITANCE</a></h2>
<p>Lucy::Search::MatchAllQuery isa <a href="../../Lucy/Search/Query.html"
class="podlinkpod"
>Lucy::Search::Query</a> isa Clownfish::Obj.</p>
Modified: websites/staging/lucy/trunk/content/docs/test/Lucy/Search/Matcher.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Search/Matcher.html
(original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Search/Matcher.html Fri
Feb 26 12:52:42 2016
@@ -71,71 +71,84 @@
<div>
<a name='___top' class='dummyTopAnchor' ></a>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="NAME"
->NAME</a></h1>
+>NAME</a></h2>
<p>Lucy::Search::Matcher - Match a set of document ids.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="SYNOPSIS"
->SYNOPSIS</a></h1>
+>SYNOPSIS</a></h2>
<pre> # abstract base class</pre>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="DESCRIPTION"
->DESCRIPTION</a></h1>
+>DESCRIPTION</a></h2>
-<p>A Matcher iterates over a set of ascending document ids. Some Matchers
implement score() and can assign relevance scores to the docs that they match.
Other implementations may be match-only.</p>
+<p>A Matcher iterates over a set of ascending document ids. Some Matchers
implement <a href="#score" class="podlinkpod"
+>score()</a> and can assign relevance scores to the docs that they match.
Other implementations may be match-only.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="CONSTRUCTORS"
->CONSTRUCTORS</a></h1>
+>CONSTRUCTORS</a></h2>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="new()"
->new()</a></h2>
+<h3><a class='u'
+name="new"
+>new</a></h3>
<pre> my $matcher = MyMatcher->SUPER::new;</pre>
<p>Abstract constructor.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="ABSTRACT_METHODS"
->ABSTRACT METHODS</a></h1>
+>ABSTRACT METHODS</a></h2>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="next()"
->next()</a></h2>
+<h3><a class='u'
+name="next"
+>next</a></h3>
+
+<pre> my $retval = $matcher->next();</pre>
<p>Proceed to the next doc id.</p>
<p>Returns: A positive doc id, or 0 once the iterator is exhausted.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_doc_id()"
->get_doc_id()</a></h2>
-
-<p>Return the current doc id. Valid only after a successful call to next() or
advance() and must not be called otherwise.</p>
-
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="score()"
->score()</a></h2>
+<h3><a class='u'
+name="get_doc_id"
+>get_doc_id</a></h3>
+
+<pre> my $retval = $matcher->get_doc_id();</pre>
+
+<p>Return the current doc id. Valid only after a successful call to <a
href="#next" class="podlinkpod"
+>next()</a> or <a href="#advance" class="podlinkpod"
+>advance()</a> and must not be called otherwise.</p>
+
+<h3><a class='u'
+name="score"
+>score</a></h3>
+
+<pre> my $retval = $matcher->score();</pre>
<p>Return the score of the current document.</p>
-<p>Only Matchers which are used for scored search need implement score().</p>
+<p>Only Matchers which are used for scored search need implement <a
href="#score" class="podlinkpod"
+>score()</a>.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="METHODS"
->METHODS</a></h1>
+>METHODS</a></h2>
+
+<h3><a class='u'
+name="advance"
+>advance</a></h3>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="advance(target)"
->advance(target)</a></h2>
+<pre> my $retval = $matcher->advance($target);</pre>
-<p>Advance the iterator to the first doc id greater than or equal to
<code>target</code>. The default implementation simply calls next() over and
over, but subclasses have the option of doing something more efficient.</p>
+<p>Advance the iterator to the first doc id greater than or equal to
<code>target</code>. The default implementation simply calls <a href="#next"
class="podlinkpod"
+>next()</a> over and over, but subclasses have the option of doing something
more efficient.</p>
<ul>
<li><b>target</b> - A positive doc id, which must be greater than the current
doc id once the iterator has been initialized.</li>
@@ -143,9 +156,9 @@ name="advance(target)"
<p>Returns: A positive doc id, or 0 once the iterator is exhausted.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="INHERITANCE"
->INHERITANCE</a></h1>
+>INHERITANCE</a></h2>
<p>Lucy::Search::Matcher isa Clownfish::Obj.</p>
Modified:
websites/staging/lucy/trunk/content/docs/test/Lucy/Search/NOTQuery.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Search/NOTQuery.html
(original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Search/NOTQuery.html Fri
Feb 26 12:52:42 2016
@@ -71,15 +71,15 @@
<div>
<a name='___top' class='dummyTopAnchor' ></a>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="NAME"
->NAME</a></h1>
+>NAME</a></h2>
<p>Lucy::Search::NOTQuery - Invert the result set of another Query.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="SYNOPSIS"
->SYNOPSIS</a></h1>
+>SYNOPSIS</a></h2>
<pre> my $not_bar_query = Lucy::Search::NOTQuery->new(
negated_query => $bar_query,
@@ -90,51 +90,78 @@ name="SYNOPSIS"
my $hits = $searcher->hits( query => $foo_and_not_bar_query );
...</pre>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="DESCRIPTION"
->DESCRIPTION</a></h1>
+>DESCRIPTION</a></h2>
<p>A NOTQuery wraps another <a href="../../Lucy/Search/Query.html"
class="podlinkpod"
>Query</a> and matches against its inverse document set. All matching docs
>recieve a score of 0.0.</p>
<p>NOTQuery is often used in conjunction with <a
href="../../Lucy/Search/ANDQuery.html" class="podlinkpod"
->ANDQuery</a> to provide "a AND NOT b" semantics.</p>
+>ANDQuery</a> to provide “a AND NOT b” semantics.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="CONSTRUCTORS"
->CONSTRUCTORS</a></h1>
+>CONSTRUCTORS</a></h2>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="new(_[labeled_params]_)"
->new( <i>[labeled params]</i> )</a></h2>
+<h3><a class='u'
+name="new"
+>new</a></h3>
<pre> my $not_query = Lucy::Search::NOTQuery->new(
negated_query => $query,
);</pre>
+<p>Create a new NOTQuery.</p>
+
<ul>
<li><b>negated_query</b> - The Query whose result set should be inverted.</li>
</ul>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="METHODS"
->METHODS</a></h1>
+>METHODS</a></h2>
+
+<h3><a class='u'
+name="get_negated_query"
+>get_negated_query</a></h3>
+
+<pre> my $retval = $not_query->get_negated_query();</pre>
+
+<p>Accessor for the object’s negated query.</p>
+
+<h3><a class='u'
+name="set_negated_query"
+>set_negated_query</a></h3>
+
+<pre> $not_query->set_negated_query($negated_query);</pre>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_negated_query()"
->get_negated_query()</a></h2>
+<p>Setter for the object’s negated query.</p>
-<p>Accessor for the object's negated query.</p>
+<h3><a class='u'
+name="make_compiler"
+>make_compiler</a></h3>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="set_negated_query(negated_query)"
->set_negated_query(negated_query)</a></h2>
+<pre> my $retval = $not_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>
-<p>Setter for the object's negated query.</p>
+<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>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="INHERITANCE"
->INHERITANCE</a></h1>
+>INHERITANCE</a></h2>
<p>Lucy::Search::NOTQuery isa <a href="../../Lucy/Search/PolyQuery.html"
class="podlinkpod"
>Lucy::Search::PolyQuery</a> isa <a href="../../Lucy/Search/Query.html"
>class="podlinkpod"
Modified:
websites/staging/lucy/trunk/content/docs/test/Lucy/Search/NoMatchQuery.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Search/NoMatchQuery.html
(original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Search/NoMatchQuery.html
Fri Feb 26 12:52:42 2016
@@ -71,36 +71,61 @@
<div>
<a name='___top' class='dummyTopAnchor' ></a>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="NAME"
->NAME</a></h1>
+>NAME</a></h2>
<p>Lucy::Search::NoMatchQuery - Query which matches no documents.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="DESCRIPTION"
->DESCRIPTION</a></h1>
+>DESCRIPTION</a></h2>
<p>NoMatchQuery is a utility class representing a query which matches nothing.
Typical usage might include e.g.
returning a NoMatchQuery when a <a href="../../Lucy/Search/QueryParser.html"
class="podlinkpod"
>QueryParser</a> is asked to parse an empty string.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="CONSTRUCTORS"
->CONSTRUCTORS</a></h1>
+>CONSTRUCTORS</a></h2>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="new()"
->new()</a></h2>
+<h3><a class='u'
+name="new"
+>new</a></h3>
<pre> my $no_match_query = Lucy::Search::NoMatchQuery->new;</pre>
<p>Constructor. Takes no arguments.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
+name="METHODS"
+>METHODS</a></h2>
+
+<h3><a class='u'
+name="make_compiler"
+>make_compiler</a></h3>
+
+<pre> my $retval = $no_match_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></h1>
+>INHERITANCE</a></h2>
<p>Lucy::Search::NoMatchQuery isa <a href="../../Lucy/Search/Query.html"
class="podlinkpod"
>Lucy::Search::Query</a> isa Clownfish::Obj.</p>
Modified: websites/staging/lucy/trunk/content/docs/test/Lucy/Search/ORQuery.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Search/ORQuery.html
(original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Search/ORQuery.html Fri
Feb 26 12:52:42 2016
@@ -71,15 +71,15 @@
<div>
<a name='___top' class='dummyTopAnchor' ></a>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="NAME"
->NAME</a></h1>
+>NAME</a></h2>
<p>Lucy::Search::ORQuery - Union multiple result sets.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="SYNOPSIS"
->SYNOPSIS</a></h1>
+>SYNOPSIS</a></h2>
<pre> my $foo_or_bar_query = Lucy::Search::ORQuery->new(
children => [ $foo_query, $bar_query ],
@@ -87,42 +87,59 @@ name="SYNOPSIS"
my $hits = $searcher->hits( query => $foo_or_bar_query );
...</pre>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="DESCRIPTION"
->DESCRIPTION</a></h1>
+>DESCRIPTION</a></h2>
<p>ORQuery is a composite <a href="../../Lucy/Search/Query.html"
class="podlinkpod"
>Query</a> which matches when any of its children match, so its result set is
>the union of their result sets. Matching documents recieve a summed score
>from all matching child Queries.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="CONSTRUCTORS"
->CONSTRUCTORS</a></h1>
+>CONSTRUCTORS</a></h2>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="new(_[labeled_params]_)"
->new( <i>[labeled params]</i> )</a></h2>
+<h3><a class='u'
+name="new"
+>new</a></h3>
<pre> my $foo_or_bar_query = Lucy::Search::ORQuery->new(
children => [ $foo_query, $bar_query ],
);</pre>
+<p>Create a new ORQuery.</p>
+
<ul>
<li><b>children</b> - An array of child Queries.</li>
</ul>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="METHODS"
->METHODS</a></h1>
+>METHODS</a></h2>
+
+<h3><a class='u'
+name="make_compiler"
+>make_compiler</a></h3>
+
+<pre> my $retval = $or_query->make_compiler(
+ searcher => $searcher # required
+ boost => $boost # required
+ subordinate => $subordinate # default: false
+ );</pre>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="add_child(query)"
->add_child(query)</a></h2>
+<p>Abstract factory method returning a Compiler derived from this Query.</p>
-<p>Add a child Query node.</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>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="INHERITANCE"
->INHERITANCE</a></h1>
+>INHERITANCE</a></h2>
<p>Lucy::Search::ORQuery isa <a href="../../Lucy/Search/PolyQuery.html"
class="podlinkpod"
>Lucy::Search::PolyQuery</a> isa <a href="../../Lucy/Search/Query.html"
>class="podlinkpod"
Modified:
websites/staging/lucy/trunk/content/docs/test/Lucy/Search/PhraseQuery.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Search/PhraseQuery.html
(original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Search/PhraseQuery.html
Fri Feb 26 12:52:42 2016
@@ -71,15 +71,15 @@
<div>
<a name='___top' class='dummyTopAnchor' ></a>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="NAME"
->NAME</a></h1>
+>NAME</a></h2>
<p>Lucy::Search::PhraseQuery - Query matching an ordered list of terms.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="SYNOPSIS"
->SYNOPSIS</a></h1>
+>SYNOPSIS</a></h2>
<pre> my $phrase_query = Lucy::Search::PhraseQuery->new(
field => 'content',
@@ -87,20 +87,27 @@ name="SYNOPSIS"
);
my $hits = $searcher->hits( query => $phrase_query );</pre>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="DESCRIPTION"
->DESCRIPTION</a></h1>
+>DESCRIPTION</a></h2>
<p>PhraseQuery is a subclass of <a href="../../Lucy/Search/Query.html"
class="podlinkpod"
->Lucy::Search::Query</a> for matching against an ordered sequence of terms.</p>
+>Query</a> for matching against an ordered sequence of terms.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="CONSTRUCTORS"
->CONSTRUCTORS</a></h1>
+>CONSTRUCTORS</a></h2>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="new(_[labeled_params]_)"
->new( <i>[labeled params]</i> )</a></h2>
+<h3><a class='u'
+name="new"
+>new</a></h3>
+
+<pre> my $phrase_query = Lucy::Search::PhraseQuery->new(
+ field => $field # required
+ terms => $terms # required
+ );</pre>
+
+<p>Create a new PhraseQuery.</p>
<ul>
<li><b>field</b> - The field that the phrase must occur in.</li>
@@ -108,25 +115,50 @@ name="new(_[labeled_params]_)"
<li><b>terms</b> - The ordered array of terms that must match.</li>
</ul>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="METHODS"
->METHODS</a></h1>
+>METHODS</a></h2>
+
+<h3><a class='u'
+name="get_field"
+>get_field</a></h3>
+
+<pre> my $retval = $phrase_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 $retval = $phrase_query->get_terms();</pre>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_field()"
->get_field()</a></h2>
+<p>Accessor for object’s array of terms.</p>
-<p>Accessor for object's field attribute.</p>
+<h3><a class='u'
+name="make_compiler"
+>make_compiler</a></h3>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_terms()"
->get_terms()</a></h2>
+<pre> my $retval = $phrase_query->make_compiler(
+ searcher => $searcher # required
+ boost => $boost # required
+ subordinate => $subordinate # default: false
+ );</pre>
-<p>Accessor for object's array of terms.</p>
+<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>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="INHERITANCE"
->INHERITANCE</a></h1>
+>INHERITANCE</a></h2>
<p>Lucy::Search::PhraseQuery isa <a href="../../Lucy/Search/Query.html"
class="podlinkpod"
>Lucy::Search::Query</a> isa Clownfish::Obj.</p>
Modified:
websites/staging/lucy/trunk/content/docs/test/Lucy/Search/PolyQuery.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Search/PolyQuery.html
(original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Search/PolyQuery.html
Fri Feb 26 12:52:42 2016
@@ -71,15 +71,15 @@
<div>
<a name='___top' class='dummyTopAnchor' ></a>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="NAME"
->NAME</a></h1>
+>NAME</a></h2>
<p>Lucy::Search::PolyQuery - Base class for composite Query objects.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="SYNOPSIS"
->SYNOPSIS</a></h1>
+>SYNOPSIS</a></h2>
<pre> sub walk {
my $query = shift;
@@ -94,9 +94,9 @@ name="SYNOPSIS"
else { ... }
}</pre>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="DESCRIPTION"
->DESCRIPTION</a></h1>
+>DESCRIPTION</a></h2>
<p>PolyQuery serves as a shared base class for <a
href="../../Lucy/Search/ANDQuery.html" class="podlinkpod"
>ANDQuery</a>, <a href="../../Lucy/Search/ORQuery.html" class="podlinkpod"
@@ -104,9 +104,21 @@ name="DESCRIPTION"
>NOTQuery</a>, and <a href="../../Lucy/Search/RequiredOptionalQuery.html"
>class="podlinkpod"
>RequiredOptionalQuery</a>. All of these classes may serve as nodes in
>composite Query with a tree structure which may be walked.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
+name="METHODS"
+>METHODS</a></h2>
+
+<h3><a class='u'
+name="add_child"
+>add_child</a></h3>
+
+<pre> $poly_query->add_child($query);</pre>
+
+<p>Add a child Query node.</p>
+
+<h2><a class='u'
name="INHERITANCE"
->INHERITANCE</a></h1>
+>INHERITANCE</a></h2>
<p>Lucy::Search::PolyQuery isa <a href="../../Lucy/Search/Query.html"
class="podlinkpod"
>Lucy::Search::Query</a> isa Clownfish::Obj.</p>
Modified:
websites/staging/lucy/trunk/content/docs/test/Lucy/Search/PolySearcher.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Search/PolySearcher.html
(original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Search/PolySearcher.html
Fri Feb 26 12:52:42 2016
@@ -71,15 +71,15 @@
<div>
<a name='___top' class='dummyTopAnchor' ></a>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="NAME"
->NAME</a></h1>
+>NAME</a></h2>
<p>Lucy::Search::PolySearcher - Aggregate results from multiple Searchers.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="SYNOPSIS"
->SYNOPSIS</a></h1>
+>SYNOPSIS</a></h2>
<pre> my $schema = MySchema->new;
for my $index (@index_paths) {
@@ -91,61 +91,53 @@ name="SYNOPSIS"
);
my $hits = $poly_searcher->hits( query => $query );</pre>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="DESCRIPTION"
->DESCRIPTION</a></h1>
+>DESCRIPTION</a></h2>
<p>The primary use for PolySearcher is to aggregate results from several
indexes on a single machine.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="CONSTRUCTORS"
->CONSTRUCTORS</a></h1>
+>CONSTRUCTORS</a></h2>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="new(_[labeled_params]_)"
->new( <i>[labeled params]</i> )</a></h2>
+<h3><a class='u'
+name="new"
+>new</a></h3>
<pre> my $poly_searcher = Lucy::Search::PolySearcher->new(
schema => $schema,
searchers => \@searchers,
);</pre>
+<p>Create a new PolySearcher.</p>
+
<ul>
<li><b>schema</b> - A Schema.</li>
<li><b>searchers</b> - An array of Searchers.</li>
</ul>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="METHODS"
->METHODS</a></h1>
-
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="hits(_[labeled_params]_)"
->hits( <i>[labeled params]</i> )</a></h2>
-
-<p>Return a Hits object containing the top results.</p>
-
-<ul>
-<li><b>query</b> - Either a Query object or a query string.</li>
+>METHODS</a></h2>
-<li><b>offset</b> - The number of most-relevant hits to discard, typically
used when "paging" through hits N at a time. Setting
<code>offset</code> to 20 and <code>num_wanted</code> to 10 retrieves hits
21-30, assuming that 30 hits can be found.</li>
+<h3><a class='u'
+name="doc_max"
+>doc_max</a></h3>
-<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"
->Lucy::Search::SortSpec</a>, which will affect how results are ranked and
returned.</li>
-</ul>
-
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="doc_max()"
->doc_max()</a></h2>
+<pre> my $retval = $poly_searcher->doc_max();</pre>
<p>Return the maximum number of docs in the collection represented by the
Searcher, which is also the highest possible internal doc id. Documents which
have been marked as deleted but not yet purged are included in this count.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="doc_freq(_[labeled_params]_)"
->doc_freq( <i>[labeled params]</i> )</a></h2>
+<h3><a class='u'
+name="doc_freq"
+>doc_freq</a></h3>
+
+<pre> my $retval = $poly_searcher->doc_freq(
+ field => $field # required
+ term => $term # required
+ );</pre>
<p>Return the number of documents which contain the term in the given
field.</p>
@@ -155,25 +147,39 @@ name="doc_freq(_[labeled_params]_)"
<li><b>term</b> - The term to look up.</li>
</ul>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="fetch_doc(doc_id)"
->fetch_doc(doc_id)</a></h2>
+<h3><a class='u'
+name="collect"
+>collect</a></h3>
+
+<pre> $poly_searcher->collect(
+ query => $query # required
+ collector => $collector # required
+ );</pre>
-<p>Retrieve a document. Throws an error if the doc id is out of range.</p>
+<p>Iterate over hits, feeding them into a <a
href="../../Lucy/Search/Collector.html" class="podlinkpod"
+>Collector</a>.</p>
<ul>
-<li><b>doc_id</b> - A document id.</li>
+<li><b>query</b> - A Query.</li>
+
+<li><b>collector</b> - A Collector.</li>
</ul>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_schema()"
->get_schema()</a></h2>
+<h3><a class='u'
+name="fetch_doc"
+>fetch_doc</a></h3>
-<p>Accessor for the object's <code>schema</code> member.</p>
+<pre> my $retval = $poly_searcher->fetch_doc($doc_id);</pre>
+
+<p>Retrieve a document. Throws an error if the doc id is out of range.</p>
+
+<ul>
+<li><b>doc_id</b> - A document id.</li>
+</ul>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="INHERITANCE"
->INHERITANCE</a></h1>
+>INHERITANCE</a></h2>
<p>Lucy::Search::PolySearcher isa <a href="../../Lucy/Search/Searcher.html"
class="podlinkpod"
>Lucy::Search::Searcher</a> isa Clownfish::Obj.</p>
Modified: websites/staging/lucy/trunk/content/docs/test/Lucy/Search/Query.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Search/Query.html
(original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Search/Query.html Fri
Feb 26 12:52:42 2016
@@ -71,15 +71,15 @@
<div>
<a name='___top' class='dummyTopAnchor' ></a>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="NAME"
->NAME</a></h1>
+>NAME</a></h2>
<p>Lucy::Search::Query - A specification for a search query.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="SYNOPSIS"
->SYNOPSIS</a></h1>
+>SYNOPSIS</a></h2>
<pre> # Query is an abstract base class.
package MyQuery;
@@ -97,27 +97,29 @@ name="SYNOPSIS"
use base ( Lucy::Search::Compiler );
...</pre>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="DESCRIPTION"
->DESCRIPTION</a></h1>
+>DESCRIPTION</a></h2>
<p>Query objects are simple containers which contain the minimum information
necessary to define a search query.</p>
-<p>The most common way to generate Query objects is to feed a search string
such as 'foo AND bar' to a <a href="../../Lucy/Search/QueryParser.html"
class="podlinkpod"
->QueryParser's</a> parse() method, which outputs an abstract syntax tree
built up from various Query subclasses such as <a
href="../../Lucy/Search/ANDQuery.html" class="podlinkpod"
+<p>The most common way to generate Query objects is to feed a search string
such as ‘foo AND bar’ to a <a
href="../../Lucy/Search/QueryParser.html" class="podlinkpod"
+>QueryParser’s</a> <a href="../../Lucy/Search/QueryParser.html#parse"
class="podlinkpod"
+>parse()</a> method, which outputs an abstract syntax tree built up from
various Query subclasses such as <a href="../../Lucy/Search/ANDQuery.html"
class="podlinkpod"
>ANDQuery</a> and <a href="../../Lucy/Search/TermQuery.html" class="podlinkpod"
>TermQuery</a>. However, it is also possible to use custom Query objects to
>build a search specification which cannot be easily represented using a
>search string.</p>
-<p>Subclasses of Query must implement make_compiler(), which is the first step
in compiling a Query down to a <a href="../../Lucy/Search/Matcher.html"
class="podlinkpod"
+<p>Subclasses of Query must implement <a href="#make_compiler"
class="podlinkpod"
+>make_compiler()</a>, which is the first step in compiling a Query down to a
<a href="../../Lucy/Search/Matcher.html" class="podlinkpod"
>Matcher</a> which can actually match and score documents.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="CONSTRUCTORS"
->CONSTRUCTORS</a></h1>
+>CONSTRUCTORS</a></h2>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="new(_[labeled_params]_)"
->new( <i>[labeled params]</i> )</a></h2>
+<h3><a class='u'
+name="new"
+>new</a></h3>
<pre> my $query = MyQuery->SUPER::new(
boost => 2.5,
@@ -129,43 +131,66 @@ name="new(_[labeled_params]_)"
<li><b>boost</b> - A scoring multiplier, affecting the Query's relative
contribution to each document's score. Typically defaults to 1.0, but
subclasses which do not contribute to document scores such as NOTQuery and
MatchAllQuery default to 0.0 instead.</li>
</ul>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="ABSTRACT_METHODS"
->ABSTRACT METHODS</a></h1>
+>ABSTRACT METHODS</a></h2>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="make_compiler(_[labeled_params]_)"
->make_compiler( <i>[labeled params]</i> )</a></h2>
+<h3><a class='u'
+name="make_compiler"
+>make_compiler</a></h3>
+
+<pre> my $retval = $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. Defaults to the Query's own
boost.</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 normalize() on
the newly minted Compiler object before returning it.</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>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="METHODS"
->METHODS</a></h1>
+>METHODS</a></h2>
+
+<h3><a class='u'
+name="set_boost"
+>set_boost</a></h3>
+
+<pre> $query->set_boost($boost);</pre>
+
+<p>Set the Query’s boost.</p>
+
+<h3><a class='u'
+name="get_boost"
+>get_boost</a></h3>
+
+<pre> my $retval = $query->get_boost();</pre>
+
+<p>Get the Query’s boost.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="set_boost(boost)"
->set_boost(boost)</a></h2>
+<h3><a class='u'
+name="dump"
+>dump</a></h3>
-<p>Set the Query's boost.</p>
+<pre> my $retval = $query->dump();</pre>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_boost()"
->get_boost()</a></h2>
+<h3><a class='u'
+name="load"
+>load</a></h3>
-<p>Get the Query's boost.</p>
+<pre> my $retval = $query->load($dump);</pre>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="INHERITANCE"
->INHERITANCE</a></h1>
+>INHERITANCE</a></h2>
<p>Lucy::Search::Query isa Clownfish::Obj.</p>
Modified:
websites/staging/lucy/trunk/content/docs/test/Lucy/Search/QueryParser.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Search/QueryParser.html
(original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Search/QueryParser.html
Fri Feb 26 12:52:42 2016
@@ -71,15 +71,15 @@
<div>
<a name='___top' class='dummyTopAnchor' ></a>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="NAME"
->NAME</a></h1>
+>NAME</a></h2>
<p>Lucy::Search::QueryParser - Transform a string into a Query object.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="SYNOPSIS"
->SYNOPSIS</a></h1>
+>SYNOPSIS</a></h2>
<pre> my $query_parser = Lucy::Search::QueryParser->new(
schema => $searcher->get_schema,
@@ -88,37 +88,41 @@ name="SYNOPSIS"
my $query = $query_parser->parse( $query_string );
my $hits = $searcher->hits( query => $query );</pre>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="DESCRIPTION"
->DESCRIPTION</a></h1>
+>DESCRIPTION</a></h2>
<p>QueryParser accepts search strings as input and produces <a
href="../../Lucy/Search/Query.html" class="podlinkpod"
->Lucy::Search::Query</a> objects, suitable for feeding into <a
href="../../Lucy/Search/IndexSearcher.html" class="podlinkpod"
+>Query</a> objects, suitable for feeding into <a
href="../../Lucy/Search/IndexSearcher.html" class="podlinkpod"
>IndexSearcher</a> and other <a href="../../Lucy/Search/Searcher.html"
>class="podlinkpod"
>Searcher</a> subclasses.</p>
<p>The following syntactical constructs are recognized by QueryParser:</p>
-<pre> * Boolean operators 'AND', 'OR', and 'AND
NOT'.
- * Prepented +plus and -minus, indicating that the labeled entity
- should be either required or forbidden -- be it a single word, a
- phrase, or a parenthetical group.
- * Logical groups, delimited by parentheses.
- * Phrases, delimited by double quotes.</pre>
-
-<p>Additionally, the following syntax can be enabled via set_heed_colons():</p>
-
-<pre> * Field-specific constructs, in the form of
'fieldname:termtext' or
- 'fieldname:(foo bar)'. (The field specified by
'fieldname:' will be
- used instead of the QueryParser's default fields).</pre>
+<ul>
+<li>Boolean operators ‘AND’, ‘OR’, and ‘AND
NOT’.</li>
+
+<li>Prepented +plus and -minus, indicating that the labeled entity should be
either required or forbidden – be it a single word, a phrase, or a
parenthetical group.</li>
+
+<li>Logical groups, delimited by parentheses.</li>
+
+<li>Phrases, delimited by double quotes.</li>
+</ul>
+
+<p>Additionally, the following syntax can be enabled via <a
href="#set_heed_colons" class="podlinkpod"
+>set_heed_colons()</a>:</p>
+
+<ul>
+<li>Field-specific constructs, in the form of ‘fieldname:termtext’
or ‘fieldname:(foo bar)’. (The field specified by
‘fieldname:’ will be used instead of the QueryParser’s
default fields).</li>
+</ul>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="CONSTRUCTORS"
->CONSTRUCTORS</a></h1>
+>CONSTRUCTORS</a></h2>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="new(_[labeled_params]_)"
->new( <i>[labeled params]</i> )</a></h2>
+<h3><a class='u'
+name="new"
+>new</a></h3>
<pre> my $query_parser = Lucy::Search::QueryParser->new(
schema => $searcher->get_schema, # required
@@ -134,22 +138,28 @@ name="new(_[labeled_params]_)"
>Schema</a>.</li>
<li><b>analyzer</b> - An <a href="../../Lucy/Analysis/Analyzer.html"
class="podlinkpod"
->Analyzer</a>. Ordinarily, the analyzers specified by each field's
definition will be used, but if <code>analyzer</code> is supplied, it will
override and be used for all fields. This can lead to mismatches between what
is in the index and what is being searched for, so use caution.</li>
+>Analyzer</a>. Ordinarily, the analyzers specified by each field’s
definition will be used, but if <code>analyzer</code> is supplied, it will
override and be used for all fields. This can lead to mismatches between what
is in the index and what is being searched for, so use caution.</li>
<li><b>fields</b> - The names of the fields which will be searched against.
Defaults to those fields which are defined as indexed in the supplied
Schema.</li>
-<li><b>default_boolop</b> - Two possible values: 'AND' and
'OR'. The default is 'OR', which means: return documents which
match any of the query terms. If you want only documents which match all of the
query terms, set this to 'AND'.</li>
+<li><b>default_boolop</b> - Two possible values: ‘AND’ and
‘OR’. The default is ‘OR’, which means: return
documents which match any of the query terms. If you want only documents which
match all of the query terms, set this to ‘AND’.</li>
</ul>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="METHODS"
->METHODS</a></h1>
-
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="parse(query_string)"
->parse(query_string)</a></h2>
+>METHODS</a></h2>
-<p>Build a Query object from the contents of a query string. At present,
implemented internally by calling tree(), expand(), and prune().</p>
+<h3><a class='u'
+name="parse"
+>parse</a></h3>
+
+<pre> my $retval = $query_parser->parse($query_string);
+ my $retval = $query_parser->parse(); # default: undef</pre>
+
+<p>Build a Query object from the contents of a query string. At present,
implemented internally by calling <a href="#tree" class="podlinkpod"
+>tree()</a>, <a href="#expand" class="podlinkpod"
+>expand()</a>, and <a href="#prune" class="podlinkpod"
+>prune()</a>.</p>
<ul>
<li><b>query_string</b> - The string to be parsed. May be undef.</li>
@@ -157,13 +167,17 @@ name="parse(query_string)"
<p>Returns: a Query.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="tree(query_string)"
->tree(query_string)</a></h2>
+<h3><a class='u'
+name="tree"
+>tree</a></h3>
+
+<pre> my $retval = $query_parser->tree($query_string);</pre>
<p>Parse the logical structure of a query string, building a tree comprised of
Query objects. Leaf nodes in the tree will most often be LeafQuery objects but
might be MatchAllQuery or NoMatchQuery objects as well. Internal nodes will be
objects which subclass PolyQuery: ANDQuery, ORQuery, NOTQuery, and
RequiredOptionalQuery.</p>
-<p>The output of tree() is an intermediate form which must be passed through
expand() before being used to feed a search.</p>
+<p>The output of <a href="#tree" class="podlinkpod"
+>tree()</a> is an intermediate form which must be passed through <a
href="#expand" class="podlinkpod"
+>expand()</a> before being used to feed a search.</p>
<ul>
<li><b>query_string</b> - The string to be parsed.</li>
@@ -171,21 +185,26 @@ name="tree(query_string)"
<p>Returns: a Query.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="expand(query)"
->expand(query)</a></h2>
+<h3><a class='u'
+name="expand"
+>expand</a></h3>
+
+<pre> my $retval = $query_parser->expand($query);</pre>
-<p>Walk the hierarchy of a Query tree, descending through all PolyQuery nodes
and calling expand_leaf() on any LeafQuery nodes encountered.</p>
+<p>Walk the hierarchy of a Query tree, descending through all PolyQuery nodes
and calling <a href="#expand_leaf" class="podlinkpod"
+>expand_leaf()</a> on any LeafQuery nodes encountered.</p>
<ul>
<li><b>query</b> - A Query object.</li>
</ul>
-<p>Returns: A Query -- usually the same one that was supplied after in-place
modification, but possibly another.</p>
+<p>Returns: A Query – usually the same one that was supplied after
in-place modification, but possibly another.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="expand_leaf(query)"
->expand_leaf(query)</a></h2>
+<h3><a class='u'
+name="expand_leaf"
+>expand_leaf</a></h3>
+
+<pre> my $retval = $query_parser->expand_leaf($query);</pre>
<p>Convert a LeafQuery into either a TermQuery, a PhraseQuery, or an ORQuery
joining multiple TermQueries/PhraseQueries to accommodate multiple fields.
LeafQuery text will be passed through the relevant Analyzer for each field.
Quoted text will be transformed into PhraseQuery objects. Unquoted text will be
converted to either a TermQuery or a PhraseQuery depending on how many tokens
are generated.</p>
@@ -195,21 +214,31 @@ name="expand_leaf(query)"
<p>Returns: A Query.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="prune(query)"
->prune(query)</a></h2>
-
-<p>Prevent certain Query structures from returning too many results. Query
objects built via tree() and expand() can generate "return the world"
result sets, such as in the case of <code>NOT a_term_not_in_the_index</code>;
prune() walks the hierarchy and eliminates such branches.</p>
+<h3><a class='u'
+name="prune"
+>prune</a></h3>
+
+<pre> my $retval = $query_parser->prune($query);
+ my $retval = $query_parser->prune(); # default: undef</pre>
+
+<p>Prevent certain Query structures from returning too many results. Query
objects built via <a href="#tree" class="podlinkpod"
+>tree()</a> and <a href="#expand" class="podlinkpod"
+>expand()</a> can generate “return the world” result sets, such as
in the case of <code>NOT a_term_not_in_the_index</code>; <a href="#prune"
class="podlinkpod"
+>prune()</a> walks the hierarchy and eliminates such branches.</p>
<pre> 'NOT foo' => [NOMATCH]
'foo OR NOT bar' => 'foo'
'foo OR (-bar AND -baz) => 'foo'</pre>
-<p>prune() also eliminates some double-negative constructs -- even though such
constructs may not actually return the world:</p>
+<p><a href="#prune" class="podlinkpod"
+>prune()</a> also eliminates some double-negative constructs – even
though such constructs may not actually return the world:</p>
<pre> 'foo AND -(-bar)' => 'foo'</pre>
-<p>In this example, safety is taking precedence over logical consistency. If
you want logical consistency instead, call tree() then expand(), skipping
prune().</p>
+<p>In this example, safety is taking precedence over logical consistency. If
you want logical consistency instead, call <a href="#tree" class="podlinkpod"
+>tree()</a> then <a href="#expand" class="podlinkpod"
+>expand()</a>, skipping <a href="#prune" class="podlinkpod"
+>prune()</a>.</p>
<ul>
<li><b>query</b> - A Query.</li>
@@ -217,15 +246,14 @@ name="prune(query)"
<p>Returns: a Query; in most cases, the supplied Query after in-place
modification.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="set_heed_colons(heed_colons)"
->set_heed_colons(heed_colons)</a></h2>
-
-<p>Enable/disable parsing of <code>fieldname:foo</code> constructs.</p>
-
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="make_term_query(_[labeled_params]_)"
->make_term_query( <i>[labeled params]</i> )</a></h2>
+<h3><a class='u'
+name="make_term_query"
+>make_term_query</a></h3>
+
+<pre> my $retval = $query_parser->make_term_query(
+ field => $field # required
+ term => $term # required
+ );</pre>
<p>Factory method creating a TermQuery.</p>
@@ -237,9 +265,14 @@ name="make_term_query(_[labeled_params]_
<p>Returns: A Query.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="make_phrase_query(_[labeled_params]_)"
->make_phrase_query( <i>[labeled params]</i> )</a></h2>
+<h3><a class='u'
+name="make_phrase_query"
+>make_phrase_query</a></h3>
+
+<pre> my $retval = $query_parser->make_phrase_query(
+ field => $field # required
+ terms => $terms # required
+ );</pre>
<p>Factory method creating a PhraseQuery.</p>
@@ -251,11 +284,14 @@ name="make_phrase_query(_[labeled_params
<p>Returns: A Query.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="make_and_query(children)"
->make_and_query(children)</a></h2>
+<h3><a class='u'
+name="make_or_query"
+>make_or_query</a></h3>
-<p>Factory method creating an ANDQuery.</p>
+<pre> my $retval = $query_parser->make_or_query($children);
+ my $retval = $query_parser->make_or_query(); # default: undef</pre>
+
+<p>Factory method creating an ORQuery.</p>
<ul>
<li><b>children</b> - Array of child Queries.</li>
@@ -263,11 +299,14 @@ name="make_and_query(children)"
<p>Returns: A Query.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="make_or_query(children)"
->make_or_query(children)</a></h2>
+<h3><a class='u'
+name="make_and_query"
+>make_and_query</a></h3>
-<p>Factory method creating an ORQuery.</p>
+<pre> my $retval = $query_parser->make_and_query($children);
+ my $retval = $query_parser->make_and_query(); # default: undef</pre>
+
+<p>Factory method creating an ANDQuery.</p>
<ul>
<li><b>children</b> - Array of child Queries.</li>
@@ -275,9 +314,11 @@ name="make_or_query(children)"
<p>Returns: A Query.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="make_not_query(negated_query)"
->make_not_query(negated_query)</a></h2>
+<h3><a class='u'
+name="make_not_query"
+>make_not_query</a></h3>
+
+<pre> my $retval = $query_parser->make_not_query($negated_query);</pre>
<p>Factory method creating a NOTQuery.</p>
@@ -287,9 +328,14 @@ name="make_not_query(negated_query)"
<p>Returns: A Query.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="make_req_opt_query(_[labeled_params]_)"
->make_req_opt_query( <i>[labeled params]</i> )</a></h2>
+<h3><a class='u'
+name="make_req_opt_query"
+>make_req_opt_query</a></h3>
+
+<pre> my $retval = $query_parser->make_req_opt_query(
+ required_query => $required_query # required
+ optional_query => $optional_query # required
+ );</pre>
<p>Factory method creating a RequiredOptionalQuery.</p>
@@ -301,9 +347,17 @@ name="make_req_opt_query(_[labeled_param
<p>Returns: A Query.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h3><a class='u'
+name="set_heed_colons"
+>set_heed_colons</a></h3>
+
+<pre> $query_parser->set_heed_colons($heed_colons);</pre>
+
+<p>Enable/disable parsing of <code>fieldname:foo</code> constructs.</p>
+
+<h2><a class='u'
name="INHERITANCE"
->INHERITANCE</a></h1>
+>INHERITANCE</a></h2>
<p>Lucy::Search::QueryParser isa Clownfish::Obj.</p>
Modified:
websites/staging/lucy/trunk/content/docs/test/Lucy/Search/RangeQuery.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Search/RangeQuery.html
(original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Search/RangeQuery.html
Fri Feb 26 12:52:42 2016
@@ -71,15 +71,15 @@
<div>
<a name='___top' class='dummyTopAnchor' ></a>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="NAME"
->NAME</a></h1>
+>NAME</a></h2>
<p>Lucy::Search::RangeQuery - Match a range of values.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="SYNOPSIS"
->SYNOPSIS</a></h1>
+>SYNOPSIS</a></h2>
<pre> # Match all articles by "Foo" published since the year 2000.
my $range_query = Lucy::Search::RangeQuery->new(
@@ -97,19 +97,19 @@ name="SYNOPSIS"
my $hits = $searcher->hits( query => $and_query );
...</pre>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="DESCRIPTION"
->DESCRIPTION</a></h1>
+>DESCRIPTION</a></h2>
<p>RangeQuery matches documents where the value for a particular field falls
within a given range.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="CONSTRUCTORS"
->CONSTRUCTORS</a></h1>
+>CONSTRUCTORS</a></h2>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="new(_[labeled_params]_)"
->new( <i>[labeled params]</i> )</a></h2>
+<h3><a class='u'
+name="new"
+>new</a></h3>
<pre> my $range_query = Lucy::Search::RangeQuery->new(
field => 'product_number', # required
@@ -119,6 +119,8 @@ name="new(_[labeled_params]_)"
include_upper => 0, # default true
);</pre>
+<p>Create a new RangeQuery.</p>
+
<p>Takes 5 parameters; <code>field</code> is required, as is at least one of
either <code>lower_term</code> or <code>upper_term</code>.</p>
<ul>
@@ -133,9 +135,34 @@ name="new(_[labeled_params]_)"
<li><b>include_upper</b> - Indicates whether docs which match
<code>upper_term</code> should be included in the results.</li>
</ul>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
+name="METHODS"
+>METHODS</a></h2>
+
+<h3><a class='u'
+name="make_compiler"
+>make_compiler</a></h3>
+
+<pre> my $retval = $range_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></h1>
+>INHERITANCE</a></h2>
<p>Lucy::Search::RangeQuery isa <a href="../../Lucy/Search/Query.html"
class="podlinkpod"
>Lucy::Search::Query</a> isa Clownfish::Obj.</p>
