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 2013/06/30 19:43:07 UTC

[lucy-commits] svn commit: r867927 [4/10] - 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/Highli...

Added: websites/staging/lucy/trunk/content/docs/test/Lucy/Highlight/Highlighter.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Highlight/Highlighter.html (added)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Highlight/Highlighter.html Sun Jun 30 17:43:05 2013
@@ -0,0 +1,230 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+    <title>Lucy::Highlight::Highlighter - Apache Lucy Documentation</title>
+    <link rel="stylesheet" type="text/css" media="screen" href="http://lucy.apache.org/css/lucy.css">
+  </head>
+
+  <body>
+
+    <div id="lucy-rigid_wrapper">
+
+      <div id="lucy-top" class="container_16 lucy-white_box_3d">
+
+        <div id="lucy-logo_box" class="grid_8">
+          <a href="/"><img src="http://lucy.apache.org/images/lucy_logo_150x100.png" alt="Apache Lucy™"></a>
+        </div> <!-- lucy-logo_box -->
+
+        <div #id="lucy-top_nav_box" class="grid_8">
+          <div id="lucy-top_nav_bar" class="container_8">
+            <ul>
+              <li><a href="http://www.apache.org/" title="Apache Software Foundation">Apache Software Foundation</a></li>
+              <li><a href="http://www.apache.org/licenses/" title="License">License</a></li>
+              <li><a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsorship">Sponsorship</a></li>
+              <li><a href="http://www.apache.org/foundation/thanks.html" title="Thanks">Thanks</a></li>
+              <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li>
+            </ul>
+          </div> <!-- lucy-top_nav_bar -->
+          <p><a href="http://www.apache.org/">Apache</a>&nbsp;&raquo&nbsp;<a href="/">Lucy</a>&nbsp;&raquo&nbsp;<a href="/docs/">Docs</a>&nbsp;&raquo&nbsp;<a href="/docs/test/">Test</a>&nbsp;&raquo&nbsp;<a href="/docs/test/Lucy/">Lucy</a>&nbsp;&raquo&nbsp;<a href="/docs/test/Lucy/Highlight/">Highlight</a></p>
+          <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search" method="get">
+            <input value="*.apache.org" name="sitesearch" type="hidden"/>
+            <input type="text" name="q" id="query" style="width:85%">
+            <input type="submit" id="submit" value="Search">
+          </form>
+        </div> <!-- lucy-top_nav_box -->
+
+        <div class="clear"></div>
+
+      </div> <!-- lucy-top -->
+
+      <div id="lucy-main_content" class="container_16 lucy-white_box_3d">
+
+        <div class="grid_4" id="lucy-left_nav_box">
+          <h6>About</h6>
+            <ul>
+              <li><a href="/">Welcome</a></li>
+              <li><a href="/faq.html">FAQ</a></li>
+              <li><a href="/people.html">People</a></li>
+            </ul>
+          <h6>Resources</h6>
+            <ul>
+              <li><a href="/download.html">Download</a></li>
+              <li><a href="/mailing_lists.html">Mailing Lists</a></li>
+              <li><a href="/docs/perl/">Documentation</a></li>
+              <li><a href="http://wiki.apache.org/lucy/">Wiki</a></li>
+              <li><a href="https://issues.apache.org/jira/browse/LUCY">Issue Tracker</a></li>
+              <li><a href="/version_control.html">Version Control</a></li>
+            </ul>
+          <h6>Related Projects</h6>
+            <ul>
+              <li><a href="http://lucene.apache.org/java/">Lucene</a></li>
+              <li><a href="http://lucene.apache.org/solr/">Solr</a></li>
+              <li><a href="http://incubator.apache.org/lucene.net/">Lucene.NET</a></li>
+              <li><a href="http://lucene.apache.org/pylucene/">PyLucene</a></li>
+              <li><a href="http://lucene.apache.org/openrelevance/">Open Relevance</a></li>
+            </ul>
+        </div> <!-- lucy-left_nav_box -->
+
+        <div id="lucy-main_content_box" class="grid_9">
+          <div>
+<a name='___top' class='dummyTopAnchor' ></a>
+
+<h1><a class='u' href='#___top' title='click to go to top of document'
+name="NAME"
+>NAME</a></h1>
+
+<p>Lucy::Highlight::Highlighter - Create and highlight excerpts.</p>
+
+<h1><a class='u' href='#___top' title='click to go to top of document'
+name="SYNOPSIS"
+>SYNOPSIS</a></h1>
+
+<pre>    my $highlighter = Lucy::Highlight::Highlighter-&#62;new(
+        searcher =&#62; $searcher,
+        query    =&#62; $query,
+        field    =&#62; &#39;body&#39;
+    );
+    my $hits = $searcher-&#62;hits( query =&#62; $query );
+    while ( my $hit = $hits-&#62;next ) {
+        my $excerpt = $highlighter-&#62;create_excerpt($hit);
+        ...
+    }</pre>
+
+<h1><a class='u' href='#___top' title='click to go to top of document'
+name="DESCRIPTION"
+>DESCRIPTION</a></h1>
+
+<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'
+name="CONSTRUCTORS"
+>CONSTRUCTORS</a></h1>
+
+<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>
+
+<pre>    my $highlighter = Lucy::Highlight::Highlighter-&#62;new(
+        searcher       =&#62; $searcher,    # required
+        query          =&#62; $query,       # required
+        field          =&#62; &#39;content&#39;,    # required
+        excerpt_length =&#62; 150,          # default: 200
+    );</pre>
+
+<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"
+>IndexSearcher</a>.</li>
+
+<li><b>query</b> - Query object or a query string.</li>
+
+<li><b>field</b> - The name of the field from which to draw the excerpt. The field must marked as be <code>highlightable</code> (see <a href="../../Lucy/Plan/FieldType.html" class="podlinkpod"
+>FieldType</a>).</li>
+
+<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'
+name="METHODS"
+>METHODS</a></h1>
+
+<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>
+
+<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>
+
+<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>
+
+<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 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>
+
+<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>
+
+<p>Setter. The default value is &#34;&#60;strong&#62;&#34;.</p>
+
+<h2><a class='u' href='#___top' title='click to go to top of document'
+name="get_pre_tag()"
+>get_pre_tag()</a></h2>
+
+<p>Accessor.</p>
+
+<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>
+
+<p>Setter. The default value is &#34;&#60;/strong&#62;&#34;.</p>
+
+<h2><a class='u' href='#___top' title='click to go to top of document'
+name="get_post_tag()"
+>get_post_tag()</a></h2>
+
+<p>Accessor.</p>
+
+<h2><a class='u' href='#___top' title='click to go to top of document'
+name="get_searcher()"
+>get_searcher()</a></h2>
+
+<p>Accessor.</p>
+
+<h2><a class='u' href='#___top' title='click to go to top of document'
+name="get_query()"
+>get_query()</a></h2>
+
+<p>Accessor.</p>
+
+<h2><a class='u' href='#___top' title='click to go to top of document'
+name="get_compiler()"
+>get_compiler()</a></h2>
+
+<p>Accessor for the Lucy::Search::Compiler object derived from <code>query</code> and <code>searcher</code>.</p>
+
+<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>
+
+<h2><a class='u' href='#___top' title='click to go to top of document'
+name="get_field()"
+>get_field()</a></h2>
+
+<p>Accessor.</p>
+
+<h1><a class='u' href='#___top' title='click to go to top of document'
+name="INHERITANCE"
+>INHERITANCE</a></h1>
+
+<p>Lucy::Highlight::Highlighter isa Clownfish::Obj.</p>
+
+</div>
+
+        </div> <!-- lucy-main_content_box --> 
+        <div class="clear"></div>
+
+      </div> <!-- lucy-main_content -->
+
+      <div id="lucy-copyright" class="container_16">
+        <p>Copyright &#169; 2010-2012 The Apache Software Foundation, Licensed under the 
+           <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+           <br/>
+           Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The
+           Apache Software Foundation.  All other marks mentioned may be trademarks or registered trademarks of their
+           respective owners.
+        </p>
+      </div> <!-- lucy-copyright -->
+
+    </div> <!-- lucy-rigid_wrapper -->
+
+  </body>
+</html>

Added: websites/staging/lucy/trunk/content/docs/test/Lucy/Index/BackgroundMerger.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Index/BackgroundMerger.html (added)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Index/BackgroundMerger.html Sun Jun 30 17:43:05 2013
@@ -0,0 +1,172 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+    <title>Lucy::Index::BackgroundMerger - Apache Lucy Documentation</title>
+    <link rel="stylesheet" type="text/css" media="screen" href="http://lucy.apache.org/css/lucy.css">
+  </head>
+
+  <body>
+
+    <div id="lucy-rigid_wrapper">
+
+      <div id="lucy-top" class="container_16 lucy-white_box_3d">
+
+        <div id="lucy-logo_box" class="grid_8">
+          <a href="/"><img src="http://lucy.apache.org/images/lucy_logo_150x100.png" alt="Apache Lucy™"></a>
+        </div> <!-- lucy-logo_box -->
+
+        <div #id="lucy-top_nav_box" class="grid_8">
+          <div id="lucy-top_nav_bar" class="container_8">
+            <ul>
+              <li><a href="http://www.apache.org/" title="Apache Software Foundation">Apache Software Foundation</a></li>
+              <li><a href="http://www.apache.org/licenses/" title="License">License</a></li>
+              <li><a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsorship">Sponsorship</a></li>
+              <li><a href="http://www.apache.org/foundation/thanks.html" title="Thanks">Thanks</a></li>
+              <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li>
+            </ul>
+          </div> <!-- lucy-top_nav_bar -->
+          <p><a href="http://www.apache.org/">Apache</a>&nbsp;&raquo&nbsp;<a href="/">Lucy</a>&nbsp;&raquo&nbsp;<a href="/docs/">Docs</a>&nbsp;&raquo&nbsp;<a href="/docs/test/">Test</a>&nbsp;&raquo&nbsp;<a href="/docs/test/Lucy/">Lucy</a>&nbsp;&raquo&nbsp;<a href="/docs/test/Lucy/Index/">Index</a></p>
+          <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search" method="get">
+            <input value="*.apache.org" name="sitesearch" type="hidden"/>
+            <input type="text" name="q" id="query" style="width:85%">
+            <input type="submit" id="submit" value="Search">
+          </form>
+        </div> <!-- lucy-top_nav_box -->
+
+        <div class="clear"></div>
+
+      </div> <!-- lucy-top -->
+
+      <div id="lucy-main_content" class="container_16 lucy-white_box_3d">
+
+        <div class="grid_4" id="lucy-left_nav_box">
+          <h6>About</h6>
+            <ul>
+              <li><a href="/">Welcome</a></li>
+              <li><a href="/faq.html">FAQ</a></li>
+              <li><a href="/people.html">People</a></li>
+            </ul>
+          <h6>Resources</h6>
+            <ul>
+              <li><a href="/download.html">Download</a></li>
+              <li><a href="/mailing_lists.html">Mailing Lists</a></li>
+              <li><a href="/docs/perl/">Documentation</a></li>
+              <li><a href="http://wiki.apache.org/lucy/">Wiki</a></li>
+              <li><a href="https://issues.apache.org/jira/browse/LUCY">Issue Tracker</a></li>
+              <li><a href="/version_control.html">Version Control</a></li>
+            </ul>
+          <h6>Related Projects</h6>
+            <ul>
+              <li><a href="http://lucene.apache.org/java/">Lucene</a></li>
+              <li><a href="http://lucene.apache.org/solr/">Solr</a></li>
+              <li><a href="http://incubator.apache.org/lucene.net/">Lucene.NET</a></li>
+              <li><a href="http://lucene.apache.org/pylucene/">PyLucene</a></li>
+              <li><a href="http://lucene.apache.org/openrelevance/">Open Relevance</a></li>
+            </ul>
+        </div> <!-- lucy-left_nav_box -->
+
+        <div id="lucy-main_content_box" class="grid_9">
+          <div>
+<a name='___top' class='dummyTopAnchor' ></a>
+
+<h1><a class='u' href='#___top' title='click to go to top of document'
+name="NAME"
+>NAME</a></h1>
+
+<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'
+name="SYNOPSIS"
+>SYNOPSIS</a></h1>
+
+<pre>    my $bg_merger = Lucy::Index::BackgroundMerger-&#62;new(
+        index  =&#62; &#39;/path/to/index&#39;,
+    );
+    $bg_merger-&#62;commit;</pre>
+
+<h1><a class='u' href='#___top' title='click to go to top of document'
+name="DESCRIPTION"
+>DESCRIPTION</a></h1>
+
+<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>
+
+<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>
+
+<h1><a class='u' href='#___top' title='click to go to top of document'
+name="CONSTRUCTORS"
+>CONSTRUCTORS</a></h1>
+
+<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>
+
+<pre>    my $bg_merger = Lucy::Index::BackgroundMerger-&#62;new(
+        index   =&#62; &#39;/path/to/index&#39;,    # required
+        manager =&#62; $manager             # default: created internally
+    );</pre>
+
+<p>Open a new BackgroundMerger.</p>
+
+<ul>
+<li><b>index</b> - Either a string filepath or a Folder.</li>
+
+<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'
+name="METHODS"
+>METHODS</a></h1>
+
+<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>Calls prepare_commit() implicitly if it has not already been called.</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.</p>
+
+<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>
+
+<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>
+
+<h1><a class='u' href='#___top' title='click to go to top of document'
+name="INHERITANCE"
+>INHERITANCE</a></h1>
+
+<p>Lucy::Index::BackgroundMerger isa Clownfish::Obj.</p>
+
+</div>
+
+        </div> <!-- lucy-main_content_box --> 
+        <div class="clear"></div>
+
+      </div> <!-- lucy-main_content -->
+
+      <div id="lucy-copyright" class="container_16">
+        <p>Copyright &#169; 2010-2012 The Apache Software Foundation, Licensed under the 
+           <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+           <br/>
+           Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The
+           Apache Software Foundation.  All other marks mentioned may be trademarks or registered trademarks of their
+           respective owners.
+        </p>
+      </div> <!-- lucy-copyright -->
+
+    </div> <!-- lucy-rigid_wrapper -->
+
+  </body>
+</html>

Added: websites/staging/lucy/trunk/content/docs/test/Lucy/Index/DataReader.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Index/DataReader.html (added)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Index/DataReader.html Sun Jun 30 17:43:05 2013
@@ -0,0 +1,202 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+    <title>Lucy::Index::DataReader - Apache Lucy Documentation</title>
+    <link rel="stylesheet" type="text/css" media="screen" href="http://lucy.apache.org/css/lucy.css">
+  </head>
+
+  <body>
+
+    <div id="lucy-rigid_wrapper">
+
+      <div id="lucy-top" class="container_16 lucy-white_box_3d">
+
+        <div id="lucy-logo_box" class="grid_8">
+          <a href="/"><img src="http://lucy.apache.org/images/lucy_logo_150x100.png" alt="Apache Lucy™"></a>
+        </div> <!-- lucy-logo_box -->
+
+        <div #id="lucy-top_nav_box" class="grid_8">
+          <div id="lucy-top_nav_bar" class="container_8">
+            <ul>
+              <li><a href="http://www.apache.org/" title="Apache Software Foundation">Apache Software Foundation</a></li>
+              <li><a href="http://www.apache.org/licenses/" title="License">License</a></li>
+              <li><a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsorship">Sponsorship</a></li>
+              <li><a href="http://www.apache.org/foundation/thanks.html" title="Thanks">Thanks</a></li>
+              <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li>
+            </ul>
+          </div> <!-- lucy-top_nav_bar -->
+          <p><a href="http://www.apache.org/">Apache</a>&nbsp;&raquo&nbsp;<a href="/">Lucy</a>&nbsp;&raquo&nbsp;<a href="/docs/">Docs</a>&nbsp;&raquo&nbsp;<a href="/docs/test/">Test</a>&nbsp;&raquo&nbsp;<a href="/docs/test/Lucy/">Lucy</a>&nbsp;&raquo&nbsp;<a href="/docs/test/Lucy/Index/">Index</a></p>
+          <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search" method="get">
+            <input value="*.apache.org" name="sitesearch" type="hidden"/>
+            <input type="text" name="q" id="query" style="width:85%">
+            <input type="submit" id="submit" value="Search">
+          </form>
+        </div> <!-- lucy-top_nav_box -->
+
+        <div class="clear"></div>
+
+      </div> <!-- lucy-top -->
+
+      <div id="lucy-main_content" class="container_16 lucy-white_box_3d">
+
+        <div class="grid_4" id="lucy-left_nav_box">
+          <h6>About</h6>
+            <ul>
+              <li><a href="/">Welcome</a></li>
+              <li><a href="/faq.html">FAQ</a></li>
+              <li><a href="/people.html">People</a></li>
+            </ul>
+          <h6>Resources</h6>
+            <ul>
+              <li><a href="/download.html">Download</a></li>
+              <li><a href="/mailing_lists.html">Mailing Lists</a></li>
+              <li><a href="/docs/perl/">Documentation</a></li>
+              <li><a href="http://wiki.apache.org/lucy/">Wiki</a></li>
+              <li><a href="https://issues.apache.org/jira/browse/LUCY">Issue Tracker</a></li>
+              <li><a href="/version_control.html">Version Control</a></li>
+            </ul>
+          <h6>Related Projects</h6>
+            <ul>
+              <li><a href="http://lucene.apache.org/java/">Lucene</a></li>
+              <li><a href="http://lucene.apache.org/solr/">Solr</a></li>
+              <li><a href="http://incubator.apache.org/lucene.net/">Lucene.NET</a></li>
+              <li><a href="http://lucene.apache.org/pylucene/">PyLucene</a></li>
+              <li><a href="http://lucene.apache.org/openrelevance/">Open Relevance</a></li>
+            </ul>
+        </div> <!-- lucy-left_nav_box -->
+
+        <div id="lucy-main_content_box" class="grid_9">
+          <div>
+<a name='___top' class='dummyTopAnchor' ></a>
+
+<h1><a class='u' href='#___top' title='click to go to top of document'
+name="NAME"
+>NAME</a></h1>
+
+<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'
+name="SYNOPSIS"
+>SYNOPSIS</a></h1>
+
+<pre>    # Abstract base class.</pre>
+
+<h1><a class='u' href='#___top' title='click to go to top of document'
+name="DESCRIPTION"
+>DESCRIPTION</a></h1>
+
+<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'
+name="CONSTRUCTORS"
+>CONSTRUCTORS</a></h1>
+
+<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>
+
+<pre>    my $reader = MyDataReader-&#62;new(
+        schema   =&#62; $seg_reader-&#62;get_schema,      # default undef
+        folder   =&#62; $seg_reader-&#62;get_folder,      # default undef
+        snapshot =&#62; $seg_reader-&#62;get_snapshot,    # default undef
+        segments =&#62; $seg_reader-&#62;get_segments,    # default undef
+        seg_tick =&#62; $seg_reader-&#62;get_seg_tick,    # default -1
+    );</pre>
+
+<ul>
+<li><b>schema</b> - A Schema.</li>
+
+<li><b>folder</b> - A Folder.</li>
+
+<li><b>snapshot</b> - A Snapshot.</li>
+
+<li><b>segments</b> - An array of Segments.</li>
+
+<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'
+name="ABSTRACT_METHODS"
+>ABSTRACT METHODS</a></h1>
+
+<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>
+
+<p>Create a reader which aggregates the output of several lower level readers. Return undef if such a reader is not valid.</p>
+
+<ul>
+<li><b>readers</b> - An array of DataReaders.</li>
+
+<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'
+name="METHODS"
+>METHODS</a></h1>
+
+<h2><a class='u' href='#___top' title='click to go to top of document'
+name="get_schema()"
+>get_schema()</a></h2>
+
+<p>Accessor for &#34;schema&#34; member var.</p>
+
+<h2><a class='u' href='#___top' title='click to go to top of document'
+name="get_folder()"
+>get_folder()</a></h2>
+
+<p>Accessor for &#34;folder&#34; member var.</p>
+
+<h2><a class='u' href='#___top' title='click to go to top of document'
+name="get_snapshot()"
+>get_snapshot()</a></h2>
+
+<p>Accessor for &#34;snapshot&#34; member var.</p>
+
+<h2><a class='u' href='#___top' title='click to go to top of document'
+name="get_segments()"
+>get_segments()</a></h2>
+
+<p>Accessor for &#34;segments&#34; member var.</p>
+
+<h2><a class='u' href='#___top' title='click to go to top of document'
+name="get_segment()"
+>get_segment()</a></h2>
+
+<p>Accessor for &#34;segment&#34; member var.</p>
+
+<h2><a class='u' href='#___top' title='click to go to top of document'
+name="get_seg_tick()"
+>get_seg_tick()</a></h2>
+
+<p>Accessor for &#34;seg_tick&#34; member var.</p>
+
+<h1><a class='u' href='#___top' title='click to go to top of document'
+name="INHERITANCE"
+>INHERITANCE</a></h1>
+
+<p>Lucy::Index::DataReader isa Clownfish::Obj.</p>
+
+</div>
+
+        </div> <!-- lucy-main_content_box --> 
+        <div class="clear"></div>
+
+      </div> <!-- lucy-main_content -->
+
+      <div id="lucy-copyright" class="container_16">
+        <p>Copyright &#169; 2010-2012 The Apache Software Foundation, Licensed under the 
+           <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+           <br/>
+           Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The
+           Apache Software Foundation.  All other marks mentioned may be trademarks or registered trademarks of their
+           respective owners.
+        </p>
+      </div> <!-- lucy-copyright -->
+
+    </div> <!-- lucy-rigid_wrapper -->
+
+  </body>
+</html>

Added: websites/staging/lucy/trunk/content/docs/test/Lucy/Index/DataWriter.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Index/DataWriter.html (added)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Index/DataWriter.html Sun Jun 30 17:43:05 2013
@@ -0,0 +1,247 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+    <title>Lucy::Index::DataWriter - Apache Lucy Documentation</title>
+    <link rel="stylesheet" type="text/css" media="screen" href="http://lucy.apache.org/css/lucy.css">
+  </head>
+
+  <body>
+
+    <div id="lucy-rigid_wrapper">
+
+      <div id="lucy-top" class="container_16 lucy-white_box_3d">
+
+        <div id="lucy-logo_box" class="grid_8">
+          <a href="/"><img src="http://lucy.apache.org/images/lucy_logo_150x100.png" alt="Apache Lucy™"></a>
+        </div> <!-- lucy-logo_box -->
+
+        <div #id="lucy-top_nav_box" class="grid_8">
+          <div id="lucy-top_nav_bar" class="container_8">
+            <ul>
+              <li><a href="http://www.apache.org/" title="Apache Software Foundation">Apache Software Foundation</a></li>
+              <li><a href="http://www.apache.org/licenses/" title="License">License</a></li>
+              <li><a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsorship">Sponsorship</a></li>
+              <li><a href="http://www.apache.org/foundation/thanks.html" title="Thanks">Thanks</a></li>
+              <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li>
+            </ul>
+          </div> <!-- lucy-top_nav_bar -->
+          <p><a href="http://www.apache.org/">Apache</a>&nbsp;&raquo&nbsp;<a href="/">Lucy</a>&nbsp;&raquo&nbsp;<a href="/docs/">Docs</a>&nbsp;&raquo&nbsp;<a href="/docs/test/">Test</a>&nbsp;&raquo&nbsp;<a href="/docs/test/Lucy/">Lucy</a>&nbsp;&raquo&nbsp;<a href="/docs/test/Lucy/Index/">Index</a></p>
+          <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search" method="get">
+            <input value="*.apache.org" name="sitesearch" type="hidden"/>
+            <input type="text" name="q" id="query" style="width:85%">
+            <input type="submit" id="submit" value="Search">
+          </form>
+        </div> <!-- lucy-top_nav_box -->
+
+        <div class="clear"></div>
+
+      </div> <!-- lucy-top -->
+
+      <div id="lucy-main_content" class="container_16 lucy-white_box_3d">
+
+        <div class="grid_4" id="lucy-left_nav_box">
+          <h6>About</h6>
+            <ul>
+              <li><a href="/">Welcome</a></li>
+              <li><a href="/faq.html">FAQ</a></li>
+              <li><a href="/people.html">People</a></li>
+            </ul>
+          <h6>Resources</h6>
+            <ul>
+              <li><a href="/download.html">Download</a></li>
+              <li><a href="/mailing_lists.html">Mailing Lists</a></li>
+              <li><a href="/docs/perl/">Documentation</a></li>
+              <li><a href="http://wiki.apache.org/lucy/">Wiki</a></li>
+              <li><a href="https://issues.apache.org/jira/browse/LUCY">Issue Tracker</a></li>
+              <li><a href="/version_control.html">Version Control</a></li>
+            </ul>
+          <h6>Related Projects</h6>
+            <ul>
+              <li><a href="http://lucene.apache.org/java/">Lucene</a></li>
+              <li><a href="http://lucene.apache.org/solr/">Solr</a></li>
+              <li><a href="http://incubator.apache.org/lucene.net/">Lucene.NET</a></li>
+              <li><a href="http://lucene.apache.org/pylucene/">PyLucene</a></li>
+              <li><a href="http://lucene.apache.org/openrelevance/">Open Relevance</a></li>
+            </ul>
+        </div> <!-- lucy-left_nav_box -->
+
+        <div id="lucy-main_content_box" class="grid_9">
+          <div>
+<a name='___top' class='dummyTopAnchor' ></a>
+
+<h1><a class='u' href='#___top' title='click to go to top of document'
+name="NAME"
+>NAME</a></h1>
+
+<p>Lucy::Index::DataWriter - Write data to an index.</p>
+
+<h1><a class='u' href='#___top' title='click to go to top of document'
+name="SYNOPSIS"
+>SYNOPSIS</a></h1>
+
+<pre>    # Abstract base class.</pre>
+
+<h1><a class='u' href='#___top' title='click to go to top of document'
+name="DESCRIPTION"
+>DESCRIPTION</a></h1>
+
+<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'
+name="CONSTRUCTORS"
+>CONSTRUCTORS</a></h1>
+
+<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>
+
+<pre>    my $writer = MyDataWriter-&#62;new(
+        snapshot   =&#62; $snapshot,      # required
+        segment    =&#62; $segment,       # required
+        polyreader =&#62; $polyreader,    # required
+    );</pre>
+
+<ul>
+<li><b>snapshot</b> - The Snapshot that will be committed at the end of the indexing session.</li>
+
+<li><b>segment</b> - The Segment in progress.</li>
+
+<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'
+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>
+
+<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>
+
+<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>
+
+<h2><a class='u' href='#___top' title='click to go to top of document'
+name="finish()"
+>finish()</a></h2>
+
+<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>
+
+<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'
+name="METHODS"
+>METHODS</a></h1>
+
+<h2><a class='u' href='#___top' title='click to go to top of document'
+name="delete_segment(reader)"
+>delete_segment(reader)</a></h2>
+
+<p>Remove a segment&#39;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>
+
+<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>
+
+<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>
+
+<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>
+
+<p>Arbitrary metadata to be serialized and stored by the Segment. The default implementation supplies a Hash with a single key-value pair for &#34;format&#34;.</p>
+
+<h2><a class='u' href='#___top' title='click to go to top of document'
+name="get_snapshot()"
+>get_snapshot()</a></h2>
+
+<p>Accessor for &#34;snapshot&#34; member var.</p>
+
+<h2><a class='u' href='#___top' title='click to go to top of document'
+name="get_segment()"
+>get_segment()</a></h2>
+
+<p>Accessor for &#34;segment&#34; member var.</p>
+
+<h2><a class='u' href='#___top' title='click to go to top of document'
+name="get_polyreader()"
+>get_polyreader()</a></h2>
+
+<p>Accessor for &#34;polyreader&#34; member var.</p>
+
+<h2><a class='u' href='#___top' title='click to go to top of document'
+name="get_schema()"
+>get_schema()</a></h2>
+
+<p>Accessor for &#34;schema&#34; member var.</p>
+
+<h2><a class='u' href='#___top' title='click to go to top of document'
+name="get_folder()"
+>get_folder()</a></h2>
+
+<p>Accessor for &#34;folder&#34; member var.</p>
+
+<h1><a class='u' href='#___top' title='click to go to top of document'
+name="INHERITANCE"
+>INHERITANCE</a></h1>
+
+<p>Lucy::Index::DataWriter isa Clownfish::Obj.</p>
+
+</div>
+
+        </div> <!-- lucy-main_content_box --> 
+        <div class="clear"></div>
+
+      </div> <!-- lucy-main_content -->
+
+      <div id="lucy-copyright" class="container_16">
+        <p>Copyright &#169; 2010-2012 The Apache Software Foundation, Licensed under the 
+           <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+           <br/>
+           Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The
+           Apache Software Foundation.  All other marks mentioned may be trademarks or registered trademarks of their
+           respective owners.
+        </p>
+      </div> <!-- lucy-copyright -->
+
+    </div> <!-- lucy-rigid_wrapper -->
+
+  </body>
+</html>

Added: websites/staging/lucy/trunk/content/docs/test/Lucy/Index/DeletionsWriter.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Index/DeletionsWriter.html (added)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Index/DeletionsWriter.html Sun Jun 30 17:43:05 2013
@@ -0,0 +1,170 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+    <title>Lucy::Index::DeletionsWriter - Apache Lucy Documentation</title>
+    <link rel="stylesheet" type="text/css" media="screen" href="http://lucy.apache.org/css/lucy.css">
+  </head>
+
+  <body>
+
+    <div id="lucy-rigid_wrapper">
+
+      <div id="lucy-top" class="container_16 lucy-white_box_3d">
+
+        <div id="lucy-logo_box" class="grid_8">
+          <a href="/"><img src="http://lucy.apache.org/images/lucy_logo_150x100.png" alt="Apache Lucy™"></a>
+        </div> <!-- lucy-logo_box -->
+
+        <div #id="lucy-top_nav_box" class="grid_8">
+          <div id="lucy-top_nav_bar" class="container_8">
+            <ul>
+              <li><a href="http://www.apache.org/" title="Apache Software Foundation">Apache Software Foundation</a></li>
+              <li><a href="http://www.apache.org/licenses/" title="License">License</a></li>
+              <li><a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsorship">Sponsorship</a></li>
+              <li><a href="http://www.apache.org/foundation/thanks.html" title="Thanks">Thanks</a></li>
+              <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li>
+            </ul>
+          </div> <!-- lucy-top_nav_bar -->
+          <p><a href="http://www.apache.org/">Apache</a>&nbsp;&raquo&nbsp;<a href="/">Lucy</a>&nbsp;&raquo&nbsp;<a href="/docs/">Docs</a>&nbsp;&raquo&nbsp;<a href="/docs/test/">Test</a>&nbsp;&raquo&nbsp;<a href="/docs/test/Lucy/">Lucy</a>&nbsp;&raquo&nbsp;<a href="/docs/test/Lucy/Index/">Index</a></p>
+          <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search" method="get">
+            <input value="*.apache.org" name="sitesearch" type="hidden"/>
+            <input type="text" name="q" id="query" style="width:85%">
+            <input type="submit" id="submit" value="Search">
+          </form>
+        </div> <!-- lucy-top_nav_box -->
+
+        <div class="clear"></div>
+
+      </div> <!-- lucy-top -->
+
+      <div id="lucy-main_content" class="container_16 lucy-white_box_3d">
+
+        <div class="grid_4" id="lucy-left_nav_box">
+          <h6>About</h6>
+            <ul>
+              <li><a href="/">Welcome</a></li>
+              <li><a href="/faq.html">FAQ</a></li>
+              <li><a href="/people.html">People</a></li>
+            </ul>
+          <h6>Resources</h6>
+            <ul>
+              <li><a href="/download.html">Download</a></li>
+              <li><a href="/mailing_lists.html">Mailing Lists</a></li>
+              <li><a href="/docs/perl/">Documentation</a></li>
+              <li><a href="http://wiki.apache.org/lucy/">Wiki</a></li>
+              <li><a href="https://issues.apache.org/jira/browse/LUCY">Issue Tracker</a></li>
+              <li><a href="/version_control.html">Version Control</a></li>
+            </ul>
+          <h6>Related Projects</h6>
+            <ul>
+              <li><a href="http://lucene.apache.org/java/">Lucene</a></li>
+              <li><a href="http://lucene.apache.org/solr/">Solr</a></li>
+              <li><a href="http://incubator.apache.org/lucene.net/">Lucene.NET</a></li>
+              <li><a href="http://lucene.apache.org/pylucene/">PyLucene</a></li>
+              <li><a href="http://lucene.apache.org/openrelevance/">Open Relevance</a></li>
+            </ul>
+        </div> <!-- lucy-left_nav_box -->
+
+        <div id="lucy-main_content_box" class="grid_9">
+          <div>
+<a name='___top' class='dummyTopAnchor' ></a>
+
+<h1><a class='u' href='#___top' title='click to go to top of document'
+name="NAME"
+>NAME</a></h1>
+
+<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'
+name="SYNOPSIS"
+>SYNOPSIS</a></h1>
+
+<pre>    my $polyreader  = $del_writer-&#62;get_polyreader;
+    my $seg_readers = $polyreader-&#62;seg_readers;
+    for my $seg_reader (@$seg_readers) {
+        my $count = $del_writer-&#62;seg_del_count( $seg_reader-&#62;get_seg_name );
+        ...
+    }</pre>
+
+<h1><a class='u' href='#___top' title='click to go to top of document'
+name="DESCRIPTION"
+>DESCRIPTION</a></h1>
+
+<p>Subclasses of DeletionsWriter provide a low-level mechanism for declaring a document deleted from an index.</p>
+
+<p>Because files in an index are never modified, and because it is not practical to delete entire segments, a DeletionsWriter does not actually remove documents from the index. Instead, it communicates to a search-time companion DeletionsReader which documents are deleted in such a way that it can create a Matcher iterator.</p>
+
+<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'
+name="ABSTRACT_METHODS"
+>ABSTRACT METHODS</a></h1>
+
+<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>
+
+<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&#39;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&#39;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>
+
+<p>Delete all documents in the index that match <code>query</code>.</p>
+
+<ul>
+<li><b>query</b> - A <a href="../../Lucy/Search/Query.html" class="podlinkpod"
+>Query</a>.</li>
+</ul>
+
+<h2><a class='u' href='#___top' title='click to go to top of document'
+name="updated()"
+>updated()</a></h2>
+
+<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>
+
+<p>Return the number of deletions for a given segment.</p>
+
+<ul>
+<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'
+name="INHERITANCE"
+>INHERITANCE</a></h1>
+
+<p>Lucy::Index::DeletionsWriter isa <a href="../../Lucy/Index/DataWriter.html" class="podlinkpod"
+>Lucy::Index::DataWriter</a> isa Clownfish::Obj.</p>
+
+</div>
+
+        </div> <!-- lucy-main_content_box --> 
+        <div class="clear"></div>
+
+      </div> <!-- lucy-main_content -->
+
+      <div id="lucy-copyright" class="container_16">
+        <p>Copyright &#169; 2010-2012 The Apache Software Foundation, Licensed under the 
+           <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+           <br/>
+           Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The
+           Apache Software Foundation.  All other marks mentioned may be trademarks or registered trademarks of their
+           respective owners.
+        </p>
+      </div> <!-- lucy-copyright -->
+
+    </div> <!-- lucy-rigid_wrapper -->
+
+  </body>
+</html>

Added: websites/staging/lucy/trunk/content/docs/test/Lucy/Index/DocReader.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Index/DocReader.html (added)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Index/DocReader.html Sun Jun 30 17:43:05 2013
@@ -0,0 +1,148 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+    <title>Lucy::Index::DocReader - Apache Lucy Documentation</title>
+    <link rel="stylesheet" type="text/css" media="screen" href="http://lucy.apache.org/css/lucy.css">
+  </head>
+
+  <body>
+
+    <div id="lucy-rigid_wrapper">
+
+      <div id="lucy-top" class="container_16 lucy-white_box_3d">
+
+        <div id="lucy-logo_box" class="grid_8">
+          <a href="/"><img src="http://lucy.apache.org/images/lucy_logo_150x100.png" alt="Apache Lucy™"></a>
+        </div> <!-- lucy-logo_box -->
+
+        <div #id="lucy-top_nav_box" class="grid_8">
+          <div id="lucy-top_nav_bar" class="container_8">
+            <ul>
+              <li><a href="http://www.apache.org/" title="Apache Software Foundation">Apache Software Foundation</a></li>
+              <li><a href="http://www.apache.org/licenses/" title="License">License</a></li>
+              <li><a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsorship">Sponsorship</a></li>
+              <li><a href="http://www.apache.org/foundation/thanks.html" title="Thanks">Thanks</a></li>
+              <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li>
+            </ul>
+          </div> <!-- lucy-top_nav_bar -->
+          <p><a href="http://www.apache.org/">Apache</a>&nbsp;&raquo&nbsp;<a href="/">Lucy</a>&nbsp;&raquo&nbsp;<a href="/docs/">Docs</a>&nbsp;&raquo&nbsp;<a href="/docs/test/">Test</a>&nbsp;&raquo&nbsp;<a href="/docs/test/Lucy/">Lucy</a>&nbsp;&raquo&nbsp;<a href="/docs/test/Lucy/Index/">Index</a></p>
+          <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search" method="get">
+            <input value="*.apache.org" name="sitesearch" type="hidden"/>
+            <input type="text" name="q" id="query" style="width:85%">
+            <input type="submit" id="submit" value="Search">
+          </form>
+        </div> <!-- lucy-top_nav_box -->
+
+        <div class="clear"></div>
+
+      </div> <!-- lucy-top -->
+
+      <div id="lucy-main_content" class="container_16 lucy-white_box_3d">
+
+        <div class="grid_4" id="lucy-left_nav_box">
+          <h6>About</h6>
+            <ul>
+              <li><a href="/">Welcome</a></li>
+              <li><a href="/faq.html">FAQ</a></li>
+              <li><a href="/people.html">People</a></li>
+            </ul>
+          <h6>Resources</h6>
+            <ul>
+              <li><a href="/download.html">Download</a></li>
+              <li><a href="/mailing_lists.html">Mailing Lists</a></li>
+              <li><a href="/docs/perl/">Documentation</a></li>
+              <li><a href="http://wiki.apache.org/lucy/">Wiki</a></li>
+              <li><a href="https://issues.apache.org/jira/browse/LUCY">Issue Tracker</a></li>
+              <li><a href="/version_control.html">Version Control</a></li>
+            </ul>
+          <h6>Related Projects</h6>
+            <ul>
+              <li><a href="http://lucene.apache.org/java/">Lucene</a></li>
+              <li><a href="http://lucene.apache.org/solr/">Solr</a></li>
+              <li><a href="http://incubator.apache.org/lucene.net/">Lucene.NET</a></li>
+              <li><a href="http://lucene.apache.org/pylucene/">PyLucene</a></li>
+              <li><a href="http://lucene.apache.org/openrelevance/">Open Relevance</a></li>
+            </ul>
+        </div> <!-- lucy-left_nav_box -->
+
+        <div id="lucy-main_content_box" class="grid_9">
+          <div>
+<a name='___top' class='dummyTopAnchor' ></a>
+
+<h1><a class='u' href='#___top' title='click to go to top of document'
+name="NAME"
+>NAME</a></h1>
+
+<p>Lucy::Index::DocReader - Retrieve stored documents.</p>
+
+<h1><a class='u' href='#___top' title='click to go to top of document'
+name="SYNOPSIS"
+>SYNOPSIS</a></h1>
+
+<pre>    my $doc_reader = $seg_reader-&#62;obtain(&#34;Lucy::Index::DocReader&#34;);
+    my $doc        = $doc_reader-&#62;fetch_doc($doc_id);</pre>
+
+<h1><a class='u' href='#___top' title='click to go to top of document'
+name="DESCRIPTION"
+>DESCRIPTION</a></h1>
+
+<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'
+name="ABSTRACT_METHODS"
+>ABSTRACT METHODS</a></h1>
+
+<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>
+
+<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'
+name="METHODS"
+>METHODS</a></h1>
+
+<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>
+
+<p>Returns a DocReader which divvies up requests to its sub-readers according to the offset range.</p>
+
+<ul>
+<li><b>readers</b> - An array of DocReaders.</li>
+
+<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'
+name="INHERITANCE"
+>INHERITANCE</a></h1>
+
+<p>Lucy::Index::DocReader isa <a href="../../Lucy/Index/DataReader.html" class="podlinkpod"
+>Lucy::Index::DataReader</a> isa Clownfish::Obj.</p>
+
+</div>
+
+        </div> <!-- lucy-main_content_box --> 
+        <div class="clear"></div>
+
+      </div> <!-- lucy-main_content -->
+
+      <div id="lucy-copyright" class="container_16">
+        <p>Copyright &#169; 2010-2012 The Apache Software Foundation, Licensed under the 
+           <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+           <br/>
+           Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The
+           Apache Software Foundation.  All other marks mentioned may be trademarks or registered trademarks of their
+           respective owners.
+        </p>
+      </div> <!-- lucy-copyright -->
+
+    </div> <!-- lucy-rigid_wrapper -->
+
+  </body>
+</html>

Added: websites/staging/lucy/trunk/content/docs/test/Lucy/Index/IndexManager.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Index/IndexManager.html (added)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Index/IndexManager.html Sun Jun 30 17:43:05 2013
@@ -0,0 +1,225 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+    <title>Lucy::Index::IndexManager - Apache Lucy Documentation</title>
+    <link rel="stylesheet" type="text/css" media="screen" href="http://lucy.apache.org/css/lucy.css">
+  </head>
+
+  <body>
+
+    <div id="lucy-rigid_wrapper">
+
+      <div id="lucy-top" class="container_16 lucy-white_box_3d">
+
+        <div id="lucy-logo_box" class="grid_8">
+          <a href="/"><img src="http://lucy.apache.org/images/lucy_logo_150x100.png" alt="Apache Lucy™"></a>
+        </div> <!-- lucy-logo_box -->
+
+        <div #id="lucy-top_nav_box" class="grid_8">
+          <div id="lucy-top_nav_bar" class="container_8">
+            <ul>
+              <li><a href="http://www.apache.org/" title="Apache Software Foundation">Apache Software Foundation</a></li>
+              <li><a href="http://www.apache.org/licenses/" title="License">License</a></li>
+              <li><a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsorship">Sponsorship</a></li>
+              <li><a href="http://www.apache.org/foundation/thanks.html" title="Thanks">Thanks</a></li>
+              <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li>
+            </ul>
+          </div> <!-- lucy-top_nav_bar -->
+          <p><a href="http://www.apache.org/">Apache</a>&nbsp;&raquo&nbsp;<a href="/">Lucy</a>&nbsp;&raquo&nbsp;<a href="/docs/">Docs</a>&nbsp;&raquo&nbsp;<a href="/docs/test/">Test</a>&nbsp;&raquo&nbsp;<a href="/docs/test/Lucy/">Lucy</a>&nbsp;&raquo&nbsp;<a href="/docs/test/Lucy/Index/">Index</a></p>
+          <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search" method="get">
+            <input value="*.apache.org" name="sitesearch" type="hidden"/>
+            <input type="text" name="q" id="query" style="width:85%">
+            <input type="submit" id="submit" value="Search">
+          </form>
+        </div> <!-- lucy-top_nav_box -->
+
+        <div class="clear"></div>
+
+      </div> <!-- lucy-top -->
+
+      <div id="lucy-main_content" class="container_16 lucy-white_box_3d">
+
+        <div class="grid_4" id="lucy-left_nav_box">
+          <h6>About</h6>
+            <ul>
+              <li><a href="/">Welcome</a></li>
+              <li><a href="/faq.html">FAQ</a></li>
+              <li><a href="/people.html">People</a></li>
+            </ul>
+          <h6>Resources</h6>
+            <ul>
+              <li><a href="/download.html">Download</a></li>
+              <li><a href="/mailing_lists.html">Mailing Lists</a></li>
+              <li><a href="/docs/perl/">Documentation</a></li>
+              <li><a href="http://wiki.apache.org/lucy/">Wiki</a></li>
+              <li><a href="https://issues.apache.org/jira/browse/LUCY">Issue Tracker</a></li>
+              <li><a href="/version_control.html">Version Control</a></li>
+            </ul>
+          <h6>Related Projects</h6>
+            <ul>
+              <li><a href="http://lucene.apache.org/java/">Lucene</a></li>
+              <li><a href="http://lucene.apache.org/solr/">Solr</a></li>
+              <li><a href="http://incubator.apache.org/lucene.net/">Lucene.NET</a></li>
+              <li><a href="http://lucene.apache.org/pylucene/">PyLucene</a></li>
+              <li><a href="http://lucene.apache.org/openrelevance/">Open Relevance</a></li>
+            </ul>
+        </div> <!-- lucy-left_nav_box -->
+
+        <div id="lucy-main_content_box" class="grid_9">
+          <div>
+<a name='___top' class='dummyTopAnchor' ></a>
+
+<h1><a class='u' href='#___top' title='click to go to top of document'
+name="NAME"
+>NAME</a></h1>
+
+<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'
+name="SYNOPSIS"
+>SYNOPSIS</a></h1>
+
+<pre>    use Sys::Hostname qw( hostname );
+    my $hostname = hostname() or die &#34;Can&#39;t get unique hostname&#34;;
+    my $manager = Lucy::Index::IndexManager-&#62;new( 
+        host =&#62; $hostname,
+    );
+
+    # Index time:
+    my $indexer = Lucy::Index::Indexer-&#62;new(
+        index =&#62; &#39;/path/to/index&#39;,
+        manager =&#62; $manager,
+    );
+
+    # Search time:
+    my $reader = Lucy::Index::IndexReader-&#62;open(
+        index   =&#62; &#39;/path/to/index&#39;,
+        manager =&#62; $manager,
+    );
+    my $searcher = Lucy::Search::IndexSearcher-&#62;new( index =&#62; $reader );</pre>
+
+<h1><a class='u' href='#___top' title='click to go to top of document'
+name="DESCRIPTION"
+>DESCRIPTION</a></h1>
+
+<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'
+name="CONSTRUCTORS"
+>CONSTRUCTORS</a></h1>
+
+<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>
+
+<pre>    my $manager = Lucy::Index::IndexManager-&#62;new(
+        host =&#62; $hostname,    # default: &#34;&#34;
+    );</pre>
+
+<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'
+name="METHODS"
+>METHODS</a></h1>
+
+<h2><a class='u' href='#___top' title='click to go to top of document'
+name="make_write_lock()"
+>make_write_lock()</a></h2>
+
+<p>Create the Lock which controls access to modifying the logical content of the index.</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>
+
+<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>
+
+<ul>
+<li><b>reader</b> - A PolyReader.</li>
+
+<li><b>del_writer</b> - A DeletionsWriter.</li>
+
+<li><b>cutoff</b> - A segment number which all returned SegReaders must exceed.</li>
+
+<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>
+
+<p>Getter for <code>folder</code> member.</p>
+
+<h2><a class='u' href='#___top' title='click to go to top of document'
+name="get_host()"
+>get_host()</a></h2>
+
+<p>Getter for <code>host</code> member.</p>
+
+<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>
+
+<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>
+
+<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>
+
+<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>
+
+<p>Getter for write lock retry interval.</p>
+
+<h1><a class='u' href='#___top' title='click to go to top of document'
+name="INHERITANCE"
+>INHERITANCE</a></h1>
+
+<p>Lucy::Index::IndexManager isa Clownfish::Obj.</p>
+
+</div>
+
+        </div> <!-- lucy-main_content_box --> 
+        <div class="clear"></div>
+
+      </div> <!-- lucy-main_content -->
+
+      <div id="lucy-copyright" class="container_16">
+        <p>Copyright &#169; 2010-2012 The Apache Software Foundation, Licensed under the 
+           <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+           <br/>
+           Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The
+           Apache Software Foundation.  All other marks mentioned may be trademarks or registered trademarks of their
+           respective owners.
+        </p>
+      </div> <!-- lucy-copyright -->
+
+    </div> <!-- lucy-rigid_wrapper -->
+
+  </body>
+</html>

Added: websites/staging/lucy/trunk/content/docs/test/Lucy/Index/IndexReader.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Index/IndexReader.html (added)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Index/IndexReader.html Sun Jun 30 17:43:05 2013
@@ -0,0 +1,221 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+    <title>Lucy::Index::IndexReader - Apache Lucy Documentation</title>
+    <link rel="stylesheet" type="text/css" media="screen" href="http://lucy.apache.org/css/lucy.css">
+  </head>
+
+  <body>
+
+    <div id="lucy-rigid_wrapper">
+
+      <div id="lucy-top" class="container_16 lucy-white_box_3d">
+
+        <div id="lucy-logo_box" class="grid_8">
+          <a href="/"><img src="http://lucy.apache.org/images/lucy_logo_150x100.png" alt="Apache Lucy™"></a>
+        </div> <!-- lucy-logo_box -->
+
+        <div #id="lucy-top_nav_box" class="grid_8">
+          <div id="lucy-top_nav_bar" class="container_8">
+            <ul>
+              <li><a href="http://www.apache.org/" title="Apache Software Foundation">Apache Software Foundation</a></li>
+              <li><a href="http://www.apache.org/licenses/" title="License">License</a></li>
+              <li><a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsorship">Sponsorship</a></li>
+              <li><a href="http://www.apache.org/foundation/thanks.html" title="Thanks">Thanks</a></li>
+              <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li>
+            </ul>
+          </div> <!-- lucy-top_nav_bar -->
+          <p><a href="http://www.apache.org/">Apache</a>&nbsp;&raquo&nbsp;<a href="/">Lucy</a>&nbsp;&raquo&nbsp;<a href="/docs/">Docs</a>&nbsp;&raquo&nbsp;<a href="/docs/test/">Test</a>&nbsp;&raquo&nbsp;<a href="/docs/test/Lucy/">Lucy</a>&nbsp;&raquo&nbsp;<a href="/docs/test/Lucy/Index/">Index</a></p>
+          <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search" method="get">
+            <input value="*.apache.org" name="sitesearch" type="hidden"/>
+            <input type="text" name="q" id="query" style="width:85%">
+            <input type="submit" id="submit" value="Search">
+          </form>
+        </div> <!-- lucy-top_nav_box -->
+
+        <div class="clear"></div>
+
+      </div> <!-- lucy-top -->
+
+      <div id="lucy-main_content" class="container_16 lucy-white_box_3d">
+
+        <div class="grid_4" id="lucy-left_nav_box">
+          <h6>About</h6>
+            <ul>
+              <li><a href="/">Welcome</a></li>
+              <li><a href="/faq.html">FAQ</a></li>
+              <li><a href="/people.html">People</a></li>
+            </ul>
+          <h6>Resources</h6>
+            <ul>
+              <li><a href="/download.html">Download</a></li>
+              <li><a href="/mailing_lists.html">Mailing Lists</a></li>
+              <li><a href="/docs/perl/">Documentation</a></li>
+              <li><a href="http://wiki.apache.org/lucy/">Wiki</a></li>
+              <li><a href="https://issues.apache.org/jira/browse/LUCY">Issue Tracker</a></li>
+              <li><a href="/version_control.html">Version Control</a></li>
+            </ul>
+          <h6>Related Projects</h6>
+            <ul>
+              <li><a href="http://lucene.apache.org/java/">Lucene</a></li>
+              <li><a href="http://lucene.apache.org/solr/">Solr</a></li>
+              <li><a href="http://incubator.apache.org/lucene.net/">Lucene.NET</a></li>
+              <li><a href="http://lucene.apache.org/pylucene/">PyLucene</a></li>
+              <li><a href="http://lucene.apache.org/openrelevance/">Open Relevance</a></li>
+            </ul>
+        </div> <!-- lucy-left_nav_box -->
+
+        <div id="lucy-main_content_box" class="grid_9">
+          <div>
+<a name='___top' class='dummyTopAnchor' ></a>
+
+<h1><a class='u' href='#___top' title='click to go to top of document'
+name="NAME"
+>NAME</a></h1>
+
+<p>Lucy::Index::IndexReader - Read from an inverted index.</p>
+
+<h1><a class='u' href='#___top' title='click to go to top of document'
+name="SYNOPSIS"
+>SYNOPSIS</a></h1>
+
+<pre>    my $reader = Lucy::Index::IndexReader-&#62;open(
+        index =&#62; &#39;/path/to/index&#39;,
+    );
+    my $seg_readers = $reader-&#62;seg_readers;
+    for my $seg_reader (@$seg_readers) {
+        my $seg_name = $seg_reader-&#62;get_segment-&#62;get_name;
+        my $num_docs = $seg_reader-&#62;doc_max;
+        print &#34;Segment $seg_name ($num_docs documents):\n&#34;;
+        my $doc_reader = $seg_reader-&#62;obtain(&#34;Lucy::Index::DocReader&#34;);
+        for my $doc_id ( 1 .. $num_docs ) {
+            my $doc = $doc_reader-&#62;fetch_doc($doc_id);
+            print &#34;  $doc_id: $doc-&#62;{title}\n&#34;;
+        }
+    }</pre>
+
+<h1><a class='u' href='#___top' title='click to go to top of document'
+name="DESCRIPTION"
+>DESCRIPTION</a></h1>
+
+<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>
+
+<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>&#39;s sub-components.</p>
+
+<h1><a class='u' href='#___top' title='click to go to top of document'
+name="CONSTRUCTORS"
+>CONSTRUCTORS</a></h1>
+
+<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>
+
+<pre>    my $reader = Lucy::Index::IndexReader-&#62;open(
+        index    =&#62; &#39;/path/to/index&#39;, # required
+        snapshot =&#62; $snapshot,
+        manager  =&#62; $index_manager,
+    );</pre>
+
+<p>IndexReader is an abstract base class; open() returns the IndexReader subclass PolyReader, which channels the output of 0 or more SegReaders.</p>
+
+<ul>
+<li><b>index</b> - Either a string filepath or a Folder.</li>
+
+<li><b>snapshot</b> - A Snapshot. If not supplied, the most recent snapshot file will be used.</li>
+
+<li><b>manager</b> - An <a href="../../Lucy/Index/IndexManager.html" class="podlinkpod"
+>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'
+name="ABSTRACT_METHODS"
+>ABSTRACT METHODS</a></h1>
+
+<h2><a class='u' href='#___top' title='click to go to top of document'
+name="doc_max()"
+>doc_max()</a></h2>
+
+<p>Return the maximum number of 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>
+
+<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>
+
+<p>Return the number of documents which have been marked as deleted but not yet purged from the index.</p>
+
+<h2><a class='u' href='#___top' title='click to go to top of document'
+name="seg_readers()"
+>seg_readers()</a></h2>
+
+<p>Return an array of all the SegReaders represented within the IndexReader.</p>
+
+<h2><a class='u' href='#___top' title='click to go to top of document'
+name="offsets()"
+>offsets()</a></h2>
+
+<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'
+name="METHODS"
+>METHODS</a></h1>
+
+<h2><a class='u' href='#___top' title='click to go to top of document'
+name="fetch(api)"
+>fetch(api)</a></h2>
+
+<p>Fetch a component, or return undef if the component can&#39;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>
+
+<p>Fetch a component, or throw an error if the component can&#39;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'
+name="INHERITANCE"
+>INHERITANCE</a></h1>
+
+<p>Lucy::Index::IndexReader isa <a href="../../Lucy/Index/DataReader.html" class="podlinkpod"
+>Lucy::Index::DataReader</a> isa Clownfish::Obj.</p>
+
+</div>
+
+        </div> <!-- lucy-main_content_box --> 
+        <div class="clear"></div>
+
+      </div> <!-- lucy-main_content -->
+
+      <div id="lucy-copyright" class="container_16">
+        <p>Copyright &#169; 2010-2012 The Apache Software Foundation, Licensed under the 
+           <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+           <br/>
+           Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The
+           Apache Software Foundation.  All other marks mentioned may be trademarks or registered trademarks of their
+           respective owners.
+        </p>
+      </div> <!-- lucy-copyright -->
+
+    </div> <!-- lucy-rigid_wrapper -->
+
+  </body>
+</html>

Added: websites/staging/lucy/trunk/content/docs/test/Lucy/Index/Indexer.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/test/Lucy/Index/Indexer.html (added)
+++ websites/staging/lucy/trunk/content/docs/test/Lucy/Index/Indexer.html Sun Jun 30 17:43:05 2013
@@ -0,0 +1,264 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+    <title>Lucy::Index::Indexer - Apache Lucy Documentation</title>
+    <link rel="stylesheet" type="text/css" media="screen" href="http://lucy.apache.org/css/lucy.css">
+  </head>
+
+  <body>
+
+    <div id="lucy-rigid_wrapper">
+
+      <div id="lucy-top" class="container_16 lucy-white_box_3d">
+
+        <div id="lucy-logo_box" class="grid_8">
+          <a href="/"><img src="http://lucy.apache.org/images/lucy_logo_150x100.png" alt="Apache Lucy™"></a>
+        </div> <!-- lucy-logo_box -->
+
+        <div #id="lucy-top_nav_box" class="grid_8">
+          <div id="lucy-top_nav_bar" class="container_8">
+            <ul>
+              <li><a href="http://www.apache.org/" title="Apache Software Foundation">Apache Software Foundation</a></li>
+              <li><a href="http://www.apache.org/licenses/" title="License">License</a></li>
+              <li><a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsorship">Sponsorship</a></li>
+              <li><a href="http://www.apache.org/foundation/thanks.html" title="Thanks">Thanks</a></li>
+              <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li>
+            </ul>
+          </div> <!-- lucy-top_nav_bar -->
+          <p><a href="http://www.apache.org/">Apache</a>&nbsp;&raquo&nbsp;<a href="/">Lucy</a>&nbsp;&raquo&nbsp;<a href="/docs/">Docs</a>&nbsp;&raquo&nbsp;<a href="/docs/test/">Test</a>&nbsp;&raquo&nbsp;<a href="/docs/test/Lucy/">Lucy</a>&nbsp;&raquo&nbsp;<a href="/docs/test/Lucy/Index/">Index</a></p>
+          <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search" method="get">
+            <input value="*.apache.org" name="sitesearch" type="hidden"/>
+            <input type="text" name="q" id="query" style="width:85%">
+            <input type="submit" id="submit" value="Search">
+          </form>
+        </div> <!-- lucy-top_nav_box -->
+
+        <div class="clear"></div>
+
+      </div> <!-- lucy-top -->
+
+      <div id="lucy-main_content" class="container_16 lucy-white_box_3d">
+
+        <div class="grid_4" id="lucy-left_nav_box">
+          <h6>About</h6>
+            <ul>
+              <li><a href="/">Welcome</a></li>
+              <li><a href="/faq.html">FAQ</a></li>
+              <li><a href="/people.html">People</a></li>
+            </ul>
+          <h6>Resources</h6>
+            <ul>
+              <li><a href="/download.html">Download</a></li>
+              <li><a href="/mailing_lists.html">Mailing Lists</a></li>
+              <li><a href="/docs/perl/">Documentation</a></li>
+              <li><a href="http://wiki.apache.org/lucy/">Wiki</a></li>
+              <li><a href="https://issues.apache.org/jira/browse/LUCY">Issue Tracker</a></li>
+              <li><a href="/version_control.html">Version Control</a></li>
+            </ul>
+          <h6>Related Projects</h6>
+            <ul>
+              <li><a href="http://lucene.apache.org/java/">Lucene</a></li>
+              <li><a href="http://lucene.apache.org/solr/">Solr</a></li>
+              <li><a href="http://incubator.apache.org/lucene.net/">Lucene.NET</a></li>
+              <li><a href="http://lucene.apache.org/pylucene/">PyLucene</a></li>
+              <li><a href="http://lucene.apache.org/openrelevance/">Open Relevance</a></li>
+            </ul>
+        </div> <!-- lucy-left_nav_box -->
+
+        <div id="lucy-main_content_box" class="grid_9">
+          <div>
+<a name='___top' class='dummyTopAnchor' ></a>
+
+<h1><a class='u' href='#___top' title='click to go to top of document'
+name="NAME"
+>NAME</a></h1>
+
+<p>Lucy::Index::Indexer - Build inverted indexes.</p>
+
+<h1><a class='u' href='#___top' title='click to go to top of document'
+name="SYNOPSIS"
+>SYNOPSIS</a></h1>
+
+<pre>    my $indexer = Lucy::Index::Indexer-&#62;new(
+        schema =&#62; $schema,
+        index  =&#62; &#39;/path/to/index&#39;,
+        create =&#62; 1,
+    );
+    while ( my ( $title, $content ) = each %source_docs ) {
+        $indexer-&#62;add_doc({
+            title   =&#62; $title,
+            content =&#62; $content,
+        });
+    }
+    $indexer-&#62;commit;</pre>
+
+<h1><a class='u' href='#___top' title='click to go to top of document'
+name="DESCRIPTION"
+>DESCRIPTION</a></h1>
+
+<p>The Indexer class is Apache Lucy&#39;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&#39;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>
+
+<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>
+
+<h1><a class='u' href='#___top' title='click to go to top of document'
+name="CONSTRUCTORS"
+>CONSTRUCTORS</a></h1>
+
+<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>
+
+<pre>    my $indexer = Lucy::Index::Indexer-&#62;new(
+        schema   =&#62; $schema,             # required at index creation
+        index    =&#62; &#39;/path/to/index&#39;,    # required
+        create   =&#62; 1,                   # default: 0
+        truncate =&#62; 1,                   # default: 0
+        manager  =&#62; $manager             # default: created internally
+    );</pre>
+
+<ul>
+<li><b>schema</b> - A Schema. Required when index is being created; if not supplied, will be extracted from the index folder.</li>
+
+<li><b>index</b> - Either a filepath to an index or a Folder.</li>
+
+<li><b>create</b> - If true and the index directory does not exist, attempt to create it.</li>
+
+<li><b>truncate</b> - If true, proceed with the intention of discarding all previous indexing data. The old data will remain intact and visible until commit() succeeds.</li>
+
+<li><b>manager</b> - An IndexManager.</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="add_doc(...)"
+>add_doc(...)</a></h2>
+
+<pre>    $indexer-&#62;add_doc($doc);
+    $indexer-&#62;add_doc( { field_name =&#62; $field_value } );
+    $indexer-&#62;add_doc(
+        doc   =&#62; { field_name =&#62; $field_value },
+        boost =&#62; 2.5,         # default: 1.0
+    );</pre>
+
+<p>Add a document to the index. Accepts either a single argument or labeled params.</p>
+
+<ul>
+<li><b>doc</b> - Either a Lucy::Document::Doc object, or a hashref (which will be attached to a Lucy::Document::Doc object internally).</li>
+
+<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>
+
+<p>Absorb an existing index into this one. The two indexes must have matching Schemas.</p>
+
+<ul>
+<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&#39;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>
+
+<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>
+
+<ul>
+<li><b>field</b> - The name of an indexed field. (If it is not spec&#39;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&#39;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>
+
+<p>Mark documents which match the supplied Query as deleted.</p>
+
+<ul>
+<li><b>query</b> - A <a href="../../Lucy/Search/Query.html" class="podlinkpod"
+>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>
+
+<p>Mark the document identified by the supplied document ID as deleted.</p>
+
+<ul>
+<li><b>doc_id</b> - A <a href="../../Lucy/Docs/DocIDs.html" class="podlinkpod"
+>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>
+
+<p>Accessor for schema.</p>
+
+<h1><a class='u' href='#___top' title='click to go to top of document'
+name="INHERITANCE"
+>INHERITANCE</a></h1>
+
+<p>Lucy::Index::Indexer isa Clownfish::Obj.</p>
+
+</div>
+
+        </div> <!-- lucy-main_content_box --> 
+        <div class="clear"></div>
+
+      </div> <!-- lucy-main_content -->
+
+      <div id="lucy-copyright" class="container_16">
+        <p>Copyright &#169; 2010-2012 The Apache Software Foundation, Licensed under the 
+           <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+           <br/>
+           Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The
+           Apache Software Foundation.  All other marks mentioned may be trademarks or registered trademarks of their
+           respective owners.
+        </p>
+      </div> <!-- lucy-copyright -->
+
+    </div> <!-- lucy-rigid_wrapper -->
+
+  </body>
+</html>