Added: websites/staging/lucy/trunk/content/docs/0.5.0/perl/Lucy/Simple.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/0.5.0/perl/Lucy/Simple.html (added) +++ websites/staging/lucy/trunk/content/docs/0.5.0/perl/Lucy/Simple.html Wed Sep 28 12:07:48 2016 @@ -0,0 +1,241 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> + <title>Lucy::Simple â Apache Lucy Documentation</title> + <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css"> + </head> + + <body> + + <div id="lucy-rigid_wrapper"> + + <div id="lucy-top" class="container_16 lucy-white_box_3d"> + + <div id="lucy-logo_box" class="grid_8"> + <a href="/"><img src="/images/lucy_logo_150x100.png" alt="Apache Lucyâ¢"></a> + </div> <!-- lucy-logo_box --> + + <div #id="lucy-top_nav_box" class="grid_8"> + <div id="lucy-top_nav_bar" class="container_8"> + <ul> + <li><a href="http://www.apache.org/"; title="Apache Software Foundation">Apache Software Foundation</a></li> + <li><a href="http://www.apache.org/licenses/"; title="License">License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html"; title="Sponsorship">Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html"; title="Thanks">Thanks</a></li> + <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li> + </ul> + </div> <!-- lucy-top_nav_bar --> + <p><a href="http://www.apache.org/";>Apache</a> » <a href="/">Lucy</a> » <a href="/docs/">Docs</a> » <a href="/docs/0.5.0/">0.5.0</a> » <a href="/docs/0.5.0/perl/">Perl</a> » <a href="/docs/0.5.0/perl/Lucy/">Lucy</a></p> + <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search"; method="get"> + <input value="*.apache.org" name="sitesearch" type="hidden"/> + <input type="text" name="q" id="query" style="width:85%"> + <input type="submit" id="submit" value="Search"> + </form> + </div> <!-- lucy-top_nav_box --> + + <div class="clear"></div> + + </div> <!-- lucy-top --> + + <div id="lucy-main_content" class="container_16 lucy-white_box_3d"> + + <div class="grid_4" id="lucy-left_nav_box"> + <h6>About</h6> + <ul> + <li><a href="/">Welcome</a></li> + <li><a href="/clownfish.html">Clownfish</a></li> + <li><a href="/faq.html">FAQ</a></li> + <li><a href="/people.html">People</a></li> + </ul> + <h6>Resources</h6> + <ul> + <li><a href="/download.html">Download</a></li> + <li><a href="/mailing_lists.html">Mailing Lists</a></li> + <li><a href="/docs/">Documentation</a></li> + <li><a href="http://wiki.apache.org/lucy/";>Wiki</a></li> + <li><a href="https://issues.apache.org/jira/browse/LUCY";>Issue Tracker</a></li> + <li><a href="/version_control.html">Version Control</a></li> + </ul> + <h6>Related Projects</h6> + <ul> + <li><a href="http://lucene.apache.org/core/";>Lucene</a></li> + <li><a href="http://dezi.org/";>Dezi</a></li> + <li><a href="http://lucene.apache.org/solr/";>Solr</a></li> + <li><a href="http://lucenenet.apache.org/";>Lucene.NET</a></li> + <li><a href="http://lucene.apache.org/pylucene/";>PyLucene</a></li> + </ul> + </div> <!-- lucy-left_nav_box --> + + <div id="lucy-main_content_box" class="grid_9"> + <div> +<a name='___top' class='dummyTopAnchor' ></a> + +<h2><a class='u' +name="NAME" +>NAME</a></h2> + +<p>Lucy::Simple - Basic search engine.</p> + +<h2><a class='u' +name="SYNOPSIS" +>SYNOPSIS</a></h2> + +<p>First, +build an index of your documents.</p> + +<pre>my $index = Lucy::Simple->new( + path => '/path/to/index/' + language => 'en', +); + +while ( my ( $title, $content ) = each %source_docs ) { + $index->add_doc({ + title => $title, + content => $content, + }); +}</pre> + +<p>Later, +search the index.</p> + +<pre>my $total_hits = $index->search( + query => $query_string, + offset => 0, + num_wanted => 10, +); + +print "Total hits: $total_hits\n"; +while ( my $hit = $index->next ) { + print "$hit->{title}\n", +}</pre> + +<h2><a class='u' +name="DESCRIPTION" +>DESCRIPTION</a></h2> + +<p>Lucy::Simple is a stripped-down interface for the Apache Lucy search engine library.</p> + +<h2><a class='u' +name="CONSTRUCTORS" +>CONSTRUCTORS</a></h2> + +<h3><a class='u' +name="new" +>new</a></h3> + +<pre>my $lucy = Lucy::Simple->new( + path => '/path/to/index/', + language => 'en', +);</pre> + +<p>Create a Lucy::Simple object, +which can be used for both indexing and searching. +Both parameters <code>path</code> and <code>language</code> are required.</p> + +<ul> +<li><b>path</b> - Where the index directory should be located. +If no index is found at the specified location, +one will be created.</li> + +<li><b>language</b> - The language of the documents in your collection, +indicated by a two-letter ISO code. +12 languages are supported: +<pre>|-----------------------| +| Language | ISO code | +|-----------------------| +| Danish | da | +| Dutch | nl | +| English | en | +| Finnish | fi | +| French | fr | +| German | de | +| Italian | it | +| Norwegian | no | +| Portuguese | pt | +| Spanish | es | +| Swedish | sv | +| Russian | ru | +|-----------------------|</pre> +</li> +</ul> + +<h2><a class='u' +name="METHODS" +>METHODS</a></h2> + +<h3><a class='u' +name="add_doc" +>add_doc</a></h3> + +<pre>$lucy->add_doc({ + location => $url, + title => $title, + content => $content, +});</pre> + +<p>Add a document to the index. +The document must be supplied as a hashref, +with field names as keys and content as values.</p> + +<h3><a class='u' +name="search" +>search</a></h3> + +<pre>my $int = $simple->search( + query => $query # required + offset => $offset # default: 0 + num_wanted => $num_wanted # default: 10 +);</pre> + +<p>Search the index. +Returns the total number of documents which match the query. +(This number is unlikely to match <code>num_wanted</code>.)</p> + +<ul> +<li><b>query</b> - A search query string.</li> + +<li><b>offset</b> - The number of most-relevant hits to discard, +typically used when “paging” through hits N at a time. +Setting offset to 20 and num_wanted to 10 retrieves hits 21-30, +assuming that 30 hits can be found.</li> + +<li><b>num_wanted</b> - The number of hits you would like to see after <code>offset</code> is taken into account.</li> +</ul> + +<h3><a class='u' +name="next" +>next</a></h3> + +<pre>my $hit_doc = $simple->next();</pre> + +<p>Return the next hit, +or undef when the iterator is exhausted.</p> + +<h2><a class='u' +name="INHERITANCE" +>INHERITANCE</a></h2> + +<p>Lucy::Simple isa Clownfish::Obj.</p> + +</div> + + </div> <!-- lucy-main_content_box --> + <div class="clear"></div> + + </div> <!-- lucy-main_content --> + + <div id="lucy-copyright" class="container_16"> + <p>Copyright © 2010-2015 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0</a>. + <br/> + Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The + Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their + respective owners. + </p> + </div> <!-- lucy-copyright --> + + </div> <!-- lucy-rigid_wrapper --> + + </body> +</html>
Added: websites/staging/lucy/trunk/content/docs/0.5.0/perl/Lucy/Store/FSFolder.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/0.5.0/perl/Lucy/Store/FSFolder.html (added) +++ websites/staging/lucy/trunk/content/docs/0.5.0/perl/Lucy/Store/FSFolder.html Wed Sep 28 12:07:48 2016 @@ -0,0 +1,143 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> + <title>Lucy::Store::FSFolder â Apache Lucy Documentation</title> + <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css"> + </head> + + <body> + + <div id="lucy-rigid_wrapper"> + + <div id="lucy-top" class="container_16 lucy-white_box_3d"> + + <div id="lucy-logo_box" class="grid_8"> + <a href="/"><img src="/images/lucy_logo_150x100.png" alt="Apache Lucyâ¢"></a> + </div> <!-- lucy-logo_box --> + + <div #id="lucy-top_nav_box" class="grid_8"> + <div id="lucy-top_nav_bar" class="container_8"> + <ul> + <li><a href="http://www.apache.org/"; title="Apache Software Foundation">Apache Software Foundation</a></li> + <li><a href="http://www.apache.org/licenses/"; title="License">License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html"; title="Sponsorship">Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html"; title="Thanks">Thanks</a></li> + <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li> + </ul> + </div> <!-- lucy-top_nav_bar --> + <p><a href="http://www.apache.org/";>Apache</a> » <a href="/">Lucy</a> » <a href="/docs/">Docs</a> » <a href="/docs/0.5.0/">0.5.0</a> » <a href="/docs/0.5.0/perl/">Perl</a> » <a href="/docs/0.5.0/perl/Lucy/">Lucy</a> » <a href="/docs/0.5.0/perl/Lucy/Store/">Store</a></p> + <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search"; method="get"> + <input value="*.apache.org" name="sitesearch" type="hidden"/> + <input type="text" name="q" id="query" style="width:85%"> + <input type="submit" id="submit" value="Search"> + </form> + </div> <!-- lucy-top_nav_box --> + + <div class="clear"></div> + + </div> <!-- lucy-top --> + + <div id="lucy-main_content" class="container_16 lucy-white_box_3d"> + + <div class="grid_4" id="lucy-left_nav_box"> + <h6>About</h6> + <ul> + <li><a href="/">Welcome</a></li> + <li><a href="/clownfish.html">Clownfish</a></li> + <li><a href="/faq.html">FAQ</a></li> + <li><a href="/people.html">People</a></li> + </ul> + <h6>Resources</h6> + <ul> + <li><a href="/download.html">Download</a></li> + <li><a href="/mailing_lists.html">Mailing Lists</a></li> + <li><a href="/docs/">Documentation</a></li> + <li><a href="http://wiki.apache.org/lucy/";>Wiki</a></li> + <li><a href="https://issues.apache.org/jira/browse/LUCY";>Issue Tracker</a></li> + <li><a href="/version_control.html">Version Control</a></li> + </ul> + <h6>Related Projects</h6> + <ul> + <li><a href="http://lucene.apache.org/core/";>Lucene</a></li> + <li><a href="http://dezi.org/";>Dezi</a></li> + <li><a href="http://lucene.apache.org/solr/";>Solr</a></li> + <li><a href="http://lucenenet.apache.org/";>Lucene.NET</a></li> + <li><a href="http://lucene.apache.org/pylucene/";>PyLucene</a></li> + </ul> + </div> <!-- lucy-left_nav_box --> + + <div id="lucy-main_content_box" class="grid_9"> + <div> +<a name='___top' class='dummyTopAnchor' ></a> + +<h2><a class='u' +name="NAME" +>NAME</a></h2> + +<p>Lucy::Store::FSFolder - File System implementation of Folder.</p> + +<h2><a class='u' +name="SYNOPSIS" +>SYNOPSIS</a></h2> + +<pre>my $folder = Lucy::Store::FSFolder->new( + path => '/path/to/folder', +);</pre> + +<h2><a class='u' +name="DESCRIPTION" +>DESCRIPTION</a></h2> + +<p>Implementation of <a href="../../Lucy/Store/Folder.html" class="podlinkpod" +>Folder</a> using a single file system directory and multiple files.</p> + +<h2><a class='u' +name="CONSTRUCTORS" +>CONSTRUCTORS</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> +</ul> + +<h2><a class='u' +name="INHERITANCE" +>INHERITANCE</a></h2> + +<p>Lucy::Store::FSFolder isa <a href="../../Lucy/Store/Folder.html" class="podlinkpod" +>Lucy::Store::Folder</a> isa Clownfish::Obj.</p> + +</div> + + </div> <!-- lucy-main_content_box --> + <div class="clear"></div> + + </div> <!-- lucy-main_content --> + + <div id="lucy-copyright" class="container_16"> + <p>Copyright © 2010-2015 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0</a>. + <br/> + Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The + Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their + respective owners. + </p> + </div> <!-- lucy-copyright --> + + </div> <!-- lucy-rigid_wrapper --> + + </body> +</html> Added: websites/staging/lucy/trunk/content/docs/0.5.0/perl/Lucy/Store/Folder.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/0.5.0/perl/Lucy/Store/Folder.html (added) +++ websites/staging/lucy/trunk/content/docs/0.5.0/perl/Lucy/Store/Folder.html Wed Sep 28 12:07:48 2016 @@ -0,0 +1,127 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> + <title>Lucy::Store::Folder â Apache Lucy Documentation</title> + <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css"> + </head> + + <body> + + <div id="lucy-rigid_wrapper"> + + <div id="lucy-top" class="container_16 lucy-white_box_3d"> + + <div id="lucy-logo_box" class="grid_8"> + <a href="/"><img src="/images/lucy_logo_150x100.png" alt="Apache Lucyâ¢"></a> + </div> <!-- lucy-logo_box --> + + <div #id="lucy-top_nav_box" class="grid_8"> + <div id="lucy-top_nav_bar" class="container_8"> + <ul> + <li><a href="http://www.apache.org/"; title="Apache Software Foundation">Apache Software Foundation</a></li> + <li><a href="http://www.apache.org/licenses/"; title="License">License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html"; title="Sponsorship">Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html"; title="Thanks">Thanks</a></li> + <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li> + </ul> + </div> <!-- lucy-top_nav_bar --> + <p><a href="http://www.apache.org/";>Apache</a> » <a href="/">Lucy</a> » <a href="/docs/">Docs</a> » <a href="/docs/0.5.0/">0.5.0</a> » <a href="/docs/0.5.0/perl/">Perl</a> » <a href="/docs/0.5.0/perl/Lucy/">Lucy</a> » <a href="/docs/0.5.0/perl/Lucy/Store/">Store</a></p> + <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search"; method="get"> + <input value="*.apache.org" name="sitesearch" type="hidden"/> + <input type="text" name="q" id="query" style="width:85%"> + <input type="submit" id="submit" value="Search"> + </form> + </div> <!-- lucy-top_nav_box --> + + <div class="clear"></div> + + </div> <!-- lucy-top --> + + <div id="lucy-main_content" class="container_16 lucy-white_box_3d"> + + <div class="grid_4" id="lucy-left_nav_box"> + <h6>About</h6> + <ul> + <li><a href="/">Welcome</a></li> + <li><a href="/clownfish.html">Clownfish</a></li> + <li><a href="/faq.html">FAQ</a></li> + <li><a href="/people.html">People</a></li> + </ul> + <h6>Resources</h6> + <ul> + <li><a href="/download.html">Download</a></li> + <li><a href="/mailing_lists.html">Mailing Lists</a></li> + <li><a href="/docs/">Documentation</a></li> + <li><a href="http://wiki.apache.org/lucy/";>Wiki</a></li> + <li><a href="https://issues.apache.org/jira/browse/LUCY";>Issue Tracker</a></li> + <li><a href="/version_control.html">Version Control</a></li> + </ul> + <h6>Related Projects</h6> + <ul> + <li><a href="http://lucene.apache.org/core/";>Lucene</a></li> + <li><a href="http://dezi.org/";>Dezi</a></li> + <li><a href="http://lucene.apache.org/solr/";>Solr</a></li> + <li><a href="http://lucenenet.apache.org/";>Lucene.NET</a></li> + <li><a href="http://lucene.apache.org/pylucene/";>PyLucene</a></li> + </ul> + </div> <!-- lucy-left_nav_box --> + + <div id="lucy-main_content_box" class="grid_9"> + <div> +<a name='___top' class='dummyTopAnchor' ></a> + +<h2><a class='u' +name="NAME" +>NAME</a></h2> + +<p>Lucy::Store::Folder - Abstract class representing a directory.</p> + +<h2><a class='u' +name="SYNOPSIS" +>SYNOPSIS</a></h2> + +<pre># Abstract base class.</pre> + +<h2><a class='u' +name="DESCRIPTION" +>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>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> + +<h2><a class='u' +name="INHERITANCE" +>INHERITANCE</a></h2> + +<p>Lucy::Store::Folder isa Clownfish::Obj.</p> + +</div> + + </div> <!-- lucy-main_content_box --> + <div class="clear"></div> + + </div> <!-- lucy-main_content --> + + <div id="lucy-copyright" class="container_16"> + <p>Copyright © 2010-2015 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0</a>. + <br/> + Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The + Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their + respective owners. + </p> + </div> <!-- lucy-copyright --> + + </div> <!-- lucy-rigid_wrapper --> + + </body> +</html> Added: websites/staging/lucy/trunk/content/docs/0.5.0/perl/Lucy/Store/Lock.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/0.5.0/perl/Lucy/Store/Lock.html (added) +++ websites/staging/lucy/trunk/content/docs/0.5.0/perl/Lucy/Store/Lock.html Wed Sep 28 12:07:48 2016 @@ -0,0 +1,243 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> + <title>Lucy::Store::Lock â Apache Lucy Documentation</title> + <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css"> + </head> + + <body> + + <div id="lucy-rigid_wrapper"> + + <div id="lucy-top" class="container_16 lucy-white_box_3d"> + + <div id="lucy-logo_box" class="grid_8"> + <a href="/"><img src="/images/lucy_logo_150x100.png" alt="Apache Lucyâ¢"></a> + </div> <!-- lucy-logo_box --> + + <div #id="lucy-top_nav_box" class="grid_8"> + <div id="lucy-top_nav_bar" class="container_8"> + <ul> + <li><a href="http://www.apache.org/"; title="Apache Software Foundation">Apache Software Foundation</a></li> + <li><a href="http://www.apache.org/licenses/"; title="License">License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html"; title="Sponsorship">Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html"; title="Thanks">Thanks</a></li> + <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li> + </ul> + </div> <!-- lucy-top_nav_bar --> + <p><a href="http://www.apache.org/";>Apache</a> » <a href="/">Lucy</a> » <a href="/docs/">Docs</a> » <a href="/docs/0.5.0/">0.5.0</a> » <a href="/docs/0.5.0/perl/">Perl</a> » <a href="/docs/0.5.0/perl/Lucy/">Lucy</a> » <a href="/docs/0.5.0/perl/Lucy/Store/">Store</a></p> + <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search"; method="get"> + <input value="*.apache.org" name="sitesearch" type="hidden"/> + <input type="text" name="q" id="query" style="width:85%"> + <input type="submit" id="submit" value="Search"> + </form> + </div> <!-- lucy-top_nav_box --> + + <div class="clear"></div> + + </div> <!-- lucy-top --> + + <div id="lucy-main_content" class="container_16 lucy-white_box_3d"> + + <div class="grid_4" id="lucy-left_nav_box"> + <h6>About</h6> + <ul> + <li><a href="/">Welcome</a></li> + <li><a href="/clownfish.html">Clownfish</a></li> + <li><a href="/faq.html">FAQ</a></li> + <li><a href="/people.html">People</a></li> + </ul> + <h6>Resources</h6> + <ul> + <li><a href="/download.html">Download</a></li> + <li><a href="/mailing_lists.html">Mailing Lists</a></li> + <li><a href="/docs/">Documentation</a></li> + <li><a href="http://wiki.apache.org/lucy/";>Wiki</a></li> + <li><a href="https://issues.apache.org/jira/browse/LUCY";>Issue Tracker</a></li> + <li><a href="/version_control.html">Version Control</a></li> + </ul> + <h6>Related Projects</h6> + <ul> + <li><a href="http://lucene.apache.org/core/";>Lucene</a></li> + <li><a href="http://dezi.org/";>Dezi</a></li> + <li><a href="http://lucene.apache.org/solr/";>Solr</a></li> + <li><a href="http://lucenenet.apache.org/";>Lucene.NET</a></li> + <li><a href="http://lucene.apache.org/pylucene/";>PyLucene</a></li> + </ul> + </div> <!-- lucy-left_nav_box --> + + <div id="lucy-main_content_box" class="grid_9"> + <div> +<a name='___top' class='dummyTopAnchor' ></a> + +<h2><a class='u' +name="NAME" +>NAME</a></h2> + +<p>Lucy::Store::Lock - Abstract class representing an interprocess mutex lock.</p> + +<h2><a class='u' +name="SYNOPSIS" +>SYNOPSIS</a></h2> + +<pre>my $lock = $lock_factory->make_lock( + name => 'write', + timeout => 5000, +); +$lock->obtain or die "can't get lock for " . $lock->get_name; +do_stuff(); +$lock->release;</pre> + +<h2><a class='u' +name="DESCRIPTION" +>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> + +<h2><a class='u' +name="CONSTRUCTORS" +>CONSTRUCTORS</a></h2> + +<h3><a class='u' +name="new" +>new</a></h3> + +<pre>my $lock = Lucy::Store::Lock->new( + name => 'commit', # required + folder => $folder, # required + host => $hostname, # required + timeout => 5000, # default: 0 + interval => 1000, # default: 100 +);</pre> + +<p>Abstract constructor.</p> + +<ul> +<li><b>folder</b> - A Folder.</li> + +<li><b>name</b> - String identifying the resource to be locked, +which must consist solely of characters matching [-_.A-Za-z0-9].</li> + +<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 <a href="#obtain" class="podlinkpod" +>obtain()</a> a lock.</li> + +<li><b>interval</b> - Time in milliseconds between retries.</li> +</ul> + +<h2><a class='u' +name="ABSTRACT_METHODS" +>ABSTRACT METHODS</a></h2> + +<h3><a class='u' +name="shared" +>shared</a></h3> + +<pre>my $bool = $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 $bool = $lock->request();</pre> + +<p>Make one attempt to acquire the lock.</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> + +<pre>$lock->release();</pre> + +<p>Release the lock.</p> + +<h3><a class='u' +name="is_locked" +>is_locked</a></h3> + +<pre>my $bool = $lock->is_locked();</pre> + +<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> + +<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> + +<h2><a class='u' +name="METHODS" +>METHODS</a></h2> + +<h3><a class='u' +name="obtain" +>obtain</a></h3> + +<pre>my $bool = $lock->obtain();</pre> + +<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 the global error object returned by Clownfish->error).</p> + +<h2><a class='u' +name="INHERITANCE" +>INHERITANCE</a></h2> + +<p>Lucy::Store::Lock isa Clownfish::Obj.</p> + +</div> + + </div> <!-- lucy-main_content_box --> + <div class="clear"></div> + + </div> <!-- lucy-main_content --> + + <div id="lucy-copyright" class="container_16"> + <p>Copyright © 2010-2015 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0</a>. + <br/> + Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The + Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their + respective owners. + </p> + </div> <!-- lucy-copyright --> + + </div> <!-- lucy-rigid_wrapper --> + + </body> +</html> Added: websites/staging/lucy/trunk/content/docs/0.5.0/perl/Lucy/Store/LockErr.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/0.5.0/perl/Lucy/Store/LockErr.html (added) +++ websites/staging/lucy/trunk/content/docs/0.5.0/perl/Lucy/Store/LockErr.html Wed Sep 28 12:07:48 2016 @@ -0,0 +1,131 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> + <title>Lucy::Store::LockErr â Apache Lucy Documentation</title> + <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css"> + </head> + + <body> + + <div id="lucy-rigid_wrapper"> + + <div id="lucy-top" class="container_16 lucy-white_box_3d"> + + <div id="lucy-logo_box" class="grid_8"> + <a href="/"><img src="/images/lucy_logo_150x100.png" alt="Apache Lucyâ¢"></a> + </div> <!-- lucy-logo_box --> + + <div #id="lucy-top_nav_box" class="grid_8"> + <div id="lucy-top_nav_bar" class="container_8"> + <ul> + <li><a href="http://www.apache.org/"; title="Apache Software Foundation">Apache Software Foundation</a></li> + <li><a href="http://www.apache.org/licenses/"; title="License">License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html"; title="Sponsorship">Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html"; title="Thanks">Thanks</a></li> + <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li> + </ul> + </div> <!-- lucy-top_nav_bar --> + <p><a href="http://www.apache.org/";>Apache</a> » <a href="/">Lucy</a> » <a href="/docs/">Docs</a> » <a href="/docs/0.5.0/">0.5.0</a> » <a href="/docs/0.5.0/perl/">Perl</a> » <a href="/docs/0.5.0/perl/Lucy/">Lucy</a> » <a href="/docs/0.5.0/perl/Lucy/Store/">Store</a></p> + <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search"; method="get"> + <input value="*.apache.org" name="sitesearch" type="hidden"/> + <input type="text" name="q" id="query" style="width:85%"> + <input type="submit" id="submit" value="Search"> + </form> + </div> <!-- lucy-top_nav_box --> + + <div class="clear"></div> + + </div> <!-- lucy-top --> + + <div id="lucy-main_content" class="container_16 lucy-white_box_3d"> + + <div class="grid_4" id="lucy-left_nav_box"> + <h6>About</h6> + <ul> + <li><a href="/">Welcome</a></li> + <li><a href="/clownfish.html">Clownfish</a></li> + <li><a href="/faq.html">FAQ</a></li> + <li><a href="/people.html">People</a></li> + </ul> + <h6>Resources</h6> + <ul> + <li><a href="/download.html">Download</a></li> + <li><a href="/mailing_lists.html">Mailing Lists</a></li> + <li><a href="/docs/">Documentation</a></li> + <li><a href="http://wiki.apache.org/lucy/";>Wiki</a></li> + <li><a href="https://issues.apache.org/jira/browse/LUCY";>Issue Tracker</a></li> + <li><a href="/version_control.html">Version Control</a></li> + </ul> + <h6>Related Projects</h6> + <ul> + <li><a href="http://lucene.apache.org/core/";>Lucene</a></li> + <li><a href="http://dezi.org/";>Dezi</a></li> + <li><a href="http://lucene.apache.org/solr/";>Solr</a></li> + <li><a href="http://lucenenet.apache.org/";>Lucene.NET</a></li> + <li><a href="http://lucene.apache.org/pylucene/";>PyLucene</a></li> + </ul> + </div> <!-- lucy-left_nav_box --> + + <div id="lucy-main_content_box" class="grid_9"> + <div> +<a name='___top' class='dummyTopAnchor' ></a> + +<h2><a class='u' +name="NAME" +>NAME</a></h2> + +<p>Lucy::Store::LockErr - Lock exception.</p> + +<h2><a class='u' +name="SYNOPSIS" +>SYNOPSIS</a></h2> + +<pre>while (1) { + my $bg_merger = eval { + Lucy::Index::BackgroundMerger->new( index => $index ); + }; + if ( blessed($@) and $@->isa("Lucy::Store::LockErr") ) { + warn "Retrying...\n"; + } + elsif (!$bg_merger) { + # Re-throw. + die "Failed to open BackgroundMerger: $@"; + } + ... +}</pre> + +<h2><a class='u' +name="DESCRIPTION" +>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> + +<h2><a class='u' +name="INHERITANCE" +>INHERITANCE</a></h2> + +<p>Lucy::Store::LockErr isa Clownfish::Err isa Clownfish::Obj.</p> + +</div> + + </div> <!-- lucy-main_content_box --> + <div class="clear"></div> + + </div> <!-- lucy-main_content --> + + <div id="lucy-copyright" class="container_16"> + <p>Copyright © 2010-2015 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0</a>. + <br/> + Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The + Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their + respective owners. + </p> + </div> <!-- lucy-copyright --> + + </div> <!-- lucy-rigid_wrapper --> + + </body> +</html> Added: websites/staging/lucy/trunk/content/docs/0.5.0/perl/Lucy/Store/LockFactory.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/0.5.0/perl/Lucy/Store/LockFactory.html (added) +++ websites/staging/lucy/trunk/content/docs/0.5.0/perl/Lucy/Store/LockFactory.html Wed Sep 28 12:07:48 2016 @@ -0,0 +1,208 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> + <title>Lucy::Store::LockFactory â Apache Lucy Documentation</title> + <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css"> + </head> + + <body> + + <div id="lucy-rigid_wrapper"> + + <div id="lucy-top" class="container_16 lucy-white_box_3d"> + + <div id="lucy-logo_box" class="grid_8"> + <a href="/"><img src="/images/lucy_logo_150x100.png" alt="Apache Lucyâ¢"></a> + </div> <!-- lucy-logo_box --> + + <div #id="lucy-top_nav_box" class="grid_8"> + <div id="lucy-top_nav_bar" class="container_8"> + <ul> + <li><a href="http://www.apache.org/"; title="Apache Software Foundation">Apache Software Foundation</a></li> + <li><a href="http://www.apache.org/licenses/"; title="License">License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html"; title="Sponsorship">Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html"; title="Thanks">Thanks</a></li> + <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li> + </ul> + </div> <!-- lucy-top_nav_bar --> + <p><a href="http://www.apache.org/";>Apache</a> » <a href="/">Lucy</a> » <a href="/docs/">Docs</a> » <a href="/docs/0.5.0/">0.5.0</a> » <a href="/docs/0.5.0/perl/">Perl</a> » <a href="/docs/0.5.0/perl/Lucy/">Lucy</a> » <a href="/docs/0.5.0/perl/Lucy/Store/">Store</a></p> + <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search"; method="get"> + <input value="*.apache.org" name="sitesearch" type="hidden"/> + <input type="text" name="q" id="query" style="width:85%"> + <input type="submit" id="submit" value="Search"> + </form> + </div> <!-- lucy-top_nav_box --> + + <div class="clear"></div> + + </div> <!-- lucy-top --> + + <div id="lucy-main_content" class="container_16 lucy-white_box_3d"> + + <div class="grid_4" id="lucy-left_nav_box"> + <h6>About</h6> + <ul> + <li><a href="/">Welcome</a></li> + <li><a href="/clownfish.html">Clownfish</a></li> + <li><a href="/faq.html">FAQ</a></li> + <li><a href="/people.html">People</a></li> + </ul> + <h6>Resources</h6> + <ul> + <li><a href="/download.html">Download</a></li> + <li><a href="/mailing_lists.html">Mailing Lists</a></li> + <li><a href="/docs/">Documentation</a></li> + <li><a href="http://wiki.apache.org/lucy/";>Wiki</a></li> + <li><a href="https://issues.apache.org/jira/browse/LUCY";>Issue Tracker</a></li> + <li><a href="/version_control.html">Version Control</a></li> + </ul> + <h6>Related Projects</h6> + <ul> + <li><a href="http://lucene.apache.org/core/";>Lucene</a></li> + <li><a href="http://dezi.org/";>Dezi</a></li> + <li><a href="http://lucene.apache.org/solr/";>Solr</a></li> + <li><a href="http://lucenenet.apache.org/";>Lucene.NET</a></li> + <li><a href="http://lucene.apache.org/pylucene/";>PyLucene</a></li> + </ul> + </div> <!-- lucy-left_nav_box --> + + <div id="lucy-main_content_box" class="grid_9"> + <div> +<a name='___top' class='dummyTopAnchor' ></a> + +<h2><a class='u' +name="NAME" +>NAME</a></h2> + +<p>Lucy::Store::LockFactory - Create Locks.</p> + +<h2><a class='u' +name="SYNOPSIS" +>SYNOPSIS</a></h2> + +<pre>use Sys::Hostname qw( hostname ); +my $hostname = hostname() or die "Can't get unique hostname"; +my $folder = Lucy::Store::FSFolder->new( + path => '/path/to/index', +); +my $lock_factory = Lucy::Store::LockFactory->new( + folder => $folder, + host => $hostname, +); +my $write_lock = $lock_factory->make_lock( + name => 'write', + timeout => 5000, + interval => 100, +);</pre> + +<h2><a class='u' +name="DESCRIPTION" +>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> + +<h2><a class='u' +name="CONSTRUCTORS" +>CONSTRUCTORS</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" +>Folder</a>.</li> + +<li><b>host</b> - An identifier which should be unique per-machine.</li> +</ul> + +<h2><a class='u' +name="METHODS" +>METHODS</a></h2> + +<h3><a class='u' +name="make_lock" +>make_lock</a></h3> + +<pre>my $lock = $lock_factory->make_lock( + name => $name # required + timeout => $timeout # default: 0 + interval => $interval # default: 100 +);</pre> + +<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 <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> + +<h3><a class='u' +name="make_shared_lock" +>make_shared_lock</a></h3> + +<pre>my $lock = $lock_factory->make_shared_lock( + name => $name # required + timeout => $timeout # default: 0 + interval => $interval # default: 100 +);</pre> + +<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 <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' +name="INHERITANCE" +>INHERITANCE</a></h2> + +<p>Lucy::Store::LockFactory isa Clownfish::Obj.</p> + +</div> + + </div> <!-- lucy-main_content_box --> + <div class="clear"></div> + + </div> <!-- lucy-main_content --> + + <div id="lucy-copyright" class="container_16"> + <p>Copyright © 2010-2015 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0</a>. + <br/> + Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The + Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their + respective owners. + </p> + </div> <!-- lucy-copyright --> + + </div> <!-- lucy-rigid_wrapper --> + + </body> +</html> Added: websites/staging/lucy/trunk/content/docs/0.5.0/perl/Lucy/Store/RAMFolder.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/0.5.0/perl/Lucy/Store/RAMFolder.html (added) +++ websites/staging/lucy/trunk/content/docs/0.5.0/perl/Lucy/Store/RAMFolder.html Wed Sep 28 12:07:48 2016 @@ -0,0 +1,145 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> + <title>Lucy::Store::RAMFolder â Apache Lucy Documentation</title> + <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css"> + </head> + + <body> + + <div id="lucy-rigid_wrapper"> + + <div id="lucy-top" class="container_16 lucy-white_box_3d"> + + <div id="lucy-logo_box" class="grid_8"> + <a href="/"><img src="/images/lucy_logo_150x100.png" alt="Apache Lucyâ¢"></a> + </div> <!-- lucy-logo_box --> + + <div #id="lucy-top_nav_box" class="grid_8"> + <div id="lucy-top_nav_bar" class="container_8"> + <ul> + <li><a href="http://www.apache.org/"; title="Apache Software Foundation">Apache Software Foundation</a></li> + <li><a href="http://www.apache.org/licenses/"; title="License">License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html"; title="Sponsorship">Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html"; title="Thanks">Thanks</a></li> + <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li> + </ul> + </div> <!-- lucy-top_nav_bar --> + <p><a href="http://www.apache.org/";>Apache</a> » <a href="/">Lucy</a> » <a href="/docs/">Docs</a> » <a href="/docs/0.5.0/">0.5.0</a> » <a href="/docs/0.5.0/perl/">Perl</a> » <a href="/docs/0.5.0/perl/Lucy/">Lucy</a> » <a href="/docs/0.5.0/perl/Lucy/Store/">Store</a></p> + <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search"; method="get"> + <input value="*.apache.org" name="sitesearch" type="hidden"/> + <input type="text" name="q" id="query" style="width:85%"> + <input type="submit" id="submit" value="Search"> + </form> + </div> <!-- lucy-top_nav_box --> + + <div class="clear"></div> + + </div> <!-- lucy-top --> + + <div id="lucy-main_content" class="container_16 lucy-white_box_3d"> + + <div class="grid_4" id="lucy-left_nav_box"> + <h6>About</h6> + <ul> + <li><a href="/">Welcome</a></li> + <li><a href="/clownfish.html">Clownfish</a></li> + <li><a href="/faq.html">FAQ</a></li> + <li><a href="/people.html">People</a></li> + </ul> + <h6>Resources</h6> + <ul> + <li><a href="/download.html">Download</a></li> + <li><a href="/mailing_lists.html">Mailing Lists</a></li> + <li><a href="/docs/">Documentation</a></li> + <li><a href="http://wiki.apache.org/lucy/";>Wiki</a></li> + <li><a href="https://issues.apache.org/jira/browse/LUCY";>Issue Tracker</a></li> + <li><a href="/version_control.html">Version Control</a></li> + </ul> + <h6>Related Projects</h6> + <ul> + <li><a href="http://lucene.apache.org/core/";>Lucene</a></li> + <li><a href="http://dezi.org/";>Dezi</a></li> + <li><a href="http://lucene.apache.org/solr/";>Solr</a></li> + <li><a href="http://lucenenet.apache.org/";>Lucene.NET</a></li> + <li><a href="http://lucene.apache.org/pylucene/";>PyLucene</a></li> + </ul> + </div> <!-- lucy-left_nav_box --> + + <div id="lucy-main_content_box" class="grid_9"> + <div> +<a name='___top' class='dummyTopAnchor' ></a> + +<h2><a class='u' +name="NAME" +>NAME</a></h2> + +<p>Lucy::Store::RAMFolder - In-memory Folder implementation.</p> + +<h2><a class='u' +name="SYNOPSIS" +>SYNOPSIS</a></h2> + +<pre>my $folder = Lucy::Store::RAMFolder->new; + +# or sometimes... +my $folder = Lucy::Store::RAMFolder->new( + path => $relative_path, +);</pre> + +<h2><a class='u' +name="DESCRIPTION" +>DESCRIPTION</a></h2> + +<p>RAMFolder is an entirely in-memory implementation of <a href="../../Lucy/Store/Folder.html" class="podlinkpod" +>Folder</a>, +primarily used for testing and development.</p> + +<h2><a class='u' +name="CONSTRUCTORS" +>CONSTRUCTORS</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> + +<h2><a class='u' +name="INHERITANCE" +>INHERITANCE</a></h2> + +<p>Lucy::Store::RAMFolder isa <a href="../../Lucy/Store/Folder.html" class="podlinkpod" +>Lucy::Store::Folder</a> isa Clownfish::Obj.</p> + +</div> + + </div> <!-- lucy-main_content_box --> + <div class="clear"></div> + + </div> <!-- lucy-main_content --> + + <div id="lucy-copyright" class="container_16"> + <p>Copyright © 2010-2015 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0</a>. + <br/> + Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The + Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their + respective owners. + </p> + </div> <!-- lucy-copyright --> + + </div> <!-- lucy-rigid_wrapper --> + + </body> +</html> Added: websites/staging/lucy/trunk/content/docs/0.5.0/perl/LucyX/Index/ByteBufDocReader.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/0.5.0/perl/LucyX/Index/ByteBufDocReader.html (added) +++ websites/staging/lucy/trunk/content/docs/0.5.0/perl/LucyX/Index/ByteBufDocReader.html Wed Sep 28 12:07:48 2016 @@ -0,0 +1,113 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> + <title>LucyX::Index::ByteBufDocReader â Apache Lucy Documentation</title> + <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css"> + </head> + + <body> + + <div id="lucy-rigid_wrapper"> + + <div id="lucy-top" class="container_16 lucy-white_box_3d"> + + <div id="lucy-logo_box" class="grid_8"> + <a href="/"><img src="/images/lucy_logo_150x100.png" alt="Apache Lucyâ¢"></a> + </div> <!-- lucy-logo_box --> + + <div #id="lucy-top_nav_box" class="grid_8"> + <div id="lucy-top_nav_bar" class="container_8"> + <ul> + <li><a href="http://www.apache.org/"; title="Apache Software Foundation">Apache Software Foundation</a></li> + <li><a href="http://www.apache.org/licenses/"; title="License">License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html"; title="Sponsorship">Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html"; title="Thanks">Thanks</a></li> + <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li> + </ul> + </div> <!-- lucy-top_nav_bar --> + <p><a href="http://www.apache.org/";>Apache</a> » <a href="/">Lucy</a> » <a href="/docs/">Docs</a> » <a href="/docs/0.5.0/">0.5.0</a> » <a href="/docs/0.5.0/perl/">Perl</a> » <a href="/docs/0.5.0/perl/LucyX/">LucyX</a> » <a href="/docs/0.5.0/perl/LucyX/Index/">Index</a></p> + <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search"; method="get"> + <input value="*.apache.org" name="sitesearch" type="hidden"/> + <input type="text" name="q" id="query" style="width:85%"> + <input type="submit" id="submit" value="Search"> + </form> + </div> <!-- lucy-top_nav_box --> + + <div class="clear"></div> + + </div> <!-- lucy-top --> + + <div id="lucy-main_content" class="container_16 lucy-white_box_3d"> + + <div class="grid_4" id="lucy-left_nav_box"> + <h6>About</h6> + <ul> + <li><a href="/">Welcome</a></li> + <li><a href="/clownfish.html">Clownfish</a></li> + <li><a href="/faq.html">FAQ</a></li> + <li><a href="/people.html">People</a></li> + </ul> + <h6>Resources</h6> + <ul> + <li><a href="/download.html">Download</a></li> + <li><a href="/mailing_lists.html">Mailing Lists</a></li> + <li><a href="/docs/">Documentation</a></li> + <li><a href="http://wiki.apache.org/lucy/";>Wiki</a></li> + <li><a href="https://issues.apache.org/jira/browse/LUCY";>Issue Tracker</a></li> + <li><a href="/version_control.html">Version Control</a></li> + </ul> + <h6>Related Projects</h6> + <ul> + <li><a href="http://lucene.apache.org/core/";>Lucene</a></li> + <li><a href="http://dezi.org/";>Dezi</a></li> + <li><a href="http://lucene.apache.org/solr/";>Solr</a></li> + <li><a href="http://lucenenet.apache.org/";>Lucene.NET</a></li> + <li><a href="http://lucene.apache.org/pylucene/";>PyLucene</a></li> + </ul> + </div> <!-- lucy-left_nav_box --> + + <div id="lucy-main_content_box" class="grid_9"> + <div> +<a name='___top' class='dummyTopAnchor' ></a> + +<h2><a class='u' +name="NAME" +>NAME</a></h2> + +<p>LucyX::Index::ByteBufDocReader - Read a Doc as a fixed-width byte array.</p> + +<h2><a class='u' +name="SYNOPSIS" +>SYNOPSIS</a></h2> + +<pre># See LucyX::Index::ByteBufDocWriter</pre> + +<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> + + </div> <!-- lucy-main_content_box --> + <div class="clear"></div> + + </div> <!-- lucy-main_content --> + + <div id="lucy-copyright" class="container_16"> + <p>Copyright © 2010-2015 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0</a>. + <br/> + Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The + Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their + respective owners. + </p> + </div> <!-- lucy-copyright --> + + </div> <!-- lucy-rigid_wrapper --> + + </body> +</html> Added: websites/staging/lucy/trunk/content/docs/0.5.0/perl/LucyX/Index/ByteBufDocWriter.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/0.5.0/perl/LucyX/Index/ByteBufDocWriter.html (added) +++ websites/staging/lucy/trunk/content/docs/0.5.0/perl/LucyX/Index/ByteBufDocWriter.html Wed Sep 28 12:07:48 2016 @@ -0,0 +1,178 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> + <title>LucyX::Index::ByteBufDocWriter â Apache Lucy Documentation</title> + <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css"> + </head> + + <body> + + <div id="lucy-rigid_wrapper"> + + <div id="lucy-top" class="container_16 lucy-white_box_3d"> + + <div id="lucy-logo_box" class="grid_8"> + <a href="/"><img src="/images/lucy_logo_150x100.png" alt="Apache Lucyâ¢"></a> + </div> <!-- lucy-logo_box --> + + <div #id="lucy-top_nav_box" class="grid_8"> + <div id="lucy-top_nav_bar" class="container_8"> + <ul> + <li><a href="http://www.apache.org/"; title="Apache Software Foundation">Apache Software Foundation</a></li> + <li><a href="http://www.apache.org/licenses/"; title="License">License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html"; title="Sponsorship">Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html"; title="Thanks">Thanks</a></li> + <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li> + </ul> + </div> <!-- lucy-top_nav_bar --> + <p><a href="http://www.apache.org/";>Apache</a> » <a href="/">Lucy</a> » <a href="/docs/">Docs</a> » <a href="/docs/0.5.0/">0.5.0</a> » <a href="/docs/0.5.0/perl/">Perl</a> » <a href="/docs/0.5.0/perl/LucyX/">LucyX</a> » <a href="/docs/0.5.0/perl/LucyX/Index/">Index</a></p> + <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search"; method="get"> + <input value="*.apache.org" name="sitesearch" type="hidden"/> + <input type="text" name="q" id="query" style="width:85%"> + <input type="submit" id="submit" value="Search"> + </form> + </div> <!-- lucy-top_nav_box --> + + <div class="clear"></div> + + </div> <!-- lucy-top --> + + <div id="lucy-main_content" class="container_16 lucy-white_box_3d"> + + <div class="grid_4" id="lucy-left_nav_box"> + <h6>About</h6> + <ul> + <li><a href="/">Welcome</a></li> + <li><a href="/clownfish.html">Clownfish</a></li> + <li><a href="/faq.html">FAQ</a></li> + <li><a href="/people.html">People</a></li> + </ul> + <h6>Resources</h6> + <ul> + <li><a href="/download.html">Download</a></li> + <li><a href="/mailing_lists.html">Mailing Lists</a></li> + <li><a href="/docs/">Documentation</a></li> + <li><a href="http://wiki.apache.org/lucy/";>Wiki</a></li> + <li><a href="https://issues.apache.org/jira/browse/LUCY";>Issue Tracker</a></li> + <li><a href="/version_control.html">Version Control</a></li> + </ul> + <h6>Related Projects</h6> + <ul> + <li><a href="http://lucene.apache.org/core/";>Lucene</a></li> + <li><a href="http://dezi.org/";>Dezi</a></li> + <li><a href="http://lucene.apache.org/solr/";>Solr</a></li> + <li><a href="http://lucenenet.apache.org/";>Lucene.NET</a></li> + <li><a href="http://lucene.apache.org/pylucene/";>PyLucene</a></li> + </ul> + </div> <!-- lucy-left_nav_box --> + + <div id="lucy-main_content_box" class="grid_9"> + <div> +<a name='___top' class='dummyTopAnchor' ></a> + +<h2><a class='u' +name="NAME" +>NAME</a></h2> + +<p>LucyX::Index::ByteBufDocWriter - Write a Doc as a fixed-width byte array.</p> + +<h2><a class='u' +name="SYNOPSIS" +>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> + +<pre>package MyArchitecture; +use base qw( Lucy::Plan::Architecture ); +use LucyX::Index::ByteBufDocReader; +use LucyX::Index::ByteBufDocWriter; + +sub register_doc_writer { + my ( $self, $seg_writer ) = @_; + my $doc_writer = LucyX::Index::ByteBufDocWriter->new( + width => 16, + field => 'value', + snapshot => $seg_writer->get_snapshot, + segment => $seg_writer->get_segment, + polyreader => $seg_writer->get_polyreader, + ); + $seg_writer->register( + api => "Lucy::Index::DocReader", + component => $doc_writer, + ); + $seg_writer->add_writer($doc_writer); +} + +sub register_doc_reader { + my ( $self, $seg_reader ) = @_; + my $doc_reader = LucyX::Index::ByteBufDocReader->new( + width => 16, + field => 'value', + schema => $seg_reader->get_schema, + folder => $seg_reader->get_folder, + segments => $seg_reader->get_segments, + seg_tick => $seg_reader->get_seg_tick, + snapshot => $seg_reader->get_snapshot, + ); + $seg_reader->register( + api => 'Lucy::Index::DocReader', + component => $doc_reader, + ); +} + +package MySchema; +use base qw( Lucy::Plan::Schema ); + +sub architecture { MyArchitecture->new }</pre> + +<p>Proceed as normal in your indexer app, +making sure that every supplied document supplies a valid value for the field in question:</p> + +<pre>$indexer->add_doc({ + title => $title, + content => $content, + id => $id, # <---- Must meet spec. +});</pre> + +<p>Then, +in your search app:</p> + +<pre>my $searcher = Lucy::Search::IndexSearcher->new( + index => '/path/to/index', +); +my $hits = $searcher->hits( query => $query ); +while ( my $id = $hits->next ) { + my $real_doc = $external_document_source->fetch( $doc->{value} ); + ... +}</pre> + +<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> + + </div> <!-- lucy-main_content_box --> + <div class="clear"></div> + + </div> <!-- lucy-main_content --> + + <div id="lucy-copyright" class="container_16"> + <p>Copyright © 2010-2015 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0</a>. + <br/> + Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The + Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their + respective owners. + </p> + </div> <!-- lucy-copyright --> + + </div> <!-- lucy-rigid_wrapper --> + + </body> +</html> Added: websites/staging/lucy/trunk/content/docs/0.5.0/perl/LucyX/Index/LongFieldSim.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/0.5.0/perl/LucyX/Index/LongFieldSim.html (added) +++ websites/staging/lucy/trunk/content/docs/0.5.0/perl/LucyX/Index/LongFieldSim.html Wed Sep 28 12:07:48 2016 @@ -0,0 +1,181 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> + <title>LucyX::Index::LongFieldSim â Apache Lucy Documentation</title> + <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css"> + </head> + + <body> + + <div id="lucy-rigid_wrapper"> + + <div id="lucy-top" class="container_16 lucy-white_box_3d"> + + <div id="lucy-logo_box" class="grid_8"> + <a href="/"><img src="/images/lucy_logo_150x100.png" alt="Apache Lucyâ¢"></a> + </div> <!-- lucy-logo_box --> + + <div #id="lucy-top_nav_box" class="grid_8"> + <div id="lucy-top_nav_bar" class="container_8"> + <ul> + <li><a href="http://www.apache.org/"; title="Apache Software Foundation">Apache Software Foundation</a></li> + <li><a href="http://www.apache.org/licenses/"; title="License">License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html"; title="Sponsorship">Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html"; title="Thanks">Thanks</a></li> + <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li> + </ul> + </div> <!-- lucy-top_nav_bar --> + <p><a href="http://www.apache.org/";>Apache</a> » <a href="/">Lucy</a> » <a href="/docs/">Docs</a> » <a href="/docs/0.5.0/">0.5.0</a> » <a href="/docs/0.5.0/perl/">Perl</a> » <a href="/docs/0.5.0/perl/LucyX/">LucyX</a> » <a href="/docs/0.5.0/perl/LucyX/Index/">Index</a></p> + <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search"; method="get"> + <input value="*.apache.org" name="sitesearch" type="hidden"/> + <input type="text" name="q" id="query" style="width:85%"> + <input type="submit" id="submit" value="Search"> + </form> + </div> <!-- lucy-top_nav_box --> + + <div class="clear"></div> + + </div> <!-- lucy-top --> + + <div id="lucy-main_content" class="container_16 lucy-white_box_3d"> + + <div class="grid_4" id="lucy-left_nav_box"> + <h6>About</h6> + <ul> + <li><a href="/">Welcome</a></li> + <li><a href="/clownfish.html">Clownfish</a></li> + <li><a href="/faq.html">FAQ</a></li> + <li><a href="/people.html">People</a></li> + </ul> + <h6>Resources</h6> + <ul> + <li><a href="/download.html">Download</a></li> + <li><a href="/mailing_lists.html">Mailing Lists</a></li> + <li><a href="/docs/">Documentation</a></li> + <li><a href="http://wiki.apache.org/lucy/";>Wiki</a></li> + <li><a href="https://issues.apache.org/jira/browse/LUCY";>Issue Tracker</a></li> + <li><a href="/version_control.html">Version Control</a></li> + </ul> + <h6>Related Projects</h6> + <ul> + <li><a href="http://lucene.apache.org/core/";>Lucene</a></li> + <li><a href="http://dezi.org/";>Dezi</a></li> + <li><a href="http://lucene.apache.org/solr/";>Solr</a></li> + <li><a href="http://lucenenet.apache.org/";>Lucene.NET</a></li> + <li><a href="http://lucene.apache.org/pylucene/";>PyLucene</a></li> + </ul> + </div> <!-- lucy-left_nav_box --> + + <div id="lucy-main_content_box" class="grid_9"> + <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> + + </div> <!-- lucy-main_content_box --> + <div class="clear"></div> + + </div> <!-- lucy-main_content --> + + <div id="lucy-copyright" class="container_16"> + <p>Copyright © 2010-2015 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0</a>. + <br/> + Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The + Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their + respective owners. + </p> + </div> <!-- lucy-copyright --> + + </div> <!-- lucy-rigid_wrapper --> + + </body> +</html> Added: websites/staging/lucy/trunk/content/docs/0.5.0/perl/LucyX/Index/ZlibDocReader.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/0.5.0/perl/LucyX/Index/ZlibDocReader.html (added) +++ websites/staging/lucy/trunk/content/docs/0.5.0/perl/LucyX/Index/ZlibDocReader.html Wed Sep 28 12:07:48 2016 @@ -0,0 +1,107 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> + <title>LucyX::Index::ZlibDocReader â Apache Lucy Documentation</title> + <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css"> + </head> + + <body> + + <div id="lucy-rigid_wrapper"> + + <div id="lucy-top" class="container_16 lucy-white_box_3d"> + + <div id="lucy-logo_box" class="grid_8"> + <a href="/"><img src="/images/lucy_logo_150x100.png" alt="Apache Lucyâ¢"></a> + </div> <!-- lucy-logo_box --> + + <div #id="lucy-top_nav_box" class="grid_8"> + <div id="lucy-top_nav_bar" class="container_8"> + <ul> + <li><a href="http://www.apache.org/"; title="Apache Software Foundation">Apache Software Foundation</a></li> + <li><a href="http://www.apache.org/licenses/"; title="License">License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html"; title="Sponsorship">Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html"; title="Thanks">Thanks</a></li> + <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li> + </ul> + </div> <!-- lucy-top_nav_bar --> + <p><a href="http://www.apache.org/";>Apache</a> » <a href="/">Lucy</a> » <a href="/docs/">Docs</a> » <a href="/docs/0.5.0/">0.5.0</a> » <a href="/docs/0.5.0/perl/">Perl</a> » <a href="/docs/0.5.0/perl/LucyX/">LucyX</a> » <a href="/docs/0.5.0/perl/LucyX/Index/">Index</a></p> + <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search"; method="get"> + <input value="*.apache.org" name="sitesearch" type="hidden"/> + <input type="text" name="q" id="query" style="width:85%"> + <input type="submit" id="submit" value="Search"> + </form> + </div> <!-- lucy-top_nav_box --> + + <div class="clear"></div> + + </div> <!-- lucy-top --> + + <div id="lucy-main_content" class="container_16 lucy-white_box_3d"> + + <div class="grid_4" id="lucy-left_nav_box"> + <h6>About</h6> + <ul> + <li><a href="/">Welcome</a></li> + <li><a href="/clownfish.html">Clownfish</a></li> + <li><a href="/faq.html">FAQ</a></li> + <li><a href="/people.html">People</a></li> + </ul> + <h6>Resources</h6> + <ul> + <li><a href="/download.html">Download</a></li> + <li><a href="/mailing_lists.html">Mailing Lists</a></li> + <li><a href="/docs/">Documentation</a></li> + <li><a href="http://wiki.apache.org/lucy/";>Wiki</a></li> + <li><a href="https://issues.apache.org/jira/browse/LUCY";>Issue Tracker</a></li> + <li><a href="/version_control.html">Version Control</a></li> + </ul> + <h6>Related Projects</h6> + <ul> + <li><a href="http://lucene.apache.org/core/";>Lucene</a></li> + <li><a href="http://dezi.org/";>Dezi</a></li> + <li><a href="http://lucene.apache.org/solr/";>Solr</a></li> + <li><a href="http://lucenenet.apache.org/";>Lucene.NET</a></li> + <li><a href="http://lucene.apache.org/pylucene/";>PyLucene</a></li> + </ul> + </div> <!-- lucy-left_nav_box --> + + <div id="lucy-main_content_box" class="grid_9"> + <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> + + </div> <!-- lucy-main_content_box --> + <div class="clear"></div> + + </div> <!-- lucy-main_content --> + + <div id="lucy-copyright" class="container_16"> + <p>Copyright © 2010-2015 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0</a>. + <br/> + Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The + Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their + respective owners. + </p> + </div> <!-- lucy-copyright --> + + </div> <!-- lucy-rigid_wrapper --> + + </body> +</html> Added: websites/staging/lucy/trunk/content/docs/0.5.0/perl/LucyX/Index/ZlibDocWriter.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/0.5.0/perl/LucyX/Index/ZlibDocWriter.html (added) +++ websites/staging/lucy/trunk/content/docs/0.5.0/perl/LucyX/Index/ZlibDocWriter.html Wed Sep 28 12:07:48 2016 @@ -0,0 +1,107 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> + <title>LucyX::Index::ZlibDocWriter â Apache Lucy Documentation</title> + <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css"> + </head> + + <body> + + <div id="lucy-rigid_wrapper"> + + <div id="lucy-top" class="container_16 lucy-white_box_3d"> + + <div id="lucy-logo_box" class="grid_8"> + <a href="/"><img src="/images/lucy_logo_150x100.png" alt="Apache Lucyâ¢"></a> + </div> <!-- lucy-logo_box --> + + <div #id="lucy-top_nav_box" class="grid_8"> + <div id="lucy-top_nav_bar" class="container_8"> + <ul> + <li><a href="http://www.apache.org/"; title="Apache Software Foundation">Apache Software Foundation</a></li> + <li><a href="http://www.apache.org/licenses/"; title="License">License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html"; title="Sponsorship">Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html"; title="Thanks">Thanks</a></li> + <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li> + </ul> + </div> <!-- lucy-top_nav_bar --> + <p><a href="http://www.apache.org/";>Apache</a> » <a href="/">Lucy</a> » <a href="/docs/">Docs</a> » <a href="/docs/0.5.0/">0.5.0</a> » <a href="/docs/0.5.0/perl/">Perl</a> » <a href="/docs/0.5.0/perl/LucyX/">LucyX</a> » <a href="/docs/0.5.0/perl/LucyX/Index/">Index</a></p> + <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search"; method="get"> + <input value="*.apache.org" name="sitesearch" type="hidden"/> + <input type="text" name="q" id="query" style="width:85%"> + <input type="submit" id="submit" value="Search"> + </form> + </div> <!-- lucy-top_nav_box --> + + <div class="clear"></div> + + </div> <!-- lucy-top --> + + <div id="lucy-main_content" class="container_16 lucy-white_box_3d"> + + <div class="grid_4" id="lucy-left_nav_box"> + <h6>About</h6> + <ul> + <li><a href="/">Welcome</a></li> + <li><a href="/clownfish.html">Clownfish</a></li> + <li><a href="/faq.html">FAQ</a></li> + <li><a href="/people.html">People</a></li> + </ul> + <h6>Resources</h6> + <ul> + <li><a href="/download.html">Download</a></li> + <li><a href="/mailing_lists.html">Mailing Lists</a></li> + <li><a href="/docs/">Documentation</a></li> + <li><a href="http://wiki.apache.org/lucy/";>Wiki</a></li> + <li><a href="https://issues.apache.org/jira/browse/LUCY";>Issue Tracker</a></li> + <li><a href="/version_control.html">Version Control</a></li> + </ul> + <h6>Related Projects</h6> + <ul> + <li><a href="http://lucene.apache.org/core/";>Lucene</a></li> + <li><a href="http://dezi.org/";>Dezi</a></li> + <li><a href="http://lucene.apache.org/solr/";>Solr</a></li> + <li><a href="http://lucenenet.apache.org/";>Lucene.NET</a></li> + <li><a href="http://lucene.apache.org/pylucene/";>PyLucene</a></li> + </ul> + </div> <!-- lucy-left_nav_box --> + + <div id="lucy-main_content_box" class="grid_9"> + <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> + + </div> <!-- lucy-main_content_box --> + <div class="clear"></div> + + </div> <!-- lucy-main_content --> + + <div id="lucy-copyright" class="container_16"> + <p>Copyright © 2010-2015 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0</a>. + <br/> + Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The + Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their + respective owners. + </p> + </div> <!-- lucy-copyright --> + + </div> <!-- lucy-rigid_wrapper --> + + </body> +</html> Added: websites/staging/lucy/trunk/content/docs/0.5.0/perl/LucyX/Remote/ClusterSearcher.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/0.5.0/perl/LucyX/Remote/ClusterSearcher.html (added) +++ websites/staging/lucy/trunk/content/docs/0.5.0/perl/LucyX/Remote/ClusterSearcher.html Wed Sep 28 12:07:48 2016 @@ -0,0 +1,141 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> + <title>LucyX::Remote::ClusterSearcher â Apache Lucy Documentation</title> + <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css"> + </head> + + <body> + + <div id="lucy-rigid_wrapper"> + + <div id="lucy-top" class="container_16 lucy-white_box_3d"> + + <div id="lucy-logo_box" class="grid_8"> + <a href="/"><img src="/images/lucy_logo_150x100.png" alt="Apache Lucyâ¢"></a> + </div> <!-- lucy-logo_box --> + + <div #id="lucy-top_nav_box" class="grid_8"> + <div id="lucy-top_nav_bar" class="container_8"> + <ul> + <li><a href="http://www.apache.org/"; title="Apache Software Foundation">Apache Software Foundation</a></li> + <li><a href="http://www.apache.org/licenses/"; title="License">License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html"; title="Sponsorship">Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html"; title="Thanks">Thanks</a></li> + <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li> + </ul> + </div> <!-- lucy-top_nav_bar --> + <p><a href="http://www.apache.org/";>Apache</a> » <a href="/">Lucy</a> » <a href="/docs/">Docs</a> » <a href="/docs/0.5.0/">0.5.0</a> » <a href="/docs/0.5.0/perl/">Perl</a> » <a href="/docs/0.5.0/perl/LucyX/">LucyX</a> » <a href="/docs/0.5.0/perl/LucyX/Remote/">Remote</a></p> + <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search"; method="get"> + <input value="*.apache.org" name="sitesearch" type="hidden"/> + <input type="text" name="q" id="query" style="width:85%"> + <input type="submit" id="submit" value="Search"> + </form> + </div> <!-- lucy-top_nav_box --> + + <div class="clear"></div> + + </div> <!-- lucy-top --> + + <div id="lucy-main_content" class="container_16 lucy-white_box_3d"> + + <div class="grid_4" id="lucy-left_nav_box"> + <h6>About</h6> + <ul> + <li><a href="/">Welcome</a></li> + <li><a href="/clownfish.html">Clownfish</a></li> + <li><a href="/faq.html">FAQ</a></li> + <li><a href="/people.html">People</a></li> + </ul> + <h6>Resources</h6> + <ul> + <li><a href="/download.html">Download</a></li> + <li><a href="/mailing_lists.html">Mailing Lists</a></li> + <li><a href="/docs/">Documentation</a></li> + <li><a href="http://wiki.apache.org/lucy/";>Wiki</a></li> + <li><a href="https://issues.apache.org/jira/browse/LUCY";>Issue Tracker</a></li> + <li><a href="/version_control.html">Version Control</a></li> + </ul> + <h6>Related Projects</h6> + <ul> + <li><a href="http://lucene.apache.org/core/";>Lucene</a></li> + <li><a href="http://dezi.org/";>Dezi</a></li> + <li><a href="http://lucene.apache.org/solr/";>Solr</a></li> + <li><a href="http://lucenenet.apache.org/";>Lucene.NET</a></li> + <li><a href="http://lucene.apache.org/pylucene/";>PyLucene</a></li> + </ul> + </div> <!-- lucy-left_nav_box --> + + <div id="lucy-main_content_box" class="grid_9"> + <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> + + </div> <!-- lucy-main_content_box --> + <div class="clear"></div> + + </div> <!-- lucy-main_content --> + + <div id="lucy-copyright" class="container_16"> + <p>Copyright © 2010-2015 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0</a>. + <br/> + Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The + Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their + respective owners. + </p> + </div> <!-- lucy-copyright --> + + </div> <!-- lucy-rigid_wrapper --> + + </body> +</html>
