Added: websites/staging/lucy/trunk/content/docs/perl/Lucy/Search/Query.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/perl/Lucy/Search/Query.html (added) +++ websites/staging/lucy/trunk/content/docs/perl/Lucy/Search/Query.html Mon Apr 4 09:23:29 2016 @@ -0,0 +1,226 @@ +<!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::Search::Query â 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/perl/">Perl</a> » <a href="/docs/perl/Lucy/">Lucy</a> » <a href="/docs/perl/Lucy/Search/">Search</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/perl/">Documentation</a></li> + <li><a href="http://wiki.apache.org/lucy/";>Wiki</a></li> + <li><a href="https://issues.apache.org/jira/browse/LUCY";>Issue Tracker</a></li> + <li><a href="/version_control.html">Version Control</a></li> + </ul> + <h6>Related Projects</h6> + <ul> + <li><a href="http://lucene.apache.org/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::Search::Query - A specification for a search query.</p> + +<h2><a class='u' +name="SYNOPSIS" +>SYNOPSIS</a></h2> + +<pre># Query is an abstract base class. +package MyQuery; +use base qw( Lucy::Search::Query ); + +sub make_compiler { + my ( $self, %args ) = @_; + my $subordinate = delete $args{subordinate}; + my $compiler = MyCompiler->new( %args, parent => $self ); + $compiler->normalize unless $subordinate; + return $compiler; +} + +package MyCompiler; +use base ( Lucy::Search::Compiler ); +...</pre> + +<h2><a class='u' +name="DESCRIPTION" +>DESCRIPTION</a></h2> + +<p>Query objects are simple containers which contain the minimum information necessary to define a search query.</p> + +<p>The most common way to generate Query objects is to feed a search string such as ‘foo AND bar’ to a <a href="../../Lucy/Search/QueryParser.html" class="podlinkpod" +>QueryParser’s</a> <a href="../../Lucy/Search/QueryParser.html#parse" class="podlinkpod" +>parse()</a> method, +which outputs an abstract syntax tree built up from various Query subclasses such as <a href="../../Lucy/Search/ANDQuery.html" class="podlinkpod" +>ANDQuery</a> and <a href="../../Lucy/Search/TermQuery.html" class="podlinkpod" +>TermQuery</a>. +However, +it is also possible to use custom Query objects to build a search specification which cannot be easily represented using a search string.</p> + +<p>Subclasses of Query must implement <a href="#make_compiler" class="podlinkpod" +>make_compiler()</a>, +which is the first step in compiling a Query down to a <a href="../../Lucy/Search/Matcher.html" class="podlinkpod" +>Matcher</a> which can actually match and score documents.</p> + +<h2><a class='u' +name="CONSTRUCTORS" +>CONSTRUCTORS</a></h2> + +<h3><a class='u' +name="new" +>new</a></h3> + +<pre>my $query = MyQuery->SUPER::new( + boost => 2.5, +);</pre> + +<p>Abstract constructor.</p> + +<ul> +<li><b>boost</b> - A scoring multiplier, +affecting the Query's relative contribution to each document's score. +Typically defaults to 1.0, +but subclasses which do not contribute to document scores such as NOTQuery and MatchAllQuery default to 0.0 instead.</li> +</ul> + +<h2><a class='u' +name="ABSTRACT_METHODS" +>ABSTRACT METHODS</a></h2> + +<h3><a class='u' +name="make_compiler" +>make_compiler</a></h3> + +<pre>my $compiler = $query->make_compiler( + searcher => $searcher # required + boost => $boost # required + subordinate => $subordinate # default: false +);</pre> + +<p>Abstract factory method returning a Compiler derived from this Query.</p> + +<ul> +<li><b>searcher</b> - A Searcher.</li> + +<li><b>boost</b> - A scoring multiplier.</li> + +<li><b>subordinate</b> - Indicates whether the Query is a subquery (as opposed to a top-level query). +If false, +the implementation must invoke <a href="../../Lucy/Search/Compiler.html#normalize" class="podlinkpod" +>normalize()</a> on the newly minted Compiler object before returning it.</li> +</ul> + +<h2><a class='u' +name="METHODS" +>METHODS</a></h2> + +<h3><a class='u' +name="set_boost" +>set_boost</a></h3> + +<pre>$query->set_boost($boost);</pre> + +<p>Set the Query’s boost.</p> + +<h3><a class='u' +name="get_boost" +>get_boost</a></h3> + +<pre>my $float = $query->get_boost();</pre> + +<p>Get the Query’s boost.</p> + +<h3><a class='u' +name="dump" +>dump</a></h3> + +<pre>my $obj = $query->dump();</pre> + +<h3><a class='u' +name="load" +>load</a></h3> + +<pre>my $obj = $query->load($dump);</pre> + +<h2><a class='u' +name="INHERITANCE" +>INHERITANCE</a></h2> + +<p>Lucy::Search::Query 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/perl/Lucy/Search/QueryParser.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/perl/Lucy/Search/QueryParser.html (added) +++ websites/staging/lucy/trunk/content/docs/perl/Lucy/Search/QueryParser.html Mon Apr 4 09:23:29 2016 @@ -0,0 +1,432 @@ +<!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::Search::QueryParser â 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/perl/">Perl</a> » <a href="/docs/perl/Lucy/">Lucy</a> » <a href="/docs/perl/Lucy/Search/">Search</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/perl/">Documentation</a></li> + <li><a href="http://wiki.apache.org/lucy/";>Wiki</a></li> + <li><a href="https://issues.apache.org/jira/browse/LUCY";>Issue Tracker</a></li> + <li><a href="/version_control.html">Version Control</a></li> + </ul> + <h6>Related Projects</h6> + <ul> + <li><a href="http://lucene.apache.org/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::Search::QueryParser - Transform a string into a Query object.</p> + +<h2><a class='u' +name="SYNOPSIS" +>SYNOPSIS</a></h2> + +<pre>my $query_parser = Lucy::Search::QueryParser->new( + schema => $searcher->get_schema, + fields => ['body'], +); +my $query = $query_parser->parse( $query_string ); +my $hits = $searcher->hits( query => $query );</pre> + +<h2><a class='u' +name="DESCRIPTION" +>DESCRIPTION</a></h2> + +<p>QueryParser accepts search strings as input and produces <a href="../../Lucy/Search/Query.html" class="podlinkpod" +>Query</a> objects, +suitable for feeding into <a href="../../Lucy/Search/IndexSearcher.html" class="podlinkpod" +>IndexSearcher</a> and other <a href="../../Lucy/Search/Searcher.html" class="podlinkpod" +>Searcher</a> subclasses.</p> + +<p>The following syntactical constructs are recognized by QueryParser:</p> + +<ul> +<li>Boolean operators ‘AND’, +‘OR’, +and ‘AND NOT’.</li> + +<li>Prepented +plus and -minus, +indicating that the labeled entity should be either required or forbidden – be it a single word, +a phrase, +or a parenthetical group.</li> + +<li>Logical groups, +delimited by parentheses.</li> + +<li>Phrases, +delimited by double quotes.</li> +</ul> + +<p>Additionally, +the following syntax can be enabled via <a href="#set_heed_colons" class="podlinkpod" +>set_heed_colons()</a>:</p> + +<ul> +<li>Field-specific constructs, +in the form of ‘fieldname:termtext’ or ‘fieldname:(foo bar)’. +(The field specified by ‘fieldname:’ will be used instead of the QueryParser’s default fields).</li> +</ul> + +<h2><a class='u' +name="CONSTRUCTORS" +>CONSTRUCTORS</a></h2> + +<h3><a class='u' +name="new" +>new</a></h3> + +<pre>my $query_parser = Lucy::Search::QueryParser->new( + schema => $searcher->get_schema, # required + analyzer => $analyzer, # overrides schema + fields => ['bodytext'], # default: indexed fields + default_boolop => 'AND', # default: 'OR' +);</pre> + +<p>Constructor.</p> + +<ul> +<li><b>schema</b> - A <a href="../../Lucy/Plan/Schema.html" class="podlinkpod" +>Schema</a>.</li> + +<li><b>analyzer</b> - An <a href="../../Lucy/Analysis/Analyzer.html" class="podlinkpod" +>Analyzer</a>. +Ordinarily, +the analyzers specified by each field’s definition will be used, +but if <code>analyzer</code> is supplied, +it will override and be used for all fields. +This can lead to mismatches between what is in the index and what is being searched for, +so use caution.</li> + +<li><b>fields</b> - The names of the fields which will be searched against. +Defaults to those fields which are defined as indexed in the supplied Schema.</li> + +<li><b>default_boolop</b> - Two possible values: ‘AND’ and ‘OR’. +The default is ‘OR’, +which means: return documents which match any of the query terms. +If you want only documents which match all of the query terms, +set this to ‘AND’.</li> +</ul> + +<h2><a class='u' +name="METHODS" +>METHODS</a></h2> + +<h3><a class='u' +name="parse" +>parse</a></h3> + +<pre>my $query = $query_parser->parse($query_string); +my $query = $query_parser->parse(); # default: undef</pre> + +<p>Build a Query object from the contents of a query string. +At present, +implemented internally by calling <a href="#tree" class="podlinkpod" +>tree()</a>, +<a href="#expand" class="podlinkpod" +>expand()</a>, +and <a href="#prune" class="podlinkpod" +>prune()</a>.</p> + +<ul> +<li><b>query_string</b> - The string to be parsed. +May be undef.</li> +</ul> + +<p>Returns: a Query.</p> + +<h3><a class='u' +name="tree" +>tree</a></h3> + +<pre>my $query = $query_parser->tree($query_string);</pre> + +<p>Parse the logical structure of a query string, +building a tree comprised of Query objects. +Leaf nodes in the tree will most often be LeafQuery objects but might be MatchAllQuery or NoMatchQuery objects as well. +Internal nodes will be objects which subclass PolyQuery: ANDQuery, +ORQuery, +NOTQuery, +and RequiredOptionalQuery.</p> + +<p>The output of <a href="#tree" class="podlinkpod" +>tree()</a> is an intermediate form which must be passed through <a href="#expand" class="podlinkpod" +>expand()</a> before being used to feed a search.</p> + +<ul> +<li><b>query_string</b> - The string to be parsed.</li> +</ul> + +<p>Returns: a Query.</p> + +<h3><a class='u' +name="expand" +>expand</a></h3> + +<pre>my $query = $query_parser->expand($query);</pre> + +<p>Walk the hierarchy of a Query tree, +descending through all PolyQuery nodes and calling <a href="#expand_leaf" class="podlinkpod" +>expand_leaf()</a> on any LeafQuery nodes encountered.</p> + +<ul> +<li><b>query</b> - A Query object.</li> +</ul> + +<p>Returns: A Query – usually the same one that was supplied after in-place modification, +but possibly another.</p> + +<h3><a class='u' +name="expand_leaf" +>expand_leaf</a></h3> + +<pre>my $query = $query_parser->expand_leaf($query);</pre> + +<p>Convert a LeafQuery into either a TermQuery, +a PhraseQuery, +or an ORQuery joining multiple TermQueries/PhraseQueries to accommodate multiple fields. +LeafQuery text will be passed through the relevant Analyzer for each field. +Quoted text will be transformed into PhraseQuery objects. +Unquoted text will be converted to either a TermQuery or a PhraseQuery depending on how many tokens are generated.</p> + +<ul> +<li><b>query</b> - A Query. +Only LeafQuery objects will be processed; others will be passed through.</li> +</ul> + +<p>Returns: A Query.</p> + +<h3><a class='u' +name="prune" +>prune</a></h3> + +<pre>my $query = $query_parser->prune($query); +my $query = $query_parser->prune(); # default: undef</pre> + +<p>Prevent certain Query structures from returning too many results. +Query objects built via <a href="#tree" class="podlinkpod" +>tree()</a> and <a href="#expand" class="podlinkpod" +>expand()</a> can generate “return the world” result sets, +such as in the case of <code>NOT a_term_not_in_the_index</code>; <a href="#prune" class="podlinkpod" +>prune()</a> walks the hierarchy and eliminates such branches.</p> + +<pre> 'NOT foo' => [NOMATCH] + 'foo OR NOT bar' => 'foo' + 'foo OR (-bar AND -baz) => 'foo'</pre> + +<p><a href="#prune" class="podlinkpod" +>prune()</a> also eliminates some double-negative constructs – even though such constructs may not actually return the world:</p> + +<pre> 'foo AND -(-bar)' => 'foo'</pre> + +<p>In this example, +safety is taking precedence over logical consistency. +If you want logical consistency instead, +call <a href="#tree" class="podlinkpod" +>tree()</a> then <a href="#expand" class="podlinkpod" +>expand()</a>, +skipping <a href="#prune" class="podlinkpod" +>prune()</a>.</p> + +<ul> +<li><b>query</b> - A Query.</li> +</ul> + +<p>Returns: a Query; in most cases, +the supplied Query after in-place modification.</p> + +<h3><a class='u' +name="make_term_query" +>make_term_query</a></h3> + +<pre>my $query = $query_parser->make_term_query( + field => $field # required + term => $term # required +);</pre> + +<p>Factory method creating a TermQuery.</p> + +<ul> +<li><b>field</b> - Field name.</li> + +<li><b>term</b> - Term text.</li> +</ul> + +<p>Returns: A Query.</p> + +<h3><a class='u' +name="make_phrase_query" +>make_phrase_query</a></h3> + +<pre>my $query = $query_parser->make_phrase_query( + field => $field # required + terms => $terms # required +);</pre> + +<p>Factory method creating a PhraseQuery.</p> + +<ul> +<li><b>field</b> - Field that the phrase must occur in.</li> + +<li><b>terms</b> - Ordered array of terms that must match.</li> +</ul> + +<p>Returns: A Query.</p> + +<h3><a class='u' +name="make_or_query" +>make_or_query</a></h3> + +<pre>my $query = $query_parser->make_or_query($children); +my $query = $query_parser->make_or_query(); # default: undef</pre> + +<p>Factory method creating an ORQuery.</p> + +<ul> +<li><b>children</b> - Array of child Queries.</li> +</ul> + +<p>Returns: A Query.</p> + +<h3><a class='u' +name="make_and_query" +>make_and_query</a></h3> + +<pre>my $query = $query_parser->make_and_query($children); +my $query = $query_parser->make_and_query(); # default: undef</pre> + +<p>Factory method creating an ANDQuery.</p> + +<ul> +<li><b>children</b> - Array of child Queries.</li> +</ul> + +<p>Returns: A Query.</p> + +<h3><a class='u' +name="make_not_query" +>make_not_query</a></h3> + +<pre>my $query = $query_parser->make_not_query($negated_query);</pre> + +<p>Factory method creating a NOTQuery.</p> + +<ul> +<li><b>negated_query</b> - Query to be inverted.</li> +</ul> + +<p>Returns: A Query.</p> + +<h3><a class='u' +name="make_req_opt_query" +>make_req_opt_query</a></h3> + +<pre>my $query = $query_parser->make_req_opt_query( + required_query => $required_query # required + optional_query => $optional_query # required +);</pre> + +<p>Factory method creating a RequiredOptionalQuery.</p> + +<ul> +<li><b>required_query</b> - Query must must match.</li> + +<li><b>optional_query</b> - Query which should match.</li> +</ul> + +<p>Returns: A Query.</p> + +<h3><a class='u' +name="set_heed_colons" +>set_heed_colons</a></h3> + +<pre>$query_parser->set_heed_colons($heed_colons);</pre> + +<p>Enable/disable parsing of <code>fieldname:foo</code> constructs.</p> + +<h2><a class='u' +name="INHERITANCE" +>INHERITANCE</a></h2> + +<p>Lucy::Search::QueryParser 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/perl/Lucy/Search/RangeQuery.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/perl/Lucy/Search/RangeQuery.html (added) +++ websites/staging/lucy/trunk/content/docs/perl/Lucy/Search/RangeQuery.html Mon Apr 4 09:23:29 2016 @@ -0,0 +1,197 @@ +<!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::Search::RangeQuery â 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/perl/">Perl</a> » <a href="/docs/perl/Lucy/">Lucy</a> » <a href="/docs/perl/Lucy/Search/">Search</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/perl/">Documentation</a></li> + <li><a href="http://wiki.apache.org/lucy/";>Wiki</a></li> + <li><a href="https://issues.apache.org/jira/browse/LUCY";>Issue Tracker</a></li> + <li><a href="/version_control.html">Version Control</a></li> + </ul> + <h6>Related Projects</h6> + <ul> + <li><a href="http://lucene.apache.org/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::Search::RangeQuery - Match a range of values.</p> + +<h2><a class='u' +name="SYNOPSIS" +>SYNOPSIS</a></h2> + +<pre># Match all articles by "Foo" published since the year 2000. +my $range_query = Lucy::Search::RangeQuery->new( + field => 'publication_date', + lower_term => '2000-01-01', + include_lower => 1, +); +my $author_query = Lucy::Search::TermQuery->new( + field => 'author_last_name', + text => 'Foo', +); +my $and_query = Lucy::Search::ANDQuery->new( + children => [ $range_query, $author_query ], +); +my $hits = $searcher->hits( query => $and_query ); +...</pre> + +<h2><a class='u' +name="DESCRIPTION" +>DESCRIPTION</a></h2> + +<p>RangeQuery matches documents where the value for a particular field falls within a given range.</p> + +<h2><a class='u' +name="CONSTRUCTORS" +>CONSTRUCTORS</a></h2> + +<h3><a class='u' +name="new" +>new</a></h3> + +<pre>my $range_query = Lucy::Search::RangeQuery->new( + field => 'product_number', # required + lower_term => '003', # see below + upper_term => '060', # see below + include_lower => 0, # default true + include_upper => 0, # default true +);</pre> + +<p>Create a new RangeQuery.</p> + +<p>Takes 5 parameters; <code>field</code> is required, +as is at least one of either <code>lower_term</code> or <code>upper_term</code>.</p> + +<ul> +<li><b>field</b> - The name of a <code>sortable</code> field.</li> + +<li><b>lower_term</b> - Lower delimiter. +If not supplied, +all values less than <code>upper_term</code> will pass.</li> + +<li><b>upper_term</b> - Upper delimiter. +If not supplied, +all values greater than <code>lower_term</code> will pass.</li> + +<li><b>include_lower</b> - Indicates whether docs which match <code>lower_term</code> should be included in the results.</li> + +<li><b>include_upper</b> - Indicates whether docs which match <code>upper_term</code> should be included in the results.</li> +</ul> + +<h2><a class='u' +name="METHODS" +>METHODS</a></h2> + +<h3><a class='u' +name="make_compiler" +>make_compiler</a></h3> + +<pre>my $compiler = $range_query->make_compiler( + searcher => $searcher # required + boost => $boost # required + subordinate => $subordinate # default: false +);</pre> + +<p>Abstract factory method returning a Compiler derived from this Query.</p> + +<ul> +<li><b>searcher</b> - A Searcher.</li> + +<li><b>boost</b> - A scoring multiplier.</li> + +<li><b>subordinate</b> - Indicates whether the Query is a subquery (as opposed to a top-level query). +If false, +the implementation must invoke <a href="../../Lucy/Search/Compiler.html#normalize" class="podlinkpod" +>normalize()</a> on the newly minted Compiler object before returning it.</li> +</ul> + +<h2><a class='u' +name="INHERITANCE" +>INHERITANCE</a></h2> + +<p>Lucy::Search::RangeQuery isa <a href="../../Lucy/Search/Query.html" class="podlinkpod" +>Lucy::Search::Query</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/perl/Lucy/Search/RequiredOptionalQuery.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/perl/Lucy/Search/RequiredOptionalQuery.html (added) +++ websites/staging/lucy/trunk/content/docs/perl/Lucy/Search/RequiredOptionalQuery.html Mon Apr 4 09:23:29 2016 @@ -0,0 +1,211 @@ +<!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::Search::RequiredOptionalQuery â 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/perl/">Perl</a> » <a href="/docs/perl/Lucy/">Lucy</a> » <a href="/docs/perl/Lucy/Search/">Search</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/perl/">Documentation</a></li> + <li><a href="http://wiki.apache.org/lucy/";>Wiki</a></li> + <li><a href="https://issues.apache.org/jira/browse/LUCY";>Issue Tracker</a></li> + <li><a href="/version_control.html">Version Control</a></li> + </ul> + <h6>Related Projects</h6> + <ul> + <li><a href="http://lucene.apache.org/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::Search::RequiredOptionalQuery - Join results for two Queries, +one required, +one optional.</p> + +<h2><a class='u' +name="SYNOPSIS" +>SYNOPSIS</a></h2> + +<pre>my $foo_and_maybe_bar = Lucy::Search::RequiredOptionalQuery->new( + required_query => $foo_query, + optional_query => $bar_query, +); +my $hits = $searcher->hits( query => $foo_and_maybe_bar ); +...</pre> + +<h2><a class='u' +name="DESCRIPTION" +>DESCRIPTION</a></h2> + +<p>RequiredOptionalQuery joins the result sets of one Query which MUST match, +and one Query which SHOULD match. +When only the required Query matches, +its score is passed along; when both match, +the scores are summed.</p> + +<h2><a class='u' +name="CONSTRUCTORS" +>CONSTRUCTORS</a></h2> + +<h3><a class='u' +name="new" +>new</a></h3> + +<pre>my $reqopt_query = Lucy::Search::RequiredOptionalQuery->new( + required_query => $foo_query, # required + optional_query => $bar_query, # required +);</pre> + +<p>Create a new RequiredOptionalQuery.</p> + +<ul> +<li><b>required_query</b> - Query must must match.</li> + +<li><b>optional_query</b> - Query which should match.</li> +</ul> + +<h2><a class='u' +name="METHODS" +>METHODS</a></h2> + +<h3><a class='u' +name="get_required_query" +>get_required_query</a></h3> + +<pre>my $query = $required_optional_query->get_required_query();</pre> + +<p>Getter for the required Query.</p> + +<h3><a class='u' +name="set_required_query" +>set_required_query</a></h3> + +<pre>$required_optional_query->set_required_query($required_query);</pre> + +<p>Setter for the required Query.</p> + +<h3><a class='u' +name="get_optional_query" +>get_optional_query</a></h3> + +<pre>my $query = $required_optional_query->get_optional_query();</pre> + +<p>Getter for the optional Query.</p> + +<h3><a class='u' +name="set_optional_query" +>set_optional_query</a></h3> + +<pre>$required_optional_query->set_optional_query($optional_query);</pre> + +<p>Setter for the optional Query.</p> + +<h3><a class='u' +name="make_compiler" +>make_compiler</a></h3> + +<pre>my $compiler = $required_optional_query->make_compiler( + searcher => $searcher # required + boost => $boost # required + subordinate => $subordinate # default: false +);</pre> + +<p>Abstract factory method returning a Compiler derived from this Query.</p> + +<ul> +<li><b>searcher</b> - A Searcher.</li> + +<li><b>boost</b> - A scoring multiplier.</li> + +<li><b>subordinate</b> - Indicates whether the Query is a subquery (as opposed to a top-level query). +If false, +the implementation must invoke <a href="../../Lucy/Search/Compiler.html#normalize" class="podlinkpod" +>normalize()</a> on the newly minted Compiler object before returning it.</li> +</ul> + +<h2><a class='u' +name="INHERITANCE" +>INHERITANCE</a></h2> + +<p>Lucy::Search::RequiredOptionalQuery isa <a href="../../Lucy/Search/PolyQuery.html" class="podlinkpod" +>Lucy::Search::PolyQuery</a> isa <a href="../../Lucy/Search/Query.html" class="podlinkpod" +>Lucy::Search::Query</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/perl/Lucy/Search/Searcher.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/perl/Lucy/Search/Searcher.html (added) +++ websites/staging/lucy/trunk/content/docs/perl/Lucy/Search/Searcher.html Mon Apr 4 09:23:29 2016 @@ -0,0 +1,257 @@ +<!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::Search::Searcher â 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/perl/">Perl</a> » <a href="/docs/perl/Lucy/">Lucy</a> » <a href="/docs/perl/Lucy/Search/">Search</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/perl/">Documentation</a></li> + <li><a href="http://wiki.apache.org/lucy/";>Wiki</a></li> + <li><a href="https://issues.apache.org/jira/browse/LUCY";>Issue Tracker</a></li> + <li><a href="/version_control.html">Version Control</a></li> + </ul> + <h6>Related Projects</h6> + <ul> + <li><a href="http://lucene.apache.org/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::Search::Searcher - Base class for searching collections of documents.</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>Abstract base class for objects which search. +Core subclasses include <a href="../../Lucy/Search/IndexSearcher.html" class="podlinkpod" +>IndexSearcher</a> and <a href="../../Lucy/Search/PolySearcher.html" class="podlinkpod" +>PolySearcher</a>.</p> + +<h2><a class='u' +name="CONSTRUCTORS" +>CONSTRUCTORS</a></h2> + +<h3><a class='u' +name="new" +>new</a></h3> + +<pre>package MySearcher; +use base qw( Lucy::Search::Searcher ); +sub new { + my $self = shift->SUPER::new; + ... + return $self; +}</pre> + +<p>Abstract constructor.</p> + +<ul> +<li><b>schema</b> - A Schema.</li> +</ul> + +<h2><a class='u' +name="ABSTRACT_METHODS" +>ABSTRACT METHODS</a></h2> + +<h3><a class='u' +name="doc_max" +>doc_max</a></h3> + +<pre>my $int = $searcher->doc_max();</pre> + +<p>Return the maximum number of docs in the collection represented by the Searcher, +which is also the highest possible internal doc id. +Documents which have been marked as deleted but not yet purged are included in this count.</p> + +<h3><a class='u' +name="doc_freq" +>doc_freq</a></h3> + +<pre>my $int = $searcher->doc_freq( + field => $field # required + term => $term # required +);</pre> + +<p>Return the number of documents which contain the term in the given field.</p> + +<ul> +<li><b>field</b> - Field name.</li> + +<li><b>term</b> - The term to look up.</li> +</ul> + +<h3><a class='u' +name="collect" +>collect</a></h3> + +<pre>$searcher->collect( + query => $query # required + collector => $collector # required +);</pre> + +<p>Iterate over hits, +feeding them into a <a href="../../Lucy/Search/Collector.html" class="podlinkpod" +>Collector</a>.</p> + +<ul> +<li><b>query</b> - A Query.</li> + +<li><b>collector</b> - A Collector.</li> +</ul> + +<h3><a class='u' +name="fetch_doc" +>fetch_doc</a></h3> + +<pre>my $hit_doc = $searcher->fetch_doc($doc_id);</pre> + +<p>Retrieve a document. +Throws an error if the doc id is out of range.</p> + +<ul> +<li><b>doc_id</b> - A document id.</li> +</ul> + +<h2><a class='u' +name="METHODS" +>METHODS</a></h2> + +<h3><a class='u' +name="glean_query" +>glean_query</a></h3> + +<pre>my $query = $searcher->glean_query($query); +my $query = $searcher->glean_query(); # default: undef</pre> + +<p>If the supplied object is a Query, +return it; if it’s a query string, +create a QueryParser and parse it to produce a query against all indexed fields.</p> + +<h3><a class='u' +name="hits" +>hits</a></h3> + +<pre>my $hits = $searcher->hits( + query => $query # required + offset => $offset # default: 0 + num_wanted => $num_wanted # default: 10 + sort_spec => $sort_spec # default: undef +);</pre> + +<p>Return a Hits object containing the top results.</p> + +<ul> +<li><b>query</b> - Either a Query object or a 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 <code>offset</code> to 20 and <code>num_wanted</code> 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> + +<li><b>sort_spec</b> - A <a href="../../Lucy/Search/SortSpec.html" class="podlinkpod" +>SortSpec</a>, +which will affect how results are ranked and returned.</li> +</ul> + +<h3><a class='u' +name="get_schema" +>get_schema</a></h3> + +<pre>my $schema = $searcher->get_schema();</pre> + +<p>Accessor for the object’s <code>schema</code> member.</p> + +<h2><a class='u' +name="INHERITANCE" +>INHERITANCE</a></h2> + +<p>Lucy::Search::Searcher 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/perl/Lucy/Search/SortRule.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/perl/Lucy/Search/SortRule.html (added) +++ websites/staging/lucy/trunk/content/docs/perl/Lucy/Search/SortRule.html Mon Apr 4 09:23:29 2016 @@ -0,0 +1,184 @@ +<!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::Search::SortRule â 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/perl/">Perl</a> » <a href="/docs/perl/Lucy/">Lucy</a> » <a href="/docs/perl/Lucy/Search/">Search</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/perl/">Documentation</a></li> + <li><a href="http://wiki.apache.org/lucy/";>Wiki</a></li> + <li><a href="https://issues.apache.org/jira/browse/LUCY";>Issue Tracker</a></li> + <li><a href="/version_control.html">Version Control</a></li> + </ul> + <h6>Related Projects</h6> + <ul> + <li><a href="http://lucene.apache.org/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::Search::SortRule - Element of a SortSpec.</p> + +<h2><a class='u' +name="SYNOPSIS" +>SYNOPSIS</a></h2> + +<pre>my $sort_spec = Lucy::Search::SortSpec->new( + rules => [ + Lucy::Search::SortRule->new( field => 'date' ), + Lucy::Search::SortRule->new( type => 'doc_id' ), + ], +);</pre> + +<h2><a class='u' +name="DESCRIPTION" +>DESCRIPTION</a></h2> + +<p>SortRules are the building blocks used to assemble <a href="../../Lucy/Search/SortSpec.html" class="podlinkpod" +>SortSpecs</a>; each SortRule defines a single level of sorting. +For example, +sorting first by “category” then by score requires a SortSpec with two SortRule elements.</p> + +<h2><a class='u' +name="CONSTRUCTORS" +>CONSTRUCTORS</a></h2> + +<h3><a class='u' +name="new" +>new</a></h3> + +<pre>my $by_title = Lucy::Search::SortRule->new( field => 'title' ); +my $by_score = Lucy::Search::SortRule->new( type => 'score' ); +my $by_doc_id = Lucy::Search::SortRule->new( type => 'doc_id' ); +my $reverse_date = Lucy::Search::SortRule->new( + field => 'date', + reverse => 1, +);</pre> + +<p>Create a new SortRule.</p> + +<ul> +<li><b>type</b> - Indicate whether to sort by score, +field, +etc. +(The default is to sort by a field.)</li> + +<li><b>field</b> - The name of a <code>sortable</code> field.</li> + +<li><b>reverse</b> - If true, +reverse the order of the sort for this rule.</li> +</ul> + +<h2><a class='u' +name="METHODS" +>METHODS</a></h2> + +<h3><a class='u' +name="get_field" +>get_field</a></h3> + +<pre>my $string = $sort_rule->get_field();</pre> + +<p>Accessor for “field” member.</p> + +<h3><a class='u' +name="get_type" +>get_type</a></h3> + +<pre>my $int = $sort_rule->get_type();</pre> + +<p>Accessor for “type” member.</p> + +<h3><a class='u' +name="get_reverse" +>get_reverse</a></h3> + +<pre>my $bool = $sort_rule->get_reverse();</pre> + +<p>Accessor for “reverse” member.</p> + +<h2><a class='u' +name="INHERITANCE" +>INHERITANCE</a></h2> + +<p>Lucy::Search::SortRule 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/perl/Lucy/Search/SortSpec.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/perl/Lucy/Search/SortSpec.html (added) +++ websites/staging/lucy/trunk/content/docs/perl/Lucy/Search/SortSpec.html Mon Apr 4 09:23:29 2016 @@ -0,0 +1,150 @@ +<!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::Search::SortSpec â 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/perl/">Perl</a> » <a href="/docs/perl/Lucy/">Lucy</a> » <a href="/docs/perl/Lucy/Search/">Search</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/perl/">Documentation</a></li> + <li><a href="http://wiki.apache.org/lucy/";>Wiki</a></li> + <li><a href="https://issues.apache.org/jira/browse/LUCY";>Issue Tracker</a></li> + <li><a href="/version_control.html">Version Control</a></li> + </ul> + <h6>Related Projects</h6> + <ul> + <li><a href="http://lucene.apache.org/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::Search::SortSpec - Specify a custom sort order for search results.</p> + +<h2><a class='u' +name="SYNOPSIS" +>SYNOPSIS</a></h2> + +<pre>my $sort_spec = Lucy::Search::SortSpec->new( + rules => [ + Lucy::Search::SortRule->new( field => 'date' ), + Lucy::Search::SortRule->new( type => 'doc_id' ), + ], +); +my $hits = $searcher->hits( + query => $query, + sort_spec => $sort_spec, +);</pre> + +<h2><a class='u' +name="DESCRIPTION" +>DESCRIPTION</a></h2> + +<p>By default, +searches return results in order of relevance; SortSpec allows you to indicate an alternate order via an array of <a href="../../Lucy/Search/SortRule.html" class="podlinkpod" +>SortRules</a>.</p> + +<p>Fields you wish to sort against must be <code>sortable</code>.</p> + +<p>For a stable sort (important when paging through results), +add a sort-by-doc rule as the last SortRule.</p> + +<h2><a class='u' +name="CONSTRUCTORS" +>CONSTRUCTORS</a></h2> + +<h3><a class='u' +name="new" +>new</a></h3> + +<pre>my $sort_spec = Lucy::Search::SortSpec->new( rules => \@rules );</pre> + +<p>Create a new SortSpec.</p> + +<ul> +<li><b>rules</b> - An array of SortRules.</li> +</ul> + +<h2><a class='u' +name="INHERITANCE" +>INHERITANCE</a></h2> + +<p>Lucy::Search::SortSpec 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/perl/Lucy/Search/Span.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/perl/Lucy/Search/Span.html (added) +++ websites/staging/lucy/trunk/content/docs/perl/Lucy/Search/Span.html Mon Apr 4 09:23:29 2016 @@ -0,0 +1,229 @@ +<!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::Search::Span â 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/perl/">Perl</a> » <a href="/docs/perl/Lucy/">Lucy</a> » <a href="/docs/perl/Lucy/Search/">Search</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/perl/">Documentation</a></li> + <li><a href="http://wiki.apache.org/lucy/";>Wiki</a></li> + <li><a href="https://issues.apache.org/jira/browse/LUCY";>Issue Tracker</a></li> + <li><a href="/version_control.html">Version Control</a></li> + </ul> + <h6>Related Projects</h6> + <ul> + <li><a href="http://lucene.apache.org/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::Search::Span - An offset, +a length, +and a weight.</p> + +<h2><a class='u' +name="SYNOPSIS" +>SYNOPSIS</a></h2> + +<pre>my $combined_length = $upper_span->get_length + + ( $upper_span->get_offset - $lower_span->get_offset ); +my $combined_span = Lucy::Search::Span->new( + offset => $lower_span->get_offset, + length => $combined_length, +); +...</pre> + +<h2><a class='u' +name="DESCRIPTION" +>DESCRIPTION</a></h2> + +<p>Span objects store information about a span across an array of… something. +The unit is context-dependent.</p> + +<p>Text is one possibility, +in which case offset and length might be measured in Unicode code points. +However, +the Span could also refer to a span within an array of tokens, +for example – in which case the start and offset might be measured in token positions.</p> + +<h2><a class='u' +name="CONSTRUCTORS" +>CONSTRUCTORS</a></h2> + +<h3><a class='u' +name="new" +>new</a></h3> + +<pre>my $span = Lucy::Search::Span->new( + offset => 75, # required + length => 7, # required + weight => 1.0, # default 0.0 +);</pre> + +<p>Create a new Span.</p> + +<ul> +<li><b>offset</b> - Integer offset, +unit is context-dependent.</li> + +<li><b>length</b> - Integer length, +unit is context-dependent.</li> + +<li><b>weight</b> - A floating point weight.</li> +</ul> + +<h2><a class='u' +name="METHODS" +>METHODS</a></h2> + +<h3><a class='u' +name="get_offset" +>get_offset</a></h3> + +<pre>my $int = $span->get_offset();</pre> + +<p>Accessor for <code>offset</code> attribute.</p> + +<h3><a class='u' +name="set_offset" +>set_offset</a></h3> + +<pre>$span->set_offset($offset);</pre> + +<p>Setter for <code>offset</code> attribute.</p> + +<h3><a class='u' +name="get_length" +>get_length</a></h3> + +<pre>my $int = $span->get_length();</pre> + +<p>Accessor for <code>length</code> attribute.</p> + +<h3><a class='u' +name="set_length" +>set_length</a></h3> + +<pre>$span->set_length($length);</pre> + +<p>Setter for <code>length</code> attribute.</p> + +<h3><a class='u' +name="get_weight" +>get_weight</a></h3> + +<pre>my $float = $span->get_weight();</pre> + +<p>Accessor for <code>weight</code> attribute.</p> + +<h3><a class='u' +name="set_weight" +>set_weight</a></h3> + +<pre>$span->set_weight($weight);</pre> + +<p>Setter for <code>weight</code> attribute.</p> + +<h3><a class='u' +name="compare_to" +>compare_to</a></h3> + +<pre>my $int = $span->compare_to($other);</pre> + +<p>Indicate whether one object is less than, +equal to, +or greater than another.</p> + +<ul> +<li><b>other</b> - Another Obj.</li> +</ul> + +<p>Returns: 0 if the objects are equal, +a negative number if <code>self</code> is less than <code>other</code>, +and a positive number if <code>self</code> is greater than <code>other</code>.</p> + +<h2><a class='u' +name="INHERITANCE" +>INHERITANCE</a></h2> + +<p>Lucy::Search::Span 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/perl/Lucy/Search/TermQuery.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/perl/Lucy/Search/TermQuery.html (added) +++ websites/staging/lucy/trunk/content/docs/perl/Lucy/Search/TermQuery.html Mon Apr 4 09:23:29 2016 @@ -0,0 +1,188 @@ +<!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::Search::TermQuery â 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/perl/">Perl</a> » <a href="/docs/perl/Lucy/">Lucy</a> » <a href="/docs/perl/Lucy/Search/">Search</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/perl/">Documentation</a></li> + <li><a href="http://wiki.apache.org/lucy/";>Wiki</a></li> + <li><a href="https://issues.apache.org/jira/browse/LUCY";>Issue Tracker</a></li> + <li><a href="/version_control.html">Version Control</a></li> + </ul> + <h6>Related Projects</h6> + <ul> + <li><a href="http://lucene.apache.org/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::Search::TermQuery - Query which matches individual terms.</p> + +<h2><a class='u' +name="SYNOPSIS" +>SYNOPSIS</a></h2> + +<pre>my $term_query = Lucy::Search::TermQuery->new( + field => 'content', + term => 'foo', +); +my $hits = $searcher->hits( query => $term_query );</pre> + +<h2><a class='u' +name="DESCRIPTION" +>DESCRIPTION</a></h2> + +<p>TermQuery is a subclass of <a href="../../Lucy/Search/Query.html" class="podlinkpod" +>Query</a> for matching individual terms in a specific field.</p> + +<h2><a class='u' +name="CONSTRUCTORS" +>CONSTRUCTORS</a></h2> + +<h3><a class='u' +name="new" +>new</a></h3> + +<pre>my $term_query = Lucy::Search::TermQuery->new( + field => 'content', # required + term => 'foo', # required +);</pre> + +<p>Create a new TermQuery.</p> + +<ul> +<li><b>field</b> - Field name.</li> + +<li><b>term</b> - Term text.</li> +</ul> + +<h2><a class='u' +name="METHODS" +>METHODS</a></h2> + +<h3><a class='u' +name="get_field" +>get_field</a></h3> + +<pre>my $string = $term_query->get_field();</pre> + +<p>Accessor for object’s <code>field</code> member.</p> + +<h3><a class='u' +name="get_term" +>get_term</a></h3> + +<pre>my $obj = $term_query->get_term();</pre> + +<p>Accessor for object’s <code>term</code> member.</p> + +<h3><a class='u' +name="make_compiler" +>make_compiler</a></h3> + +<pre>my $compiler = $term_query->make_compiler( + searcher => $searcher # required + boost => $boost # required + subordinate => $subordinate # default: false +);</pre> + +<p>Abstract factory method returning a Compiler derived from this Query.</p> + +<ul> +<li><b>searcher</b> - A Searcher.</li> + +<li><b>boost</b> - A scoring multiplier.</li> + +<li><b>subordinate</b> - Indicates whether the Query is a subquery (as opposed to a top-level query). +If false, +the implementation must invoke <a href="../../Lucy/Search/Compiler.html#normalize" class="podlinkpod" +>normalize()</a> on the newly minted Compiler object before returning it.</li> +</ul> + +<h2><a class='u' +name="INHERITANCE" +>INHERITANCE</a></h2> + +<p>Lucy::Search::TermQuery isa <a href="../../Lucy/Search/Query.html" class="podlinkpod" +>Lucy::Search::Query</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/perl/Lucy/Simple.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/perl/Lucy/Simple.html (added) +++ websites/staging/lucy/trunk/content/docs/perl/Lucy/Simple.html Mon Apr 4 09:23:29 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/perl/">Perl</a> » <a href="/docs/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/perl/">Documentation</a></li> + <li><a href="http://wiki.apache.org/lucy/";>Wiki</a></li> + <li><a href="https://issues.apache.org/jira/browse/LUCY";>Issue Tracker</a></li> + <li><a href="/version_control.html">Version Control</a></li> + </ul> + <h6>Related Projects</h6> + <ul> + <li><a href="http://lucene.apache.org/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>
