Author: buildbot
Date: Wed Dec 31 02:05:50 2014
New Revision: 934528
Log:
Staging update by buildbot for lucy
Added:
websites/staging/lucy/trunk/content/docs/perl/Lucy/Analysis/EasyAnalyzer.html
websites/staging/lucy/trunk/content/docs/perl/Lucy/Analysis/Normalizer.html
websites/staging/lucy/trunk/content/docs/perl/Lucy/Analysis/StandardTokenizer.html
websites/staging/lucy/trunk/content/docs/perl/LucyX/Remote/ClusterSearcher.html
Modified:
websites/staging/lucy/trunk/content/ (props changed)
websites/staging/lucy/trunk/content/docs/perl/Lucy.html
websites/staging/lucy/trunk/content/docs/perl/Lucy/Docs/Cookbook/CustomQuery.html
websites/staging/lucy/trunk/content/docs/perl/Lucy/Docs/Tutorial/BeyondSimple.html
websites/staging/lucy/trunk/content/docs/perl/Lucy/Docs/Tutorial/FieldType.html
websites/staging/lucy/trunk/content/docs/perl/Lucy/Docs/Tutorial/QueryObjects.html
websites/staging/lucy/trunk/content/docs/perl/Lucy/Docs/Tutorial/Simple.html
websites/staging/lucy/trunk/content/docs/perl/Lucy/Search/PolySearcher.html
websites/staging/lucy/trunk/content/docs/perl/LucyX/Remote/SearchClient.html
websites/staging/lucy/trunk/content/docs/perl/LucyX/Remote/SearchServer.html
websites/staging/lucy/trunk/content/docs/perl/index.html
Propchange: websites/staging/lucy/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Wed Dec 31 02:05:50 2014
@@ -1 +1 @@
-1648641
+1648645
Modified: websites/staging/lucy/trunk/content/docs/perl/Lucy.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/perl/Lucy.html (original)
+++ websites/staging/lucy/trunk/content/docs/perl/Lucy.html Wed Dec 31 02:05:50
2014
@@ -13,7 +13,7 @@
<h1 id="VERSION">VERSION</h1>
-<p>0.2.2</p>
+<p>0.3.3</p>
<h1 id="SYNOPSIS">SYNOPSIS</h1>
@@ -67,7 +67,7 @@
<h1 id="DESCRIPTION">DESCRIPTION</h1>
-<p>Apache Lucy is a high-performance, modular search engine library.</p>
+<p>The Apache Lucy search engine library delivers high-performance, modular
full-text search.</p>
<h2 id="Features">Features</h2>
@@ -144,7 +144,7 @@
<p>For creating complex queries, see <a
href="Lucy/Search/Query.html">Lucy::Search::Query</a> and its subclasses <a
href="Lucy/Search/TermQuery.html">TermQuery</a>, <a
href="Lucy/Search/PhraseQuery.html">PhraseQuery</a>, <a
href="Lucy/Search/ANDQuery.html">ANDQuery</a>, <a
href="Lucy/Search/ORQuery.html">ORQuery</a>, <a
href="Lucy/Search/NOTQuery.html">NOTQuery</a>, <a
href="Lucy/Search/RequiredOptionalQuery.html">RequiredOptionalQuery</a>, <a
href="Lucy/Search/MatchAllQuery.html">MatchAllQuery</a>, and <a
href="Lucy/Search/NoMatchQuery.html">NoMatchQuery</a>, plus <a
href="Lucy/Search/QueryParser.html">Lucy::Search::QueryParser</a>.</p>
-<p>For distributed searching, see <a
href="LucyX/Remote/SearchServer.html">LucyX::Remote::SearchServer</a>, <a
href="LucyX/Remote/SearchClient.html">LucyX::Remote::SearchClient</a>, and <a
href="Lucy/Search/PolySearcher.html">Lucy::Search::PolySearcher</a>.</p>
+<p>For distributed searching, see <a
href="LucyX/Remote/SearchServer.html">LucyX::Remote::SearchServer</a>, <a
href="LucyX/Remote/SearchClient.html">LucyX::Remote::SearchClient</a>, and <a
href="LucyX/Remote/ClusterSearcher.html">LucyX::Remote::ClusterSearcher</a>.</p>
<h2 id="Backwards-Compatibility-Policy">Backwards Compatibility Policy</h2>
@@ -164,7 +164,7 @@
<h1 id="SUPPORT">SUPPORT</h1>
-<p>The Apache Lucy homepage, where you'll find links to our mailing lists
and so on, is <a
href="http://incubator.apache.org/lucy";>http://incubator.apache.org/lucy</a>.
Please direct support questions to the Lucy users mailing list.</p>
+<p>The Apache Lucy homepage, where you'll find links to our mailing lists
and so on, is <a href="http://lucy.apache.org";>http://lucy.apache.org</a>.
Please direct support questions to the Lucy users mailing list.</p>
<h1 id="BUGS">BUGS</h1>
@@ -174,10 +174,6 @@
<p>If you find a bug, please inquire on the Lucy users mailing list about it,
then report it on the Lucy issue tracker once it has been confirmed: <a
href="https://issues.apache.org/jira/browse/LUCY";>https://issues.apache.org/jira/browse/LUCY</a>.</p>
-<h1 id="DISCLAIMER">DISCLAIMER</h1>
-
-<p>Apache Lucy is an effort undergoing incubation at The Apache Software
Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of
all newly accepted projects until a further review indicates that the
infrastructure, communications, and decision making process have stabilized in
a manner consistent with other successful ASF projects. While incubation status
is not necessarily a reflection of the completeness or stability of the code,
it does indicate that the project has yet to be fully endorsed by the ASF.</p>
-
<h1 id="COPYRIGHT">COPYRIGHT</h1>
<p>Apache Lucy is distributed under the Apache License, Version 2.0, as
described in the file <code>LICENSE</code> included with the distribution.</p>
Added:
websites/staging/lucy/trunk/content/docs/perl/Lucy/Analysis/EasyAnalyzer.html
==============================================================================
---
websites/staging/lucy/trunk/content/docs/perl/Lucy/Analysis/EasyAnalyzer.html
(added)
+++
websites/staging/lucy/trunk/content/docs/perl/Lucy/Analysis/EasyAnalyzer.html
Wed Dec 31 02:05:50 2014
@@ -0,0 +1,69 @@
+
+<html>
+<head>
+<title></title>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+</head>
+<body>
+
+
+<h1 id="NAME">NAME</h1>
+
+<p>Lucy::Analysis::EasyAnalyzer - A simple analyzer chain</p>
+
+<p>EasyAnalyzer is an analyzer chain consisting of a <a
href="../../Lucy/Analysis/StandardTokenizer.html">StandardTokenizer</a>, a <a
href="../../Lucy/Analysis/Normalizer.html">Normalizer</a>, and a <a
href="../../Lucy/Analysis/EasyAnalyzer.html">EasyAnalyzer</a>.</p>
+
+<h1 id="SYNOPSIS">SYNOPSIS</h1>
+
+<pre><code> my $schema = Lucy::Plan::Schema->new;
+ my $analyzer = Lucy::Analysis::EasyAnalyzer->new(
+ language => 'en',
+ );
+ my $type = Lucy::Plan::FullTextType->new(
+ analyzer => $analyzer,
+ );
+ $schema->spec_field( name => 'title', type => $type );
+ $schema->spec_field( name => 'content', type => $type
);</code></pre>
+
+<h1 id="DESCRIPTION">DESCRIPTION</h1>
+
+<p>Supported languages:</p>
+
+<pre><code> en => English,
+ da => Danish,
+ de => German,
+ es => Spanish,
+ fi => Finnish,
+ fr => French,
+ hu => Hungarian,
+ it => Italian,
+ nl => Dutch,
+ no => Norwegian,
+ pt => Portuguese,
+ ro => Romanian,
+ ru => Russian,
+ sv => Swedish,
+ tr => Turkish,</code></pre>
+
+<h1 id="CONSTRUCTORS">CONSTRUCTORS</h1>
+
+<h2 id="new-labeled-params">new( <i>[labeled params]</i> )</h2>
+
+<pre><code> my $analyzer = Lucy::Analysis::EasyAnalyzer->new(
+ language => 'es',
+ );</code></pre>
+
+<ul>
+
+<li><p><b>language</b> - An ISO code from the list of supported languages.</p>
+
+</li>
+</ul>
+
+<h1 id="INHERITANCE">INHERITANCE</h1>
+
+<p>Lucy::Analysis::EasyAnalyzer isa <a
href="../../Lucy/Analysis/Analyzer.html">Lucy::Analysis::Analyzer</a> isa <a
href="../../Lucy/Object/Obj.html">Lucy::Object::Obj</a>.</p>
+
+</body>
+</html>
+
Added:
websites/staging/lucy/trunk/content/docs/perl/Lucy/Analysis/Normalizer.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/perl/Lucy/Analysis/Normalizer.html
(added)
+++ websites/staging/lucy/trunk/content/docs/perl/Lucy/Analysis/Normalizer.html
Wed Dec 31 02:05:50 2014
@@ -0,0 +1,59 @@
+
+<html>
+<head>
+<title></title>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+</head>
+<body>
+
+
+<h1 id="NAME">NAME</h1>
+
+<p>Lucy::Analysis::Normalizer - Unicode normalization, case folding and accent
stripping</p>
+
+<p>Normalizer is an <a href="../../Lucy/Analysis/Analyzer.html">Analyzer</a>
which normalizes tokens to one of the Unicode normalization forms.</p>
+
+<h1 id="SYNOPSIS">SYNOPSIS</h1>
+
+<pre><code> my $normalizer = Lucy::Analysis::Normalizer->new;
+
+ my $polyanalyzer = Lucy::Analysis::PolyAnalyzer->new(
+ analyzers => [ $normalizer, $tokenizer, $stemmer ],
+ );</code></pre>
+
+<h1 id="DESCRIPTION">DESCRIPTION</h1>
+
+<p>Optionally, it performs Unicode case folding and converts accented
characters to their base character.</p>
+
+<p>If you use highlighting, Normalizer should be run after tokenization
because it might add or remove characters.</p>
+
+<h1 id="CONSTRUCTORS">CONSTRUCTORS</h1>
+
+<h2 id="new-labeled-params">new( <i>[labeled params]</i> )</h2>
+
+<pre><code> my $normalizer = Lucy::Analysis::Normalizer->new(
+ normalization_form => 'NFKC',
+ case_fold => 1,
+ strip_accents => 0,
+ );</code></pre>
+
+<ul>
+
+<li><p><b>normalization_form</b> - Unicode normalization form, can be one of
'NFC', 'NFKC', 'NFD', 'NFKD'. Defaults to
'NFKC'.</p>
+
+</li>
+<li><p><b>case_fold</b> - Perform case folding, default is true.</p>
+
+</li>
+<li><p><b>strip_accents</b> - Strip accents, default is false.</p>
+
+</li>
+</ul>
+
+<h1 id="INHERITANCE">INHERITANCE</h1>
+
+<p>Lucy::Analysis::Normalizer isa <a
href="../../Lucy/Analysis/Analyzer.html">Lucy::Analysis::Analyzer</a> isa <a
href="../../Lucy/Object/Obj.html">Lucy::Object::Obj</a>.</p>
+
+</body>
+</html>
+
Added:
websites/staging/lucy/trunk/content/docs/perl/Lucy/Analysis/StandardTokenizer.html
==============================================================================
---
websites/staging/lucy/trunk/content/docs/perl/Lucy/Analysis/StandardTokenizer.html
(added)
+++
websites/staging/lucy/trunk/content/docs/perl/Lucy/Analysis/StandardTokenizer.html
Wed Dec 31 02:05:50 2014
@@ -0,0 +1,42 @@
+
+<html>
+<head>
+<title></title>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+</head>
+<body>
+
+
+<h1 id="NAME">NAME</h1>
+
+<p>Lucy::Analysis::StandardTokenizer - Split a string into tokens.</p>
+
+<h1 id="SYNOPSIS">SYNOPSIS</h1>
+
+<pre><code> my $tokenizer = Lucy::Analysis::StandardTokenizer->new;
+
+ # Then... once you have a tokenizer, put it into a PolyAnalyzer:
+ my $polyanalyzer = Lucy::Analysis::PolyAnalyzer->new(
+ analyzers => [ $case_folder, $tokenizer, $stemmer ], );</code></pre>
+
+<h1 id="DESCRIPTION">DESCRIPTION</h1>
+
+<p>Generically, "tokenizing" is a process of breaking up a string
into an array of "tokens". For instance, the string "three blind
mice" might be tokenized into "three", "blind",
"mice".</p>
+
+<p>Lucy::Analysis::StandardTokenizer breaks up the text at the word boundaries
defined in Unicode Standard Annex #29. It then returns those words that start
with an alphabetic or numeric character.</p>
+
+<h1 id="CONSTRUCTORS">CONSTRUCTORS</h1>
+
+<h2 id="new">new()</h2>
+
+<pre><code> my $tokenizer =
Lucy::Analysis::StandardTokenizer->new;</code></pre>
+
+<p>Constructor. Takes no arguments.</p>
+
+<h1 id="INHERITANCE">INHERITANCE</h1>
+
+<p>Lucy::Analysis::StandardTokenizer isa <a
href="../../Lucy/Analysis/Analyzer.html">Lucy::Analysis::Analyzer</a> isa <a
href="../../Lucy/Object/Obj.html">Lucy::Object::Obj</a>.</p>
+
+</body>
+</html>
+
Modified:
websites/staging/lucy/trunk/content/docs/perl/Lucy/Docs/Cookbook/CustomQuery.html
==============================================================================
---
websites/staging/lucy/trunk/content/docs/perl/Lucy/Docs/Cookbook/CustomQuery.html
(original)
+++
websites/staging/lucy/trunk/content/docs/perl/Lucy/Docs/Cookbook/CustomQuery.html
Wed Dec 31 02:05:50 2014
@@ -121,7 +121,7 @@
<p>PrefixQuery's make_compiler() method will be called internally at
search-time by objects which subclass <a
href="../../../Lucy/Search/Searcher.html">Lucy::Search::Searcher</a> -- such as
<a href="../../../Lucy/Search/IndexSearcher.html">IndexSearchers</a>.</p>
-<p>A Searcher is associated with a particular collection of documents. These
documents may all reside in one index, as with IndexSearcher, or they may be
spread out across multiple indexes on one or more machines, as with <a
href="../../../Lucy/Search/PolySearcher.html">Lucy::Search::PolySearcher</a>.</p>
+<p>A Searcher is associated with a particular collection of documents. These
documents may all reside in one index, as with IndexSearcher, or they may be
spread out across multiple indexes on one or more machines, as with <a
href="../../../LucyX/Remote/ClusterSearcher.html">LucyX::Remote::ClusterSearcher</a>.</p>
<p>Searcher objects have access to certain statistical information about the
collections they represent; for instance, a Searcher can tell you how many
documents are in the collection...</p>
Modified:
websites/staging/lucy/trunk/content/docs/perl/Lucy/Docs/Tutorial/BeyondSimple.html
==============================================================================
---
websites/staging/lucy/trunk/content/docs/perl/Lucy/Docs/Tutorial/BeyondSimple.html
(original)
+++
websites/staging/lucy/trunk/content/docs/perl/Lucy/Docs/Tutorial/BeyondSimple.html
Wed Dec 31 02:05:50 2014
@@ -83,7 +83,7 @@
<p>Next, have the <code>$indexer</code> object <code>add_doc</code> where we
were having the <code>$lucy</code> object <code>add_doc</code> before:</p>
<pre><code> foreach my $filename (@filenames) {
- my $doc = slurp_and_parse_file($filename);
+ my $doc = parse_file($filename);
$indexer->add_doc($doc);
}</code></pre>
Modified:
websites/staging/lucy/trunk/content/docs/perl/Lucy/Docs/Tutorial/FieldType.html
==============================================================================
---
websites/staging/lucy/trunk/content/docs/perl/Lucy/Docs/Tutorial/FieldType.html
(original)
+++
websites/staging/lucy/trunk/content/docs/perl/Lucy/Docs/Tutorial/FieldType.html
Wed Dec 31 02:05:50 2014
@@ -32,7 +32,7 @@
<p>Instead of FullTextType, we'll use a <a
href="../../../Lucy/Plan/StringType.html">StringType</a>, which doesn't use
an Analyzer to break up text into individual fields. Furthermore, we'll
mark this StringType as unindexed, so that its content won't be searchable
at all.</p>
-<pre><code> my $url_type = Lucy::Plan::StringType( indexed => 0 );
+<pre><code> my $url_type = Lucy::Plan::StringType->new( indexed => 0
);
$schema->spec_field( name => 'url', type => $url_type
);</code></pre>
<p>To observe the change in behavior, try searching for
<code>us_constitution</code> both before and after changing the Schema and
re-indexing.</p>
Modified:
websites/staging/lucy/trunk/content/docs/perl/Lucy/Docs/Tutorial/QueryObjects.html
==============================================================================
---
websites/staging/lucy/trunk/content/docs/perl/Lucy/Docs/Tutorial/QueryObjects.html
(original)
+++
websites/staging/lucy/trunk/content/docs/perl/Lucy/Docs/Tutorial/QueryObjects.html
Wed Dec 31 02:05:50 2014
@@ -51,7 +51,7 @@
<h2 id="Adaptations-to-search.cgi">Adaptations to search.cgi</h2>
-<p>The "category" constraint will be added to our search interface
using an HTML "select" element:</p>
+<p>The "category" constraint will be added to our search interface
using an HTML "select" element (this routine will need to be
integrated into the HTML generation section of search.cgi):</p>
<pre><code> # Build up the HTML "select" object for the
"category" field.
sub generate_category_select {
Modified:
websites/staging/lucy/trunk/content/docs/perl/Lucy/Docs/Tutorial/Simple.html
==============================================================================
---
websites/staging/lucy/trunk/content/docs/perl/Lucy/Docs/Tutorial/Simple.html
(original)
+++
websites/staging/lucy/trunk/content/docs/perl/Lucy/Docs/Tutorial/Simple.html
Wed Dec 31 02:05:50 2014
@@ -58,7 +58,6 @@
title => $title,
content => $bodytext,
url => "/us_constitution/$filename",
- category => $category,
};
}</code></pre>
@@ -179,7 +178,6 @@
# Create a url for use in paging links.
my $href = $cgi->url( -relative => 1 );
$href .= "?q=" . CGI::escape($query_string);
- $href .= ";category=" . CGI::escape($category);
$href .= ";offset=" . CGI::escape($offset);
# Generate the "Prev" link.
@@ -254,7 +252,7 @@
<p style="font-size: smaller; color: #666">
<em>
- Powered by <a href="http://incubator.apache.org/lucy/"
+ Powered by <a href="http://lucy.apache.org/"
>Apache
Lucy<small><sup>TM</sup></small></a>
</em>
</p>
Modified:
websites/staging/lucy/trunk/content/docs/perl/Lucy/Search/PolySearcher.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/perl/Lucy/Search/PolySearcher.html
(original)
+++ websites/staging/lucy/trunk/content/docs/perl/Lucy/Search/PolySearcher.html
Wed Dec 31 02:05:50 2014
@@ -14,12 +14,8 @@
<h1 id="SYNOPSIS">SYNOPSIS</h1>
<pre><code> my $schema = MySchema->new;
- for my $server_name (@server_names) {
- push @searchers, LucyX::Remote::SearchClient->new(
- peer_address => "$server_name:$port",
- password => $pass,
- schema => $schema,
- );
+ for my $index (@index_paths) {
+ push @searchers, Lucy::Search::IndexSearcher->new( index =>
$index );
}
my $poly_searcher = Lucy::Search::PolySearcher->new(
schema => $schema,
@@ -29,7 +25,7 @@
<h1 id="DESCRIPTION">DESCRIPTION</h1>
-<p>The primary use for PolySearcher is to aggregate results from several
remote <a href="../../Lucy/Search/Searcher.html">Searchers</a> via <a
href="../../LucyX/Remote/SearchClient.html">LucyX::Remote::SearchClient</a>,
diffusing the cost of searching a large corpus over multiple machines. It is
also possible to aggregate results from multiple Searchers on a single
machine.</p>
+<p>The primary use for PolySearcher is to aggregate results from several
indexes on a single machine.</p>
<h1 id="CONSTRUCTORS">CONSTRUCTORS</h1>
Added:
websites/staging/lucy/trunk/content/docs/perl/LucyX/Remote/ClusterSearcher.html
==============================================================================
---
websites/staging/lucy/trunk/content/docs/perl/LucyX/Remote/ClusterSearcher.html
(added)
+++
websites/staging/lucy/trunk/content/docs/perl/LucyX/Remote/ClusterSearcher.html
Wed Dec 31 02:05:50 2014
@@ -0,0 +1,47 @@
+
+<html>
+<head>
+<title></title>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+</head>
+<body>
+
+
+<h1 id="NAME">NAME</h1>
+
+<p>LucyX::Remote::ClusterSearcher - Search multiple remote indexes.</p>
+
+<h1 id="SYNOPSIS">SYNOPSIS</h1>
+
+<pre><code> my $searcher = eval {
+ LucyX::Remote::ClusterSearcher->new(
+ schema => MySchema->new,
+ shards => [ 'search1:7890', 'search2:7890',
'search3:7890' ],
+ );
+ };
+ ...
+ my $hits = eval { $searcher->hits( query => $query ) };</code></pre>
+
+<h1 id="DESCRIPTION">DESCRIPTION</h1>
+
+<p>ClusterSearcher is a subclass of <a
href="../../Lucy/Search/Searcher.html">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">LucyX::Remote::SearchServer</a>.</p>
+
+<h1 id="METHODS">METHODS</h1>
+
+<h2 id="new">new</h2>
+
+<p>Constructor. Takes hash-style params.</p>
+
+<ul>
+
+<li><p><b>schema</b> - A Schema, which must match the Schema used by each
remote node.</p>
+
+</li>
+<li><p><b>shards</b> - An array of host:port pairs running
LucyX::Remote::SearchServer instances, which identifying the shards that make
up the composite index.</p>
+
+</li>
+</ul>
+
+</body>
+</html>
+
Modified:
websites/staging/lucy/trunk/content/docs/perl/LucyX/Remote/SearchClient.html
==============================================================================
---
websites/staging/lucy/trunk/content/docs/perl/LucyX/Remote/SearchClient.html
(original)
+++
websites/staging/lucy/trunk/content/docs/perl/LucyX/Remote/SearchClient.html
Wed Dec 31 02:05:50 2014
@@ -9,38 +9,6 @@
<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>
-<h1 id="NAME">NAME</h1>
-
-<p>LucyX::Remote::SearchClient - Connect to a remote SearchServer.</p>
-
-<h1 id="SYNOPSIS">SYNOPSIS</h1>
-
-<pre><code> my $client = LucyX::Remote::SearchClient->new(
- peer_address => 'searchserver1:7890',
- password => $pass,
- );
- my $hits = $client->hits( query => $query );</code></pre>
-
-<h1 id="DESCRIPTION">DESCRIPTION</h1>
-
-<p>SearchClient is a subclass of <a
href="../../Lucy/Search/Searcher.html">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">SearchServer</a>.</p>
-
-<h1 id="METHODS">METHODS</h1>
-
-<h2 id="new">new</h2>
-
-<p>Constructor. Takes hash-style params.</p>
-
-<ul>
-
-<li><p><b>peer_address</b> - The name/IP and the port number which the client
should attempt to connect to.</p>
-
-</li>
-<li><p><b>password</b> - Password to be supplied to the SearchServer when
initializing socket connection.</p>
-
-</li>
-</ul>
-
</body>
</html>
Modified:
websites/staging/lucy/trunk/content/docs/perl/LucyX/Remote/SearchServer.html
==============================================================================
---
websites/staging/lucy/trunk/content/docs/perl/LucyX/Remote/SearchServer.html
(original)
+++
websites/staging/lucy/trunk/content/docs/perl/LucyX/Remote/SearchServer.html
Wed Dec 31 02:05:50 2014
@@ -17,17 +17,17 @@
index => '/path/to/index'
);
my $search_server = LucyX::Remote::SearchServer->new(
- searcher => $searcher,
- port => 7890,
- password => $pass,
+ searcher => $searcher
);
- $search_server->serve;</code></pre>
+ $search_server->serve(
+ port => 7890
+ );</code></pre>
<h1 id="DESCRIPTION">DESCRIPTION</h1>
-<p>The SearchServer class, in conjunction with <a
href="../../LucyX/Remote/SearchClient.html">SearchClient</a>, makes it possible
to run a search on one machine and report results on another.</p>
+<p>The SearchServer class, in conjunction with either <a
href="../../LucyX/Remote/SearchClient.html">SearchClient</a> or <a
href="../../LucyX/Remote/ClusterSearcher.html">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 <a
href="../../Lucy/Search/PolySearcher.html">PolySearcher</a>, 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>
+<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 id="METHODS">METHODS</h1>
@@ -35,8 +35,6 @@
<pre><code> my $search_server = LucyX::Remote::SearchServer->new(
searcher => $searcher, # required
- port => 7890, # required
- password => $pass, # required
);</code></pre>
<p>Constructor. Takes hash-style parameters.</p>
@@ -46,19 +44,28 @@
<li><p><b>searcher</b> - the <a
href="../../Lucy/Search/IndexSearcher.html">Searcher</a> that the SearchServer
will wrap.</p>
</li>
-<li><p><b>port</b> - the port on localhost that the server should open and
listen on.</p>
+</ul>
-</li>
-<li><p><b>password</b> - a password which must be supplied by clients.</p>
+<h2 id="serve">serve</h2>
+
+<pre><code> $search_server->serve(
+ port => 7890, # required
+ );</code></pre>
+
+<p>Open a listening socket on localhost and wait for SearchClients to
connect.</p>
+
+<ul>
+
+<li><p><b>port</b> - the port on localhost that the server should open and
listen on.</p>
</li>
</ul>
-<h2 id="serve">serve</h2>
+<h2 id="serve_rpc">serve_rpc</h2>
-<pre><code> $search_server->serve;</code></pre>
+<pre><code> my $status = $search_server->serve_rpc($sock);</code></pre>
-<p>Open a listening socket on localhost and wait for SearchClients to
connect.</p>
+<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>
</body>
</html>
Modified: websites/staging/lucy/trunk/content/docs/perl/index.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/perl/index.html (original)
+++ websites/staging/lucy/trunk/content/docs/perl/index.html Wed Dec 31
02:05:50 2014
@@ -67,16 +67,19 @@
</div> <!-- lucy-left_nav_box -->
<div id="lucy-main_content_box" class="grid_9">
- <h4>Perl API documentation for Apache Lucy 0.2.2</h4>
+ <h4>Perl API documentation for Apache Lucy 0.3.3</h4>
<ul>
<li><a href="Lucy.html">Lucy</a> - Apache Lucy search engine library.</li>
<li><a href="Lucy/Analysis/Analyzer.html">Lucy::Analysis::Analyzer</a> -
Tokenize/modify/filter text.</li>
<li><a href="Lucy/Analysis/CaseFolder.html">Lucy::Analysis::CaseFolder</a> -
Normalize case, facilitating case-insensitive search.</li>
+<li><a href="Lucy/Analysis/EasyAnalyzer.html">Lucy::Analysis::EasyAnalyzer</a>
- A simple analyzer chain</li>
+<li><a href="Lucy/Analysis/Normalizer.html">Lucy::Analysis::Normalizer</a> -
Unicode normalization, case folding and accent stripping</li>
<li><a href="Lucy/Analysis/PolyAnalyzer.html">Lucy::Analysis::PolyAnalyzer</a>
- Multiple Analyzers in series.</li>
<li><a
href="Lucy/Analysis/RegexTokenizer.html">Lucy::Analysis::RegexTokenizer</a> -
Split a string into tokens.</li>
<li><a
href="Lucy/Analysis/SnowballStemmer.html">Lucy::Analysis::SnowballStemmer</a> -
Reduce related words to a shared root.</li>
<li><a
href="Lucy/Analysis/SnowballStopFilter.html">Lucy::Analysis::SnowballStopFilter</a>
- Suppress a "stoplist" of common words.</li>
+<li><a
href="Lucy/Analysis/StandardTokenizer.html">Lucy::Analysis::StandardTokenizer</a>
- Split a string into tokens.</li>
<li><a href="Lucy/Docs/Cookbook.html">Lucy::Docs::Cookbook</a> - Apache Lucy
recipes.</li>
<li><a
href="Lucy/Docs/Cookbook/CustomQuery.html">Lucy::Docs::Cookbook::CustomQuery</a>
- Sample subclass of Query.</li>
<li><a
href="Lucy/Docs/Cookbook/CustomQueryParser.html">Lucy::Docs::Cookbook::CustomQueryParser</a>
- Sample subclass of QueryParser.</li>
@@ -159,6 +162,7 @@
<li><a href="LucyX/Index/LongFieldSim.html">LucyX::Index::LongFieldSim</a> -
Similarity optimized for long fields.</li>
<li><a href="LucyX/Index/ZlibDocReader.html">LucyX::Index::ZlibDocReader</a> -
Compressed doc storage.</li>
<li><a href="LucyX/Index/ZlibDocWriter.html">LucyX::Index::ZlibDocWriter</a> -
Compressed doc storage.</li>
+<li><a
href="LucyX/Remote/ClusterSearcher.html">LucyX::Remote::ClusterSearcher</a> -
Search multiple remote indexes.</li>
<li><a href="LucyX/Remote/SearchClient.html">LucyX::Remote::SearchClient</a> -
Connect to a remote SearchServer.</li>
<li><a href="LucyX/Remote/SearchServer.html">LucyX::Remote::SearchServer</a> -
Make a Searcher remotely accessible.</li>
<li><a href="LucyX/Search/Filter.html">LucyX::Search::Filter</a> - Build a
caching filter based on results of a Query.</li>
