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 [6/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/Store/FSFolder.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Store/FSFolder.mdtext?rev=1732471&r1=1732470&r2=1732471&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Store/FSFolder.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Store/FSFolder.mdtext Fri Feb 26 12:52:25 2016
@@ -3,46 +3,48 @@ Title: Lucy::Store::FSFolder - Apache Lu
<div>
<a name='___top' class='dummyTopAnchor' ></a>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="NAME"
->NAME</a></h1>
+>NAME</a></h2>
<p>Lucy::Store::FSFolder - File System implementation of Folder.</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 $folder = Lucy::Store::FSFolder->new(
path => '/path/to/folder',
);</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>Implementation of <a href="../../Lucy/Store/Folder.html" class="podlinkpod"
->Lucy::Store::Folder</a> using a single file system directory and multiple files.</p>
+>Folder</a> using a single file system directory and multiple files.</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 $folder = Lucy::Store::FSFolder->new(
path => '/path/to/folder',
);</pre>
+<p>Create a new Folder.</p>
+
<ul>
-<li><b>path</b> - Location of the index. If the specified directory does not exist already, it will NOT be created, in order to prevent misconfigured read applications from spawning bogus files -- so it may be necessary to create the directory yourself.</li>
+<li><b>path</b> - Location of the index. If the specified directory does not exist already, it will NOT be created, in order to prevent misconfigured read applications from spawning bogus files – so it may be necessary to create the directory yourself.</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::Store::FSFolder isa <a href="../../Lucy/Store/Folder.html" class="podlinkpod"
>Lucy::Store::Folder</a> isa Clownfish::Obj.</p>
Modified: lucy/site/trunk/content/docs/test/Lucy/Store/Folder.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Store/Folder.mdtext?rev=1732471&r1=1732470&r2=1732471&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Store/Folder.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Store/Folder.mdtext Fri Feb 26 12:52:25 2016
@@ -3,30 +3,30 @@ Title: Lucy::Store::Folder - Apache Lucy
<div>
<a name='___top' class='dummyTopAnchor' ></a>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="NAME"
->NAME</a></h1>
+>NAME</a></h2>
<p>Lucy::Store::Folder - Abstract class representing a directory.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="SYNOPSIS"
->SYNOPSIS</a></h1>
+>SYNOPSIS</a></h2>
<pre> # Abstract base class.</pre>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="DESCRIPTION"
->DESCRIPTION</a></h1>
+>DESCRIPTION</a></h2>
-<p>A "file" within a Folder might be a real file on disk -- or it might be a RAM buffer. Similarly, delete() might delete a file from the file system, or a key-value pair from a hash, or something else.</p>
+<p>A “file” within a Folder might be a real file on disk – or it might be a RAM buffer. Similarly, Delete() might delete a file from the file system, or a key-value pair from a hash, or something else.</p>
<p>The archetypal implementation of Folder, <a href="../../Lucy/Store/FSFolder.html" class="podlinkpod"
>FSFolder</a>, represents a directory on the file system holding a collection of files.</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::Store::Folder isa Clownfish::Obj.</p>
Modified: lucy/site/trunk/content/docs/test/Lucy/Store/Lock.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Store/Lock.mdtext?rev=1732471&r1=1732470&r2=1732471&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Store/Lock.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Store/Lock.mdtext Fri Feb 26 12:52:25 2016
@@ -3,15 +3,15 @@ Title: Lucy::Store::Lock - Apache Lucy D
<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::Store::Lock - Abstract class representing an interprocess mutex lock.</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 $lock = $lock_factory->make_lock(
name => 'write',
@@ -21,21 +21,21 @@ name="SYNOPSIS"
do_stuff();
$lock->release;</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 Lock class produces an interprocess mutex lock. The default subclass uses dot-lock files, but alternative implementations are possible.</p>
-<p>Each lock must have a name which is unique per resource to be locked. Each lock also has a "host" id which should be unique per machine; it is used to help clear away stale locks.</p>
+<p>Each lock must have a name which is unique per resource to be locked. Each lock also has a “host” id which should be unique per machine; it is used to help clear away stale locks.</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 $lock = Lucy::Store::Lock->new(
name => 'commit', # required
@@ -54,60 +54,87 @@ name="new(_[labeled_params]_)"
<li><b>host</b> - A unique per-machine identifier.</li>
-<li><b>timeout</b> - Time in milliseconds to keep retrying before abandoning the attempt to obtain() a lock.</li>
+<li><b>timeout</b> - Time in milliseconds to keep retrying before abandoning the attempt to <a href="#obtain" class="podlinkpod"
+>obtain()</a> a lock.</li>
<li><b>interval</b> - Time in milliseconds between retries.</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="request()"
->request()</a></h2>
+<h3><a class='u'
+name="shared"
+>shared</a></h3>
-<p>Make one attempt to acquire the lock.</p>
+<pre> my $retval = $lock->shared();</pre>
+
+<p>Returns true if the Lock is shared, false if the Lock is exclusive.</p>
+
+<h3><a class='u'
+name="request"
+>request</a></h3>
+
+<pre> my $retval = $lock->request();</pre>
-<p>The semantics of request() differ depending on whether shared() returns true. If the Lock is shared(), then request() should not fail if another lock is held against the resource identified by <code>name</code> (though it might fail for other reasons). If it is not shared() -- i.e. it's an exclusive (write) lock -- then other locks should cause request() to fail.</p>
+<p>Make one attempt to acquire the lock.</p>
-<p>Returns: true on success, false on failure (sets Clownfish->error).</p>
+<p>The semantics of <a href="#request" class="podlinkpod"
+>request()</a> differ depending on whether <a href="#shared" class="podlinkpod"
+>shared()</a> returns true. If the Lock is <a href="#shared" class="podlinkpod"
+>shared()</a>, then <a href="#request" class="podlinkpod"
+>request()</a> should not fail if another lock is held against the resource identified by <code>name</code> (though it might fail for other reasons). If it is not <a href="#shared" class="podlinkpod"
+>shared()</a> – i.e. it’s an exclusive (write) lock – then other locks should cause <a href="#request" class="podlinkpod"
+>request()</a> to fail.</p>
+
+<p>Returns: true on success, false on failure (sets the global error object returned by Clownfish->error).</p>
+
+<h3><a class='u'
+name="release"
+>release</a></h3>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="release()"
->release()</a></h2>
+<pre> $lock->release();</pre>
<p>Release the lock.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="is_locked()"
->is_locked()</a></h2>
+<h3><a class='u'
+name="is_locked"
+>is_locked</a></h3>
+
+<pre> my $retval = $lock->is_locked();</pre>
-<p>Indicate whether the resource identified by this lock's name is currently locked.</p>
+<p>Indicate whether the resource identified by this lock’s name is currently locked.</p>
<p>Returns: true if the resource is locked, false otherwise.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="clear_stale()"
->clear_stale()</a></h2>
+<h3><a class='u'
+name="clear_stale"
+>clear_stale</a></h3>
+
+<pre> $lock->clear_stale();</pre>
<p>Release all locks that meet the following three conditions: the lock name matches, the host id matches, and the process id that the lock was created under no longer identifies an active process.</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="obtain"
+>obtain</a></h3>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="obtain()"
->obtain()</a></h2>
+<pre> my $retval = $lock->obtain();</pre>
-<p>Call request() once per <code>interval</code> until request() returns success or the <code>timeout</code> has been reached.</p>
+<p>Call <a href="#request" class="podlinkpod"
+>request()</a> once per <code>interval</code> until <a href="#request" class="podlinkpod"
+>request()</a> returns success or the <code>timeout</code> has been reached.</p>
-<p>Returns: true on success, false on failure (sets Clownfish->error).</p>
+<p>Returns: true on success, false on failure (sets the global error object returned by Clownfish->error).</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="INHERITANCE"
->INHERITANCE</a></h1>
+>INHERITANCE</a></h2>
<p>Lucy::Store::Lock isa Clownfish::Obj.</p>
Modified: lucy/site/trunk/content/docs/test/Lucy/Store/LockErr.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Store/LockErr.mdtext?rev=1732471&r1=1732470&r2=1732471&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Store/LockErr.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Store/LockErr.mdtext Fri Feb 26 12:52:25 2016
@@ -3,15 +3,15 @@ Title: Lucy::Store::LockErr - 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::Store::LockErr - Lock exception.</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> while (1) {
my $bg_merger = eval {
@@ -27,16 +27,16 @@ 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>LockErr is a subclass of <a href="../../Clownfish/Err.html" class="podlinkpod"
>Err</a> which indicates that a file locking problem occurred.</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::Store::LockErr isa Clownfish::Err isa Clownfish::Obj.</p>
Modified: lucy/site/trunk/content/docs/test/Lucy/Store/LockFactory.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Store/LockFactory.mdtext?rev=1732471&r1=1732470&r2=1732471&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Store/LockFactory.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Store/LockFactory.mdtext Fri Feb 26 12:52:25 2016
@@ -3,15 +3,15 @@ Title: Lucy::Store::LockFactory - 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::Store::LockFactory - Create Locks.</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";
@@ -28,67 +28,86 @@ name="SYNOPSIS"
interval => 100,
);</pre>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="DESCRIPTION"
->DESCRIPTION</a></h1>
+>DESCRIPTION</a></h2>
<p>LockFactory is used to spin off interprocess mutex locks used by various index reading and writing components. The default implementation uses lockfiles, but LockFactory subclasses which are implemented using alternatives such as flock() are possible.</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 $lock_factory = Lucy::Store::LockFactory->new(
folder => $folder, # required
host => $hostname, # required
);</pre>
+<p>Create a new LockFactory.</p>
+
<ul>
<li><b>folder</b> - A <a href="../../Lucy/Store/Folder.html" class="podlinkpod"
->Lucy::Store::Folder</a>.</li>
+>Folder</a>.</li>
<li><b>host</b> - An identifier which should be unique per-machine.</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_lock(_[labeled_params]_)"
->make_lock( <i>[labeled params]</i> )</a></h2>
+<h3><a class='u'
+name="make_lock"
+>make_lock</a></h3>
+
+<pre> my $retval = $lock_factory->make_lock(
+ name => $name # required
+ timeout => $timeout # default: 0
+ interval => $interval # default: 100
+ );</pre>
-<p>Return a Lock object, which, once obtain() returns successfully, maintains an exclusive lock on a resource.</p>
+<p>Return a Lock object, which, once <a href="../../Lucy/Store/Lock.html#obtain" class="podlinkpod"
+>obtain()</a> returns successfully, maintains an exclusive lock on a resource.</p>
<ul>
<li><b>name</b> - A file-system-friendly id which identifies the resource to be locked.</li>
-<li><b>timeout</b> - Time in milliseconds to keep retrying before abandoning the attempt to obtain() a lock.</li>
+<li><b>timeout</b> - Time in milliseconds to keep retrying before abandoning the attempt to <a href="../../Lucy/Store/Lock.html#obtain" class="podlinkpod"
+>obtain()</a> a lock.</li>
<li><b>interval</b> - Time in milliseconds between retries.</li>
</ul>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="make_shared_lock(_[labeled_params]_)"
->make_shared_lock( <i>[labeled params]</i> )</a></h2>
+<h3><a class='u'
+name="make_shared_lock"
+>make_shared_lock</a></h3>
+
+<pre> my $retval = $lock_factory->make_shared_lock(
+ name => $name # required
+ timeout => $timeout # default: 0
+ interval => $interval # default: 100
+ );</pre>
-<p>Return a Lock object for which shared() returns true, and which maintains a non-exclusive lock on a resource once obtain() returns success.</p>
+<p>Return a Lock object for which <a href="../../Lucy/Store/Lock.html#shared" class="podlinkpod"
+>shared()</a> returns true, and which maintains a non-exclusive lock on a resource once <a href="../../Lucy/Store/Lock.html#obtain" class="podlinkpod"
+>obtain()</a> returns success.</p>
<ul>
<li><b>name</b> - A file-system-friendly id which identifies the resource to be locked.</li>
-<li><b>timeout</b> - Time in milliseconds to keep retrying before abandoning the attempt to obtain() a lock.</li>
+<li><b>timeout</b> - Time in milliseconds to keep retrying before abandoning the attempt to <a href="../../Lucy/Store/Lock.html#obtain" class="podlinkpod"
+>obtain()</a> a lock.</li>
<li><b>interval</b> - Time in milliseconds between retries.</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::Store::LockFactory isa Clownfish::Obj.</p>
Modified: lucy/site/trunk/content/docs/test/Lucy/Store/RAMFolder.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/Lucy/Store/RAMFolder.mdtext?rev=1732471&r1=1732470&r2=1732471&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/Lucy/Store/RAMFolder.mdtext (original)
+++ lucy/site/trunk/content/docs/test/Lucy/Store/RAMFolder.mdtext Fri Feb 26 12:52:25 2016
@@ -3,15 +3,15 @@ Title: Lucy::Store::RAMFolder - 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::Store::RAMFolder - In-memory Folder implementation.</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 $folder = Lucy::Store::RAMFolder->new;
@@ -20,32 +20,34 @@ name="SYNOPSIS"
path => $relative_path,
);</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>RAMFolder is an entirely in-memory implementation of <a href="../../Lucy/Store/Folder.html" class="podlinkpod"
->Lucy::Store::Folder</a>, primarily used for testing and development.</p>
+>Folder</a>, primarily used for testing and development.</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 $folder = Lucy::Store::RAMFolder->new(
path => $relative_path, # default: empty string
);</pre>
+<p>Create a new RAMFolder.</p>
+
<ul>
<li><b>path</b> - Relative path, used for subfolders.</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::Store::RAMFolder isa <a href="../../Lucy/Store/Folder.html" class="podlinkpod"
>Lucy::Store::Folder</a> isa Clownfish::Obj.</p>
Modified: lucy/site/trunk/content/docs/test/LucyX/Index/ByteBufDocReader.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/LucyX/Index/ByteBufDocReader.mdtext?rev=1732471&r1=1732470&r2=1732471&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/LucyX/Index/ByteBufDocReader.mdtext (original)
+++ lucy/site/trunk/content/docs/test/LucyX/Index/ByteBufDocReader.mdtext Fri Feb 26 12:52:25 2016
@@ -3,21 +3,21 @@ Title: LucyX::Index::ByteBufDocReader -
<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>LucyX::Index::ByteBufDocReader - Read a Doc as a fixed-width byte array.</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> # See LucyX::Index::ByteBufDocWriter</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>This is a proof-of-concept class to demonstrate alternate implementations for fetching documents. It is unsupported.</p>
Modified: lucy/site/trunk/content/docs/test/LucyX/Index/ByteBufDocWriter.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/LucyX/Index/ByteBufDocWriter.mdtext?rev=1732471&r1=1732470&r2=1732471&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/LucyX/Index/ByteBufDocWriter.mdtext (original)
+++ lucy/site/trunk/content/docs/test/LucyX/Index/ByteBufDocWriter.mdtext Fri Feb 26 12:52:25 2016
@@ -3,15 +3,15 @@ Title: LucyX::Index::ByteBufDocWriter -
<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>LucyX::Index::ByteBufDocWriter - Write a Doc as a fixed-width byte array.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="SYNOPSIS"
->SYNOPSIS</a></h1>
+>SYNOPSIS</a></h2>
<p>Create an <a href="../../Lucy/Plan/Architecture.html" class="podlinkpod"
>Architecture</a> subclass which overrides register_doc_writer() and register_doc_reader():</p>
@@ -78,9 +78,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>This is a proof-of-concept class to demonstrate alternate implementations for fetching documents. It is unsupported.</p>
Modified: lucy/site/trunk/content/docs/test/LucyX/Index/LongFieldSim.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/LucyX/Index/LongFieldSim.mdtext?rev=1732471&r1=1732470&r2=1732471&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/LucyX/Index/LongFieldSim.mdtext (original)
+++ lucy/site/trunk/content/docs/test/LucyX/Index/LongFieldSim.mdtext Fri Feb 26 12:52:25 2016
@@ -3,24 +3,24 @@ Title: LucyX::Index::LongFieldSim - 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>LucyX::Index::LongFieldSim - Similarity optimized for long fields.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="SYNOPSIS"
->SYNOPSIS</a></h1>
+>SYNOPSIS</a></h2>
<pre> package MySchema::body;
use base qw( Lucy::Plan::FullTextType );
use LucyX::Index::LongFieldSim;
sub make_similarity { LucyX::Index::LongFieldSim->new }</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>Apache Lucy's default <a href="../../Lucy/Index/Similarity.html" class="podlinkpod"
>Similarity</a> implmentation produces a bias towards extremely short fields.</p>
Modified: lucy/site/trunk/content/docs/test/LucyX/Index/ZlibDocReader.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/LucyX/Index/ZlibDocReader.mdtext?rev=1732471&r1=1732470&r2=1732471&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/LucyX/Index/ZlibDocReader.mdtext (original)
+++ lucy/site/trunk/content/docs/test/LucyX/Index/ZlibDocReader.mdtext Fri Feb 26 12:52:25 2016
@@ -3,15 +3,15 @@ Title: LucyX::Index::ZlibDocReader - Apa
<div>
<a name='___top' class='dummyTopAnchor' ></a>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="NAME"
->NAME</a></h1>
+>NAME</a></h2>
<p>LucyX::Index::ZlibDocReader - Compressed doc storage.</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>This is a proof-of-concept class to demonstrate alternate implementations for fetching documents.
It is unsupported.</p>
Modified: lucy/site/trunk/content/docs/test/LucyX/Index/ZlibDocWriter.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/LucyX/Index/ZlibDocWriter.mdtext?rev=1732471&r1=1732470&r2=1732471&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/LucyX/Index/ZlibDocWriter.mdtext (original)
+++ lucy/site/trunk/content/docs/test/LucyX/Index/ZlibDocWriter.mdtext Fri Feb 26 12:52:25 2016
@@ -3,15 +3,15 @@ Title: LucyX::Index::ZlibDocWriter - Apa
<div>
<a name='___top' class='dummyTopAnchor' ></a>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="NAME"
->NAME</a></h1>
+>NAME</a></h2>
<p>LucyX::Index::ZlibDocWriter - Compressed doc storage.</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>This is a proof-of-concept class to demonstrate alternate implementations for fetching documents.
It is unsupported.</p>
Modified: lucy/site/trunk/content/docs/test/LucyX/Remote/ClusterSearcher.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/LucyX/Remote/ClusterSearcher.mdtext?rev=1732471&r1=1732470&r2=1732471&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/LucyX/Remote/ClusterSearcher.mdtext (original)
+++ lucy/site/trunk/content/docs/test/LucyX/Remote/ClusterSearcher.mdtext Fri Feb 26 12:52:25 2016
@@ -3,15 +3,15 @@ Title: LucyX::Remote::ClusterSearcher -
<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>LucyX::Remote::ClusterSearcher - Search multiple remote 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 $searcher = eval {
LucyX::Remote::ClusterSearcher->new(
@@ -22,21 +22,21 @@ name="SYNOPSIS"
...
my $hits = eval { $searcher->hits( query => $query ) };</pre>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="DESCRIPTION"
->DESCRIPTION</a></h1>
+>DESCRIPTION</a></h2>
<p>ClusterSearcher is a subclass of <a href="../../Lucy/Search/Searcher.html" class="podlinkpod"
>Lucy::Search::Searcher</a> which can be used to search a composite index made up of multiple shards, where each shard is represented by a host:port pair running <a href="../../LucyX/Remote/SearchServer.html" class="podlinkpod"
>LucyX::Remote::SearchServer</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'
+<h3><a class='u'
name="new"
->new</a></h2>
+>new</a></h3>
<p>Constructor. Takes hash-style params.</p>
Modified: lucy/site/trunk/content/docs/test/LucyX/Remote/SearchClient.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/LucyX/Remote/SearchClient.mdtext?rev=1732471&r1=1732470&r2=1732471&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/LucyX/Remote/SearchClient.mdtext (original)
+++ lucy/site/trunk/content/docs/test/LucyX/Remote/SearchClient.mdtext Fri Feb 26 12:52:25 2016
@@ -1,4 +1,4 @@
-Title: - Apache Lucy Documentation
+Title: LucyX::Remote::SearchClient - Apache Lucy Documentation
<div>
<a name='___top' class='dummyTopAnchor' ></a>
@@ -7,4 +7,41 @@ Title: - Apache Lucy Documentation
For every call that does not close/terminate the socket connection,
expect a response back that's been serialized using Storable.</p>
+<h2><a class='u'
+name="NAME"
+>NAME</a></h2>
+
+<p>LucyX::Remote::SearchClient - Connect to a remote SearchServer.</p>
+
+<h2><a class='u'
+name="SYNOPSIS"
+>SYNOPSIS</a></h2>
+
+<pre> my $client = LucyX::Remote::SearchClient->new(
+ peer_address => 'searchserver1:7890',
+ );
+ my $hits = $client->hits( query => $query );</pre>
+
+<h2><a class='u'
+name="DESCRIPTION"
+>DESCRIPTION</a></h2>
+
+<p>SearchClient is a subclass of <a href="../../Lucy/Search/Searcher.html" class="podlinkpod"
+>Lucy::Search::Searcher</a> which can be used to search an index on a remote machine made accessible via <a href="../../LucyX/Remote/SearchServer.html" class="podlinkpod"
+>SearchServer</a>.</p>
+
+<h2><a class='u'
+name="METHODS"
+>METHODS</a></h2>
+
+<h3><a class='u'
+name="new"
+>new</a></h3>
+
+<p>Constructor. Takes hash-style params.</p>
+
+<ul>
+<li><b>peer_address</b> - The name/IP and the port number which the client should attempt to connect to.</li>
+</ul>
+
</div>
Modified: lucy/site/trunk/content/docs/test/LucyX/Remote/SearchServer.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/LucyX/Remote/SearchServer.mdtext?rev=1732471&r1=1732470&r2=1732471&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/LucyX/Remote/SearchServer.mdtext (original)
+++ lucy/site/trunk/content/docs/test/LucyX/Remote/SearchServer.mdtext Fri Feb 26 12:52:25 2016
@@ -3,15 +3,15 @@ Title: LucyX::Remote::SearchServer - Apa
<div>
<a name='___top' class='dummyTopAnchor' ></a>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="NAME"
->NAME</a></h1>
+>NAME</a></h2>
<p>LucyX::Remote::SearchServer - Make a Searcher remotely accessible.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="SYNOPSIS"
->SYNOPSIS</a></h1>
+>SYNOPSIS</a></h2>
<pre> my $searcher = Lucy::Search::IndexSearcher->new(
index => '/path/to/index'
@@ -23,9 +23,9 @@ name="SYNOPSIS"
port => 7890
);</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 SearchServer class, in conjunction with either <a href="../../LucyX/Remote/SearchClient.html" class="podlinkpod"
>SearchClient</a> or <a href="../../LucyX/Remote/ClusterSearcher.html" class="podlinkpod"
@@ -33,13 +33,13 @@ name="DESCRIPTION"
<p>By aggregating several SearchClients under a ClusterSearcher, the cost of searching what might have been a prohibitively large monolithic index can be distributed across multiple nodes, each with its own, smaller index.</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'
+<h3><a class='u'
name="new"
->new</a></h2>
+>new</a></h3>
<pre> my $search_server = LucyX::Remote::SearchServer->new(
searcher => $searcher, # required
@@ -52,9 +52,9 @@ name="new"
>Searcher</a> that the SearchServer will wrap.</li>
</ul>
-<h2><a class='u' href='#___top' title='click to go to top of document'
+<h3><a class='u'
name="serve"
->serve</a></h2>
+>serve</a></h3>
<pre> $search_server->serve(
port => 7890, # required
@@ -66,9 +66,9 @@ name="serve"
<li><b>port</b> - the port on localhost that the server should open and listen on.</li>
</ul>
-<h2><a class='u' href='#___top' title='click to go to top of document'
+<h3><a class='u'
name="serve_rpc"
->serve_rpc</a></h2>
+>serve_rpc</a></h3>
<pre> my $status = $search_server->serve_rpc($sock);</pre>
Modified: lucy/site/trunk/content/docs/test/LucyX/Search/Filter.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/LucyX/Search/Filter.mdtext?rev=1732471&r1=1732470&r2=1732471&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/LucyX/Search/Filter.mdtext (original)
+++ lucy/site/trunk/content/docs/test/LucyX/Search/Filter.mdtext Fri Feb 26 12:52:25 2016
@@ -3,15 +3,15 @@ Title: LucyX::Search::Filter - Apache Lu
<div>
<a name='___top' class='dummyTopAnchor' ></a>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="NAME"
->NAME</a></h1>
+>NAME</a></h2>
<p>LucyX::Search::Filter - Build a caching filter based on results of a Query.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="SYNOPSIS"
->SYNOPSIS</a></h1>
+>SYNOPSIS</a></h2>
<pre> my %category_filters;
for my $category (qw( sweet sour salty bitter )) {
@@ -33,9 +33,9 @@ name="SYNOPSIS"
my $hits = $searcher->hits( query => $and_query );
...</pre>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="DESCRIPTION"
->DESCRIPTION</a></h1>
+>DESCRIPTION</a></h2>
<p>A Filter is a <a href="../../Lucy/Search/Query.html" class="podlinkpod"
>Lucy::Search::Query</a> subclass that can be used to filter the results of another Query. The effect is very similar to simply using the wrapped inner query, but there are two important differences:</p>
@@ -48,13 +48,13 @@ name="DESCRIPTION"
<p>To obtain logically equivalent results to the Filter but avoid the caching, substitute the wrapped query but use set_boost() to set its <code>boost</code> to 0.</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'
+<h3><a class='u'
name="new"
->new</a></h2>
+>new</a></h3>
<pre> my $filter = LucyX::Search::Filter->new(
query => $query;
@@ -63,9 +63,9 @@ name="new"
<p>Constructor. Takes one hash-style parameter, <code>query</code>, which must be an object belonging to a subclass of <a href="../../Lucy/Search/Query.html" class="podlinkpod"
>Lucy::Search::Query</a>.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="BUGS"
->BUGS</a></h1>
+>BUGS</a></h2>
<p>Filters do not cache when used in a search cluster with LucyX::Remote's SearchServer and SearchClient.</p>
Modified: lucy/site/trunk/content/docs/test/LucyX/Search/MockMatcher.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/LucyX/Search/MockMatcher.mdtext?rev=1732471&r1=1732470&r2=1732471&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/LucyX/Search/MockMatcher.mdtext (original)
+++ lucy/site/trunk/content/docs/test/LucyX/Search/MockMatcher.mdtext Fri Feb 26 12:52:25 2016
@@ -3,15 +3,15 @@ Title: LucyX::Search::MockMatcher - 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>LucyX::Search::MockMatcher - Matcher with arbitrary docs and scores.</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>Used for testing combining <a href="../../Lucy/Search/Matcher.html" class="podlinkpod"
>Matchers</a> such as ANDMatcher,
@@ -20,13 +20,13 @@ obviating the need for clever index cons
<p>MockMatcher is a testing and demonstration class; it is unsupported.</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'
+<h3><a class='u'
name="new(_[labeled_params]_)"
->new( [<i>labeled params</i>] )</a></h2>
+>new( [<i>labeled params</i>] )</a></h3>
<ul>
<li><b>doc_ids</b> - A sorted array of <a href="../../Lucy/Docs/DocIDs.html" class="podlinkpod"
Modified: lucy/site/trunk/content/docs/test/LucyX/Search/ProximityQuery.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/LucyX/Search/ProximityQuery.mdtext?rev=1732471&r1=1732470&r2=1732471&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/test/LucyX/Search/ProximityQuery.mdtext (original)
+++ lucy/site/trunk/content/docs/test/LucyX/Search/ProximityQuery.mdtext Fri Feb 26 12:52:25 2016
@@ -3,15 +3,15 @@ Title: LucyX::Search::ProximityQuery - 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>LucyX::Search::ProximityQuery - Query matching an ordered list of terms.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="SYNOPSIS"
->SYNOPSIS</a></h1>
+>SYNOPSIS</a></h2>
<pre> my $proximity_query = LucyX::Search::ProximityQuery->new(
field => 'content',
@@ -20,20 +20,28 @@ name="SYNOPSIS"
);
my $hits = $searcher->hits( query => $proximity_query );</pre>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="DESCRIPTION"
->DESCRIPTION</a></h1>
+>DESCRIPTION</a></h2>
<p>ProximityQuery is a subclass of <a href="../../Lucy/Search/Query.html" class="podlinkpod"
->Lucy::Search::Query</a> for matching against an ordered sequence of terms.</p>
+>Query</a> for matching against an ordered sequence of terms.</p>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="CONSTRUCTORS"
->CONSTRUCTORS</a></h1>
+>CONSTRUCTORS</a></h2>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="new(_[labeled_params]_)"
->new( <i>[labeled params]</i> )</a></h2>
+<h3><a class='u'
+name="new"
+>new</a></h3>
+
+<pre> my $proximity_query = LucyX::Search::ProximityQuery->new(
+ field => $field # required
+ terms => $terms # required
+ within => $within # required
+ );</pre>
+
+<p>Create a new ProximityQuery.</p>
<ul>
<li><b>field</b> - The field that the phrase must occur in.</li>
@@ -41,31 +49,58 @@ name="new(_[labeled_params]_)"
<li><b>terms</b> - The ordered array of terms that must match.</li>
</ul>
-<h1><a class='u' href='#___top' title='click to go to top of document'
+<h2><a class='u'
name="METHODS"
->METHODS</a></h1>
+>METHODS</a></h2>
+
+<h3><a class='u'
+name="get_field"
+>get_field</a></h3>
+
+<pre> my $retval = $proximity_query->get_field();</pre>
+
+<p>Accessor for object’s field attribute.</p>
+
+<h3><a class='u'
+name="get_terms"
+>get_terms</a></h3>
+
+<pre> my $retval = $proximity_query->get_terms();</pre>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_field()"
->get_field()</a></h2>
+<p>Accessor for object’s array of terms.</p>
-<p>Accessor for object's field attribute.</p>
+<h3><a class='u'
+name="get_within"
+>get_within</a></h3>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_terms()"
->get_terms()</a></h2>
+<pre> my $retval = $proximity_query->get_within();</pre>
-<p>Accessor for object's array of terms.</p>
+<p>Accessor for object’s within attribute.</p>
-<h2><a class='u' href='#___top' title='click to go to top of document'
-name="get_within()"
->get_within()</a></h2>
+<h3><a class='u'
+name="make_compiler"
+>make_compiler</a></h3>
-<p>Accessor for object's within attribute.</p>
+<pre> my $retval = $proximity_query->make_compiler(
+ searcher => $searcher # required
+ boost => $boost # required
+ subordinate => $subordinate # default: false
+ );</pre>
+
+<p>Abstract factory method returning a Compiler derived from this Query.</p>
+
+<ul>
+<li><b>searcher</b> - A Searcher.</li>
+
+<li><b>boost</b> - A scoring multiplier.</li>
+
+<li><b>subordinate</b> - Indicates whether the Query is a subquery (as opposed to a top-level query). If false, the implementation must invoke <a href="../../Lucy/Search/Compiler.html#normalize" class="podlinkpod"
+>normalize()</a> on the newly minted Compiler object before returning it.</li>
+</ul>
-<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>LucyX::Search::ProximityQuery isa <a href="../../Lucy/Search/Query.html" class="podlinkpod"
>Lucy::Search::Query</a> isa Clownfish::Obj.</p>
Added: lucy/site/trunk/content/docs/test/index.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/test/index.mdtext?rev=1732471&view=auto
==============================================================================
--- lucy/site/trunk/content/docs/test/index.mdtext (added)
+++ lucy/site/trunk/content/docs/test/index.mdtext Fri Feb 26 12:52:25 2016
@@ -0,0 +1,103 @@
+Title: Perl API documentation for Apache Lucy 0.5.0
+
+## Perl API documentation for Apache Lucy 0.5.0
+
+ - [Lucy](Lucy.html) - Apache Lucy search engine library.
+ - [Lucy::Analysis::Analyzer](Lucy/Analysis/Analyzer.html) - Tokenize/modify/filter text.
+ - [Lucy::Analysis::CaseFolder](Lucy/Analysis/CaseFolder.html) - Normalize case, facilitating case-insensitive search.
+ - [Lucy::Analysis::EasyAnalyzer](Lucy/Analysis/EasyAnalyzer.html) - A simple analyzer chain.
+ - [Lucy::Analysis::Inversion](Lucy/Analysis/Inversion.html) - A collection of Tokens.
+ - [Lucy::Analysis::Normalizer](Lucy/Analysis/Normalizer.html) - Unicode normalization, case folding and accent stripping.
+ - [Lucy::Analysis::PolyAnalyzer](Lucy/Analysis/PolyAnalyzer.html) - Multiple Analyzers in series.
+ - [Lucy::Analysis::RegexTokenizer](Lucy/Analysis/RegexTokenizer.html) - Split a string into tokens.
+ - [Lucy::Analysis::SnowballStemmer](Lucy/Analysis/SnowballStemmer.html) - Reduce related words to a shared root.
+ - [Lucy::Analysis::SnowballStopFilter](Lucy/Analysis/SnowballStopFilter.html) - Suppress a âstoplistâ of common words.
+ - [Lucy::Analysis::StandardTokenizer](Lucy/Analysis/StandardTokenizer.html) - Split a string into tokens.
+ - [Lucy::Analysis::Token](Lucy/Analysis/Token.html) - Unit of text.
+ - [Lucy::Docs::Cookbook](Lucy/Docs/Cookbook.html) - Apache Lucy recipes
+ - [Lucy::Docs::Cookbook::CustomQuery](Lucy/Docs/Cookbook/CustomQuery.html) - Sample subclass of Query
+ - [Lucy::Docs::Cookbook::CustomQueryParser](Lucy/Docs/Cookbook/CustomQueryParser.html) - Sample subclass of QueryParser.
+ - [Lucy::Docs::Cookbook::FastUpdates](Lucy/Docs/Cookbook/FastUpdates.html) - Near real-time index updates
+ - [Lucy::Docs::DevGuide](Lucy/Docs/DevGuide.html) - Quick-start guide to hacking on Apache Lucy.
+ - [Lucy::Docs::DocIDs](Lucy/Docs/DocIDs.html) - Characteristics of Apache Lucy document ids.
+ - [Lucy::Docs::FileFormat](Lucy/Docs/FileFormat.html) - Overview of index file format
+ - [Lucy::Docs::FileLocking](Lucy/Docs/FileLocking.html) - Manage indexes on shared volumes.
+ - [Lucy::Docs::IRTheory](Lucy/Docs/IRTheory.html) - Crash course in information retrieval
+ - [Lucy::Docs::Tutorial](Lucy/Docs/Tutorial.html) - Step-by-step introduction to Apache Lucy.
+ - [Lucy::Docs::Tutorial::AnalysisTutorial](Lucy/Docs/Tutorial/AnalysisTutorial.html) - How to choose and use Analyzers.
+ - [Lucy::Docs::Tutorial::BeyondSimpleTutorial](Lucy/Docs/Tutorial/BeyondSimpleTutorial.html) - A more flexible app structure.
+ - [Lucy::Docs::Tutorial::FieldTypeTutorial](Lucy/Docs/Tutorial/FieldTypeTutorial.html) - Specify per-field properties and behaviors.
+ - [Lucy::Docs::Tutorial::HighlighterTutorial](Lucy/Docs/Tutorial/HighlighterTutorial.html) - Augment search results with highlighted excerpts.
+ - [Lucy::Docs::Tutorial::QueryObjectsTutorial](Lucy/Docs/Tutorial/QueryObjectsTutorial.html) - Use Query objects instead of query strings.
+ - [Lucy::Docs::Tutorial::SimpleTutorial](Lucy/Docs/Tutorial/SimpleTutorial.html) - Bare-bones search app.
+ - [Lucy::Document::Doc](Lucy/Document/Doc.html) - A document.
+ - [Lucy::Document::HitDoc](Lucy/Document/HitDoc.html) - A document read from an index.
+ - [Lucy::Highlight::Highlighter](Lucy/Highlight/Highlighter.html) - Create and highlight excerpts.
+ - [Lucy::Index::BackgroundMerger](Lucy/Index/BackgroundMerger.html) - Consolidate index segments in the background.
+ - [Lucy::Index::DataReader](Lucy/Index/DataReader.html) - Abstract base class for reading index data.
+ - [Lucy::Index::DataWriter](Lucy/Index/DataWriter.html) - Write data to an index.
+ - [Lucy::Index::DeletionsWriter](Lucy/Index/DeletionsWriter.html) - Abstract base class for marking documents as deleted.
+ - [Lucy::Index::DocReader](Lucy/Index/DocReader.html) - Retrieve stored documents.
+ - [Lucy::Index::IndexManager](Lucy/Index/IndexManager.html) - Policies governing index updating, locking, and file deletion.
+ - [Lucy::Index::IndexReader](Lucy/Index/IndexReader.html) - Read from an inverted index.
+ - [Lucy::Index::Indexer](Lucy/Index/Indexer.html) - Build inverted indexes.
+ - [Lucy::Index::Lexicon](Lucy/Index/Lexicon.html) - Iterator for a fieldâs terms.
+ - [Lucy::Index::LexiconReader](Lucy/Index/LexiconReader.html) - Read Lexicon data.
+ - [Lucy::Index::PolyReader](Lucy/Index/PolyReader.html) - Multi-segment implementation of IndexReader.
+ - [Lucy::Index::PostingList](Lucy/Index/PostingList.html) - Term-Document pairings.
+ - [Lucy::Index::PostingListReader](Lucy/Index/PostingListReader.html) - Read postings data.
+ - [Lucy::Index::SegReader](Lucy/Index/SegReader.html) - Single-segment IndexReader.
+ - [Lucy::Index::SegWriter](Lucy/Index/SegWriter.html) - Write one segment of an index.
+ - [Lucy::Index::Segment](Lucy/Index/Segment.html) - Warehouse for information about one segment of an inverted index.
+ - [Lucy::Index::Similarity](Lucy/Index/Similarity.html) - Judge how well a document matches a query.
+ - [Lucy::Index::Snapshot](Lucy/Index/Snapshot.html) - Point-in-time index file list.
+ - [Lucy::Object::BitVector](Lucy/Object/BitVector.html) - An array of bits.
+ - [Lucy::Object::Obj](Lucy/Object/Obj.html) - Moved.
+ - [Lucy::Plan::Architecture](Lucy/Plan/Architecture.html) - Configure major components of an index.
+ - [Lucy::Plan::BlobType](Lucy/Plan/BlobType.html) - Default behaviors for binary fields.
+ - [Lucy::Plan::FieldType](Lucy/Plan/FieldType.html) - Define a fieldâs behavior.
+ - [Lucy::Plan::FullTextType](Lucy/Plan/FullTextType.html) - Full-text search field type.
+ - [Lucy::Plan::Schema](Lucy/Plan/Schema.html) - User-created specification for an inverted index.
+ - [Lucy::Plan::StringType](Lucy/Plan/StringType.html) - Non-tokenized text type.
+ - [Lucy::Search::ANDQuery](Lucy/Search/ANDQuery.html) - Intersect multiple result sets.
+ - [Lucy::Search::Collector](Lucy/Search/Collector.html) - Process hits.
+ - [Lucy::Search::Collector::BitCollector](Lucy/Search/Collector/BitCollector.html) - Collector which records doc nums in a BitVector.
+ - [Lucy::Search::Compiler](Lucy/Search/Compiler.html) - Query-to-Matcher compiler.
+ - [Lucy::Search::Hits](Lucy/Search/Hits.html) - Access search results.
+ - [Lucy::Search::IndexSearcher](Lucy/Search/IndexSearcher.html) - Execute searches against a single index.
+ - [Lucy::Search::LeafQuery](Lucy/Search/LeafQuery.html) - Leaf node in a tree created by QueryParser.
+ - [Lucy::Search::MatchAllQuery](Lucy/Search/MatchAllQuery.html) - Query which matches all documents.
+ - [Lucy::Search::Matcher](Lucy/Search/Matcher.html) - Match a set of document ids.
+ - [Lucy::Search::NOTQuery](Lucy/Search/NOTQuery.html) - Invert the result set of another Query.
+ - [Lucy::Search::NoMatchQuery](Lucy/Search/NoMatchQuery.html) - Query which matches no documents.
+ - [Lucy::Search::ORQuery](Lucy/Search/ORQuery.html) - Union multiple result sets.
+ - [Lucy::Search::PhraseQuery](Lucy/Search/PhraseQuery.html) - Query matching an ordered list of terms.
+ - [Lucy::Search::PolyQuery](Lucy/Search/PolyQuery.html) - Base class for composite Query objects.
+ - [Lucy::Search::PolySearcher](Lucy/Search/PolySearcher.html) - Aggregate results from multiple Searchers.
+ - [Lucy::Search::Query](Lucy/Search/Query.html) - A specification for a search query.
+ - [Lucy::Search::QueryParser](Lucy/Search/QueryParser.html) - Transform a string into a Query object.
+ - [Lucy::Search::RangeQuery](Lucy/Search/RangeQuery.html) - Match a range of values.
+ - [Lucy::Search::RequiredOptionalQuery](Lucy/Search/RequiredOptionalQuery.html) - Join results for two Queries, one required, one optional.
+ - [Lucy::Search::Searcher](Lucy/Search/Searcher.html) - Base class for searching collections of documents.
+ - [Lucy::Search::SortRule](Lucy/Search/SortRule.html) - Element of a SortSpec.
+ - [Lucy::Search::SortSpec](Lucy/Search/SortSpec.html) - Specify a custom sort order for search results.
+ - [Lucy::Search::Span](Lucy/Search/Span.html) - An offset, a length, and a weight.
+ - [Lucy::Search::TermQuery](Lucy/Search/TermQuery.html) - Query which matches individual terms.
+ - [Lucy::Simple](Lucy/Simple.html) - Basic search engine.
+ - [Lucy::Store::FSFolder](Lucy/Store/FSFolder.html) - File System implementation of Folder.
+ - [Lucy::Store::Folder](Lucy/Store/Folder.html) - Abstract class representing a directory.
+ - [Lucy::Store::Lock](Lucy/Store/Lock.html) - Abstract class representing an interprocess mutex lock.
+ - [Lucy::Store::LockErr](Lucy/Store/LockErr.html) - Lock exception.
+ - [Lucy::Store::LockFactory](Lucy/Store/LockFactory.html) - Create Locks.
+ - [Lucy::Store::RAMFolder](Lucy/Store/RAMFolder.html) - In-memory Folder implementation.
+ - [LucyX::Index::ByteBufDocReader](LucyX/Index/ByteBufDocReader.html) - Read a Doc as a fixed-width byte array.
+ - [LucyX::Index::ByteBufDocWriter](LucyX/Index/ByteBufDocWriter.html) - Write a Doc as a fixed-width byte array.
+ - [LucyX::Index::LongFieldSim](LucyX/Index/LongFieldSim.html) - Similarity optimized for long fields.
+ - [LucyX::Index::ZlibDocReader](LucyX/Index/ZlibDocReader.html) - Compressed doc storage.
+ - [LucyX::Index::ZlibDocWriter](LucyX/Index/ZlibDocWriter.html) - Compressed doc storage.
+ - [LucyX::Remote::ClusterSearcher](LucyX/Remote/ClusterSearcher.html) - Search multiple remote indexes.
+ - [LucyX::Remote::SearchClient](LucyX/Remote/SearchClient.html) - Connect to a remote SearchServer.
+ - [LucyX::Remote::SearchServer](LucyX/Remote/SearchServer.html) - Make a Searcher remotely accessible.
+ - [LucyX::Search::Filter](LucyX/Search/Filter.html) - Build a caching filter based on results of a Query.
+ - [LucyX::Search::MockMatcher](LucyX/Search/MockMatcher.html) - Matcher with arbitrary docs and scores.
+ - [LucyX::Search::ProximityQuery](LucyX/Search/ProximityQuery.html) - Query matching an ordered list of terms.