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 [3/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/Highlight/Highlighter.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Highlight/Highlighter.mdtext?rev=1732471&r1=1732470&r2=1732471&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Highlight/Highlighter.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Highlight/Highlighter.mdtext Fri Feb 26 12:52:25 2016
@@ -3,15 +3,15 @@ Title: Lucy::Highlight::Highlighter - Ap
<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::Highlight::Highlighter - Create and highlight excerpts.</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 $highlighter = Lucy::Highlight::Highlighter->new(
searcher => $searcher,
@@ -24,19 +24,19 @@ 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>The Highlighter can be used to select relevant snippets from a document, and to surround search terms with highlighting tags. It handles both stems and phrases correctly and efficiently, using special-purpose data generated at index-time.</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 $highlighter = Lucy::Highlight::Highlighter->new(
searcher => $searcher, # required
@@ -45,6 +45,8 @@ name="new(_[labeled_params]_)"
excerpt_length => 150, # default: 200
);</pre>
+<p>Create a new Highlighter.</p>
+
<ul>
<li><b>searcher</b> - An object which inherits from <a href="../../Lucy/Search/Searcher.html" class="podlinkpod"
>Searcher</a>, such as an <a href="../../Lucy/Search/IndexSearcher.html" class="podlinkpod"
@@ -58,85 +60,111 @@ name="new(_[labeled_params]_)"
<li><b>excerpt_length</b> - Maximum length of the excerpt, in characters.</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="create_excerpt"
+>create_excerpt</a></h3>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="create_excerpt(hit_doc)"
->create_excerpt(hit_doc)</a></h2>
+<pre> my $retval = $highlighter->create_excerpt($hit_doc);</pre>
<p>Take a HitDoc object and return a highlighted excerpt as a string if the HitDoc has a value for the specified <code>field</code>.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="highlight(text)"
->highlight(text)</a></h2>
+<h3><a class='u'
+name="encode"
+>encode</a></h3>
-<p>Highlight a small section of text. By default, prepends pre-tag and appends post-tag. This method is called internally by create_excerpt() when assembling an excerpt.</p>
+<pre> my $retval = $highlighter->encode($text);</pre>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="encode(text)"
->encode(text)</a></h2>
+<p>Encode text with HTML entities. This method is called internally by <a href="#create_excerpt" class="podlinkpod"
+>create_excerpt()</a> for each text fragment when assembling an excerpt. A subclass can override this if the text should be encoded differently or not at all.</p>
-<p>Encode text with HTML entities. This method is called internally by create_excerpt() for each text fragment when assembling an excerpt. A subclass can override this if the text should be encoded differently or not at all.</p>
+<h3><a class='u'
+name="highlight"
+>highlight</a></h3>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="set_pre_tag(pre_tag)"
->set_pre_tag(pre_tag)</a></h2>
+<pre> my $retval = $highlighter->highlight($text);</pre>
-<p>Setter. The default value is "<strong>".</p>
+<p>Highlight a small section of text. By default, prepends pre-tag and appends post-tag. This method is called internally by <a href="#create_excerpt" class="podlinkpod"
+>create_excerpt()</a> when assembling an excerpt.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_pre_tag()"
->get_pre_tag()</a></h2>
+<h3><a class='u'
+name="set_pre_tag"
+>set_pre_tag</a></h3>
-<p>Accessor.</p>
+<pre> $highlighter->set_pre_tag($pre_tag);</pre>
+
+<p>Setter. The default value is “<strong>”.</p>
+
+<h3><a class='u'
+name="set_post_tag"
+>set_post_tag</a></h3>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="set_post_tag(post_tag)"
->set_post_tag(post_tag)</a></h2>
+<pre> $highlighter->set_post_tag($post_tag);</pre>
-<p>Setter. The default value is "</strong>".</p>
+<p>Setter. The default value is “</strong>”.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_post_tag()"
->get_post_tag()</a></h2>
+<h3><a class='u'
+name="get_pre_tag"
+>get_pre_tag</a></h3>
+
+<pre> my $retval = $highlighter->get_pre_tag();</pre>
<p>Accessor.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_searcher()"
->get_searcher()</a></h2>
+<h3><a class='u'
+name="get_post_tag"
+>get_post_tag</a></h3>
+
+<pre> my $retval = $highlighter->get_post_tag();</pre>
<p>Accessor.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_query()"
->get_query()</a></h2>
+<h3><a class='u'
+name="get_field"
+>get_field</a></h3>
+
+<pre> my $retval = $highlighter->get_field();</pre>
<p>Accessor.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_compiler()"
->get_compiler()</a></h2>
+<h3><a class='u'
+name="get_excerpt_length"
+>get_excerpt_length</a></h3>
-<p>Accessor for the Lucy::Search::Compiler object derived from <code>query</code> and <code>searcher</code>.</p>
+<pre> my $retval = $highlighter->get_excerpt_length();</pre>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_excerpt_length()"
->get_excerpt_length()</a></h2>
+<p>Accessor.</p>
+
+<h3><a class='u'
+name="get_searcher"
+>get_searcher</a></h3>
+
+<pre> my $retval = $highlighter->get_searcher();</pre>
<p>Accessor.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_field()"
->get_field()</a></h2>
+<h3><a class='u'
+name="get_query"
+>get_query</a></h3>
+
+<pre> my $retval = $highlighter->get_query();</pre>
<p>Accessor.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h3><a class='u'
+name="get_compiler"
+>get_compiler</a></h3>
+
+<pre> my $retval = $highlighter->get_compiler();</pre>
+
+<p>Accessor for the Lucy::Search::Compiler object derived from <code>query</code> and <code>searcher</code>.</p>
+
+<h2><a class='u'
name="INHERITANCE"
->INHERITANCE</a></h1>
+>INHERITANCE</a></h2>
<p>Lucy::Highlight::Highlighter isa Clownfish::Obj.</p>
Modified: lucy/site/trunk/content/docs/test/Lucy/Index/BackgroundMerger.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Index/BackgroundMerger.mdtext?rev=1732471&r1=1732470&r2=1732471&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Index/BackgroundMerger.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Index/BackgroundMerger.mdtext Fri Feb 26 12:52:25 2016
@@ -3,39 +3,39 @@ Title: Lucy::Index::BackgroundMerger - A
<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::Index::BackgroundMerger - Consolidate index segments in the background.</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 $bg_merger = Lucy::Index::BackgroundMerger->new(
index => '/path/to/index',
);
$bg_merger->commit;</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>Adding documents to an index is usually fast, but every once in a while the index must be compacted and an update takes substantially longer to complete. See <a href="../../Lucy/Docs/Cookbook/FastUpdates.html" class="podlinkpod"
->Lucy::Docs::Cookbook::FastUpdates</a> for how to use this class to control worst-case index update performance.</p>
+>FastUpdates</a> for how to use this class to control worst-case index update performance.</p>
<p>As with <a href="../../Lucy/Index/Indexer.html" class="podlinkpod"
>Indexer</a>, see <a href="../../Lucy/Docs/FileLocking.html" class="podlinkpod"
->Lucy::Docs::FileLocking</a> if your index is on a shared volume.</p>
+>FileLocking</a> if your index is on a shared volume.</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 $bg_merger = Lucy::Index::BackgroundMerger->new(
index => '/path/to/index', # required
@@ -50,35 +50,46 @@ name="new(_[labeled_params]_)"
<li><b>manager</b> - An IndexManager. If not supplied, an IndexManager with a 10-second write lock timeout will be created.</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="commit()"
->commit()</a></h2>
+<h3><a class='u'
+name="optimize"
+>optimize</a></h3>
-<p>Commit any changes made to the index. Until this is called, none of the changes made during an indexing session are permanent.</p>
+<pre> $background_merger->optimize();</pre>
-<p>Calls prepare_commit() implicitly if it has not already been called.</p>
+<p>Optimize the index for search-time performance. This may take a while, as it can involve rewriting large amounts of data.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="prepare_commit()"
->prepare_commit()</a></h2>
+<h3><a class='u'
+name="commit"
+>commit</a></h3>
-<p>Perform the expensive setup for commit() in advance, so that commit() completes quickly.</p>
+<pre> $background_merger->commit();</pre>
-<p>Towards the end of prepare_commit(), the BackgroundMerger attempts to re-acquire the write lock, which is then held until commit() finishes and releases it.</p>
+<p>Commit any changes made to the index. Until this is called, none of the changes made during an indexing session are permanent.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="optimize()"
->optimize()</a></h2>
+<p>Calls <a href="#prepare_commit" class="podlinkpod"
+>prepare_commit()</a> implicitly if it has not already been called.</p>
-<p>Optimize the index for search-time performance. This may take a while, as it can involve rewriting large amounts of data.</p>
+<h3><a class='u'
+name="prepare_commit"
+>prepare_commit</a></h3>
+
+<pre> $background_merger->prepare_commit();</pre>
+
+<p>Perform the expensive setup for <a href="#commit" class="podlinkpod"
+>commit()</a> in advance, so that <a href="#commit" class="podlinkpod"
+>commit()</a> completes quickly.</p>
+
+<p>Towards the end of <a href="#prepare_commit" class="podlinkpod"
+>prepare_commit()</a>, the BackgroundMerger attempts to re-acquire the write lock, which is then held until <a href="#commit" class="podlinkpod"
+>commit()</a> finishes and releases it.</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::Index::BackgroundMerger isa Clownfish::Obj.</p>
Modified: lucy/site/trunk/content/docs/test/Lucy/Index/DataReader.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Index/DataReader.mdtext?rev=1732471&r1=1732470&r2=1732471&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Index/DataReader.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Index/DataReader.mdtext Fri Feb 26 12:52:25 2016
@@ -3,32 +3,32 @@ Title: Lucy::Index::DataReader - 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::Index::DataReader - Abstract base class for reading index data.</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>DataReader is the companion class to <a href="../../Lucy/Index/DataWriter.html" class="podlinkpod"
>DataWriter</a>. Every index component will implement one of each.</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 $reader = MyDataReader->new(
schema => $seg_reader->get_schema, # default undef
@@ -38,6 +38,8 @@ name="new(_[labeled_params]_)"
seg_tick => $seg_reader->get_seg_tick, # default -1
);</pre>
+<p>Abstract constructor.</p>
+
<ul>
<li><b>schema</b> - A Schema.</li>
@@ -50,13 +52,18 @@ name="new(_[labeled_params]_)"
<li><b>seg_tick</b> - The array index of the Segment object within the <code>segments</code> array that this particular DataReader is assigned to, if any. A value of -1 indicates that no Segment should be assigned.</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="aggregator(_[labeled_params]_)"
->aggregator( <i>[labeled params]</i> )</a></h2>
+<h3><a class='u'
+name="aggregator"
+>aggregator</a></h3>
+
+<pre> my $retval = $data_reader->aggregator(
+ readers => $readers # required
+ offsets => $offsets # required
+ );</pre>
<p>Create a reader which aggregates the output of several lower level readers. Return undef if such a reader is not valid.</p>
@@ -66,49 +73,61 @@ name="aggregator(_[labeled_params]_)"
<li><b>offsets</b> - Doc id start offsets for each reader.</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_schema"
+>get_schema</a></h3>
+
+<pre> my $retval = $data_reader->get_schema();</pre>
+
+<p>Accessor for “schema” member var.</p>
+
+<h3><a class='u'
+name="get_folder"
+>get_folder</a></h3>
+
+<pre> my $retval = $data_reader->get_folder();</pre>
+
+<p>Accessor for “folder” member var.</p>
-<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="get_snapshot"
+>get_snapshot</a></h3>
-<p>Accessor for "schema" member var.</p>
+<pre> my $retval = $data_reader->get_snapshot();</pre>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_folder()"
->get_folder()</a></h2>
+<p>Accessor for “snapshot” member var.</p>
-<p>Accessor for "folder" member var.</p>
+<h3><a class='u'
+name="get_segments"
+>get_segments</a></h3>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_snapshot()"
->get_snapshot()</a></h2>
+<pre> my $retval = $data_reader->get_segments();</pre>
-<p>Accessor for "snapshot" member var.</p>
+<p>Accessor for “segments” member var.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_segments()"
->get_segments()</a></h2>
+<h3><a class='u'
+name="get_segment"
+>get_segment</a></h3>
-<p>Accessor for "segments" member var.</p>
+<pre> my $retval = $data_reader->get_segment();</pre>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_segment()"
->get_segment()</a></h2>
+<p>Accessor for “segment” member var.</p>
-<p>Accessor for "segment" member var.</p>
+<h3><a class='u'
+name="get_seg_tick"
+>get_seg_tick</a></h3>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_seg_tick()"
->get_seg_tick()</a></h2>
+<pre> my $retval = $data_reader->get_seg_tick();</pre>
-<p>Accessor for "seg_tick" member var.</p>
+<p>Accessor for “seg_tick” member var.</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::Index::DataReader isa Clownfish::Obj.</p>
Modified: lucy/site/trunk/content/docs/test/Lucy/Index/DataWriter.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Index/DataWriter.mdtext?rev=1732471&r1=1732470&r2=1732471&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Index/DataWriter.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Index/DataWriter.mdtext Fri Feb 26 12:52:25 2016
@@ -3,35 +3,35 @@ Title: Lucy::Index::DataWriter - 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::Index::DataWriter - Write data to an index.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="SYNOPSIS"
->SYNOPSIS</a></h1>
+>SYNOPSIS</a></h2>
<pre> # 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>DataWriter is an abstract base class for writing index data, generally in segment-sized chunks. Each component of an index -- e.g. stored fields, lexicon, postings, deletions -- is represented by a DataWriter/<a href="../../Lucy/Index/DataReader.html" class="podlinkpod"
+<p>DataWriter is an abstract base class for writing index data, generally in segment-sized chunks. Each component of an index – e.g. stored fields, lexicon, postings, deletions – is represented by a DataWriter/<a href="../../Lucy/Index/DataReader.html" class="podlinkpod"
>DataReader</a> pair.</p>
<p>Components may be specified per index by subclassing <a href="../../Lucy/Plan/Architecture.html" class="podlinkpod"
>Architecture</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> my $writer = MyDataWriter->new(
snapshot => $snapshot, # required
@@ -39,6 +39,8 @@ name="new(_[labeled_params]_)"
polyreader => $polyreader, # required
);</pre>
+<p>Abstract constructor.</p>
+
<ul>
<li><b>snapshot</b> - The Snapshot that will be committed at the end of the indexing session.</li>
@@ -47,25 +49,18 @@ name="new(_[labeled_params]_)"
<li><b>polyreader</b> - A PolyReader representing all existing data in the index. (If the index is brand new, the PolyReader will have no sub-readers).</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>
-
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="add_inverted_doc(_[labeled_params]_)"
->add_inverted_doc( <i>[labeled params]</i> )</a></h2>
-
-<p>Process a document, previously inverted by <code>inverter</code>.</p>
-
-<ul>
-<li><b>inverter</b> - An Inverter wrapping an inverted document.</li>
+>ABSTRACT METHODS</a></h2>
-<li><b>doc_id</b> - Internal number assigned to this document within the segment.</li>
-</ul>
-
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="add_segment(_[labeled_params]_)"
->add_segment( <i>[labeled params]</i> )</a></h2>
+<h3><a class='u'
+name="add_segment"
+>add_segment</a></h3>
+
+<pre> $data_writer->add_segment(
+ reader => $reader # required
+ doc_map => $doc_map # default: undef
+ );</pre>
<p>Add content from an existing segment into the one currently being written.</p>
@@ -75,39 +70,52 @@ name="add_segment(_[labeled_params]_)"
<li><b>doc_map</b> - An array of integers mapping old document ids to new. Deleted documents are mapped to 0, indicating that they should be skipped.</li>
</ul>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="finish()"
->finish()</a></h2>
+<h3><a class='u'
+name="finish"
+>finish</a></h3>
+
+<pre> $data_writer->finish();</pre>
<p>Complete the segment: close all streams, store metadata, etc.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="format()"
->format()</a></h2>
+<h3><a class='u'
+name="format"
+>format</a></h3>
+
+<pre> my $retval = $data_writer->format();</pre>
<p>Every writer must specify a file format revision number, which should increment each time the format changes. Responsibility for revision checking is left to the companion DataReader.</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="delete_segment"
+>delete_segment</a></h3>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="delete_segment(reader)"
->delete_segment(reader)</a></h2>
+<pre> $data_writer->delete_segment($reader);</pre>
-<p>Remove a segment's data. The default implementation is a no-op, as all files within the segment directory will be automatically deleted. Subclasses which manage their own files outside of the segment system should override this method and use it as a trigger for cleaning up obsolete data.</p>
+<p>Remove a segment’s data. The default implementation is a no-op, as all files within the segment directory will be automatically deleted. Subclasses which manage their own files outside of the segment system should override this method and use it as a trigger for cleaning up obsolete data.</p>
<ul>
<li><b>reader</b> - The SegReader containing content to merge, which must represent a segment which is part of the the current snapshot.</li>
</ul>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="merge_segment(_[labeled_params]_)"
->merge_segment( <i>[labeled params]</i> )</a></h2>
+<h3><a class='u'
+name="merge_segment"
+>merge_segment</a></h3>
+
+<pre> $data_writer->merge_segment(
+ reader => $reader # required
+ doc_map => $doc_map # default: undef
+ );</pre>
<p>Move content from an existing segment into the one currently being written.</p>
-<p>The default implementation calls add_segment() then delete_segment().</p>
+<p>The default implementation calls <a href="#add_segment" class="podlinkpod"
+>add_segment()</a> then <a href="#delete_segment" class="podlinkpod"
+>delete_segment()</a>.</p>
<ul>
<li><b>reader</b> - The SegReader containing content to merge, which must represent a segment which is part of the the current snapshot.</li>
@@ -115,45 +123,57 @@ name="merge_segment(_[labeled_params]_)"
<li><b>doc_map</b> - An array of integers mapping old document ids to new. Deleted documents are mapped to 0, indicating that they should be skipped.</li>
</ul>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="metadata()"
->metadata()</a></h2>
+<h3><a class='u'
+name="metadata"
+>metadata</a></h3>
+
+<pre> my $retval = $data_writer->metadata();</pre>
+
+<p>Arbitrary metadata to be serialized and stored by the Segment. The default implementation supplies a Hash with a single key-value pair for “format”.</p>
+
+<h3><a class='u'
+name="get_snapshot"
+>get_snapshot</a></h3>
+
+<pre> my $retval = $data_writer->get_snapshot();</pre>
+
+<p>Accessor for “snapshot” member var.</p>
+
+<h3><a class='u'
+name="get_segment"
+>get_segment</a></h3>
-<p>Arbitrary metadata to be serialized and stored by the Segment. The default implementation supplies a Hash with a single key-value pair for "format".</p>
+<pre> my $retval = $data_writer->get_segment();</pre>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_snapshot()"
->get_snapshot()</a></h2>
+<p>Accessor for “segment” member var.</p>
-<p>Accessor for "snapshot" member var.</p>
+<h3><a class='u'
+name="get_polyreader"
+>get_polyreader</a></h3>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_segment()"
->get_segment()</a></h2>
+<pre> my $retval = $data_writer->get_polyreader();</pre>
-<p>Accessor for "segment" member var.</p>
+<p>Accessor for “polyreader” member var.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_polyreader()"
->get_polyreader()</a></h2>
+<h3><a class='u'
+name="get_schema"
+>get_schema</a></h3>
-<p>Accessor for "polyreader" member var.</p>
+<pre> my $retval = $data_writer->get_schema();</pre>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_schema()"
->get_schema()</a></h2>
+<p>Accessor for “schema” member var.</p>
-<p>Accessor for "schema" member var.</p>
+<h3><a class='u'
+name="get_folder"
+>get_folder</a></h3>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_folder()"
->get_folder()</a></h2>
+<pre> my $retval = $data_writer->get_folder();</pre>
-<p>Accessor for "folder" member var.</p>
+<p>Accessor for “folder” member var.</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::Index::DataWriter isa Clownfish::Obj.</p>
Modified: lucy/site/trunk/content/docs/test/Lucy/Index/DeletionsWriter.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Index/DeletionsWriter.mdtext?rev=1732471&r1=1732470&r2=1732471&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Index/DeletionsWriter.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Index/DeletionsWriter.mdtext Fri Feb 26 12:52:25 2016
@@ -3,15 +3,15 @@ Title: Lucy::Index::DeletionsWriter - Ap
<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::Index::DeletionsWriter - Abstract base class for marking documents as deleted.</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 $polyreader = $del_writer->get_polyreader;
my $seg_readers = $polyreader->seg_readers;
@@ -20,9 +20,9 @@ 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>Subclasses of DeletionsWriter provide a low-level mechanism for declaring a document deleted from an index.</p>
@@ -30,25 +30,32 @@ name="DESCRIPTION"
<p>Documents are truly deleted only when the segments which contain them are merged into new ones.</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="delete_by_term(_[labeled_params]_)"
->delete_by_term( <i>[labeled params]</i> )</a></h2>
+<h3><a class='u'
+name="delete_by_term"
+>delete_by_term</a></h3>
+
+<pre> $deletions_writer->delete_by_term(
+ field => $field # required
+ term => $term # required
+ );</pre>
<p>Delete all documents in the index that index the supplied term.</p>
<ul>
-<li><b>field</b> - The name of an indexed field. (If it is not spec'd as <code>indexed</code>, an error will occur.)</li>
+<li><b>field</b> - The name of an indexed field. (If it is not spec’d as <code>indexed</code>, an error will occur.)</li>
-<li><b>term</b> - The term which identifies docs to be marked as deleted. If <code>field</code> is associated with an Analyzer, <code>term</code> will be processed automatically (so don't pre-process it yourself).</li>
+<li><b>term</b> - The term which identifies docs to be marked as deleted. If <code>field</code> is associated with an Analyzer, <code>term</code> will be processed automatically (so don’t pre-process it yourself).</li>
</ul>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="delete_by_query(query)"
->delete_by_query(query)</a></h2>
+<h3><a class='u'
+name="delete_by_query"
+>delete_by_query</a></h3>
+
+<pre> $deletions_writer->delete_by_query($query);</pre>
<p>Delete all documents in the index that match <code>query</code>.</p>
@@ -57,15 +64,19 @@ name="delete_by_query(query)"
>Query</a>.</li>
</ul>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="updated()"
->updated()</a></h2>
+<h3><a class='u'
+name="updated"
+>updated</a></h3>
+
+<pre> my $retval = $deletions_writer->updated();</pre>
<p>Returns true if there are updates that need to be written.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="seg_del_count(seg_name)"
->seg_del_count(seg_name)</a></h2>
+<h3><a class='u'
+name="seg_del_count"
+>seg_del_count</a></h3>
+
+<pre> my $retval = $deletions_writer->seg_del_count($seg_name);</pre>
<p>Return the number of deletions for a given segment.</p>
@@ -73,9 +84,9 @@ name="seg_del_count(seg_name)"
<li><b>seg_name</b> - The name of the segment.</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::Index::DeletionsWriter isa <a href="../../Lucy/Index/DataWriter.html" class="podlinkpod"
>Lucy::Index::DataWriter</a> isa Clownfish::Obj.</p>
Modified: lucy/site/trunk/content/docs/test/Lucy/Index/DocReader.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Index/DocReader.mdtext?rev=1732471&r1=1732470&r2=1732471&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Index/DocReader.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Index/DocReader.mdtext Fri Feb 26 12:52:25 2016
@@ -3,45 +3,52 @@ Title: Lucy::Index::DocReader - 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::Index::DocReader - Retrieve stored 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> my $doc_reader = $seg_reader->obtain("Lucy::Index::DocReader");
my $doc = $doc_reader->fetch_doc($doc_id);</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>DocReader defines the interface by which documents (with all stored fields) are retrieved from the index. The default implementation returns <a href="../../Lucy/Document/HitDoc.html" class="podlinkpod"
>HitDoc</a> objects.</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="fetch_doc(doc_id)"
->fetch_doc(doc_id)</a></h2>
+<h3><a class='u'
+name="fetch_doc"
+>fetch_doc</a></h3>
+
+<pre> my $retval = $doc_reader->fetch_doc($doc_id);</pre>
<p>Retrieve the document identified by <code>doc_id</code>.</p>
<p>Returns: a HitDoc.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="METHODS"
->METHODS</a></h1>
+>METHODS</a></h2>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="aggregator(_[labeled_params]_)"
->aggregator( <i>[labeled params]</i> )</a></h2>
+<h3><a class='u'
+name="aggregator"
+>aggregator</a></h3>
+
+<pre> my $retval = $doc_reader->aggregator(
+ readers => $readers # required
+ offsets => $offsets # required
+ );</pre>
<p>Returns a DocReader which divvies up requests to its sub-readers according to the offset range.</p>
@@ -51,9 +58,9 @@ name="aggregator(_[labeled_params]_)"
<li><b>offsets</b> - Doc id start offsets for each reader.</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::Index::DocReader isa <a href="../../Lucy/Index/DataReader.html" class="podlinkpod"
>Lucy::Index::DataReader</a> isa Clownfish::Obj.</p>
Modified: lucy/site/trunk/content/docs/test/Lucy/Index/IndexManager.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Index/IndexManager.mdtext?rev=1732471&r1=1732470&r2=1732471&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Index/IndexManager.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Index/IndexManager.mdtext Fri Feb 26 12:52:25 2016
@@ -3,17 +3,17 @@ Title: Lucy::Index::IndexManager - 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::Index::IndexManager - Policies governing index updating,
locking,
and file deletion.</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> use Sys::Hostname qw( hostname );
my $hostname = hostname() or die "Can't get unique hostname";
@@ -34,46 +34,74 @@ name="SYNOPSIS"
);
my $searcher = Lucy::Search::IndexSearcher->new( index => $reader );</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>IndexManager is an advanced-use class for controlling index locking, updating, merging, and deletion behaviors.</p>
<p>IndexManager and <a href="../../Lucy/Plan/Architecture.html" class="podlinkpod"
>Architecture</a> are complementary classes: Architecture is used to define traits and behaviors which cannot change for the life of an index; IndexManager is used for defining rules which may change from process to process.</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 $manager = Lucy::Index::IndexManager->new(
host => $hostname, # default: ""
);</pre>
+<p>Create a new IndexManager.</p>
+
<ul>
<li><b>host</b> - An identifier which should be unique per-machine.</li>
<li><b>lock_factory</b> - A LockFactory.</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="make_write_lock()"
->make_write_lock()</a></h2>
+<h3><a class='u'
+name="set_folder"
+>set_folder</a></h3>
-<p>Create the Lock which controls access to modifying the logical content of the index.</p>
+<pre> $index_manager->set_folder($folder);
+ $index_manager->set_folder(); # default: undef</pre>
+
+<p>Setter for <code>folder</code> member. Typical clients (Indexer, IndexReader) will use this method to install their own Folder instance.</p>
+
+<h3><a class='u'
+name="get_folder"
+>get_folder</a></h3>
+
+<pre> my $retval = $index_manager->get_folder();</pre>
+
+<p>Getter for <code>folder</code> member.</p>
+
+<h3><a class='u'
+name="get_host"
+>get_host</a></h3>
+
+<pre> my $retval = $index_manager->get_host();</pre>
+
+<p>Getter for <code>host</code> member.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="recycle(_[labeled_params]_)"
->recycle( <i>[labeled params]</i> )</a></h2>
+<h3><a class='u'
+name="recycle"
+>recycle</a></h3>
+
+<pre> my $retval = $index_manager->recycle(
+ reader => $reader # required
+ del_writer => $del_writer # required
+ cutoff => $cutoff # required
+ optimize => $optimize # default: false
+ );</pre>
<p>Return an array of SegReaders representing segments that should be consolidated. Implementations must balance index-time churn against search-time degradation due to segment proliferation. The default implementation prefers small segments or segments with a high proportion of deletions.</p>
@@ -87,51 +115,49 @@ name="recycle(_[labeled_params]_)"
<li><b>optimize</b> - A boolean indicating whether to spend extra time optimizing the index for search-time performance.</li>
</ul>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="set_folder(folder)"
->set_folder(folder)</a></h2>
-
-<p>Setter for <code>folder</code> member. Typical clients (Indexer, IndexReader) will use this method to install their own Folder instance.</p>
-
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_folder()"
->get_folder()</a></h2>
+<h3><a class='u'
+name="make_write_lock"
+>make_write_lock</a></h3>
-<p>Getter for <code>folder</code> member.</p>
+<pre> my $retval = $index_manager->make_write_lock();</pre>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_host()"
->get_host()</a></h2>
+<p>Create the Lock which controls access to modifying the logical content of the index.</p>
-<p>Getter for <code>host</code> member.</p>
+<h3><a class='u'
+name="set_write_lock_timeout"
+>set_write_lock_timeout</a></h3>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="set_write_lock_timeout(timeout)"
->set_write_lock_timeout(timeout)</a></h2>
+<pre> $index_manager->set_write_lock_timeout($timeout);</pre>
<p>Setter for write lock timeout. Default: 1000 milliseconds.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_write_lock_timeout()"
->get_write_lock_timeout()</a></h2>
+<h3><a class='u'
+name="get_write_lock_timeout"
+>get_write_lock_timeout</a></h3>
+
+<pre> my $retval = $index_manager->get_write_lock_timeout();</pre>
<p>Getter for write lock timeout.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="set_write_lock_interval(timeout)"
->set_write_lock_interval(timeout)</a></h2>
+<h3><a class='u'
+name="set_write_lock_interval"
+>set_write_lock_interval</a></h3>
+
+<pre> $index_manager->set_write_lock_interval($timeout);</pre>
<p>Setter for write lock retry interval. Default: 100 milliseconds.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_write_lock_interval()"
->get_write_lock_interval()</a></h2>
+<h3><a class='u'
+name="get_write_lock_interval"
+>get_write_lock_interval</a></h3>
+
+<pre> my $retval = $index_manager->get_write_lock_interval();</pre>
<p>Getter for write lock retry interval.</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::Index::IndexManager isa Clownfish::Obj.</p>
Modified: lucy/site/trunk/content/docs/test/Lucy/Index/IndexReader.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Index/IndexReader.mdtext?rev=1732471&r1=1732470&r2=1732471&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Index/IndexReader.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Index/IndexReader.mdtext Fri Feb 26 12:52:25 2016
@@ -3,15 +3,15 @@ Title: Lucy::Index::IndexReader - 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::Index::IndexReader - Read from an inverted index.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="SYNOPSIS"
->SYNOPSIS</a></h1>
+>SYNOPSIS</a></h2>
<pre> my $reader = Lucy::Index::IndexReader->open(
index => '/path/to/index',
@@ -28,9 +28,9 @@ 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>IndexReader is the interface through which <a href="../../Lucy/Search/IndexSearcher.html" class="podlinkpod"
>IndexSearcher</a> objects access the content of an index.</p>
@@ -38,16 +38,18 @@ name="DESCRIPTION"
<p>IndexReader objects always represent a point-in-time view of an index as it existed at the moment the reader was created. If you want search results to reflect modifications to an index, you must create a new IndexReader after the update process completes.</p>
<p>IndexReaders are composites; most of the work is done by individual <a href="../../Lucy/Index/DataReader.html" class="podlinkpod"
->DataReader</a> sub-components, which may be accessed via fetch() and obtain(). The most efficient and powerful access to index data happens at the segment level via <a href="../../Lucy/Index/SegReader.html" class="podlinkpod"
->SegReader</a>'s sub-components.</p>
+>DataReader</a> sub-components, which may be accessed via <a href="#fetch" class="podlinkpod"
+>fetch()</a> and <a href="#obtain" class="podlinkpod"
+>obtain()</a>. The most efficient and powerful access to index data happens at the segment level via <a href="../../Lucy/Index/SegReader.html" class="podlinkpod"
+>SegReader</a>’s sub-components.</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="open(_[labeled_params]_)"
->open( <i>[labeled params]</i> )</a></h2>
+<h3><a class='u'
+name="open"
+>open</a></h3>
<pre> my $reader = Lucy::Index::IndexReader->open(
index => '/path/to/index', # required
@@ -66,67 +68,81 @@ name="open(_[labeled_params]_)"
>IndexManager</a>. Read-locking is off by default; supplying this argument turns it on.</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="doc_max()"
->doc_max()</a></h2>
+<h3><a class='u'
+name="doc_max"
+>doc_max</a></h3>
+
+<pre> my $retval = $index_reader->doc_max();</pre>
<p>Return the maximum number of documents available to the reader, which is also the highest possible internal document id. Documents which have been marked as deleted but not yet purged from the index are included in this count.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="doc_count()"
->doc_count()</a></h2>
+<h3><a class='u'
+name="doc_count"
+>doc_count</a></h3>
+
+<pre> my $retval = $index_reader->doc_count();</pre>
<p>Return the number of documents available to the reader, subtracting any that are marked as deleted.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="del_count()"
->del_count()</a></h2>
+<h3><a class='u'
+name="del_count"
+>del_count</a></h3>
-<p>Return the number of documents which have been marked as deleted but not yet purged from the index.</p>
+<pre> my $retval = $index_reader->del_count();</pre>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="seg_readers()"
->seg_readers()</a></h2>
+<p>Return the number of documents which have been marked as deleted but not yet purged from the index.</p>
-<p>Return an array of all the SegReaders represented within the IndexReader.</p>
+<h3><a class='u'
+name="offsets"
+>offsets</a></h3>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="offsets()"
->offsets()</a></h2>
+<pre> my $retval = $index_reader->offsets();</pre>
<p>Return an array with one entry for each segment, corresponding to segment doc_id start offset.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h3><a class='u'
+name="seg_readers"
+>seg_readers</a></h3>
+
+<pre> my $retval = $index_reader->seg_readers();</pre>
+
+<p>Return an array of all the SegReaders represented within the IndexReader.</p>
+
+<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="fetch(api)"
->fetch(api)</a></h2>
+<h3><a class='u'
+name="obtain"
+>obtain</a></h3>
-<p>Fetch a component, or return undef if the component can't be found.</p>
+<pre> my $retval = $index_reader->obtain($api);</pre>
+
+<p>Fetch a component, or throw an error if the component can’t be found.</p>
<ul>
<li><b>api</b> - The name of the DataReader subclass that the desired component must implement.</li>
</ul>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="obtain(api)"
->obtain(api)</a></h2>
+<h3><a class='u'
+name="fetch"
+>fetch</a></h3>
+
+<pre> my $retval = $index_reader->fetch($api);</pre>
-<p>Fetch a component, or throw an error if the component can't be found.</p>
+<p>Fetch a component, or return undef if the component can’t be found.</p>
<ul>
<li><b>api</b> - The name of the DataReader subclass that the desired component must implement.</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::Index::IndexReader isa <a href="../../Lucy/Index/DataReader.html" class="podlinkpod"
>Lucy::Index::DataReader</a> isa Clownfish::Obj.</p>
Modified: lucy/site/trunk/content/docs/test/Lucy/Index/Indexer.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Index/Indexer.mdtext?rev=1732471&r1=1732470&r2=1732471&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Index/Indexer.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Index/Indexer.mdtext Fri Feb 26 12:52:25 2016
@@ -3,15 +3,15 @@ Title: Lucy::Index::Indexer - Apache Luc
<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::Index::Indexer - Build inverted indexes.</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 $indexer = Lucy::Index::Indexer->new(
schema => $schema,
@@ -26,28 +26,30 @@ name="SYNOPSIS"
}
$indexer->commit;</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 Indexer class is Apache Lucy's primary tool for managing the content of inverted indexes, which may later be searched using <a href="../../Lucy/Search/IndexSearcher.html" class="podlinkpod"
+<p>The Indexer class is Apache Lucy’s primary tool for managing the content of inverted indexes, which may later be searched using <a href="../../Lucy/Search/IndexSearcher.html" class="podlinkpod"
>IndexSearcher</a>.</p>
<p>In general, only one Indexer at a time may write to an index safely. If a write lock cannot be secured, new() will throw an exception.</p>
<p>If an index is located on a shared volume, each writer application must identify itself by supplying an <a href="../../Lucy/Index/IndexManager.html" class="podlinkpod"
->IndexManager</a> with a unique <code>host</code> id to Indexer's constructor or index corruption will occur. See <a href="../../Lucy/Docs/FileLocking.html" class="podlinkpod"
->Lucy::Docs::FileLocking</a> for a detailed discussion.</p>
+>IndexManager</a> with a unique <code>host</code> id to Indexer’s constructor or index corruption will occur. See <a href="../../Lucy/Docs/FileLocking.html" class="podlinkpod"
+>FileLocking</a> for a detailed discussion.</p>
-<p>Note: at present, delete_by_term() and delete_by_query() only affect documents which had been previously committed to the index -- and not any documents added this indexing session but not yet committed. This may change in a future update.</p>
+<p>Note: at present, <a href="#delete_by_term" class="podlinkpod"
+>delete_by_term()</a> and <a href="#delete_by_query" class="podlinkpod"
+>delete_by_query()</a> only affect documents which had been previously committed to the index – and not any documents added this indexing session but not yet committed. This may change in a future update.</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 $indexer = Lucy::Index::Indexer->new(
schema => $schema, # required at index creation
@@ -69,13 +71,13 @@ name="new(_[labeled_params]_)"
<li><b>manager</b> - An IndexManager.</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="add_doc(...)"
->add_doc(...)</a></h2>
+<h3><a class='u'
+name="add_doc"
+>add_doc</a></h3>
<pre> $indexer->add_doc($doc);
$indexer->add_doc( { field_name => $field_value } );
@@ -92,9 +94,11 @@ name="add_doc(...)"
<li><b>boost</b> - A floating point weight which affects how this document scores.</li>
</ul>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="add_index(index)"
->add_index(index)</a></h2>
+<h3><a class='u'
+name="add_index"
+>add_index</a></h3>
+
+<pre> $indexer->add_index($index);</pre>
<p>Absorb an existing index into this one. The two indexes must have matching Schemas.</p>
@@ -102,47 +106,29 @@ name="add_index(index)"
<li><b>index</b> - Either an index path name or a Folder.</li>
</ul>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="optimize()"
->optimize()</a></h2>
-
-<p>Optimize the index for search-time performance. This may take a while, as it can involve rewriting large amounts of data.</p>
-
-<p>Every Indexer session which changes index content and ends in a commit() creates a new segment. Once written, segments are never modified. However, they are periodically recycled by feeding their content into the segment currently being written.</p>
-
-<p>The optimize() method causes all existing index content to be fed back into the Indexer. When commit() completes after an optimize(), the index will consist of one segment. So optimize() must be called before commit(). Also, optimizing a fresh index created from scratch has no effect.</p>
-
-<p>Historically, there was a significant search-time performance benefit to collapsing down to a single segment versus even two segments. Now the effect of collapsing is much less significant, and calling optimize() is rarely justified.</p>
-
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="commit()"
->commit()</a></h2>
-
-<p>Commit any changes made to the index. Until this is called, none of the changes made during an indexing session are permanent.</p>
-
-<p>Calling commit() invalidates the Indexer, so if you want to make more changes you'll need a new one.</p>
-
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="prepare_commit()"
->prepare_commit()</a></h2>
-
-<p>Perform the expensive setup for commit() in advance, so that commit() completes quickly. (If prepare_commit() is not called explicitly by the user, commit() will call it internally.)</p>
-
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="delete_by_term(_[labeled_params]_)"
->delete_by_term( <i>[labeled params]</i> )</a></h2>
+<h3><a class='u'
+name="delete_by_term"
+>delete_by_term</a></h3>
+
+<pre> $indexer->delete_by_term(
+ field => $field # required
+ term => $term # required
+ );</pre>
-<p>Mark documents which contain the supplied term as deleted, so that they will be excluded from search results and eventually removed altogether. The change is not apparent to search apps until after commit() succeeds.</p>
+<p>Mark documents which contain the supplied term as deleted, so that they will be excluded from search results and eventually removed altogether. The change is not apparent to search apps until after <a href="#commit" class="podlinkpod"
+>commit()</a> succeeds.</p>
<ul>
-<li><b>field</b> - The name of an indexed field. (If it is not spec'd as <code>indexed</code>, an error will occur.)</li>
+<li><b>field</b> - The name of an indexed field. (If it is not spec’d as <code>indexed</code>, an error will occur.)</li>
-<li><b>term</b> - The term which identifies docs to be marked as deleted. If <code>field</code> is associated with an Analyzer, <code>term</code> will be processed automatically (so don't pre-process it yourself).</li>
+<li><b>term</b> - The term which identifies docs to be marked as deleted. If <code>field</code> is associated with an Analyzer, <code>term</code> will be processed automatically (so don’t pre-process it yourself).</li>
</ul>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="delete_by_query(query)"
->delete_by_query(query)</a></h2>
+<h3><a class='u'
+name="delete_by_query"
+>delete_by_query</a></h3>
+
+<pre> $indexer->delete_by_query($query);</pre>
<p>Mark documents which match the supplied Query as deleted.</p>
@@ -151,9 +137,11 @@ name="delete_by_query(query)"
>Query</a>.</li>
</ul>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="delete_by_doc_id(doc_id)"
->delete_by_doc_id(doc_id)</a></h2>
+<h3><a class='u'
+name="delete_by_doc_id"
+>delete_by_doc_id</a></h3>
+
+<pre> $indexer->delete_by_doc_id($doc_id);</pre>
<p>Mark the document identified by the supplied document ID as deleted.</p>
@@ -162,15 +150,61 @@ name="delete_by_doc_id(doc_id)"
>document id</a>.</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="optimize"
+>optimize</a></h3>
+
+<pre> $indexer->optimize();</pre>
+
+<p>Optimize the index for search-time performance. This may take a while, as it can involve rewriting large amounts of data.</p>
+
+<p>Every Indexer session which changes index content and ends in a <a href="#commit" class="podlinkpod"
+>commit()</a> creates a new segment. Once written, segments are never modified. However, they are periodically recycled by feeding their content into the segment currently being written.</p>
+
+<p>The <a href="#optimize" class="podlinkpod"
+>optimize()</a> method causes all existing index content to be fed back into the Indexer. When <a href="#commit" class="podlinkpod"
+>commit()</a> completes after an <a href="#optimize" class="podlinkpod"
+>optimize()</a>, the index will consist of one segment. So <a href="#optimize" class="podlinkpod"
+>optimize()</a> must be called before <a href="#commit" class="podlinkpod"
+>commit()</a>. Also, optimizing a fresh index created from scratch has no effect.</p>
+
+<p>Historically, there was a significant search-time performance benefit to collapsing down to a single segment versus even two segments. Now the effect of collapsing is much less significant, and calling <a href="#optimize" class="podlinkpod"
+>optimize()</a> is rarely justified.</p>
+
+<h3><a class='u'
+name="commit"
+>commit</a></h3>
+
+<pre> $indexer->commit();</pre>
+
+<p>Commit any changes made to the index. Until this is called, none of the changes made during an indexing session are permanent.</p>
+
+<p>Calling <a href="#commit" class="podlinkpod"
+>commit()</a> invalidates the Indexer, so if you want to make more changes you’ll need a new one.</p>
+
+<h3><a class='u'
+name="prepare_commit"
+>prepare_commit</a></h3>
+
+<pre> $indexer->prepare_commit();</pre>
+
+<p>Perform the expensive setup for <a href="#commit" class="podlinkpod"
+>commit()</a> in advance, so that <a href="#commit" class="podlinkpod"
+>commit()</a> completes quickly. (If <a href="#prepare_commit" class="podlinkpod"
+>prepare_commit()</a> is not called explicitly by the user, <a href="#commit" class="podlinkpod"
+>commit()</a> will call it internally.)</p>
+
+<h3><a class='u'
+name="get_schema"
+>get_schema</a></h3>
+
+<pre> my $retval = $indexer->get_schema();</pre>
<p>Accessor for schema.</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::Index::Indexer isa Clownfish::Obj.</p>
Modified: lucy/site/trunk/content/docs/test/Lucy/Index/Lexicon.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Index/Lexicon.mdtext?rev=1732471&r1=1732470&r2=1732471&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Index/Lexicon.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Index/Lexicon.mdtext Fri Feb 26 12:52:25 2016
@@ -3,15 +3,15 @@ Title: Lucy::Index::Lexicon - Apache Luc
<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::Index::Lexicon - Iterator for a field's terms.</p>
+<p>Lucy::Index::Lexicon - Iterator for a field’s 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 $lex_reader = $seg_reader->obtain('Lucy::Index::LexiconReader');
my $lexicon = $lex_reader->lexicon( field => 'content' );
@@ -19,52 +19,62 @@ name="SYNOPSIS"
print $lexicon->get_term . "\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>A Lexicon is an iterator which provides access to all the unique terms for a given field in sorted order.</p>
-<p>If an index consists of two documents with a 'content' field holding "three blind mice" and "three musketeers" respectively, then iterating through the 'content' field's lexicon would produce this list:</p>
+<p>If an index consists of two documents with a ‘content’ field holding “three blind mice” and “three musketeers” respectively, then iterating through the ‘content’ field’s lexicon would produce this list:</p>
<pre> blind
mice
musketeers
three</pre>
-<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="seek(target)"
->seek(target)</a></h2>
+<h3><a class='u'
+name="seek"
+>seek</a></h3>
+
+<pre> $lexicon->seek($target);
+ $lexicon->seek(); # default: undef</pre>
<p>Seek the Lexicon to the first iterator state which is greater than or equal to <code>target</code>. If <code>target</code> is undef, reset the iterator.</p>
-<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 = $lexicon->next();</pre>
<p>Proceed to the next term.</p>
<p>Returns: true until the iterator is exhausted, then false.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_term()"
->get_term()</a></h2>
+<h3><a class='u'
+name="reset"
+>reset</a></h3>
-<p>Return the current term, or undef if the iterator is not in a valid state.</p>
+<pre> $lexicon->reset();</pre>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="reset()"
->reset()</a></h2>
+<p>Reset the iterator. <a href="#next" class="podlinkpod"
+>next()</a> must be called to proceed to the first element.</p>
-<p>Reset the iterator. next() must be called to proceed to the first element.</p>
+<h3><a class='u'
+name="get_term"
+>get_term</a></h3>
+
+<pre> my $retval = $lexicon->get_term();</pre>
+
+<p>Return the current term, or undef if the iterator is not in a valid state.</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::Index::Lexicon isa Clownfish::Obj.</p>
Modified: lucy/site/trunk/content/docs/test/Lucy/Index/LexiconReader.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Index/LexiconReader.mdtext?rev=1732471&r1=1732470&r2=1732471&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Index/LexiconReader.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Index/LexiconReader.mdtext Fri Feb 26 12:52:25 2016
@@ -3,32 +3,37 @@ Title: Lucy::Index::LexiconReader - 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::Index::LexiconReader - Read Lexicon data.</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 $lex_reader = $seg_reader->obtain("Lucy::Index::LexiconReader");
my $lexicon = $lex_reader->lexicon( field => 'title' );</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>LexiconReader reads term dictionary information.</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="lexicon(_[labeled_params]_)"
->lexicon( <i>[labeled params]</i> )</a></h2>
+<h3><a class='u'
+name="lexicon"
+>lexicon</a></h3>
+
+<pre> my $retval = $lexicon_reader->lexicon(
+ field => $field # required
+ term => $term # default: undef
+ );</pre>
<p>Return a new Lexicon for the given <code>field</code>. Will return undef if either the field is not indexed, or if no documents contain a value for the field.</p>
@@ -38,15 +43,41 @@ name="lexicon(_[labeled_params]_)"
<li><b>term</b> - Pre-locate the Lexicon to this term.</li>
</ul>
-<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 = $lexicon_reader->doc_freq(
+ field => $field # required
+ term => $term # required
+ );</pre>
<p>Return the number of documents where the specified term is present.</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="aggregator"
+>aggregator</a></h3>
+
+<pre> my $retval = $lexicon_reader->aggregator(
+ readers => $readers # required
+ offsets => $offsets # required
+ );</pre>
+
+<p>Return a LexiconReader which merges the output of other LexiconReaders.</p>
+
+<ul>
+<li><b>readers</b> - An array of LexiconReaders.</li>
+
+<li><b>offsets</b> - Doc id start offsets for each reader.</li>
+</ul>
+
+<h2><a class='u'
name="INHERITANCE"
->INHERITANCE</a></h1>
+>INHERITANCE</a></h2>
<p>Lucy::Index::LexiconReader isa <a href="../../Lucy/Index/DataReader.html" class="podlinkpod"
>Lucy::Index::DataReader</a> isa Clownfish::Obj.</p>
Modified: lucy/site/trunk/content/docs/test/Lucy/Index/PolyReader.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Index/PolyReader.mdtext?rev=1732471&r1=1732470&r2=1732471&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Index/PolyReader.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Index/PolyReader.mdtext Fri Feb 26 12:52:25 2016
@@ -3,15 +3,15 @@ Title: Lucy::Index::PolyReader - 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::Index::PolyReader - Multi-segment implementation of IndexReader.</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 $polyreader = Lucy::Index::IndexReader->open(
index => '/path/to/index',
@@ -22,19 +22,64 @@ name="SYNOPSIS"
print " $doc_id: $doc->{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>PolyReader conflates index data from multiple segments. For instance, if an index contains three segments with 10 documents each, PolyReader's doc_max() method will return 30.</p>
+<p>PolyReader conflates index data from multiple segments. For instance, if an index contains three segments with 10 documents each, PolyReader’s <a href="../../Lucy/Index/IndexReader.html#doc_max" class="podlinkpod"
+>doc_max()</a> method will return 30.</p>
-<p>Some of PolyReader's <a href="../../Lucy/Index/DataReader.html" class="podlinkpod"
+<p>Some of PolyReader’s <a href="../../Lucy/Index/DataReader.html" class="podlinkpod"
>DataReader</a> components may be less efficient or complete than the single-segment implementations accessed via <a href="../../Lucy/Index/SegReader.html" class="podlinkpod"
>SegReader</a>.</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="doc_max"
+>doc_max</a></h3>
+
+<pre> my $retval = $poly_reader->doc_max();</pre>
+
+<p>Return the maximum number of documents available to the reader, which is also the highest possible internal document id. Documents which have been marked as deleted but not yet purged from the index are included in this count.</p>
+
+<h3><a class='u'
+name="doc_count"
+>doc_count</a></h3>
+
+<pre> my $retval = $poly_reader->doc_count();</pre>
+
+<p>Return the number of documents available to the reader, subtracting any that are marked as deleted.</p>
+
+<h3><a class='u'
+name="del_count"
+>del_count</a></h3>
+
+<pre> my $retval = $poly_reader->del_count();</pre>
+
+<p>Return the number of documents which have been marked as deleted but not yet purged from the index.</p>
+
+<h3><a class='u'
+name="offsets"
+>offsets</a></h3>
+
+<pre> my $retval = $poly_reader->offsets();</pre>
+
+<p>Return an array with one entry for each segment, corresponding to segment doc_id start offset.</p>
+
+<h3><a class='u'
+name="seg_readers"
+>seg_readers</a></h3>
+
+<pre> my $retval = $poly_reader->seg_readers();</pre>
+
+<p>Return an array of all the SegReaders represented within the IndexReader.</p>
+
+<h2><a class='u'
name="INHERITANCE"
->INHERITANCE</a></h1>
+>INHERITANCE</a></h2>
<p>Lucy::Index::PolyReader isa <a href="../../Lucy/Index/IndexReader.html" class="podlinkpod"
>Lucy::Index::IndexReader</a> isa <a href="../../Lucy/Index/DataReader.html" class="podlinkpod"
Modified: lucy/site/trunk/content/docs/test/Lucy/Index/PostingList.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Index/PostingList.mdtext?rev=1732471&r1=1732470&r2=1732471&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Index/PostingList.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Index/PostingList.mdtext Fri Feb 26 12:52:25 2016
@@ -3,15 +3,15 @@ Title: Lucy::Index::PostingList - 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::Index::PostingList - Term-Document pairings.</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 $posting_list_reader
= $seg_reader->obtain("Lucy::Index::PostingListReader");
@@ -23,42 +23,33 @@ name="SYNOPSIS"
say "Matching doc id: $doc_id";
}</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>PostingList is an iterator which supplies a list of document ids that match a given term.</p>
<p>See <a href="../../Lucy/Docs/IRTheory.html" class="podlinkpod"
->Lucy::Docs::IRTheory</a> for definitions of "posting" and "posting list".</p>
+>IRTheory</a> for definitions of “posting” and “posting list”.</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="get_doc_freq"
+>get_doc_freq</a></h3>
-<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="get_doc_freq()"
->get_doc_freq()</a></h2>
+<pre> my $retval = $posting_list->get_doc_freq();</pre>
<p>Return the number of documents that the PostingList contains. (This number will include any documents which have been marked as deleted but not yet purged.)</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="seek(target)"
->seek(target)</a></h2>
+<h3><a class='u'
+name="seek"
+>seek</a></h3>
+
+<pre> $posting_list->seek($target);
+ $posting_list->seek(); # default: undef</pre>
<p>Prepare the PostingList object to iterate over matches for documents that match <code>target</code>.</p>
@@ -66,25 +57,9 @@ name="seek(target)"
<li><b>target</b> - The term to match. If undef, the iterator will be empty.</li>
</ul>
-<h1><a class='u' href='#___top' title='click to go to top of document'
-name="METHODS"
->METHODS</a></h1>
-
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="advance(target)"
->advance(target)</a></h2>
-
-<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>
-
-<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>
-</ul>
-
-<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::Index::PostingList isa <a href="../../Lucy/Search/Matcher.html" class="podlinkpod"
>Lucy::Search::Matcher</a> isa Clownfish::Obj.</p>
Modified: lucy/site/trunk/content/docs/test/Lucy/Index/PostingListReader.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Index/PostingListReader.mdtext?rev=1732471&r1=1732470&r2=1732471&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Index/PostingListReader.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Index/PostingListReader.mdtext Fri Feb 26 12:52:25 2016
@@ -3,15 +3,15 @@ Title: Lucy::Index::PostingListReader -
<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::Index::PostingListReader - Read postings data.</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 $posting_list_reader
= $seg_reader->obtain("Lucy::Index::PostingListReader");
@@ -20,32 +20,53 @@ name="SYNOPSIS"
term => 'foo',
);</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>PostingListReaders produce <a href="../../Lucy/Index/PostingList.html" class="podlinkpod"
>PostingList</a> objects which convey document matching information.</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="posting_list(_[labeled_params]_)"
->posting_list( <i>[labeled params]</i> )</a></h2>
+<h3><a class='u'
+name="posting_list"
+>posting_list</a></h3>
+
+<pre> my $retval = $posting_list_reader->posting_list(
+ field => $field # default: undef
+ term => $term # default: undef
+ );</pre>
<p>Returns a PostingList, or undef if either <code>field</code> is undef or <code>field</code> is not present in any documents.</p>
<ul>
<li><b>field</b> - A field name.</li>
-<li><b>term</b> - If supplied, the PostingList will be pre-located to this term using seek().</li>
+<li><b>term</b> - If supplied, the PostingList will be pre-located to this term using <a href="../../Lucy/Index/PostingList.html#seek" class="podlinkpod"
+>seek()</a>.</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="aggregator"
+>aggregator</a></h3>
+
+<pre> my $retval = $posting_list_reader->aggregator(
+ readers => $readers # required
+ offsets => $offsets # required
+ );</pre>
+
+<p>Returns undef since PostingLists may only be iterated at the segment level.</p>
+
+<h2><a class='u'
name="INHERITANCE"
->INHERITANCE</a></h1>
+>INHERITANCE</a></h2>
<p>Lucy::Index::PostingListReader isa <a href="../../Lucy/Index/DataReader.html" class="podlinkpod"
>Lucy::Index::DataReader</a> isa Clownfish::Obj.</p>
Modified: lucy/site/trunk/content/docs/test/Lucy/Index/SegReader.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Index/SegReader.mdtext?rev=1732471&r1=1732470&r2=1732471&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Index/SegReader.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Index/SegReader.mdtext Fri Feb 26 12:52:25 2016
@@ -3,15 +3,15 @@ Title: Lucy::Index::SegReader - 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::Index::SegReader - Single-segment IndexReader.</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 $polyreader = Lucy::Index::IndexReader->open(
index => '/path/to/index',
@@ -28,36 +28,80 @@ 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>SegReader interprets the data within a single segment of an index.</p>
<p>Generally speaking, only advanced users writing subclasses which manipulate data at the segment level need to deal with the SegReader API directly.</p>
-<p>Nearly all of SegReader's functionality is implemented by pluggable components spawned by <a href="../../Lucy/Plan/Architecture.html" class="podlinkpod"
->Architecture</a>'s factory methods.</p>
+<p>Nearly all of SegReader’s functionality is implemented by pluggable components spawned by <a href="../../Lucy/Plan/Architecture.html" class="podlinkpod"
+>Architecture</a>’s factory methods.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="METHODS"
->METHODS</a></h1>
+>METHODS</a></h2>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_seg_name()"
->get_seg_name()</a></h2>
+<h3><a class='u'
+name="get_seg_name"
+>get_seg_name</a></h3>
+
+<pre> my $retval = $seg_reader->get_seg_name();</pre>
<p>Return the name of the segment.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_seg_num()"
->get_seg_num()</a></h2>
+<h3><a class='u'
+name="get_seg_num"
+>get_seg_num</a></h3>
+
+<pre> my $retval = $seg_reader->get_seg_num();</pre>
<p>Return the number of the segment.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h3><a class='u'
+name="del_count"
+>del_count</a></h3>
+
+<pre> my $retval = $seg_reader->del_count();</pre>
+
+<p>Return the number of documents which have been marked as deleted but not yet purged from the index.</p>
+
+<h3><a class='u'
+name="doc_max"
+>doc_max</a></h3>
+
+<pre> my $retval = $seg_reader->doc_max();</pre>
+
+<p>Return the maximum number of documents available to the reader, which is also the highest possible internal document id. Documents which have been marked as deleted but not yet purged from the index are included in this count.</p>
+
+<h3><a class='u'
+name="doc_count"
+>doc_count</a></h3>
+
+<pre> my $retval = $seg_reader->doc_count();</pre>
+
+<p>Return the number of documents available to the reader, subtracting any that are marked as deleted.</p>
+
+<h3><a class='u'
+name="_offsets"
+>_offsets</a></h3>
+
+<pre> my $retval = $seg_reader->_offsets();</pre>
+
+<p>Return an array with one entry for each segment, corresponding to segment doc_id start offset.</p>
+
+<h3><a class='u'
+name="seg_readers"
+>seg_readers</a></h3>
+
+<pre> my $retval = $seg_reader->seg_readers();</pre>
+
+<p>Return an array of all the SegReaders represented within the IndexReader.</p>
+
+<h2><a class='u'
name="INHERITANCE"
->INHERITANCE</a></h1>
+>INHERITANCE</a></h2>
<p>Lucy::Index::SegReader isa <a href="../../Lucy/Index/IndexReader.html" class="podlinkpod"
>Lucy::Index::IndexReader</a> isa <a href="../../Lucy/Index/DataReader.html" class="podlinkpod"
Modified: lucy/site/trunk/content/docs/test/Lucy/Index/SegWriter.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Index/SegWriter.mdtext?rev=1732471&r1=1732470&r2=1732471&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Index/SegWriter.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Index/SegWriter.mdtext Fri Feb 26 12:52:25 2016
@@ -3,15 +3,15 @@ Title: Lucy::Index::SegWriter - 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::Index::SegWriter - Write one segment of an index.</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>SegWriter is a conduit through which information fed to Indexer passes.
It manages <a href="../../Lucy/Index/Segment.html" class="podlinkpod"
@@ -23,35 +23,26 @@ and feeds low level <a href="../../Lucy/
<p>The sub-components of a SegWriter are determined by <a href="../../Lucy/Plan/Architecture.html" class="podlinkpod"
>Architecture</a>.
-DataWriter components which are added to the stack of writers via add_writer() have add_inverted_doc() invoked for each document supplied to SegWriter's add_doc().</p>
+DataWriter components which are added to the stack of writers via <a href="#add_writer" class="podlinkpod"
+>add_writer()</a> have Add_Inverted_Doc() invoked for each document supplied to SegWriter’s <a href="#add_doc" class="podlinkpod"
+>add_doc()</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>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="add_doc(_[labeled_params]_)"
->add_doc( <i>[labeled params]</i> )</a></h2>
-
-<p>Add a document to the segment.
-Inverts <code>doc</code>,
-increments the Segment's internal document id,
-then calls add_inverted_doc(),
-feeding all sub-writers.</p>
-
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="add_writer(writer)"
->add_writer(writer)</a></h2>
-
-<p>Add a DataWriter to the SegWriter's stack of writers.</p>
-
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="register(_[labeled_params]_)"
->register( <i>[labeled params]</i> )</a></h2>
-
-<p>Register a DataWriter component with the SegWriter.
-(Note that registration simply makes the writer available via fetch(),
-so you may also want to call add_writer()).</p>
+<h3><a class='u'
+name="register"
+>register</a></h3>
+
+<pre> $seg_writer->register(
+ api => $api # required
+ component => $component # required
+ );</pre>
+
+<p>Register a DataWriter component with the SegWriter. (Note that registration simply makes the writer available via <a href="#fetch" class="podlinkpod"
+>fetch()</a>, so you may also want to call <a href="#add_writer" class="podlinkpod"
+>add_writer()</a>).</p>
<ul>
<li><b>api</b> - The name of the DataWriter api which <code>writer</code> implements.</li>
@@ -59,9 +50,11 @@ so you may also want to call add_writer(
<li><b>component</b> - A DataWriter.</li>
</ul>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="fetch(api)"
->fetch(api)</a></h2>
+<h3><a class='u'
+name="fetch"
+>fetch</a></h3>
+
+<pre> my $retval = $seg_writer->fetch($api);</pre>
<p>Retrieve a registered component.</p>
@@ -69,9 +62,53 @@ name="fetch(api)"
<li><b>api</b> - The name of the DataWriter api which the component implements.</li>
</ul>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h3><a class='u'
+name="add_writer"
+>add_writer</a></h3>
+
+<pre> $seg_writer->add_writer($writer);</pre>
+
+<p>Add a DataWriter to the SegWriter’s stack of writers.</p>
+
+<h3><a class='u'
+name="add_doc"
+>add_doc</a></h3>
+
+<pre> $seg_writer->add_doc(
+ doc => $doc # required
+ boost => $boost # default: 1.0
+ );</pre>
+
+<p>Add a document to the segment. Inverts <code>doc</code>, increments the Segment’s internal document id, then calls Add_Inverted_Doc(), feeding all sub-writers.</p>
+
+<h3><a class='u'
+name="add_segment"
+>add_segment</a></h3>
+
+<pre> $seg_writer->add_segment(
+ reader => $reader # required
+ doc_map => $doc_map # default: undef
+ );</pre>
+
+<p>Add content from an existing segment into the one currently being written.</p>
+
+<ul>
+<li><b>reader</b> - The SegReader containing content to add.</li>
+
+<li><b>doc_map</b> - An array of integers mapping old document ids to new. Deleted documents are mapped to 0, indicating that they should be skipped.</li>
+</ul>
+
+<h3><a class='u'
+name="finish"
+>finish</a></h3>
+
+<pre> $seg_writer->finish();</pre>
+
+<p>Complete the segment: close all streams, store metadata, etc.</p>
+
+<h2><a class='u'
name="INHERITANCE"
->INHERITANCE</a></h1>
+>INHERITANCE</a></h2>
<p>Lucy::Index::SegWriter isa <a href="../../Lucy/Index/DataWriter.html" class="podlinkpod"
>Lucy::Index::DataWriter</a> isa Clownfish::Obj.</p>