You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucy.apache.org by bu...@apache.org on 2016/02/26 14:44:49 UTC
svn commit: r981214 [5/6] - in /websites/staging/lucy/trunk/content: ./
docs/test/ docs/test/Lucy/ docs/test/Lucy/Analysis/ docs/test/Lucy/Docs/
docs/test/Lucy/Docs/Cookbook/ docs/test/Lucy/Docs/Tutorial/
docs/test/Lucy/Document/ docs/test/Lucy/Highlig...
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 13:44:48 2016
@@ -81,24 +81,28 @@ name="NAME"
name="SYNOPSIS"
>SYNOPSIS</a></h2>
-<pre> my $searcher = Lucy::Search::IndexSearcher->new(
- index => '/path/to/index'
- );
- my $hits = $searcher->hits(
- query => 'foo bar',
- offset => 0,
- num_wanted => 100,
- );</pre>
+<pre>my $searcher = Lucy::Search::IndexSearcher->new(
+ index => '/path/to/index'
+);
+my $hits = $searcher->hits(
+ query => 'foo bar',
+ offset => 0,
+ num_wanted => 100,
+);</pre>
<h2><a class='u'
name="DESCRIPTION"
>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"
+<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>
<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>
+>Snapshot</a> of the index.
+If an index is modified,
+a new IndexSearcher must be opened to access the changes.</p>
<h2><a class='u'
name="CONSTRUCTORS"
@@ -108,14 +112,16 @@ name="CONSTRUCTORS"
name="new"
>new</a></h3>
-<pre> my $searcher = Lucy::Search::IndexSearcher->new(
- index => '/path/to/index'
- );</pre>
+<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>
+<li><b>index</b> - Either a string filepath,
+a Folder,
+or an IndexReader.</li>
</ul>
<h2><a class='u'
@@ -126,18 +132,20 @@ name="METHODS"
name="doc_max"
>doc_max</a></h3>
-<pre> my $retval = $index_searcher->doc_max();</pre>
+<pre>my $retval = $index_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>
+<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>
<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>
+<pre>my $retval = $index_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>
@@ -151,12 +159,13 @@ name="doc_freq"
name="collect"
>collect</a></h3>
-<pre> $index_searcher->collect(
- query => $query # required
- collector => $collector # required
- );</pre>
+<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"
+<p>Iterate over hits,
+feeding them into a <a href="../../Lucy/Search/Collector.html" class="podlinkpod"
>Collector</a>.</p>
<ul>
@@ -169,9 +178,10 @@ name="collect"
name="fetch_doc"
>fetch_doc</a></h3>
-<pre> my $retval = $index_searcher->fetch_doc($doc_id);</pre>
+<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>
+<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>
@@ -181,7 +191,7 @@ name="fetch_doc"
name="get_reader"
>get_reader</a></h3>
-<pre> my $retval = $index_searcher->get_reader();</pre>
+<pre>my $retval = $index_searcher->get_reader();</pre>
<p>Accessor for the object’s <code>reader</code> member.</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 13:44:48 2016
@@ -81,21 +81,21 @@ name="NAME"
name="SYNOPSIS"
>SYNOPSIS</a></h2>
-<pre> package MyQueryParser;
- use base qw( Lucy::Search::QueryParser );
+<pre>package MyQueryParser;
+use base qw( Lucy::Search::QueryParser );
- sub expand_leaf {
- my ( $self, $leaf_query ) = @_;
- if ( $leaf_query->get_text =~ /.\*\s*$/ ) {
- return PrefixQuery->new(
- query_string => $leaf_query->get_text,
- field => $leaf_query->get_field,
- );
- }
- else {
- return $self->SUPER::expand_leaf($leaf_query);
- }
- }</pre>
+sub expand_leaf {
+ my ( $self, $leaf_query ) = @_;
+ if ( $leaf_query->get_text =~ /.\*\s*$/ ) {
+ return PrefixQuery->new(
+ query_string => $leaf_query->get_text,
+ field => $leaf_query->get_field,
+ );
+ }
+ else {
+ return $self->SUPER::expand_leaf($leaf_query);
+ }
+}</pre>
<h2><a class='u'
name="DESCRIPTION"
@@ -103,9 +103,13 @@ name="DESCRIPTION"
<p>LeafQuery objects serve as leaf nodes in the tree structure generated by <a href="../../Lucy/Search/QueryParser.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"
+>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>
+>PhraseQuery</a> objects,
+as attempting to search a LeafQuery causes an error.</p>
<h2><a class='u'
name="CONSTRUCTORS"
@@ -115,10 +119,10 @@ name="CONSTRUCTORS"
name="new"
>new</a></h3>
-<pre> my $leaf_query = Lucy::Search::LeafQuery->new(
- text => '"three blind mice"', # required
- field => 'content', # default: undef
- );</pre>
+<pre>my $leaf_query = Lucy::Search::LeafQuery->new(
+ text => '"three blind mice"', # required
+ field => 'content', # default: undef
+);</pre>
<p>Create a new LeafQuery.</p>
@@ -136,7 +140,7 @@ name="METHODS"
name="get_field"
>get_field</a></h3>
-<pre> my $retval = $leaf_query->get_field();</pre>
+<pre>my $retval = $leaf_query->get_field();</pre>
<p>Accessor for object’s <code>field</code> attribute.</p>
@@ -144,7 +148,7 @@ name="get_field"
name="get_text"
>get_text</a></h3>
-<pre> my $retval = $leaf_query->get_text();</pre>
+<pre>my $retval = $leaf_query->get_text();</pre>
<p>Accessor for object’s <code>text</code> attribute.</p>
@@ -152,11 +156,11 @@ name="get_text"
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>
+<pre>my $retval = $leaf_query->make_compiler(
+ searcher => $searcher # required
+ boost => $boost # required
+ subordinate => $subordinate # default: false
+);</pre>
<p>Throws an error.</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 13:44:48 2016
@@ -94,9 +94,10 @@ name="CONSTRUCTORS"
name="new"
>new</a></h3>
-<pre> my $match_all_query = Lucy::Search::MatchAllQuery->new;</pre>
+<pre>my $match_all_query = Lucy::Search::MatchAllQuery->new;</pre>
-<p>Constructor. Takes no arguments.</p>
+<p>Constructor.
+Takes no arguments.</p>
<h2><a class='u'
name="METHODS"
@@ -106,11 +107,11 @@ name="METHODS"
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>
+<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>
@@ -119,7 +120,9 @@ name="make_compiler"
<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"
+<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>
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 13:44:48 2016
@@ -81,14 +81,16 @@ name="NAME"
name="SYNOPSIS"
>SYNOPSIS</a></h2>
-<pre> # abstract base class</pre>
+<pre># abstract base class</pre>
<h2><a class='u'
name="DESCRIPTION"
>DESCRIPTION</a></h2>
-<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>
+<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>
<h2><a class='u'
name="CONSTRUCTORS"
@@ -98,7 +100,7 @@ name="CONSTRUCTORS"
name="new"
>new</a></h3>
-<pre> my $matcher = MyMatcher->SUPER::new;</pre>
+<pre>my $matcher = MyMatcher->SUPER::new;</pre>
<p>Abstract constructor.</p>
@@ -110,19 +112,21 @@ name="ABSTRACT_METHODS"
name="next"
>next</a></h3>
-<pre> my $retval = $matcher->next();</pre>
+<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>
+<p>Returns: A positive doc id,
+or 0 once the iterator is exhausted.</p>
<h3><a class='u'
name="get_doc_id"
>get_doc_id</a></h3>
-<pre> my $retval = $matcher->get_doc_id();</pre>
+<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"
+<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>
@@ -130,7 +134,7 @@ name="get_doc_id"
name="score"
>score</a></h3>
-<pre> my $retval = $matcher->score();</pre>
+<pre>my $retval = $matcher->score();</pre>
<p>Return the score of the current document.</p>
@@ -145,16 +149,20 @@ name="METHODS"
name="advance"
>advance</a></h3>
-<pre> my $retval = $matcher->advance($target);</pre>
+<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 <a href="#next" class="podlinkpod"
->next()</a> 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>
+<li><b>target</b> - A positive doc id,
+which must be greater than the current doc id once the iterator has been initialized.</li>
</ul>
-<p>Returns: A positive doc id, or 0 once the iterator is exhausted.</p>
+<p>Returns: A positive doc id,
+or 0 once the iterator is exhausted.</p>
<h2><a class='u'
name="INHERITANCE"
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 13:44:48 2016
@@ -81,21 +81,22 @@ name="NAME"
name="SYNOPSIS"
>SYNOPSIS</a></h2>
-<pre> my $not_bar_query = Lucy::Search::NOTQuery->new(
- negated_query => $bar_query,
- );
- my $foo_and_not_bar_query = Lucy::Search::ANDQuery->new(
- children => [ $foo_query, $not_bar_query ].
- );
- my $hits = $searcher->hits( query => $foo_and_not_bar_query );
- ...</pre>
+<pre>my $not_bar_query = Lucy::Search::NOTQuery->new(
+ negated_query => $bar_query,
+);
+my $foo_and_not_bar_query = Lucy::Search::ANDQuery->new(
+ children => [ $foo_query, $not_bar_query ].
+);
+my $hits = $searcher->hits( query => $foo_and_not_bar_query );
+...</pre>
<h2><a class='u'
name="DESCRIPTION"
>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>
+>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>
@@ -108,9 +109,9 @@ name="CONSTRUCTORS"
name="new"
>new</a></h3>
-<pre> my $not_query = Lucy::Search::NOTQuery->new(
- negated_query => $query,
- );</pre>
+<pre>my $not_query = Lucy::Search::NOTQuery->new(
+ negated_query => $query,
+);</pre>
<p>Create a new NOTQuery.</p>
@@ -126,7 +127,7 @@ name="METHODS"
name="get_negated_query"
>get_negated_query</a></h3>
-<pre> my $retval = $not_query->get_negated_query();</pre>
+<pre>my $retval = $not_query->get_negated_query();</pre>
<p>Accessor for the object’s negated query.</p>
@@ -134,7 +135,7 @@ name="get_negated_query"
name="set_negated_query"
>set_negated_query</a></h3>
-<pre> $not_query->set_negated_query($negated_query);</pre>
+<pre>$not_query->set_negated_query($negated_query);</pre>
<p>Setter for the object’s negated query.</p>
@@ -142,11 +143,11 @@ name="set_negated_query"
name="make_compiler"
>make_compiler</a></h3>
-<pre> my $retval = $not_query->make_compiler(
- searcher => $searcher # required
- boost => $boost # required
- subordinate => $subordinate # default: false
- );</pre>
+<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>
@@ -155,7 +156,9 @@ name="make_compiler"
<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"
+<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>
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 13:44:48 2016
@@ -94,9 +94,10 @@ name="CONSTRUCTORS"
name="new"
>new</a></h3>
-<pre> my $no_match_query = Lucy::Search::NoMatchQuery->new;</pre>
+<pre>my $no_match_query = Lucy::Search::NoMatchQuery->new;</pre>
-<p>Constructor. Takes no arguments.</p>
+<p>Constructor.
+Takes no arguments.</p>
<h2><a class='u'
name="METHODS"
@@ -106,11 +107,11 @@ name="METHODS"
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>
+<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>
@@ -119,7 +120,9 @@ name="make_compiler"
<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"
+<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>
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 13:44:48 2016
@@ -81,18 +81,20 @@ name="NAME"
name="SYNOPSIS"
>SYNOPSIS</a></h2>
-<pre> my $foo_or_bar_query = Lucy::Search::ORQuery->new(
- children => [ $foo_query, $bar_query ],
- );
- my $hits = $searcher->hits( query => $foo_or_bar_query );
- ...</pre>
+<pre>my $foo_or_bar_query = Lucy::Search::ORQuery->new(
+ children => [ $foo_query, $bar_query ],
+);
+my $hits = $searcher->hits( query => $foo_or_bar_query );
+...</pre>
<h2><a class='u'
name="DESCRIPTION"
>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>
+>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>
<h2><a class='u'
name="CONSTRUCTORS"
@@ -102,9 +104,9 @@ name="CONSTRUCTORS"
name="new"
>new</a></h3>
-<pre> my $foo_or_bar_query = Lucy::Search::ORQuery->new(
- children => [ $foo_query, $bar_query ],
- );</pre>
+<pre>my $foo_or_bar_query = Lucy::Search::ORQuery->new(
+ children => [ $foo_query, $bar_query ],
+);</pre>
<p>Create a new ORQuery.</p>
@@ -120,11 +122,11 @@ name="METHODS"
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>
+<pre>my $retval = $or_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>
@@ -133,7 +135,9 @@ name="make_compiler"
<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"
+<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>
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 13:44:48 2016
@@ -81,11 +81,11 @@ name="NAME"
name="SYNOPSIS"
>SYNOPSIS</a></h2>
-<pre> my $phrase_query = Lucy::Search::PhraseQuery->new(
- field => 'content',
- terms => [qw( the who )],
- );
- my $hits = $searcher->hits( query => $phrase_query );</pre>
+<pre>my $phrase_query = Lucy::Search::PhraseQuery->new(
+ field => 'content',
+ terms => [qw( the who )],
+);
+my $hits = $searcher->hits( query => $phrase_query );</pre>
<h2><a class='u'
name="DESCRIPTION"
@@ -102,10 +102,10 @@ name="CONSTRUCTORS"
name="new"
>new</a></h3>
-<pre> my $phrase_query = Lucy::Search::PhraseQuery->new(
- field => $field # required
- terms => $terms # required
- );</pre>
+<pre>my $phrase_query = Lucy::Search::PhraseQuery->new(
+ field => $field # required
+ terms => $terms # required
+);</pre>
<p>Create a new PhraseQuery.</p>
@@ -123,7 +123,7 @@ name="METHODS"
name="get_field"
>get_field</a></h3>
-<pre> my $retval = $phrase_query->get_field();</pre>
+<pre>my $retval = $phrase_query->get_field();</pre>
<p>Accessor for object’s field attribute.</p>
@@ -131,7 +131,7 @@ name="get_field"
name="get_terms"
>get_terms</a></h3>
-<pre> my $retval = $phrase_query->get_terms();</pre>
+<pre>my $retval = $phrase_query->get_terms();</pre>
<p>Accessor for object’s array of terms.</p>
@@ -139,11 +139,11 @@ name="get_terms"
name="make_compiler"
>make_compiler</a></h3>
-<pre> my $retval = $phrase_query->make_compiler(
- searcher => $searcher # required
- boost => $boost # required
- subordinate => $subordinate # default: false
- );</pre>
+<pre>my $retval = $phrase_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>
@@ -152,7 +152,9 @@ name="make_compiler"
<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"
+<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>
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 13:44:48 2016
@@ -81,28 +81,32 @@ name="NAME"
name="SYNOPSIS"
>SYNOPSIS</a></h2>
-<pre> sub walk {
- my $query = shift;
- if ( $query->isa("Lucy::Search::PolyQuery") ) {
- if ( $query->isa("Lucy::Search::ORQuery") ) { ... }
- elsif ( $query->isa("Lucy::Search::ANDQuery") ) { ... }
- elsif ( $query->isa("Lucy::Search::RequiredOptionalQuery") ) {
- ...
- }
- elsif ( $query->isa("Lucy::Search::NOTQuery") ) { ... }
+<pre>sub walk {
+ my $query = shift;
+ if ( $query->isa("Lucy::Search::PolyQuery") ) {
+ if ( $query->isa("Lucy::Search::ORQuery") ) { ... }
+ elsif ( $query->isa("Lucy::Search::ANDQuery") ) { ... }
+ elsif ( $query->isa("Lucy::Search::RequiredOptionalQuery") ) {
+ ...
}
- else { ... }
- }</pre>
+ elsif ( $query->isa("Lucy::Search::NOTQuery") ) { ... }
+ }
+ else { ... }
+}</pre>
<h2><a class='u'
name="DESCRIPTION"
>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"
->ORQuery</a>, <a href="../../Lucy/Search/NOTQuery.html" class="podlinkpod"
->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>
+>ANDQuery</a>,
+<a href="../../Lucy/Search/ORQuery.html" class="podlinkpod"
+>ORQuery</a>,
+<a href="../../Lucy/Search/NOTQuery.html" class="podlinkpod"
+>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>
<h2><a class='u'
name="METHODS"
@@ -112,7 +116,7 @@ name="METHODS"
name="add_child"
>add_child</a></h3>
-<pre> $poly_query->add_child($query);</pre>
+<pre>$poly_query->add_child($query);</pre>
<p>Add a child Query node.</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 13:44:48 2016
@@ -81,15 +81,15 @@ name="NAME"
name="SYNOPSIS"
>SYNOPSIS</a></h2>
-<pre> my $schema = MySchema->new;
- for my $index (@index_paths) {
- push @searchers, Lucy::Search::IndexSearcher->new( index => $index );
- }
- my $poly_searcher = Lucy::Search::PolySearcher->new(
- schema => $schema,
- searchers => \@searchers,
- );
- my $hits = $poly_searcher->hits( query => $query );</pre>
+<pre>my $schema = MySchema->new;
+for my $index (@index_paths) {
+ push @searchers, Lucy::Search::IndexSearcher->new( index => $index );
+}
+my $poly_searcher = Lucy::Search::PolySearcher->new(
+ schema => $schema,
+ searchers => \@searchers,
+);
+my $hits = $poly_searcher->hits( query => $query );</pre>
<h2><a class='u'
name="DESCRIPTION"
@@ -105,10 +105,10 @@ name="CONSTRUCTORS"
name="new"
>new</a></h3>
-<pre> my $poly_searcher = Lucy::Search::PolySearcher->new(
- schema => $schema,
- searchers => \@searchers,
- );</pre>
+<pre>my $poly_searcher = Lucy::Search::PolySearcher->new(
+ schema => $schema,
+ searchers => \@searchers,
+);</pre>
<p>Create a new PolySearcher.</p>
@@ -126,18 +126,20 @@ name="METHODS"
name="doc_max"
>doc_max</a></h3>
-<pre> my $retval = $poly_searcher->doc_max();</pre>
+<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>
+<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>
<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>
+<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>
@@ -151,12 +153,13 @@ name="doc_freq"
name="collect"
>collect</a></h3>
-<pre> $poly_searcher->collect(
- query => $query # required
- collector => $collector # required
- );</pre>
+<pre>$poly_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"
+<p>Iterate over hits,
+feeding them into a <a href="../../Lucy/Search/Collector.html" class="podlinkpod"
>Collector</a>.</p>
<ul>
@@ -169,9 +172,10 @@ name="collect"
name="fetch_doc"
>fetch_doc</a></h3>
-<pre> my $retval = $poly_searcher->fetch_doc($doc_id);</pre>
+<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>
+<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>
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 13:44:48 2016
@@ -81,21 +81,21 @@ name="NAME"
name="SYNOPSIS"
>SYNOPSIS</a></h2>
-<pre> # Query is an abstract base class.
- package MyQuery;
- use base qw( Lucy::Search::Query );
-
- sub make_compiler {
- my ( $self, %args ) = @_;
- my $subordinate = delete $args{subordinate};
- my $compiler = MyCompiler->new( %args, parent => $self );
- $compiler->normalize unless $subordinate;
- return $compiler;
- }
-
- package MyCompiler;
- use base ( Lucy::Search::Compiler );
- ...</pre>
+<pre># Query is an abstract base class.
+package MyQuery;
+use base qw( Lucy::Search::Query );
+
+sub make_compiler {
+ my ( $self, %args ) = @_;
+ my $subordinate = delete $args{subordinate};
+ my $compiler = MyCompiler->new( %args, parent => $self );
+ $compiler->normalize unless $subordinate;
+ return $compiler;
+}
+
+package MyCompiler;
+use base ( Lucy::Search::Compiler );
+...</pre>
<h2><a class='u'
name="DESCRIPTION"
@@ -105,12 +105,16 @@ name="DESCRIPTION"
<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"
+>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>
+>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 <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"
+>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>
<h2><a class='u'
@@ -121,14 +125,17 @@ name="CONSTRUCTORS"
name="new"
>new</a></h3>
-<pre> my $query = MyQuery->SUPER::new(
- boost => 2.5,
- );</pre>
+<pre>my $query = MyQuery->SUPER::new(
+ boost => 2.5,
+);</pre>
<p>Abstract constructor.</p>
<ul>
-<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>
+<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>
<h2><a class='u'
@@ -139,11 +146,11 @@ name="ABSTRACT_METHODS"
name="make_compiler"
>make_compiler</a></h3>
-<pre> my $retval = $query->make_compiler(
- searcher => $searcher # required
- boost => $boost # required
- subordinate => $subordinate # default: false
- );</pre>
+<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>
@@ -152,7 +159,9 @@ name="make_compiler"
<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"
+<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>
@@ -164,7 +173,7 @@ name="METHODS"
name="set_boost"
>set_boost</a></h3>
-<pre> $query->set_boost($boost);</pre>
+<pre>$query->set_boost($boost);</pre>
<p>Set the Query’s boost.</p>
@@ -172,7 +181,7 @@ name="set_boost"
name="get_boost"
>get_boost</a></h3>
-<pre> my $retval = $query->get_boost();</pre>
+<pre>my $retval = $query->get_boost();</pre>
<p>Get the Query’s boost.</p>
@@ -180,13 +189,13 @@ name="get_boost"
name="dump"
>dump</a></h3>
-<pre> my $retval = $query->dump();</pre>
+<pre>my $retval = $query->dump();</pre>
<h3><a class='u'
name="load"
>load</a></h3>
-<pre> my $retval = $query->load($dump);</pre>
+<pre>my $retval = $query->load($dump);</pre>
<h2><a class='u'
name="INHERITANCE"
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 13:44:48 2016
@@ -81,39 +81,50 @@ name="NAME"
name="SYNOPSIS"
>SYNOPSIS</a></h2>
-<pre> my $query_parser = Lucy::Search::QueryParser->new(
- schema => $searcher->get_schema,
- fields => ['body'],
- );
- my $query = $query_parser->parse( $query_string );
- my $hits = $searcher->hits( query => $query );</pre>
+<pre>my $query_parser = Lucy::Search::QueryParser->new(
+ schema => $searcher->get_schema,
+ fields => ['body'],
+);
+my $query = $query_parser->parse( $query_string );
+my $hits = $searcher->hits( query => $query );</pre>
<h2><a class='u'
name="DESCRIPTION"
>DESCRIPTION</a></h2>
<p>QueryParser accepts search strings as input and produces <a href="../../Lucy/Search/Query.html" class="podlinkpod"
->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>
<ul>
-<li>Boolean operators ‘AND’, ‘OR’, and ‘AND NOT’.</li>
+<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>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>Logical groups,
+delimited by parentheses.</li>
-<li>Phrases, delimited by double quotes.</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"
+<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>
+<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>
<h2><a class='u'
@@ -124,12 +135,12 @@ name="CONSTRUCTORS"
name="new"
>new</a></h3>
-<pre> my $query_parser = Lucy::Search::QueryParser->new(
- schema => $searcher->get_schema, # required
- analyzer => $analyzer, # overrides schema
- fields => ['bodytext'], # default: indexed fields
- default_boolop => 'AND', # default: 'OR'
- );</pre>
+<pre>my $query_parser = Lucy::Search::QueryParser->new(
+ schema => $searcher->get_schema, # required
+ analyzer => $analyzer, # overrides schema
+ fields => ['bodytext'], # default: indexed fields
+ default_boolop => 'AND', # default: 'OR'
+);</pre>
<p>Constructor.</p>
@@ -138,11 +149,22 @@ name="new"
>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>
-
-<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>
+>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>
</ul>
<h2><a class='u'
@@ -153,16 +175,21 @@ name="METHODS"
name="parse"
>parse</a></h3>
-<pre> my $retval = $query_parser->parse($query_string);
- my $retval = $query_parser->parse(); # default: undef</pre>
+<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"
+<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>
+<li><b>query_string</b> - The string to be parsed.
+May be undef.</li>
</ul>
<p>Returns: a Query.</p>
@@ -171,9 +198,15 @@ name="parse"
name="tree"
>tree</a></h3>
-<pre> my $retval = $query_parser->tree($query_string);</pre>
+<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>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 <a href="#tree" class="podlinkpod"
>tree()</a> is an intermediate form which must be passed through <a href="#expand" class="podlinkpod"
@@ -189,27 +222,35 @@ name="tree"
name="expand"
>expand</a></h3>
-<pre> my $retval = $query_parser->expand($query);</pre>
+<pre>my $retval = $query_parser->expand($query);</pre>
-<p>Walk the hierarchy of a Query tree, descending through all PolyQuery nodes and calling <a href="#expand_leaf" class="podlinkpod"
+<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>
<h3><a class='u'
name="expand_leaf"
>expand_leaf</a></h3>
-<pre> my $retval = $query_parser->expand_leaf($query);</pre>
+<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>
+<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>
<ul>
-<li><b>query</b> - A Query. Only LeafQuery objects will be processed; others will be passed through.</li>
+<li><b>query</b> - A Query.
+Only LeafQuery objects will be processed; others will be passed through.</li>
</ul>
<p>Returns: A Query.</p>
@@ -218,42 +259,49 @@ name="expand_leaf"
name="prune"
>prune</a></h3>
-<pre> my $retval = $query_parser->prune($query);
- my $retval = $query_parser->prune(); # default: undef</pre>
+<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"
+<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"
+>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>
+<pre> 'NOT foo' => [NOMATCH]
+ 'foo OR NOT bar' => 'foo'
+ 'foo OR (-bar AND -baz) => 'foo'</pre>
<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>
+<pre> 'foo AND -(-bar)' => 'foo'</pre>
-<p>In this example, safety is taking precedence over logical consistency. If you want logical consistency instead, call <a href="#tree" class="podlinkpod"
+<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"
+>expand()</a>,
+skipping <a href="#prune" class="podlinkpod"
>prune()</a>.</p>
<ul>
<li><b>query</b> - A Query.</li>
</ul>
-<p>Returns: a Query; in most cases, the supplied Query after in-place modification.</p>
+<p>Returns: a Query; in most cases,
+the supplied Query after in-place modification.</p>
<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>
+<pre>my $retval = $query_parser->make_term_query(
+ field => $field # required
+ term => $term # required
+);</pre>
<p>Factory method creating a TermQuery.</p>
@@ -269,10 +317,10 @@ name="make_term_query"
name="make_phrase_query"
>make_phrase_query</a></h3>
-<pre> my $retval = $query_parser->make_phrase_query(
- field => $field # required
- terms => $terms # required
- );</pre>
+<pre>my $retval = $query_parser->make_phrase_query(
+ field => $field # required
+ terms => $terms # required
+);</pre>
<p>Factory method creating a PhraseQuery.</p>
@@ -288,8 +336,8 @@ name="make_phrase_query"
name="make_or_query"
>make_or_query</a></h3>
-<pre> my $retval = $query_parser->make_or_query($children);
- my $retval = $query_parser->make_or_query(); # default: undef</pre>
+<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>
@@ -303,8 +351,8 @@ name="make_or_query"
name="make_and_query"
>make_and_query</a></h3>
-<pre> my $retval = $query_parser->make_and_query($children);
- my $retval = $query_parser->make_and_query(); # default: undef</pre>
+<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>
@@ -318,7 +366,7 @@ name="make_and_query"
name="make_not_query"
>make_not_query</a></h3>
-<pre> my $retval = $query_parser->make_not_query($negated_query);</pre>
+<pre>my $retval = $query_parser->make_not_query($negated_query);</pre>
<p>Factory method creating a NOTQuery.</p>
@@ -332,10 +380,10 @@ name="make_not_query"
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>
+<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>
@@ -351,7 +399,7 @@ name="make_req_opt_query"
name="set_heed_colons"
>set_heed_colons</a></h3>
-<pre> $query_parser->set_heed_colons($heed_colons);</pre>
+<pre>$query_parser->set_heed_colons($heed_colons);</pre>
<p>Enable/disable parsing of <code>fieldname:foo</code> constructs.</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 13:44:48 2016
@@ -81,21 +81,21 @@ name="NAME"
name="SYNOPSIS"
>SYNOPSIS</a></h2>
-<pre> # Match all articles by "Foo" published since the year 2000.
- my $range_query = Lucy::Search::RangeQuery->new(
- field => 'publication_date',
- lower_term => '2000-01-01',
- include_lower => 1,
- );
- my $author_query = Lucy::Search::TermQuery->new(
- field => 'author_last_name',
- text => 'Foo',
- );
- my $and_query = Lucy::Search::ANDQuery->new(
- children => [ $range_query, $author_query ],
- );
- my $hits = $searcher->hits( query => $and_query );
- ...</pre>
+<pre># Match all articles by "Foo" published since the year 2000.
+my $range_query = Lucy::Search::RangeQuery->new(
+ field => 'publication_date',
+ lower_term => '2000-01-01',
+ include_lower => 1,
+);
+my $author_query = Lucy::Search::TermQuery->new(
+ field => 'author_last_name',
+ text => 'Foo',
+);
+my $and_query = Lucy::Search::ANDQuery->new(
+ children => [ $range_query, $author_query ],
+);
+my $hits = $searcher->hits( query => $and_query );
+...</pre>
<h2><a class='u'
name="DESCRIPTION"
@@ -111,24 +111,29 @@ name="CONSTRUCTORS"
name="new"
>new</a></h3>
-<pre> my $range_query = Lucy::Search::RangeQuery->new(
- field => 'product_number', # required
- lower_term => '003', # see below
- upper_term => '060', # see below
- include_lower => 0, # default true
- include_upper => 0, # default true
- );</pre>
+<pre>my $range_query = Lucy::Search::RangeQuery->new(
+ field => 'product_number', # required
+ lower_term => '003', # see below
+ upper_term => '060', # see below
+ include_lower => 0, # default true
+ 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>
+<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>
<li><b>field</b> - The name of a <code>sortable</code> field.</li>
-<li><b>lower_term</b> - Lower delimiter. If not supplied, all values less than <code>upper_term</code> will pass.</li>
-
-<li><b>upper_term</b> - Upper delimiter. If not supplied, all values greater than <code>lower_term</code> will pass.</li>
+<li><b>lower_term</b> - Lower delimiter.
+If not supplied,
+all values less than <code>upper_term</code> will pass.</li>
+
+<li><b>upper_term</b> - Upper delimiter.
+If not supplied,
+all values greater than <code>lower_term</code> will pass.</li>
<li><b>include_lower</b> - Indicates whether docs which match <code>lower_term</code> should be included in the results.</li>
@@ -143,11 +148,11 @@ name="METHODS"
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>
+<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>
@@ -156,7 +161,9 @@ name="make_compiler"
<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"
+<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>
Modified: websites/staging/lucy/trunk/content/docs/test/Lucy/Search/RequiredOptionalQuery.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Search/RequiredOptionalQuery.html (original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Search/RequiredOptionalQuery.html Fri Feb 26 13:44:48 2016
@@ -83,18 +83,22 @@ one optional.</p>
name="SYNOPSIS"
>SYNOPSIS</a></h2>
-<pre> my $foo_and_maybe_bar = Lucy::Search::RequiredOptionalQuery->new(
- required_query => $foo_query,
- optional_query => $bar_query,
- );
- my $hits = $searcher->hits( query => $foo_and_maybe_bar );
- ...</pre>
+<pre>my $foo_and_maybe_bar = Lucy::Search::RequiredOptionalQuery->new(
+ required_query => $foo_query,
+ optional_query => $bar_query,
+);
+my $hits = $searcher->hits( query => $foo_and_maybe_bar );
+...</pre>
<h2><a class='u'
name="DESCRIPTION"
>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>
+<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>
<h2><a class='u'
name="CONSTRUCTORS"
@@ -104,10 +108,10 @@ name="CONSTRUCTORS"
name="new"
>new</a></h3>
-<pre> my $reqopt_query = Lucy::Search::RequiredOptionalQuery->new(
- required_query => $foo_query, # required
- optional_query => $bar_query, # required
- );</pre>
+<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>
@@ -125,7 +129,7 @@ name="METHODS"
name="get_required_query"
>get_required_query</a></h3>
-<pre> my $retval = $required_optional_query->get_required_query();</pre>
+<pre>my $retval = $required_optional_query->get_required_query();</pre>
<p>Getter for the required Query.</p>
@@ -133,7 +137,7 @@ name="get_required_query"
name="set_required_query"
>set_required_query</a></h3>
-<pre> $required_optional_query->set_required_query($required_query);</pre>
+<pre>$required_optional_query->set_required_query($required_query);</pre>
<p>Setter for the required Query.</p>
@@ -141,7 +145,7 @@ name="set_required_query"
name="get_optional_query"
>get_optional_query</a></h3>
-<pre> my $retval = $required_optional_query->get_optional_query();</pre>
+<pre>my $retval = $required_optional_query->get_optional_query();</pre>
<p>Getter for the optional Query.</p>
@@ -149,7 +153,7 @@ name="get_optional_query"
name="set_optional_query"
>set_optional_query</a></h3>
-<pre> $required_optional_query->set_optional_query($optional_query);</pre>
+<pre>$required_optional_query->set_optional_query($optional_query);</pre>
<p>Setter for the optional Query.</p>
@@ -157,11 +161,11 @@ name="set_optional_query"
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>
+<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>
@@ -170,7 +174,9 @@ name="make_compiler"
<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"
+<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>
Modified: websites/staging/lucy/trunk/content/docs/test/Lucy/Search/Searcher.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Search/Searcher.html (original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Search/Searcher.html Fri Feb 26 13:44:48 2016
@@ -81,13 +81,14 @@ name="NAME"
name="SYNOPSIS"
>SYNOPSIS</a></h2>
-<pre> # Abstract base class.</pre>
+<pre># Abstract base class.</pre>
<h2><a class='u'
name="DESCRIPTION"
>DESCRIPTION</a></h2>
-<p>Abstract base class for objects which search. Core subclasses include <a href="../../Lucy/Search/IndexSearcher.html" class="podlinkpod"
+<p>Abstract base class for objects which search.
+Core subclasses include <a href="../../Lucy/Search/IndexSearcher.html" class="podlinkpod"
>IndexSearcher</a> and <a href="../../Lucy/Search/PolySearcher.html" class="podlinkpod"
>PolySearcher</a>.</p>
@@ -99,13 +100,13 @@ name="CONSTRUCTORS"
name="new"
>new</a></h3>
-<pre> package MySearcher;
- use base qw( Lucy::Search::Searcher );
- sub new {
- my $self = shift->SUPER::new;
- ...
- return $self;
- }</pre>
+<pre>package MySearcher;
+use base qw( Lucy::Search::Searcher );
+sub new {
+ my $self = shift->SUPER::new;
+ ...
+ return $self;
+}</pre>
<p>Abstract constructor.</p>
@@ -121,18 +122,20 @@ name="ABSTRACT_METHODS"
name="doc_max"
>doc_max</a></h3>
-<pre> my $retval = $searcher->doc_max();</pre>
+<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>
+<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>
<h3><a class='u'
name="doc_freq"
>doc_freq</a></h3>
-<pre> my $retval = $searcher->doc_freq(
- field => $field # required
- term => $term # required
- );</pre>
+<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>
@@ -146,12 +149,13 @@ name="doc_freq"
name="collect"
>collect</a></h3>
-<pre> $searcher->collect(
- query => $query # required
- collector => $collector # required
- );</pre>
+<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"
+<p>Iterate over hits,
+feeding them into a <a href="../../Lucy/Search/Collector.html" class="podlinkpod"
>Collector</a>.</p>
<ul>
@@ -164,9 +168,10 @@ name="collect"
name="fetch_doc"
>fetch_doc</a></h3>
-<pre> my $retval = $searcher->fetch_doc($doc_id);</pre>
+<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>
+<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>
@@ -180,40 +185,46 @@ name="METHODS"
name="glean_query"
>glean_query</a></h3>
-<pre> my $retval = $searcher->glean_query($query);
- my $retval = $searcher->glean_query(); # default: undef</pre>
+<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>
+<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>
+<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"
->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>
<h3><a class='u'
name="get_schema"
>get_schema</a></h3>
-<pre> my $retval = $searcher->get_schema();</pre>
+<pre>my $retval = $searcher->get_schema();</pre>
<p>Accessor for the object’s <code>schema</code> member.</p>
Modified: websites/staging/lucy/trunk/content/docs/test/Lucy/Search/SortRule.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Search/SortRule.html (original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Search/SortRule.html Fri Feb 26 13:44:48 2016
@@ -81,19 +81,21 @@ name="NAME"
name="SYNOPSIS"
>SYNOPSIS</a></h2>
-<pre> my $sort_spec = Lucy::Search::SortSpec->new(
- rules => [
- Lucy::Search::SortRule->new( field => 'date' ),
- Lucy::Search::SortRule->new( type => 'doc_id' ),
- ],
- );</pre>
+<pre>my $sort_spec = Lucy::Search::SortSpec->new(
+ rules => [
+ Lucy::Search::SortRule->new( field => 'date' ),
+ Lucy::Search::SortRule->new( type => 'doc_id' ),
+ ],
+);</pre>
<h2><a class='u'
name="DESCRIPTION"
>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>
<h2><a class='u'
name="CONSTRUCTORS"
@@ -103,22 +105,26 @@ name="CONSTRUCTORS"
name="new"
>new</a></h3>
-<pre> my $by_title = Lucy::Search::SortRule->new( field => 'title' );
- my $by_score = Lucy::Search::SortRule->new( type => 'score' );
- my $by_doc_id = Lucy::Search::SortRule->new( type => 'doc_id' );
- my $reverse_date = Lucy::Search::SortRule->new(
- field => 'date',
- reverse => 1,
- );</pre>
+<pre>my $by_title = Lucy::Search::SortRule->new( field => 'title' );
+my $by_score = Lucy::Search::SortRule->new( type => 'score' );
+my $by_doc_id = Lucy::Search::SortRule->new( type => 'doc_id' );
+my $reverse_date = Lucy::Search::SortRule->new(
+ field => 'date',
+ 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>
+<li><b>type</b> - Indicate whether to sort by score,
+field,
+etc.
+(The default is to sort by a field.)</li>
<li><b>field</b> - The name of a <code>sortable</code> field.</li>
-<li><b>reverse</b> - If true, reverse the order of the sort for this rule.</li>
+<li><b>reverse</b> - If true,
+reverse the order of the sort for this rule.</li>
</ul>
<h2><a class='u'
@@ -129,7 +135,7 @@ name="METHODS"
name="get_field"
>get_field</a></h3>
-<pre> my $retval = $sort_rule->get_field();</pre>
+<pre>my $retval = $sort_rule->get_field();</pre>
<p>Accessor for “field” member.</p>
@@ -137,7 +143,7 @@ name="get_field"
name="get_type"
>get_type</a></h3>
-<pre> my $retval = $sort_rule->get_type();</pre>
+<pre>my $retval = $sort_rule->get_type();</pre>
<p>Accessor for “type” member.</p>
@@ -145,7 +151,7 @@ name="get_type"
name="get_reverse"
>get_reverse</a></h3>
-<pre> my $retval = $sort_rule->get_reverse();</pre>
+<pre>my $retval = $sort_rule->get_reverse();</pre>
<p>Accessor for “reverse” member.</p>
Modified: websites/staging/lucy/trunk/content/docs/test/Lucy/Search/SortSpec.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Search/SortSpec.html (original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Search/SortSpec.html Fri Feb 26 13:44:48 2016
@@ -81,27 +81,29 @@ name="NAME"
name="SYNOPSIS"
>SYNOPSIS</a></h2>
-<pre> my $sort_spec = Lucy::Search::SortSpec->new(
- rules => [
- Lucy::Search::SortRule->new( field => 'date' ),
- Lucy::Search::SortRule->new( type => 'doc_id' ),
- ],
- );
- my $hits = $searcher->hits(
- query => $query,
- sort_spec => $sort_spec,
- );</pre>
+<pre>my $sort_spec = Lucy::Search::SortSpec->new(
+ rules => [
+ Lucy::Search::SortRule->new( field => 'date' ),
+ Lucy::Search::SortRule->new( type => 'doc_id' ),
+ ],
+);
+my $hits = $searcher->hits(
+ query => $query,
+ sort_spec => $sort_spec,
+);</pre>
<h2><a class='u'
name="DESCRIPTION"
>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"
+<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>
<p>Fields you wish to sort against must be <code>sortable</code>.</p>
-<p>For a stable sort (important when paging through results), add a sort-by-doc rule as the last SortRule.</p>
+<p>For a stable sort (important when paging through results),
+add a sort-by-doc rule as the last SortRule.</p>
<h2><a class='u'
name="CONSTRUCTORS"
@@ -111,7 +113,7 @@ name="CONSTRUCTORS"
name="new"
>new</a></h3>
-<pre> my $sort_spec = Lucy::Search::SortSpec->new( rules => \@rules );</pre>
+<pre>my $sort_spec = Lucy::Search::SortSpec->new( rules => \@rules );</pre>
<p>Create a new SortSpec.</p>
Modified: websites/staging/lucy/trunk/content/docs/test/Lucy/Search/Span.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Search/Span.html (original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Search/Span.html Fri Feb 26 13:44:48 2016
@@ -83,21 +83,26 @@ and a weight.</p>
name="SYNOPSIS"
>SYNOPSIS</a></h2>
-<pre> my $combined_length = $upper_span->get_length
- + ( $upper_span->get_offset - $lower_span->get_offset );
- my $combined_span = Lucy::Search::Span->new(
- offset => $lower_span->get_offset,
- length => $combined_length,
- );
- ...</pre>
+<pre>my $combined_length = $upper_span->get_length
+ + ( $upper_span->get_offset - $lower_span->get_offset );
+my $combined_span = Lucy::Search::Span->new(
+ offset => $lower_span->get_offset,
+ length => $combined_length,
+);
+...</pre>
<h2><a class='u'
name="DESCRIPTION"
>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>
<h2><a class='u'
name="CONSTRUCTORS"
@@ -107,18 +112,20 @@ name="CONSTRUCTORS"
name="new"
>new</a></h3>
-<pre> my $span = Lucy::Search::Span->new(
- offset => 75, # required
- length => 7, # required
- weight => 1.0, # default 0.0
- );</pre>
+<pre>my $span = Lucy::Search::Span->new(
+ offset => 75, # required
+ length => 7, # required
+ 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>
+<li><b>offset</b> - Integer offset,
+unit is context-dependent.</li>
-<li><b>length</b> - Integer length, unit is context-dependent.</li>
+<li><b>length</b> - Integer length,
+unit is context-dependent.</li>
<li><b>weight</b> - A floating point weight.</li>
</ul>
@@ -131,7 +138,7 @@ name="METHODS"
name="get_offset"
>get_offset</a></h3>
-<pre> my $retval = $span->get_offset();</pre>
+<pre>my $retval = $span->get_offset();</pre>
<p>Accessor for <code>offset</code> attribute.</p>
@@ -139,7 +146,7 @@ name="get_offset"
name="set_offset"
>set_offset</a></h3>
-<pre> $span->set_offset($offset);</pre>
+<pre>$span->set_offset($offset);</pre>
<p>Setter for <code>offset</code> attribute.</p>
@@ -147,7 +154,7 @@ name="set_offset"
name="get_length"
>get_length</a></h3>
-<pre> my $retval = $span->get_length();</pre>
+<pre>my $retval = $span->get_length();</pre>
<p>Accessor for <code>length</code> attribute.</p>
@@ -155,7 +162,7 @@ name="get_length"
name="set_length"
>set_length</a></h3>
-<pre> $span->set_length($length);</pre>
+<pre>$span->set_length($length);</pre>
<p>Setter for <code>length</code> attribute.</p>
@@ -163,7 +170,7 @@ name="set_length"
name="get_weight"
>get_weight</a></h3>
-<pre> my $retval = $span->get_weight();</pre>
+<pre>my $retval = $span->get_weight();</pre>
<p>Accessor for <code>weight</code> attribute.</p>
@@ -171,7 +178,7 @@ name="get_weight"
name="set_weight"
>set_weight</a></h3>
-<pre> $span->set_weight($weight);</pre>
+<pre>$span->set_weight($weight);</pre>
<p>Setter for <code>weight</code> attribute.</p>
@@ -179,15 +186,19 @@ name="set_weight"
name="compare_to"
>compare_to</a></h3>
-<pre> my $retval = $span->compare_to($other);</pre>
+<pre>my $retval = $span->compare_to($other);</pre>
-<p>Indicate whether one object is less than, equal to, or greater than another.</p>
+<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>
+<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>
<h2><a class='u'
name="INHERITANCE"
Modified: websites/staging/lucy/trunk/content/docs/test/Lucy/Search/TermQuery.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Search/TermQuery.html (original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Search/TermQuery.html Fri Feb 26 13:44:48 2016
@@ -81,11 +81,11 @@ name="NAME"
name="SYNOPSIS"
>SYNOPSIS</a></h2>
-<pre> my $term_query = Lucy::Search::TermQuery->new(
- field => 'content',
- term => 'foo',
- );
- my $hits = $searcher->hits( query => $term_query );</pre>
+<pre>my $term_query = Lucy::Search::TermQuery->new(
+ field => 'content',
+ term => 'foo',
+);
+my $hits = $searcher->hits( query => $term_query );</pre>
<h2><a class='u'
name="DESCRIPTION"
@@ -102,10 +102,10 @@ name="CONSTRUCTORS"
name="new"
>new</a></h3>
-<pre> my $term_query = Lucy::Search::TermQuery->new(
- field => 'content', # required
- term => 'foo', # required
- );</pre>
+<pre>my $term_query = Lucy::Search::TermQuery->new(
+ field => 'content', # required
+ term => 'foo', # required
+);</pre>
<p>Create a new TermQuery.</p>
@@ -123,7 +123,7 @@ name="METHODS"
name="get_field"
>get_field</a></h3>
-<pre> my $retval = $term_query->get_field();</pre>
+<pre>my $retval = $term_query->get_field();</pre>
<p>Accessor for object’s <code>field</code> member.</p>
@@ -131,7 +131,7 @@ name="get_field"
name="get_term"
>get_term</a></h3>
-<pre> my $retval = $term_query->get_term();</pre>
+<pre>my $retval = $term_query->get_term();</pre>
<p>Accessor for object’s <code>term</code> member.</p>
@@ -139,11 +139,11 @@ name="get_term"
name="make_compiler"
>make_compiler</a></h3>
-<pre> my $retval = $term_query->make_compiler(
- searcher => $searcher # required
- boost => $boost # required
- subordinate => $subordinate # default: false
- );</pre>
+<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>
@@ -152,7 +152,9 @@ name="make_compiler"
<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"
+<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>
Modified: websites/staging/lucy/trunk/content/docs/test/Lucy/Simple.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Simple.html (original)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Simple.html Fri Feb 26 13:44:48 2016
@@ -84,30 +84,31 @@ name="SYNOPSIS"
<p>First,
build an index of your documents.</p>
-<pre> my $index = Lucy::Simple->new(
- path => '/path/to/index/'
- language => 'en',
- );
-
- while ( my ( $title, $content ) = each %source_docs ) {
- $index->add_doc({
- title => $title,
- content => $content,
- });
- }</pre>
-
-<p>Later, search the index.</p>
-
-<pre> my $total_hits = $index->search(
- query => $query_string,
- offset => 0,
- num_wanted => 10,
- );
-
- print "Total hits: $total_hits\n";
- while ( my $hit = $index->next ) {
- print "$hit->{title}\n",
- }</pre>
+<pre>my $index = Lucy::Simple->new(
+ path => '/path/to/index/'
+ language => 'en',
+);
+
+while ( my ( $title, $content ) = each %source_docs ) {
+ $index->add_doc({
+ title => $title,
+ content => $content,
+ });
+}</pre>
+
+<p>Later,
+search the index.</p>
+
+<pre>my $total_hits = $index->search(
+ query => $query_string,
+ offset => 0,
+ num_wanted => 10,
+);
+
+print "Total hits: $total_hits\n";
+while ( my $hit = $index->next ) {
+ print "$hit->{title}\n",
+}</pre>
<h2><a class='u'
name="DESCRIPTION"
@@ -123,33 +124,39 @@ name="CONSTRUCTORS"
name="new"
>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. Both parameters <code>path</code> and <code>language</code> are required.</p>
+<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.
+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>
-
-<li><b>language</b> - The language of the documents in your collection, indicated by a two-letter ISO code. 12 languages are supported:
-<pre> |-----------------------|
- | Language | ISO code |
- |-----------------------|
- | Danish | da |
- | Dutch | nl |
- | English | en |
- | Finnish | fi |
- | French | fr |
- | German | de |
- | Italian | it |
- | Norwegian | no |
- | Portuguese | pt |
- | Spanish | es |
- | Swedish | sv |
- | Russian | ru |
- |-----------------------|</pre>
+<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>
+
+<li><b>language</b> - The language of the documents in your collection,
+indicated by a two-letter ISO code.
+12 languages are supported:
+<pre>|-----------------------|
+| Language | ISO code |
+|-----------------------|
+| Danish | da |
+| Dutch | nl |
+| English | en |
+| Finnish | fi |
+| French | fr |
+| German | de |
+| Italian | it |
+| Norwegian | no |
+| Portuguese | pt |
+| Spanish | es |
+| Swedish | sv |
+| Russian | ru |
+|-----------------------|</pre>
</li>
</ul>
@@ -161,30 +168,37 @@ name="METHODS"
name="add_doc"
>add_doc</a></h3>
-<pre> $lucy->add_doc({
- location => $url,
- title => $title,
- content => $content,
- });</pre>
-
-<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>
+<pre>$lucy->add_doc({
+ location => $url,
+ title => $title,
+ content => $content,
+});</pre>
+
+<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>
<h3><a class='u'
name="search"
>search</a></h3>
-<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>
+<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>
<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>
@@ -193,9 +207,10 @@ name="search"
name="next"
>next</a></h3>
-<pre> my $retval = $simple->next();</pre>
+<pre>my $retval = $simple->next();</pre>
-<p>Return the next hit, or undef when the iterator is exhausted.</p>
+<p>Return the next hit,
+or undef when the iterator is exhausted.</p>
<h2><a class='u'
name="INHERITANCE"