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/04/04 11:22:33 UTC
svn commit: r1737642 [7/7] - in /lucy/site/trunk/content/docs: 0.4.0/
0.4.0/perl/ 0.4.0/perl/Lucy/ 0.4.0/perl/Lucy/Analysis/
0.4.0/perl/Lucy/Docs/ 0.4.0/perl/Lucy/Docs/Cookbook/
0.4.0/perl/Lucy/Docs/Tutorial/ 0.4.0/perl/Lucy/Document/ 0.4.0/perl/Lucy/H...
Added: lucy/site/trunk/content/docs/perl/LucyX/Index/LongFieldSim.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/perl/LucyX/Index/LongFieldSim.mdtext?rev=1737642&view=auto
==============================================================================
--- lucy/site/trunk/content/docs/perl/LucyX/Index/LongFieldSim.mdtext (added)
+++ lucy/site/trunk/content/docs/perl/LucyX/Index/LongFieldSim.mdtext Mon Apr 4 09:22:30 2016
@@ -0,0 +1,93 @@
+Title: LucyX::Index::LongFieldSim â Apache Lucy Documentation
+
+<div>
+<a name='___top' class='dummyTopAnchor' ></a>
+
+<h2><a class='u'
+name="NAME"
+>NAME</a></h2>
+
+<p>LucyX::Index::LongFieldSim - Similarity optimized for long fields.</p>
+
+<h2><a class='u'
+name="SYNOPSIS"
+>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>
+
+<h2><a class='u'
+name="DESCRIPTION"
+>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>
+
+<pre>Lucy::Index::Similarity
+
+| more weight
+| *
+| **
+| ***
+| **********
+| ********************
+| *******************************
+| less weight ****
+|------------------------------------------------------------------------
+ fewer tokens more tokens</pre>
+
+<p>LongFieldSim eliminates this bias.</p>
+
+<pre>LucyX::Index::LongFieldSim
+
+| more weight
+|
+|
+|
+|*****************
+| ********************
+| *******************************
+| less weight ****
+|------------------------------------------------------------------------
+ fewer tokens more tokens</pre>
+
+<p>In most cases,
+the default bias towards short fields is desirable.
+For instance,
+say you have two documents:</p>
+
+<ul>
+<li>"George Washington"</li>
+
+<li>"George Washington Carver"</li>
+</ul>
+
+<p>If a user searches for "george washington",
+we want the exact title match to appear first.
+Under the default Similarity implementation it will,
+because the "Carver" in "George Washington Carver" dilutes the impact of the other two tokens.</p>
+
+<p>However,
+under LongFieldSim,
+the two titles will yield equal scores.
+That would be bad in this particular case,
+but it could be good in another.</p>
+
+<pre> "George Washington Carver is cool."
+
+ "George Washington Carver was born on the eve of the US Civil War, in
+ 1864. His exact date of birth is unknown... Carver's research in crop
+ rotation revolutionized agriculture..."</pre>
+
+<p>The first document is succinct,
+but useless.
+Unfortunately,
+the default similarity will assess it as extremely relevant to a query of "george washington carver".
+However,
+under LongFieldSim,
+the short-field bias is eliminated,
+and the addition of other mentions of Carver's name in the second document yield a higher score and a higher rank.</p>
+
+</div>
Added: lucy/site/trunk/content/docs/perl/LucyX/Index/ZlibDocReader.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/perl/LucyX/Index/ZlibDocReader.mdtext?rev=1737642&view=auto
==============================================================================
--- lucy/site/trunk/content/docs/perl/LucyX/Index/ZlibDocReader.mdtext (added)
+++ lucy/site/trunk/content/docs/perl/LucyX/Index/ZlibDocReader.mdtext Mon Apr 4 09:22:30 2016
@@ -0,0 +1,19 @@
+Title: LucyX::Index::ZlibDocReader â Apache Lucy Documentation
+
+<div>
+<a name='___top' class='dummyTopAnchor' ></a>
+
+<h2><a class='u'
+name="NAME"
+>NAME</a></h2>
+
+<p>LucyX::Index::ZlibDocReader - Compressed doc storage.</p>
+
+<h2><a class='u'
+name="DESCRIPTION"
+>DESCRIPTION</a></h2>
+
+<p>This is a proof-of-concept class to demonstrate alternate implementations for fetching documents.
+It is unsupported.</p>
+
+</div>
Added: lucy/site/trunk/content/docs/perl/LucyX/Index/ZlibDocWriter.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/perl/LucyX/Index/ZlibDocWriter.mdtext?rev=1737642&view=auto
==============================================================================
--- lucy/site/trunk/content/docs/perl/LucyX/Index/ZlibDocWriter.mdtext (added)
+++ lucy/site/trunk/content/docs/perl/LucyX/Index/ZlibDocWriter.mdtext Mon Apr 4 09:22:30 2016
@@ -0,0 +1,19 @@
+Title: LucyX::Index::ZlibDocWriter â Apache Lucy Documentation
+
+<div>
+<a name='___top' class='dummyTopAnchor' ></a>
+
+<h2><a class='u'
+name="NAME"
+>NAME</a></h2>
+
+<p>LucyX::Index::ZlibDocWriter - Compressed doc storage.</p>
+
+<h2><a class='u'
+name="DESCRIPTION"
+>DESCRIPTION</a></h2>
+
+<p>This is a proof-of-concept class to demonstrate alternate implementations for fetching documents.
+It is unsupported.</p>
+
+</div>
Added: lucy/site/trunk/content/docs/perl/LucyX/Remote/ClusterSearcher.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/perl/LucyX/Remote/ClusterSearcher.mdtext?rev=1737642&view=auto
==============================================================================
--- lucy/site/trunk/content/docs/perl/LucyX/Remote/ClusterSearcher.mdtext (added)
+++ lucy/site/trunk/content/docs/perl/LucyX/Remote/ClusterSearcher.mdtext Mon Apr 4 09:22:30 2016
@@ -0,0 +1,53 @@
+Title: LucyX::Remote::ClusterSearcher â Apache Lucy Documentation
+
+<div>
+<a name='___top' class='dummyTopAnchor' ></a>
+
+<h2><a class='u'
+name="NAME"
+>NAME</a></h2>
+
+<p>LucyX::Remote::ClusterSearcher - Search multiple remote indexes.</p>
+
+<h2><a class='u'
+name="SYNOPSIS"
+>SYNOPSIS</a></h2>
+
+<pre>my $searcher = eval {
+ LucyX::Remote::ClusterSearcher->new(
+ schema => MySchema->new,
+ shards => [ 'search1:7890', 'search2:7890', 'search3:7890' ],
+ );
+};
+...
+my $hits = eval { $searcher->hits( query => $query ) };</pre>
+
+<h2><a class='u'
+name="DESCRIPTION"
+>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>
+
+<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>schema</b> - A Schema,
+which must match the Schema used by each remote node.</li>
+
+<li><b>shards</b> - An array of host:port pairs running LucyX::Remote::SearchServer instances,
+which identifying the shards that make up the composite index.</li>
+</ul>
+
+</div>
Added: lucy/site/trunk/content/docs/perl/LucyX/Remote/SearchClient.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/perl/LucyX/Remote/SearchClient.mdtext?rev=1737642&view=auto
==============================================================================
--- lucy/site/trunk/content/docs/perl/LucyX/Remote/SearchClient.mdtext (added)
+++ lucy/site/trunk/content/docs/perl/LucyX/Remote/SearchClient.mdtext Mon Apr 4 09:22:30 2016
@@ -0,0 +1,48 @@
+Title: LucyX::Remote::SearchClient â Apache Lucy Documentation
+
+<div>
+<a name='___top' class='dummyTopAnchor' ></a>
+
+<p>Make a remote procedure call.
+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>
Added: lucy/site/trunk/content/docs/perl/LucyX/Remote/SearchServer.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/perl/LucyX/Remote/SearchServer.mdtext?rev=1737642&view=auto
==============================================================================
--- lucy/site/trunk/content/docs/perl/LucyX/Remote/SearchServer.mdtext (added)
+++ lucy/site/trunk/content/docs/perl/LucyX/Remote/SearchServer.mdtext Mon Apr 4 09:22:30 2016
@@ -0,0 +1,86 @@
+Title: LucyX::Remote::SearchServer â Apache Lucy Documentation
+
+<div>
+<a name='___top' class='dummyTopAnchor' ></a>
+
+<h2><a class='u'
+name="NAME"
+>NAME</a></h2>
+
+<p>LucyX::Remote::SearchServer - Make a Searcher remotely accessible.</p>
+
+<h2><a class='u'
+name="SYNOPSIS"
+>SYNOPSIS</a></h2>
+
+<pre>my $searcher = Lucy::Search::IndexSearcher->new(
+ index => '/path/to/index'
+);
+my $search_server = LucyX::Remote::SearchServer->new(
+ searcher => $searcher
+);
+$search_server->serve(
+ port => 7890
+);</pre>
+
+<h2><a class='u'
+name="DESCRIPTION"
+>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"
+>ClusterSearcher</a>,
+makes it possible to run a search on one machine and report results on another.</p>
+
+<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>
+
+<h2><a class='u'
+name="METHODS"
+>METHODS</a></h2>
+
+<h3><a class='u'
+name="new"
+>new</a></h3>
+
+<pre>my $search_server = LucyX::Remote::SearchServer->new(
+ searcher => $searcher, # required
+);</pre>
+
+<p>Constructor.
+Takes hash-style parameters.</p>
+
+<ul>
+<li><b>searcher</b> - the <a href="../../Lucy/Search/IndexSearcher.html" class="podlinkpod"
+>Searcher</a> that the SearchServer will wrap.</li>
+</ul>
+
+<h3><a class='u'
+name="serve"
+>serve</a></h3>
+
+<pre>$search_server->serve(
+ port => 7890, # required
+);</pre>
+
+<p>Open a listening socket on localhost and wait for SearchClients to connect.</p>
+
+<ul>
+<li><b>port</b> - the port on localhost that the server should open and listen on.</li>
+</ul>
+
+<h3><a class='u'
+name="serve_rpc"
+>serve_rpc</a></h3>
+
+<pre>my $status = $search_server->serve_rpc($sock);</pre>
+
+<p>Handle a single RPC from socket $sock.
+Returns 'done' if the connection should be closed.
+Returns 'terminate' if the server should shut down.
+Returns 'continue' if the server should continue to handle requests from this client.</p>
+
+</div>
Added: lucy/site/trunk/content/docs/perl/LucyX/Search/Filter.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/perl/LucyX/Search/Filter.mdtext?rev=1737642&view=auto
==============================================================================
--- lucy/site/trunk/content/docs/perl/LucyX/Search/Filter.mdtext (added)
+++ lucy/site/trunk/content/docs/perl/LucyX/Search/Filter.mdtext Mon Apr 4 09:22:30 2016
@@ -0,0 +1,79 @@
+Title: LucyX::Search::Filter â Apache Lucy Documentation
+
+<div>
+<a name='___top' class='dummyTopAnchor' ></a>
+
+<h2><a class='u'
+name="NAME"
+>NAME</a></h2>
+
+<p>LucyX::Search::Filter - Build a caching filter based on results of a Query.</p>
+
+<h2><a class='u'
+name="SYNOPSIS"
+>SYNOPSIS</a></h2>
+
+<pre>my %category_filters;
+for my $category (qw( sweet sour salty bitter )) {
+ my $cat_query = Lucy::Search::TermQuery->new(
+ field => 'category',
+ term => $category,
+ );
+ $category_filters{$category} = LucyX::Search::Filter->new(
+ query => $cat_query,
+ );
+}
+
+while ( my $cgi = CGI::Fast->new ) {
+ my $user_query = $cgi->param('q');
+ my $filter = $category_filters{ $cgi->param('category') };
+ my $and_query = Lucy::Search::ANDQuery->new;
+ $and_query->add_child($user_query);
+ $and_query->add_child($filter);
+ my $hits = $searcher->hits( query => $and_query );
+ ...</pre>
+
+<h2><a class='u'
+name="DESCRIPTION"
+>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>
+
+<ul>
+<li>A Filter does not contribute to the score of the documents it matches.</li>
+
+<li>A Filter caches its results,
+so it is more efficient if you use it more than once.</li>
+</ul>
+
+<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>
+
+<h2><a class='u'
+name="METHODS"
+>METHODS</a></h2>
+
+<h3><a class='u'
+name="new"
+>new</a></h3>
+
+<pre>my $filter = LucyX::Search::Filter->new(
+ query => $query;
+);</pre>
+
+<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>
+
+<h2><a class='u'
+name="BUGS"
+>BUGS</a></h2>
+
+<p>Filters do not cache when used in a search cluster with LucyX::Remote's SearchServer and SearchClient.</p>
+
+</div>
Added: lucy/site/trunk/content/docs/perl/LucyX/Search/MockMatcher.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/perl/LucyX/Search/MockMatcher.mdtext?rev=1737642&view=auto
==============================================================================
--- lucy/site/trunk/content/docs/perl/LucyX/Search/MockMatcher.mdtext (added)
+++ lucy/site/trunk/content/docs/perl/LucyX/Search/MockMatcher.mdtext Mon Apr 4 09:22:30 2016
@@ -0,0 +1,39 @@
+Title: LucyX::Search::MockMatcher â Apache Lucy Documentation
+
+<div>
+<a name='___top' class='dummyTopAnchor' ></a>
+
+<h2><a class='u'
+name="NAME"
+>NAME</a></h2>
+
+<p>LucyX::Search::MockMatcher - Matcher with arbitrary docs and scores.</p>
+
+<h2><a class='u'
+name="DESCRIPTION"
+>DESCRIPTION</a></h2>
+
+<p>Used for testing combining <a href="../../Lucy/Search/Matcher.html" class="podlinkpod"
+>Matchers</a> such as ANDMatcher,
+MockMatcher allows arbitrary match criteria to be supplied,
+obviating the need for clever index construction to cover corner cases.</p>
+
+<p>MockMatcher is a testing and demonstration class; it is unsupported.</p>
+
+<h2><a class='u'
+name="CONSTRUCTORS"
+>CONSTRUCTORS</a></h2>
+
+<h3><a class='u'
+name="new(_[labeled_params]_)"
+>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"
+>doc_ids</a>.</li>
+
+<li><b>scores</b> - An array of scores,
+one for each doc_id.</li>
+</ul>
+
+</div>
Added: lucy/site/trunk/content/docs/perl/LucyX/Search/ProximityQuery.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/perl/LucyX/Search/ProximityQuery.mdtext?rev=1737642&view=auto
==============================================================================
--- lucy/site/trunk/content/docs/perl/LucyX/Search/ProximityQuery.mdtext (added)
+++ lucy/site/trunk/content/docs/perl/LucyX/Search/ProximityQuery.mdtext Mon Apr 4 09:22:30 2016
@@ -0,0 +1,110 @@
+Title: LucyX::Search::ProximityQuery â Apache Lucy Documentation
+
+<div>
+<a name='___top' class='dummyTopAnchor' ></a>
+
+<h2><a class='u'
+name="NAME"
+>NAME</a></h2>
+
+<p>LucyX::Search::ProximityQuery - Query matching an ordered list of terms.</p>
+
+<h2><a class='u'
+name="SYNOPSIS"
+>SYNOPSIS</a></h2>
+
+<pre>my $proximity_query = LucyX::Search::ProximityQuery->new(
+ field => 'content',
+ terms => [qw( the who )],
+ within => 10, # match within 10 positions
+);
+my $hits = $searcher->hits( query => $proximity_query );</pre>
+
+<h2><a class='u'
+name="DESCRIPTION"
+>DESCRIPTION</a></h2>
+
+<p>ProximityQuery is a subclass of <a href="../../Lucy/Search/Query.html" class="podlinkpod"
+>Query</a> for matching against an ordered sequence of terms.</p>
+
+<h2><a class='u'
+name="CONSTRUCTORS"
+>CONSTRUCTORS</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>
+
+<li><b>terms</b> - The ordered array of terms that must match.</li>
+</ul>
+
+<h2><a class='u'
+name="METHODS"
+>METHODS</a></h2>
+
+<h3><a class='u'
+name="get_field"
+>get_field</a></h3>
+
+<pre>my $string = $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 $arrayref = $proximity_query->get_terms();</pre>
+
+<p>Accessor for object’s array of terms.</p>
+
+<h3><a class='u'
+name="get_within"
+>get_within</a></h3>
+
+<pre>my $int = $proximity_query->get_within();</pre>
+
+<p>Accessor for object’s within attribute.</p>
+
+<h3><a class='u'
+name="make_compiler"
+>make_compiler</a></h3>
+
+<pre>my $compiler = $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>
+
+<h2><a class='u'
+name="INHERITANCE"
+>INHERITANCE</a></h2>
+
+<p>LucyX::Search::ProximityQuery isa <a href="../../Lucy/Search/Query.html" class="podlinkpod"
+>Lucy::Search::Query</a> isa Clownfish::Obj.</p>
+
+</div>
Added: lucy/site/trunk/content/docs/perl/clownfish-index.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/perl/clownfish-index.mdtext?rev=1737642&view=auto
==============================================================================
--- lucy/site/trunk/content/docs/perl/clownfish-index.mdtext (added)
+++ lucy/site/trunk/content/docs/perl/clownfish-index.mdtext Mon Apr 4 09:22:30 2016
@@ -0,0 +1,22 @@
+Title: Perl API documentation for Apache Clownfish 0.5.0
+
+## Perl API documentation for Apache Clownfish 0.5.0
+
+- [Clownfish](Clownfish.html) â Apache Clownfish symbiotic object system
+- [Clownfish::Blob](Clownfish/Blob.html) â Immutable buffer holding arbitrary bytes.
+- [Clownfish::Boolean](Clownfish/Boolean.html) â Boolean type.
+- [Clownfish::ByteBuf](Clownfish/ByteBuf.html) â Growable buffer holding arbitrary bytes.
+- [Clownfish::CharBuf](Clownfish/CharBuf.html) â Growable buffer holding Unicode characters.
+- [Clownfish::Class](Clownfish/Class.html) â Class.
+- [Clownfish::Docs::BuildingProjects](Clownfish/Docs/BuildingProjects.html) â Building Apache Clownfish projects in C environments
+- [Clownfish::Docs::ClassIntro](Clownfish/Docs/ClassIntro.html) â Working with Apache Clownfish classes in C
+- [Clownfish::Docs::WritingClasses](Clownfish/Docs/WritingClasses.html) â Writing Apache Clownfish classes
+- [Clownfish::Err](Clownfish/Err.html) â Exception.
+- [Clownfish::Float](Clownfish/Float.html) â Immutable double precision floating point number.
+- [Clownfish::Hash](Clownfish/Hash.html) â Hashtable.
+- [Clownfish::HashIterator](Clownfish/HashIterator.html) â Hashtable Iterator.
+- [Clownfish::Integer](Clownfish/Integer.html) â Immutable 64-bit signed integer.
+- [Clownfish::Obj](Clownfish/Obj.html) â Base class for all objects.
+- [Clownfish::String](Clownfish/String.html) â Immutable string holding Unicode characters.
+- [Clownfish::StringIterator](Clownfish/StringIterator.html) â Iterate Unicode code points in a String.
+- [Clownfish::Vector](Clownfish/Vector.html) â Variable-sized array.
Modified: lucy/site/trunk/content/docs/perl/index.mdtext
URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/perl/index.mdtext?rev=1737642&r1=1737641&r2=1737642&view=diff
==============================================================================
--- lucy/site/trunk/content/docs/perl/index.mdtext (original)
+++ lucy/site/trunk/content/docs/perl/index.mdtext Mon Apr 4 09:22:30 2016
@@ -1,100 +1,103 @@
-#### Perl API documentation for Apache Lucy 0.4.2
+Title: 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::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::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::Analysis](Lucy/Docs/Tutorial/Analysis.html) - How to choose and use Analyzers.
- - [Lucy::Docs::Tutorial::BeyondSimple](Lucy/Docs/Tutorial/BeyondSimple.html) - A more flexible app structure.
- - [Lucy::Docs::Tutorial::FieldType](Lucy/Docs/Tutorial/FieldType.html) - Specify per-field properties and behaviors.
- - [Lucy::Docs::Tutorial::Highlighter](Lucy/Docs/Tutorial/Highlighter.html) - Augment search results with highlighted excerpts.
- - [Lucy::Docs::Tutorial::QueryObjects](Lucy/Docs/Tutorial/QueryObjects.html) - Use Query objects instead of query strings.
- - [Lucy::Docs::Tutorial::Simple](Lucy/Docs/Tutorial/Simple.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.
+## 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.