You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucy.apache.org by nw...@apache.org on 2016/02/26 13:52:27 UTC
svn commit: r1732471 [5/6] - in /lucy/site/trunk/content/docs/test: ./ Lucy/
Lucy/Analysis/ Lucy/Docs/ Lucy/Docs/Cookbook/ Lucy/Docs/Tutorial/
Lucy/Document/ Lucy/Highlight/ Lucy/Index/ Lucy/Object/ Lucy/Plan/
Lucy/Search/ Lucy/Search/Collector/ Lucy/S...
Modified: lucy/site/trunk/content/docs/test/Lucy/Search/MatchAllQuery.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Search/MatchAllQuery.mdtext?rev=1732471&r1=1732470&r2=1732471&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Search/MatchAllQuery.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Search/MatchAllQuery.mdtext Fri Feb 26 12:52:25 2016
@@ -3,36 +3,61 @@ Title: Lucy::Search::MatchAllQuery - Apa
<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: lucy/site/trunk/content/docs/test/Lucy/Search/Matcher.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Search/Matcher.mdtext?rev=1732471&r1=1732470&r2=1732471&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Search/Matcher.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Search/Matcher.mdtext Fri Feb 26 12:52:25 2016
@@ -3,71 +3,84 @@ Title: Lucy::Search::Matcher - Apache Lu
<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>
@@ -75,9 +88,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: lucy/site/trunk/content/docs/test/Lucy/Search/NOTQuery.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Search/NOTQuery.mdtext?rev=1732471&r1=1732470&r2=1732471&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Search/NOTQuery.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Search/NOTQuery.mdtext Fri Feb 26 12:52:25 2016
@@ -3,15 +3,15 @@ Title: Lucy::Search::NOTQuery - Apache L
<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,
@@ -22,51 +22,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: lucy/site/trunk/content/docs/test/Lucy/Search/NoMatchQuery.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Search/NoMatchQuery.mdtext?rev=1732471&r1=1732470&r2=1732471&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Search/NoMatchQuery.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Search/NoMatchQuery.mdtext Fri Feb 26 12:52:25 2016
@@ -3,36 +3,61 @@ Title: Lucy::Search::NoMatchQuery - Apac
<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: lucy/site/trunk/content/docs/test/Lucy/Search/ORQuery.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Search/ORQuery.mdtext?rev=1732471&r1=1732470&r2=1732471&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Search/ORQuery.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Search/ORQuery.mdtext Fri Feb 26 12:52:25 2016
@@ -3,15 +3,15 @@ Title: Lucy::Search::ORQuery - Apache Lu
<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 ],
@@ -19,42 +19,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: lucy/site/trunk/content/docs/test/Lucy/Search/PhraseQuery.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Search/PhraseQuery.mdtext?rev=1732471&r1=1732470&r2=1732471&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Search/PhraseQuery.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Search/PhraseQuery.mdtext Fri Feb 26 12:52:25 2016
@@ -3,15 +3,15 @@ Title: Lucy::Search::PhraseQuery - Apach
<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',
@@ -19,20 +19,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>
@@ -40,25 +47,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: lucy/site/trunk/content/docs/test/Lucy/Search/PolyQuery.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Search/PolyQuery.mdtext?rev=1732471&r1=1732470&r2=1732471&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Search/PolyQuery.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Search/PolyQuery.mdtext Fri Feb 26 12:52:25 2016
@@ -3,15 +3,15 @@ Title: Lucy::Search::PolyQuery - Apache
<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;
@@ -26,9 +26,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"
@@ -36,9 +36,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: lucy/site/trunk/content/docs/test/Lucy/Search/PolySearcher.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Search/PolySearcher.mdtext?rev=1732471&r1=1732470&r2=1732471&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Search/PolySearcher.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Search/PolySearcher.mdtext Fri Feb 26 12:52:25 2016
@@ -3,15 +3,15 @@ Title: Lucy::Search::PolySearcher - Apac
<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) {
@@ -23,61 +23,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>
@@ -87,25 +79,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: lucy/site/trunk/content/docs/test/Lucy/Search/Query.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Search/Query.mdtext?rev=1732471&r1=1732470&r2=1732471&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Search/Query.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Search/Query.mdtext Fri Feb 26 12:52:25 2016
@@ -3,15 +3,15 @@ Title: Lucy::Search::Query - Apache Lucy
<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;
@@ -29,27 +29,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,
@@ -61,43 +63,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: lucy/site/trunk/content/docs/test/Lucy/Search/QueryParser.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Search/QueryParser.mdtext?rev=1732471&r1=1732470&r2=1732471&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Search/QueryParser.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Search/QueryParser.mdtext Fri Feb 26 12:52:25 2016
@@ -3,15 +3,15 @@ Title: Lucy::Search::QueryParser - Apach
<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,
@@ -20,37 +20,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
@@ -66,22 +70,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>
@@ -89,13 +99,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>
@@ -103,21 +117,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>
@@ -127,21 +146,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>
@@ -149,15 +178,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>
@@ -169,9 +197,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>
@@ -183,11 +216,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>
@@ -195,11 +231,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>
@@ -207,9 +246,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>
@@ -219,9 +260,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>
@@ -233,9 +279,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: lucy/site/trunk/content/docs/test/Lucy/Search/RangeQuery.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Search/RangeQuery.mdtext?rev=1732471&r1=1732470&r2=1732471&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Search/RangeQuery.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Search/RangeQuery.mdtext Fri Feb 26 12:52:25 2016
@@ -3,15 +3,15 @@ Title: Lucy::Search::RangeQuery - Apache
<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(
@@ -29,19 +29,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
@@ -51,6 +51,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>
@@ -65,9 +67,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>
Modified: lucy/site/trunk/content/docs/test/Lucy/Search/RequiredOptionalQuery.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Search/RequiredOptionalQuery.mdtext?rev=1732471&r1=1732470&r2=1732471&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Search/RequiredOptionalQuery.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Search/RequiredOptionalQuery.mdtext Fri Feb 26 12:52:25 2016
@@ -3,17 +3,17 @@ Title: Lucy::Search::RequiredOptionalQue
<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::RequiredOptionalQuery - Join results for two Queries,
one required,
one optional.</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_maybe_bar = Lucy::Search::RequiredOptionalQuery->new(
required_query => $foo_query,
@@ -22,62 +22,93 @@ name="SYNOPSIS"
my $hits = $searcher->hits( query => $foo_and_maybe_bar );
...</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>RequiredOptionalQuery joins the result sets of one Query which MUST match, and one Query which SHOULD match. When only the required Query matches, its score is passed along; when both match, the scores are summed.</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 $reqopt_query = Lucy::Search::RequiredOptionalQuery->new(
required_query => $foo_query, # required
optional_query => $bar_query, # required
);</pre>
+<p>Create a new RequiredOptionalQuery.</p>
+
<ul>
<li><b>required_query</b> - Query must must match.</li>
<li><b>optional_query</b> - Query which should 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_required_query"
+>get_required_query</a></h3>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_required_query()"
->get_required_query()</a></h2>
+<pre> my $retval = $required_optional_query->get_required_query();</pre>
<p>Getter for the required Query.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="set_required_query(required_query)"
->set_required_query(required_query)</a></h2>
+<h3><a class='u'
+name="set_required_query"
+>set_required_query</a></h3>
+
+<pre> $required_optional_query->set_required_query($required_query);</pre>
<p>Setter for the required Query.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_optional_query()"
->get_optional_query()</a></h2>
+<h3><a class='u'
+name="get_optional_query"
+>get_optional_query</a></h3>
+
+<pre> my $retval = $required_optional_query->get_optional_query();</pre>
<p>Getter for the optional Query.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="set_optional_query(optional_query)"
->set_optional_query(optional_query)</a></h2>
+<h3><a class='u'
+name="set_optional_query"
+>set_optional_query</a></h3>
+
+<pre> $required_optional_query->set_optional_query($optional_query);</pre>
<p>Setter for the optional Query.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h3><a class='u'
+name="make_compiler"
+>make_compiler</a></h3>
+
+<pre> my $retval = $required_optional_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::RequiredOptionalQuery isa <a href="../../Lucy/Search/PolyQuery.html" class="podlinkpod"
>Lucy::Search::PolyQuery</a> isa <a href="../../Lucy/Search/Query.html" class="podlinkpod"
Modified: lucy/site/trunk/content/docs/test/Lucy/Search/Searcher.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Search/Searcher.mdtext?rev=1732471&r1=1732470&r2=1732471&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Search/Searcher.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Search/Searcher.mdtext Fri Feb 26 12:52:25 2016
@@ -3,33 +3,33 @@ Title: Lucy::Search::Searcher - Apache L
<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::Searcher - Base class for searching collections of documents.</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>Abstract base class for objects which search. Core subclasses include <a href="../../Lucy/Search/IndexSearcher.html" class="podlinkpod"
->Lucy::Search::IndexSearcher</a> and <a href="../../Lucy/Search/PolySearcher.html" class="podlinkpod"
->Lucy::Search::PolySearcher</a>.</p>
+>IndexSearcher</a> and <a href="../../Lucy/Search/PolySearcher.html" class="podlinkpod"
+>PolySearcher</a>.</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> package MySearcher;
use base qw( Lucy::Search::Searcher );
@@ -45,32 +45,26 @@ name="new(_[labeled_params]_)"
<li><b>schema</b> - A Schema.</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="collect(_[labeled_params]_)"
->collect( <i>[labeled params]</i> )</a></h2>
+<h3><a class='u'
+name="doc_max"
+>doc_max</a></h3>
-<p>Iterate over hits, feeding them into a <a href="../../Lucy/Search/Collector.html" class="podlinkpod"
->Collector</a>.</p>
-
-<ul>
-<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="doc_max()"
->doc_max()</a></h2>
+<pre> my $retval = $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 = $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>
@@ -80,9 +74,29 @@ 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> $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>
+
+<ul>
+<li><b>query</b> - A Query.</li>
+
+<li><b>collector</b> - A Collector.</li>
+</ul>
+
+<h3><a class='u'
+name="fetch_doc"
+>fetch_doc</a></h3>
+
+<pre> my $retval = $searcher->fetch_doc($doc_id);</pre>
<p>Retrieve a document. Throws an error if the doc id is out of range.</p>
@@ -90,42 +104,54 @@ name="fetch_doc(doc_id)"
<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="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="glean_query"
+>glean_query</a></h3>
+
+<pre> my $retval = $searcher->glean_query($query);
+ my $retval = $searcher->glean_query(); # default: undef</pre>
+
+<p>If the supplied object is a Query, return it; if it’s a query string, create a QueryParser and parse it to produce a query against all indexed fields.</p>
+
+<h3><a class='u'
+name="hits"
+>hits</a></h3>
+
+<pre> my $retval = $searcher->hits(
+ query => $query # required
+ offset => $offset # default: 0
+ num_wanted => $num_wanted # default: 10
+ sort_spec => $sort_spec # default: undef
+ );</pre>
<p>Return a Hits object containing the top results.</p>
<ul>
<li><b>query</b> - Either a Query object or a query string.</li>
-<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>
+<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>
<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>
+>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="glean_query(query)"
->glean_query(query)</a></h2>
-
-<p>If the supplied object is a Query, return it; if it's a query string, create a QueryParser and parse it to produce a query against all indexed fields.</p>
+<h3><a class='u'
+name="get_schema"
+>get_schema</a></h3>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_schema()"
->get_schema()</a></h2>
+<pre> my $retval = $searcher->get_schema();</pre>
-<p>Accessor for the object's <code>schema</code> member.</p>
+<p>Accessor for the object’s <code>schema</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::Searcher isa Clownfish::Obj.</p>
Modified: lucy/site/trunk/content/docs/test/Lucy/Search/SortRule.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Search/SortRule.mdtext?rev=1732471&r1=1732470&r2=1732471&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Search/SortRule.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Search/SortRule.mdtext Fri Feb 26 12:52:25 2016
@@ -3,15 +3,15 @@ Title: Lucy::Search::SortRule - Apache L
<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::SortRule - Element of a SortSpec.</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 $sort_spec = Lucy::Search::SortSpec->new(
rules => [
@@ -20,20 +20,20 @@ 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>SortRules are the building blocks used to assemble <a href="../../Lucy/Search/SortSpec.html" class="podlinkpod"
->SortSpecs</a>; each SortRule defines a single level of sorting. For example, sorting first by "category" then by score requires a SortSpec with two SortRule elements.</p>
+>SortSpecs</a>; each SortRule defines a single level of sorting. For example, sorting first by “category” then by score requires a SortSpec with two SortRule elements.</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 $by_title = Lucy::Search::SortRule->new( field => 'title' );
my $by_score = Lucy::Search::SortRule->new( type => 'score' );
@@ -43,6 +43,8 @@ name="new(_[labeled_params]_)"
reverse => 1,
);</pre>
+<p>Create a new SortRule.</p>
+
<ul>
<li><b>type</b> - Indicate whether to sort by score, field, etc. (The default is to sort by a field.)</li>
@@ -51,25 +53,37 @@ name="new(_[labeled_params]_)"
<li><b>reverse</b> - If true, reverse the order of the sort for this rule.</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 = $sort_rule->get_field();</pre>
+
+<p>Accessor for “field” member.</p>
+
+<h3><a class='u'
+name="get_type"
+>get_type</a></h3>
+
+<pre> my $retval = $sort_rule->get_type();</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 “type” member.</p>
-<p>Accessor for "field" member.</p>
+<h3><a class='u'
+name="get_reverse"
+>get_reverse</a></h3>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_reverse()"
->get_reverse()</a></h2>
+<pre> my $retval = $sort_rule->get_reverse();</pre>
-<p>Accessor for "reverse" member.</p>
+<p>Accessor for “reverse” 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::SortRule isa Clownfish::Obj.</p>
Modified: lucy/site/trunk/content/docs/test/Lucy/Search/SortSpec.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Search/SortSpec.mdtext?rev=1732471&r1=1732470&r2=1732471&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Search/SortSpec.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Search/SortSpec.mdtext Fri Feb 26 12:52:25 2016
@@ -3,15 +3,15 @@ Title: Lucy::Search::SortSpec - Apache L
<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::SortSpec - Specify a custom sort order for 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 $sort_spec = Lucy::Search::SortSpec->new(
rules => [
@@ -24,9 +24,9 @@ name="SYNOPSIS"
sort_spec => $sort_spec,
);</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>By default, searches return results in order of relevance; SortSpec allows you to indicate an alternate order via an array of <a href="../../Lucy/Search/SortRule.html" class="podlinkpod"
>SortRules</a>.</p>
@@ -35,23 +35,25 @@ name="DESCRIPTION"
<p>For a stable sort (important when paging through results), add a sort-by-doc rule as the last SortRule.</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 $sort_spec = Lucy::Search::SortSpec->new( rules => \@rules );</pre>
+<p>Create a new SortSpec.</p>
+
<ul>
<li><b>rules</b> - An array of SortRules.</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::SortSpec isa Clownfish::Obj.</p>
Modified: lucy/site/trunk/content/docs/test/Lucy/Search/Span.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Search/Span.mdtext?rev=1732471&r1=1732470&r2=1732471&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Search/Span.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Search/Span.mdtext Fri Feb 26 12:52:25 2016
@@ -3,17 +3,17 @@ Title: Lucy::Search::Span - Apache Lucy
<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::Span - An offset,
a length,
and a weight.</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 $combined_length = $upper_span->get_length
+ ( $upper_span->get_offset - $lower_span->get_offset );
@@ -23,21 +23,21 @@ 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>Span objects store information about a span across an array of... something. The unit is context-dependent.</p>
+<p>Span objects store information about a span across an array of… something. The unit is context-dependent.</p>
-<p>Text is one possibility, in which case offset and length might be measured in Unicode code points. However, the Span could also refer to a span within an array of tokens, for example -- in which case the start and offset might be measured in token positions.</p>
+<p>Text is one possibility, in which case offset and length might be measured in Unicode code points. However, the Span could also refer to a span within an array of tokens, for example – in which case the start and offset might be measured in token positions.</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 $span = Lucy::Search::Span->new(
offset => 75, # required
@@ -45,6 +45,8 @@ name="new(_[labeled_params]_)"
weight => 1.0, # default 0.0
);</pre>
+<p>Create a new Span.</p>
+
<ul>
<li><b>offset</b> - Integer offset, unit is context-dependent.</li>
@@ -53,49 +55,75 @@ name="new(_[labeled_params]_)"
<li><b>weight</b> - A floating point weight.</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_offset"
+>get_offset</a></h3>
+
+<pre> my $retval = $span->get_offset();</pre>
+
+<p>Accessor for <code>offset</code> attribute.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="set_offset(offset)"
->set_offset(offset)</a></h2>
+<h3><a class='u'
+name="set_offset"
+>set_offset</a></h3>
+
+<pre> $span->set_offset($offset);</pre>
<p>Setter for <code>offset</code> attribute.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_offset()"
->get_offset()</a></h2>
+<h3><a class='u'
+name="get_length"
+>get_length</a></h3>
-<p>Accessor for <code>offset</code> attribute.</p>
+<pre> my $retval = $span->get_length();</pre>
+
+<p>Accessor for <code>length</code> attribute.</p>
+
+<h3><a class='u'
+name="set_length"
+>set_length</a></h3>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="set_length(length)"
->set_length(length)</a></h2>
+<pre> $span->set_length($length);</pre>
<p>Setter for <code>length</code> attribute.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_length()"
->get_length()</a></h2>
+<h3><a class='u'
+name="get_weight"
+>get_weight</a></h3>
-<p>Accessor for <code>length</code> attribute.</p>
+<pre> my $retval = $span->get_weight();</pre>
+
+<p>Accessor for <code>weight</code> attribute.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="set_weight(weight)"
->set_weight(weight)</a></h2>
+<h3><a class='u'
+name="set_weight"
+>set_weight</a></h3>
+
+<pre> $span->set_weight($weight);</pre>
<p>Setter for <code>weight</code> attribute.</p>
-<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="compare_to"
+>compare_to</a></h3>
-<p>Accessor for <code>weight</code> attribute.</p>
+<pre> my $retval = $span->compare_to($other);</pre>
+
+<p>Indicate whether one object is less than, equal to, or greater than another.</p>
+
+<ul>
+<li><b>other</b> - Another Obj.</li>
+</ul>
+
+<p>Returns: 0 if the objects are equal, a negative number if <code>self</code> is less than <code>other</code>, and a positive number if <code>self</code> is greater than <code>other</code>.</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::Span isa Clownfish::Obj.</p>
Modified: lucy/site/trunk/content/docs/test/Lucy/Search/TermQuery.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Search/TermQuery.mdtext?rev=1732471&r1=1732470&r2=1732471&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Search/TermQuery.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Search/TermQuery.mdtext Fri Feb 26 12:52:25 2016
@@ -3,15 +3,15 @@ Title: Lucy::Search::TermQuery - Apache
<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::TermQuery - Query which matches individual 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 $term_query = Lucy::Search::TermQuery->new(
field => 'content',
@@ -19,51 +19,78 @@ name="SYNOPSIS"
);
my $hits = $searcher->hits( query => $term_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>TermQuery is a subclass of <a href="../../Lucy/Search/Query.html" class="podlinkpod"
->Lucy::Search::Query</a> for matching individual terms in a specific field.</p>
+>Query</a> for matching individual terms in a specific field.</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 $term_query = Lucy::Search::TermQuery->new(
field => 'content', # required
term => 'foo', # required
);</pre>
+<p>Create a new TermQuery.</p>
+
<ul>
<li><b>field</b> - Field name.</li>
<li><b>term</b> - Term 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 = $term_query->get_field();</pre>
+
+<p>Accessor for object’s <code>field</code> member.</p>
+
+<h3><a class='u'
+name="get_term"
+>get_term</a></h3>
+
+<pre> my $retval = $term_query->get_term();</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 <code>term</code> member.</p>
-<p>Accessor for object's <code>field</code> member.</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_term()"
->get_term()</a></h2>
+<pre> my $retval = $term_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>Accessor for object's <code>term</code> member.</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::TermQuery isa <a href="../../Lucy/Search/Query.html" class="podlinkpod"
>Lucy::Search::Query</a> isa Clownfish::Obj.</p>
Modified: lucy/site/trunk/content/docs/test/Lucy/Simple.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Simple.mdtext?rev=1732471&r1=1732470&r2=1732471&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Simple.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Simple.mdtext Fri Feb 26 12:52:25 2016
@@ -3,15 +3,15 @@ Title: Lucy::Simple - Apache Lucy Docume
<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::Simple - Basic search engine.</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>
<p>First,
build an index of your documents.</p>
@@ -30,7 +30,7 @@ build an index of your documents.</p>
<p>Later, search the index.</p>
-<pre> my $total_hits = $index->search(
+<pre> my $total_hits = $index->search(
query => $query_string,
offset => 0,
num_wanted => 10,
@@ -41,27 +41,26 @@ build an index of your documents.</p>
print "$hit->{title}\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>Lucy::Simple is a stripped-down interface for the <a href="../Lucy.html" class="podlinkpod"
->Apache Lucy</a> search engine library.</p>
+<p>Lucy::Simple is a stripped-down interface for the Apache Lucy search engine library.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
-name="METHODS"
->METHODS</a></h1>
+<h2><a class='u'
+name="CONSTRUCTORS"
+>CONSTRUCTORS</a></h2>
-<h2><a class='u' href='#___top' title='click to go to top of document'
+<h3><a class='u'
name="new"
->new</a></h2>
+>new</a></h3>
<pre> my $lucy = Lucy::Simple->new(
path => '/path/to/index/',
language => 'en',
);</pre>
-<p>Create a Lucy::Simple object, which can be used for both indexing and searching. Two hash-style parameters are required.</p>
+<p>Create a Lucy::Simple object, which can be used for both indexing and searching. Both parameters <code>path</code> and <code>language</code> are required.</p>
<ul>
<li><b>path</b> - Where the index directory should be located. If no index is found at the specified location, one will be created.</li>
@@ -86,9 +85,13 @@ name="new"
</li>
</ul>
-<h2><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_doc"
->add_doc</a></h2>
+>add_doc</a></h3>
<pre> $lucy->add_doc({
location => $url,
@@ -98,14 +101,14 @@ name="add_doc"
<p>Add a document to the index. The document must be supplied as a hashref, with field names as keys and content as values.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
+<h3><a class='u'
name="search"
->search</a></h2>
+>search</a></h3>
-<pre> my $total_hits = $lucy->search(
- query => $query_string, # required
- offset => 40, # default 0
- num_wanted => 20, # default 10
+<pre> my $retval = $simple->search(
+ query => $query # required
+ offset => $offset # default: 0
+ num_wanted => $num_wanted # default: 10
);</pre>
<p>Search the index. Returns the total number of documents which match the query. (This number is unlikely to match <code>num_wanted</code>.)</p>
@@ -113,15 +116,23 @@ name="search"
<ul>
<li><b>query</b> - A search query string.</li>
-<li><b>offset</b> - The number of most-relevant hits to discard, typically used when "paging" through hits N at a time. Setting offset to 20 and num_wanted to 10 retrieves hits 21-30, assuming that 30 hits can be found.</li>
+<li><b>offset</b> - The number of most-relevant hits to discard, typically used when “paging” through hits N at a time. Setting offset to 20 and num_wanted to 10 retrieves hits 21-30, assuming that 30 hits can be found.</li>
<li><b>num_wanted</b> - The number of hits you would like to see after <code>offset</code> is taken into account.</li>
</ul>
-<h1><a class='u' href='#___top' title='click to go to top of document'
-name="BUGS"
->BUGS</a></h1>
+<h3><a class='u'
+name="next"
+>next</a></h3>
+
+<pre> my $retval = $simple->next();</pre>
+
+<p>Return the next hit, or undef when the iterator is exhausted.</p>
+
+<h2><a class='u'
+name="INHERITANCE"
+>INHERITANCE</a></h2>
-<p>Not thread-safe.</p>
+<p>Lucy::Simple isa Clownfish::Obj.</p>
</div>