Author: buildbot Date: Mon Apr 4 09:23:29 2016 New Revision: 984656 Log: Staging update by buildbot for lucy
Added: websites/staging/lucy/trunk/content/docs/perl/Lucy.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Analysis/Analyzer.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Analysis/CaseFolder.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Analysis/EasyAnalyzer.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Analysis/Normalizer.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Analysis/PolyAnalyzer.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Analysis/RegexTokenizer.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Analysis/SnowballStemmer.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Analysis/SnowballStopFilter.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Analysis/StandardTokenizer.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Docs/Cookbook.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Docs/Cookbook/CustomQuery.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Docs/Cookbook/CustomQueryParser.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Docs/Cookbook/FastUpdates.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Docs/DevGuide.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Docs/DocIDs.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Docs/FileFormat.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Docs/FileLocking.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Docs/IRTheory.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Docs/Tutorial.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Document/Doc.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Document/HitDoc.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Highlight/Highlighter.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Index/BackgroundMerger.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Index/DataReader.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Index/DataWriter.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Index/DeletionsWriter.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Index/DocReader.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Index/IndexManager.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Index/IndexReader.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Index/Indexer.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Index/Lexicon.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Index/LexiconReader.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Index/PolyReader.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Index/PostingList.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Index/PostingListReader.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Index/SegReader.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Index/SegWriter.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Index/Segment.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Index/Similarity.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Index/Snapshot.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Object/BitVector.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Object/Obj.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Plan/Architecture.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Plan/BlobType.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Plan/FieldType.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Plan/FullTextType.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Plan/Schema.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Plan/StringType.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Search/ANDQuery.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Search/Collector.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Search/Collector/BitCollector.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Search/Compiler.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Search/Hits.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Search/IndexSearcher.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Search/LeafQuery.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Search/MatchAllQuery.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Search/Matcher.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Search/NOTQuery.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Search/NoMatchQuery.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Search/ORQuery.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Search/PhraseQuery.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Search/PolyQuery.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Search/PolySearcher.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Search/Query.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Search/QueryParser.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Search/RangeQuery.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Search/RequiredOptionalQuery.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Search/Searcher.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Search/SortRule.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Search/SortSpec.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Search/Span.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Search/TermQuery.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Simple.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Store/FSFolder.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Store/Folder.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Store/Lock.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Store/LockErr.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Store/LockFactory.html websites/staging/lucy/trunk/content/docs/perl/Lucy/Store/RAMFolder.html websites/staging/lucy/trunk/content/docs/perl/LucyX/Index/ByteBufDocReader.html websites/staging/lucy/trunk/content/docs/perl/LucyX/Index/ByteBufDocWriter.html websites/staging/lucy/trunk/content/docs/perl/LucyX/Index/LongFieldSim.html websites/staging/lucy/trunk/content/docs/perl/LucyX/Index/ZlibDocReader.html websites/staging/lucy/trunk/content/docs/perl/LucyX/Index/ZlibDocWriter.html websites/staging/lucy/trunk/content/docs/perl/LucyX/Remote/ClusterSearcher.html websites/staging/lucy/trunk/content/docs/perl/LucyX/Remote/SearchClient.html websites/staging/lucy/trunk/content/docs/perl/LucyX/Remote/SearchServer.html websites/staging/lucy/trunk/content/docs/perl/LucyX/Search/Filter.html websites/staging/lucy/trunk/content/docs/perl/LucyX/Search/MockMatcher.html websites/staging/lucy/trunk/content/docs/perl/LucyX/Search/ProximityQuery.html Removed: websites/staging/lucy/trunk/content/docs/test/ Modified: websites/staging/lucy/trunk/content/ (props changed) Propchange: websites/staging/lucy/trunk/content/ ------------------------------------------------------------------------------ --- cms:source-revision (original) +++ cms:source-revision Mon Apr 4 09:23:29 2016 @@ -1 +1 @@ -1737642 +1737643 Added: websites/staging/lucy/trunk/content/docs/perl/Lucy.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/perl/Lucy.html (added) +++ websites/staging/lucy/trunk/content/docs/perl/Lucy.html Mon Apr 4 09:23:29 2016 @@ -0,0 +1,331 @@ +<!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 â 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></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 - Apache Lucy search engine library.</p> + +<h2><a class='u' +name="VERSION" +>VERSION</a></h2> + +<p>0.5.0</p> + +<h2><a class='u' +name="SYNOPSIS" +>SYNOPSIS</a></h2> + +<p>First, +plan out your index structure, +create the index, +and add documents:</p> + +<pre># indexer.pl + +use Lucy::Index::Indexer; +use Lucy::Plan::Schema; +use Lucy::Analysis::EasyAnalyzer; +use Lucy::Plan::FullTextType; + +# Create a Schema which defines index fields. +my $schema = Lucy::Plan::Schema->new; +my $easyanalyzer = Lucy::Analysis::EasyAnalyzer->new( + language => 'en', +); +my $type = Lucy::Plan::FullTextType->new( + analyzer => $easyanalyzer, +); +$schema->spec_field( name => 'title', type => $type ); +$schema->spec_field( name => 'content', type => $type ); + +# Create the index and add documents. +my $indexer = Lucy::Index::Indexer->new( + schema => $schema, + index => '/path/to/index', + create => 1, +); +while ( my ( $title, $content ) = each %source_docs ) { + $indexer->add_doc({ + title => $title, + content => $content, + }); +} +$indexer->commit;</pre> + +<p>Then, +search the index:</p> + +<pre># search.pl + +use Lucy::Search::IndexSearcher; + +my $searcher = Lucy::Search::IndexSearcher->new( + index => '/path/to/index' +); +my $hits = $searcher->hits( query => "foo bar" ); +while ( my $hit = $hits->next ) { + print "$hit->{title}\n"; +}</pre> + +<h2><a class='u' +name="DESCRIPTION" +>DESCRIPTION</a></h2> + +<p>The Apache Lucy search engine library delivers high-performance, +modular full-text search.</p> + +<h3><a class='u' +name="Features" +>Features</a></h3> + +<ul> +<li>Extremely fast. +A single machine can handle millions of documents.</li> + +<li>Scalable to multiple machines.</li> + +<li>Incremental indexing (addition/deletion of documents to/from an existing index).</li> + +<li>Configurable near-real-time index updates.</li> + +<li>Unicode support.</li> + +<li>Support for boolean operators AND, +OR, +and AND NOT; parenthetical groupings; prepended +plus and -minus.</li> + +<li>Algorithmic selection of relevant excerpts and highlighting of search terms within excerpts.</li> + +<li>Highly customizable query and indexing APIs.</li> + +<li>Customizable sorting.</li> + +<li>Phrase matching.</li> + +<li>Stemming.</li> + +<li>Stoplists.</li> +</ul> + +<h3><a class='u' +name="Getting_Started" +>Getting Started</a></h3> + +<p><a href="./Lucy/Simple.html" class="podlinkpod" +>Lucy::Simple</a> provides a stripped down API which may suffice for many tasks.</p> + +<p><a href="./Lucy/Docs/Tutorial.html" class="podlinkpod" +>Lucy::Docs::Tutorial</a> demonstrates how to build a basic CGI search application.</p> + +<p>The tutorial spends most of its time on these five classes:</p> + +<ul> +<li><a href="./Lucy/Plan/Schema.html" class="podlinkpod" +>Lucy::Plan::Schema</a> - Plan out your index.</li> + +<li><a href="./Lucy/Plan/FieldType.html" class="podlinkpod" +>Lucy::Plan::FieldType</a> - Define index fields.</li> + +<li><a href="./Lucy/Index/Indexer.html" class="podlinkpod" +>Lucy::Index::Indexer</a> - Manipulate index content.</li> + +<li><a href="./Lucy/Search/IndexSearcher.html" class="podlinkpod" +>Lucy::Search::IndexSearcher</a> - Search an index.</li> + +<li><a href="./Lucy/Analysis/EasyAnalyzer.html" class="podlinkpod" +>Lucy::Analysis::EasyAnalyzer</a> - A one-size-fits-all parser/tokenizer.</li> +</ul> + +<h3><a class='u' +name="Delving_Deeper" +>Delving Deeper</a></h3> + +<p><a href="./Lucy/Docs/Cookbook.html" class="podlinkpod" +>Lucy::Docs::Cookbook</a> augments the tutorial with more advanced recipes.</p> + +<p>For creating complex queries, +see <a href="./Lucy/Search/Query.html" class="podlinkpod" +>Lucy::Search::Query</a> and its subclasses <a href="./Lucy/Search/TermQuery.html" class="podlinkpod" +>TermQuery</a>, +<a href="./Lucy/Search/PhraseQuery.html" class="podlinkpod" +>PhraseQuery</a>, +<a href="./Lucy/Search/ANDQuery.html" class="podlinkpod" +>ANDQuery</a>, +<a href="./Lucy/Search/ORQuery.html" class="podlinkpod" +>ORQuery</a>, +<a href="./Lucy/Search/NOTQuery.html" class="podlinkpod" +>NOTQuery</a>, +<a href="./Lucy/Search/RequiredOptionalQuery.html" class="podlinkpod" +>RequiredOptionalQuery</a>, +<a href="./Lucy/Search/MatchAllQuery.html" class="podlinkpod" +>MatchAllQuery</a>, +and <a href="./Lucy/Search/NoMatchQuery.html" class="podlinkpod" +>NoMatchQuery</a>, +plus <a href="./Lucy/Search/QueryParser.html" class="podlinkpod" +>Lucy::Search::QueryParser</a>.</p> + +<p>For distributed searching, +see <a href="./LucyX/Remote/SearchServer.html" class="podlinkpod" +>LucyX::Remote::SearchServer</a>, +<a href="./LucyX/Remote/SearchClient.html" class="podlinkpod" +>LucyX::Remote::SearchClient</a>, +and <a href="./LucyX/Remote/ClusterSearcher.html" class="podlinkpod" +>LucyX::Remote::ClusterSearcher</a>.</p> + +<h3><a class='u' +name="Backwards_Compatibility_Policy" +>Backwards Compatibility Policy</a></h3> + +<p>Lucy will spin off stable forks into new namespaces periodically. +The first will be named "Lucy1". +Users who require strong backwards compatibility should use a stable fork.</p> + +<p>The main namespace, +"Lucy", +is an API-unstable development branch (as hinted at by its 0.x.x version number). +Superficial interface changes happen frequently. +Hard file format compatibility breaks which require reindexing are rare, +as we generally try to provide continuity across multiple releases, +but we reserve the right to make such changes.</p> + +<h2><a class='u' +name="CLASS_METHODS" +>CLASS METHODS</a></h2> + +<p>The Lucy module itself does not have a large interface, +providing only a single public class method.</p> + +<h3><a class='u' +name="error" +>error</a></h3> + +<pre>my $instream = $folder->open_in( file => 'foo' ) or die Clownfish->error;</pre> + +<p>Access a shared variable which is set by some routines on failure. +It will always be either a <a href="./Clownfish/Err.html" class="podlinkpod" +>Clownfish::Err</a> object or undef.</p> + +<h2><a class='u' +name="SUPPORT" +>SUPPORT</a></h2> + +<p>The Apache Lucy homepage, +where you'll find links to our mailing lists and so on, +is <a href="http://lucy.apache.org" class="podlinkurl" +>http://lucy.apache.org</a>. +Please direct support questions to the Lucy users mailing list.</p> + +<h2><a class='u' +name="BUGS" +>BUGS</a></h2> + +<p>Not thread-safe.</p> + +<p>Some exceptions leak memory.</p> + +<p>If you find a bug, +please inquire on the Lucy users mailing list about it, +then report it on the Lucy issue tracker once it has been confirmed: <a href="https://issues.apache.org/jira/browse/LUCY" class="podlinkurl" +>https://issues.apache.org/jira/browse/LUCY</a>.</p> + +<h2><a class='u' +name="COPYRIGHT" +>COPYRIGHT</a></h2> + +<p>Apache Lucy is distributed under the Apache License, +Version 2.0, +as described in the file <code>LICENSE</code> included with the distribution.</p> + +</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/Analysis/Analyzer.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/perl/Lucy/Analysis/Analyzer.html (added) +++ websites/staging/lucy/trunk/content/docs/perl/Lucy/Analysis/Analyzer.html Mon Apr 4 09:23:29 2016 @@ -0,0 +1,231 @@ +<!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::Analysis::Analyzer â 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/Analysis/">Analysis</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::Analysis::Analyzer - Tokenize/modify/filter text.</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>An Analyzer is a filter which processes text, +transforming it from one form into another. +For instance, +an analyzer might break up a long text into smaller pieces (<a href="../../Lucy/Analysis/RegexTokenizer.html" class="podlinkpod" +>RegexTokenizer</a>), +or it might perform case folding to facilitate case-insensitive search (<a href="../../Lucy/Analysis/Normalizer.html" class="podlinkpod" +>Normalizer</a>).</p> + +<h2><a class='u' +name="CONSTRUCTORS" +>CONSTRUCTORS</a></h2> + +<h3><a class='u' +name="new" +>new</a></h3> + +<pre>package MyAnalyzer; +use base qw( Lucy::Analysis::Analyzer ); +our %foo; +sub new { + my $self = shift->SUPER::new; + my %args = @_; + $foo{$$self} = $args{foo}; + return $self; +}</pre> + +<p>Abstract constructor. +Takes no arguments.</p> + +<h2><a class='u' +name="ABSTRACT_METHODS" +>ABSTRACT METHODS</a></h2> + +<h3><a class='u' +name="transform" +>transform</a></h3> + +<pre>my $inversion = $analyzer->transform($inversion);</pre> + +<p>Take a single <a href="../../Lucy/Analysis/Inversion.html" class="podlinkpod" +>Inversion</a> as input and returns an Inversion, +either the same one (presumably transformed in some way), +or a new one.</p> + +<ul> +<li><b>inversion</b> - An inversion.</li> +</ul> + +<h2><a class='u' +name="METHODS" +>METHODS</a></h2> + +<h3><a class='u' +name="transform_text" +>transform_text</a></h3> + +<pre>my $inversion = $analyzer->transform_text($text);</pre> + +<p>Kick off an analysis chain, +creating an Inversion from string input. +The default implementation simply creates an initial Inversion with a single Token, +then calls <a href="#transform" class="podlinkpod" +>transform()</a>, +but occasionally subclasses will provide an optimized implementation which minimizes string copies.</p> + +<ul> +<li><b>text</b> - A string.</li> +</ul> + +<h3><a class='u' +name="split" +>split</a></h3> + +<pre>my $arrayref = $analyzer->split($text);</pre> + +<p>Analyze text and return an array of token texts.</p> + +<ul> +<li><b>text</b> - A string.</li> +</ul> + +<h3><a class='u' +name="dump" +>dump</a></h3> + +<pre>my $obj = $analyzer->dump();</pre> + +<p>Dump the analyzer as hash.</p> + +<p>Subclasses should call <a href="#dump" class="podlinkpod" +>dump()</a> on the superclass. +The returned object is a hash which should be populated with parameters of the analyzer.</p> + +<p>Returns: A hash containing a description of the analyzer.</p> + +<h3><a class='u' +name="load" +>load</a></h3> + +<pre>my $obj = $analyzer->load($dump);</pre> + +<p>Reconstruct an analyzer from a dump.</p> + +<p>Subclasses should first call <a href="#load" class="podlinkpod" +>load()</a> on the superclass. +The returned object is an analyzer which should be reconstructed by setting the dumped parameters from the hash contained in <code>dump</code>.</p> + +<p>Note that the invocant analyzer is unused.</p> + +<ul> +<li><b>dump</b> - A hash.</li> +</ul> + +<p>Returns: An analyzer.</p> + +<h2><a class='u' +name="INHERITANCE" +>INHERITANCE</a></h2> + +<p>Lucy::Analysis::Analyzer 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/Analysis/CaseFolder.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/perl/Lucy/Analysis/CaseFolder.html (added) +++ websites/staging/lucy/trunk/content/docs/perl/Lucy/Analysis/CaseFolder.html Mon Apr 4 09:23:29 2016 @@ -0,0 +1,161 @@ +<!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::Analysis::CaseFolder â 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/Analysis/">Analysis</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::Analysis::CaseFolder - Normalize case, +facilitating case-insensitive search.</p> + +<h2><a class='u' +name="SYNOPSIS" +>SYNOPSIS</a></h2> + +<pre>my $case_folder = Lucy::Analysis::CaseFolder->new; + +my $polyanalyzer = Lucy::Analysis::PolyAnalyzer->new( + analyzers => [ $tokenizer, $case_folder, $stemmer ], +);</pre> + +<h2><a class='u' +name="DESCRIPTION" +>DESCRIPTION</a></h2> + +<p>CaseFolder is DEPRECATED. +Use <a href="../../Lucy/Analysis/Normalizer.html" class="podlinkpod" +>Normalizer</a> instead.</p> + +<p>CaseFolder normalizes text according to Unicode case-folding rules, +so that searches will be case-insensitive.</p> + +<h2><a class='u' +name="CONSTRUCTORS" +>CONSTRUCTORS</a></h2> + +<h3><a class='u' +name="new" +>new</a></h3> + +<pre>my $case_folder = Lucy::Analysis::CaseFolder->new;</pre> + +<p>Constructor. +Takes no arguments.</p> + +<h2><a class='u' +name="METHODS" +>METHODS</a></h2> + +<h3><a class='u' +name="transform" +>transform</a></h3> + +<pre>my $inversion = $case_folder->transform($inversion);</pre> + +<p>Take a single <a href="../../Lucy/Analysis/Inversion.html" class="podlinkpod" +>Inversion</a> as input and returns an Inversion, +either the same one (presumably transformed in some way), +or a new one.</p> + +<ul> +<li><b>inversion</b> - An inversion.</li> +</ul> + +<h2><a class='u' +name="INHERITANCE" +>INHERITANCE</a></h2> + +<p>Lucy::Analysis::CaseFolder isa <a href="../../Lucy/Analysis/Analyzer.html" class="podlinkpod" +>Lucy::Analysis::Analyzer</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/Analysis/EasyAnalyzer.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/perl/Lucy/Analysis/EasyAnalyzer.html (added) +++ websites/staging/lucy/trunk/content/docs/perl/Lucy/Analysis/EasyAnalyzer.html Mon Apr 4 09:23:29 2016 @@ -0,0 +1,187 @@ +<!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::Analysis::EasyAnalyzer â 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/Analysis/">Analysis</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::Analysis::EasyAnalyzer - A simple analyzer chain.</p> + +<h2><a class='u' +name="SYNOPSIS" +>SYNOPSIS</a></h2> + +<pre>my $schema = Lucy::Plan::Schema->new; +my $analyzer = Lucy::Analysis::EasyAnalyzer->new( + language => 'en', +); +my $type = Lucy::Plan::FullTextType->new( + analyzer => $analyzer, +); +$schema->spec_field( name => 'title', type => $type ); +$schema->spec_field( name => 'content', type => $type );</pre> + +<h2><a class='u' +name="DESCRIPTION" +>DESCRIPTION</a></h2> + +<p>EasyAnalyzer is an analyzer chain consisting of a <a href="../../Lucy/Analysis/StandardTokenizer.html" class="podlinkpod" +>StandardTokenizer</a>, +a <a href="../../Lucy/Analysis/Normalizer.html" class="podlinkpod" +>Normalizer</a>, +and a <a href="../../Lucy/Analysis/SnowballStemmer.html" class="podlinkpod" +>SnowballStemmer</a>.</p> + +<p>Supported languages:</p> + +<pre>en => English, +da => Danish, +de => German, +es => Spanish, +fi => Finnish, +fr => French, +hu => Hungarian, +it => Italian, +nl => Dutch, +no => Norwegian, +pt => Portuguese, +ro => Romanian, +ru => Russian, +sv => Swedish, +tr => Turkish,</pre> + +<h2><a class='u' +name="CONSTRUCTORS" +>CONSTRUCTORS</a></h2> + +<h3><a class='u' +name="new" +>new</a></h3> + +<pre>my $analyzer = Lucy::Analysis::EasyAnalyzer->new( + language => 'es', +);</pre> + +<p>Create a new EasyAnalyzer.</p> + +<ul> +<li><b>language</b> - An ISO code from the list of supported languages.</li> +</ul> + +<h2><a class='u' +name="METHODS" +>METHODS</a></h2> + +<h3><a class='u' +name="transform" +>transform</a></h3> + +<pre>my $inversion = $easy_analyzer->transform($inversion);</pre> + +<p>Take a single <a href="../../Lucy/Analysis/Inversion.html" class="podlinkpod" +>Inversion</a> as input and returns an Inversion, +either the same one (presumably transformed in some way), +or a new one.</p> + +<ul> +<li><b>inversion</b> - An inversion.</li> +</ul> + +<h2><a class='u' +name="INHERITANCE" +>INHERITANCE</a></h2> + +<p>Lucy::Analysis::EasyAnalyzer isa <a href="../../Lucy/Analysis/Analyzer.html" class="podlinkpod" +>Lucy::Analysis::Analyzer</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/Analysis/Normalizer.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/perl/Lucy/Analysis/Normalizer.html (added) +++ websites/staging/lucy/trunk/content/docs/perl/Lucy/Analysis/Normalizer.html Mon Apr 4 09:23:29 2016 @@ -0,0 +1,180 @@ +<!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::Analysis::Normalizer â 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/Analysis/">Analysis</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::Analysis::Normalizer - Unicode normalization, +case folding and accent stripping.</p> + +<h2><a class='u' +name="SYNOPSIS" +>SYNOPSIS</a></h2> + +<pre>my $normalizer = Lucy::Analysis::Normalizer->new; + +my $polyanalyzer = Lucy::Analysis::PolyAnalyzer->new( + analyzers => [ $tokenizer, $normalizer, $stemmer ], +);</pre> + +<h2><a class='u' +name="DESCRIPTION" +>DESCRIPTION</a></h2> + +<p>Normalizer is an <a href="../../Lucy/Analysis/Analyzer.html" class="podlinkpod" +>Analyzer</a> which normalizes tokens to one of the Unicode normalization forms. +Optionally, +it performs Unicode case folding and converts accented characters to their base character.</p> + +<p>If you use highlighting, +Normalizer should be run after tokenization because it might add or remove characters.</p> + +<h2><a class='u' +name="CONSTRUCTORS" +>CONSTRUCTORS</a></h2> + +<h3><a class='u' +name="new" +>new</a></h3> + +<pre>my $normalizer = Lucy::Analysis::Normalizer->new( + normalization_form => 'NFKC', + case_fold => 1, + strip_accents => 0, +);</pre> + +<p>Create a new Normalizer.</p> + +<ul> +<li><b>normalization_form</b> - Unicode normalization form, +can be one of ‘NFC’, +‘NFKC’, +‘NFD’, +‘NFKD’. +Defaults to ‘NFKC’.</li> + +<li><b>case_fold</b> - Perform case folding, +default is true.</li> + +<li><b>strip_accents</b> - Strip accents, +default is false.</li> +</ul> + +<h2><a class='u' +name="METHODS" +>METHODS</a></h2> + +<h3><a class='u' +name="transform" +>transform</a></h3> + +<pre>my $inversion = $normalizer->transform($inversion);</pre> + +<p>Take a single <a href="../../Lucy/Analysis/Inversion.html" class="podlinkpod" +>Inversion</a> as input and returns an Inversion, +either the same one (presumably transformed in some way), +or a new one.</p> + +<ul> +<li><b>inversion</b> - An inversion.</li> +</ul> + +<h2><a class='u' +name="INHERITANCE" +>INHERITANCE</a></h2> + +<p>Lucy::Analysis::Normalizer isa <a href="../../Lucy/Analysis/Analyzer.html" class="podlinkpod" +>Lucy::Analysis::Analyzer</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/Analysis/PolyAnalyzer.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/perl/Lucy/Analysis/PolyAnalyzer.html (added) +++ websites/staging/lucy/trunk/content/docs/perl/Lucy/Analysis/PolyAnalyzer.html Mon Apr 4 09:23:29 2016 @@ -0,0 +1,222 @@ +<!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::Analysis::PolyAnalyzer â 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/Analysis/">Analysis</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::Analysis::PolyAnalyzer - Multiple Analyzers in series.</p> + +<h2><a class='u' +name="SYNOPSIS" +>SYNOPSIS</a></h2> + +<pre>my $schema = Lucy::Plan::Schema->new; +my $polyanalyzer = Lucy::Analysis::PolyAnalyzer->new( + analyzers => \@analyzers, +); +my $type = Lucy::Plan::FullTextType->new( + analyzer => $polyanalyzer, +); +$schema->spec_field( name => 'title', type => $type ); +$schema->spec_field( name => 'content', type => $type );</pre> + +<h2><a class='u' +name="DESCRIPTION" +>DESCRIPTION</a></h2> + +<p>A PolyAnalyzer is a series of <a href="../../Lucy/Analysis/Analyzer.html" class="podlinkpod" +>Analyzers</a>, +each of which will be called upon to “analyze” text in turn. +You can either provide the Analyzers yourself, +or you can specify a supported language, +in which case a PolyAnalyzer consisting of a <a href="../../Lucy/Analysis/CaseFolder.html" class="podlinkpod" +>CaseFolder</a>, +a <a href="../../Lucy/Analysis/RegexTokenizer.html" class="podlinkpod" +>RegexTokenizer</a>, +and a <a href="../../Lucy/Analysis/SnowballStemmer.html" class="podlinkpod" +>SnowballStemmer</a> will be generated for you.</p> + +<p>The language parameter is DEPRECATED. +Use <a href="../../Lucy/Analysis/EasyAnalyzer.html" class="podlinkpod" +>EasyAnalyzer</a> instead.</p> + +<p>Supported languages:</p> + +<pre>en => English, +da => Danish, +de => German, +es => Spanish, +fi => Finnish, +fr => French, +hu => Hungarian, +it => Italian, +nl => Dutch, +no => Norwegian, +pt => Portuguese, +ro => Romanian, +ru => Russian, +sv => Swedish, +tr => Turkish,</pre> + +<h2><a class='u' +name="CONSTRUCTORS" +>CONSTRUCTORS</a></h2> + +<h3><a class='u' +name="new" +>new</a></h3> + +<pre>my $tokenizer = Lucy::Analysis::StandardTokenizer->new; +my $normalizer = Lucy::Analysis::Normalizer->new; +my $stemmer = Lucy::Analysis::SnowballStemmer->new( language => 'en' ); +my $polyanalyzer = Lucy::Analysis::PolyAnalyzer->new( + analyzers => [ $tokenizer, $normalizer, $stemmer, ], );</pre> + +<p>Create a new PolyAnalyzer.</p> + +<ul> +<li><b>language</b> - An ISO code from the list of supported languages. +DEPRECATED, +use <a href="../../Lucy/Analysis/EasyAnalyzer.html" class="podlinkpod" +>EasyAnalyzer</a> instead.</li> + +<li><b>analyzers</b> - An array of Analyzers. +The order of the analyzers matters. +Don’t put a SnowballStemmer before a RegexTokenizer (can’t stem whole documents or paragraphs – just individual words), +or a SnowballStopFilter after a SnowballStemmer (stemmed words, +e.g. +“themselv”, +will not appear in a stoplist). +In general, +the sequence should be: tokenize, +normalize, +stopalize, +stem.</li> +</ul> + +<h2><a class='u' +name="METHODS" +>METHODS</a></h2> + +<h3><a class='u' +name="get_analyzers" +>get_analyzers</a></h3> + +<pre>my $arrayref = $poly_analyzer->get_analyzers();</pre> + +<p>Getter for “analyzers” member.</p> + +<h3><a class='u' +name="transform" +>transform</a></h3> + +<pre>my $inversion = $poly_analyzer->transform($inversion);</pre> + +<p>Take a single <a href="../../Lucy/Analysis/Inversion.html" class="podlinkpod" +>Inversion</a> as input and returns an Inversion, +either the same one (presumably transformed in some way), +or a new one.</p> + +<ul> +<li><b>inversion</b> - An inversion.</li> +</ul> + +<h2><a class='u' +name="INHERITANCE" +>INHERITANCE</a></h2> + +<p>Lucy::Analysis::PolyAnalyzer isa <a href="../../Lucy/Analysis/Analyzer.html" class="podlinkpod" +>Lucy::Analysis::Analyzer</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/Analysis/RegexTokenizer.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/perl/Lucy/Analysis/RegexTokenizer.html (added) +++ websites/staging/lucy/trunk/content/docs/perl/Lucy/Analysis/RegexTokenizer.html Mon Apr 4 09:23:29 2016 @@ -0,0 +1,196 @@ +<!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::Analysis::RegexTokenizer â 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/Analysis/">Analysis</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::Analysis::RegexTokenizer - Split a string into tokens.</p> + +<h2><a class='u' +name="SYNOPSIS" +>SYNOPSIS</a></h2> + +<pre>my $whitespace_tokenizer + = Lucy::Analysis::RegexTokenizer->new( pattern => '\S+' ); + +# or... +my $word_char_tokenizer + = Lucy::Analysis::RegexTokenizer->new( pattern => '\w+' ); + +# or... +my $apostrophising_tokenizer = Lucy::Analysis::RegexTokenizer->new; + +# Then... once you have a tokenizer, put it into a PolyAnalyzer: +my $polyanalyzer = Lucy::Analysis::PolyAnalyzer->new( + analyzers => [ $word_char_tokenizer, $normalizer, $stemmer ], );</pre> + +<h2><a class='u' +name="DESCRIPTION" +>DESCRIPTION</a></h2> + +<p>Generically, +“tokenizing” is a process of breaking up a string into an array of “tokens”. +For instance, +the string “three blind mice” might be tokenized into “three”, +“blind”, +“mice”.</p> + +<p>Lucy::Analysis::RegexTokenizer decides where it should break up the text based on a regular expression compiled from a supplied <code>pattern</code> matching one token. +If our source string is…</p> + +<pre>"Eats, Shoots and Leaves."</pre> + +<p>… then a “whitespace tokenizer” with a <code>pattern</code> of <code>"\\S+"</code> produces…</p> + +<pre>Eats, +Shoots +and +Leaves.</pre> + +<p>… while a “word character tokenizer” with a <code>pattern</code> of <code>"\\w+"</code> produces…</p> + +<pre>Eats +Shoots +and +Leaves</pre> + +<p>… the difference being that the word character tokenizer skips over punctuation as well as whitespace when determining token boundaries.</p> + +<h2><a class='u' +name="CONSTRUCTORS" +>CONSTRUCTORS</a></h2> + +<h3><a class='u' +name="new" +>new</a></h3> + +<pre>my $word_char_tokenizer = Lucy::Analysis::RegexTokenizer->new( + pattern => '\w+', # required +);</pre> + +<p>Create a new RegexTokenizer.</p> + +<ul> +<li><b>pattern</b> - A string specifying a Perl-syntax regular expression which should match one token. +The default value is <code>\w+(?:[\x{2019}']\w+)*</code>, +which matches “it’s” as well as “it” and “O’Henry’s” as well as “Henry”.</li> +</ul> + +<h2><a class='u' +name="METHODS" +>METHODS</a></h2> + +<h3><a class='u' +name="transform" +>transform</a></h3> + +<pre>my $inversion = $regex_tokenizer->transform($inversion);</pre> + +<p>Take a single <a href="../../Lucy/Analysis/Inversion.html" class="podlinkpod" +>Inversion</a> as input and returns an Inversion, +either the same one (presumably transformed in some way), +or a new one.</p> + +<ul> +<li><b>inversion</b> - An inversion.</li> +</ul> + +<h2><a class='u' +name="INHERITANCE" +>INHERITANCE</a></h2> + +<p>Lucy::Analysis::RegexTokenizer isa <a href="../../Lucy/Analysis/Analyzer.html" class="podlinkpod" +>Lucy::Analysis::Analyzer</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/Analysis/SnowballStemmer.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/perl/Lucy/Analysis/SnowballStemmer.html (added) +++ websites/staging/lucy/trunk/content/docs/perl/Lucy/Analysis/SnowballStemmer.html Mon Apr 4 09:23:29 2016 @@ -0,0 +1,166 @@ +<!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::Analysis::SnowballStemmer â 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/Analysis/">Analysis</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::Analysis::SnowballStemmer - Reduce related words to a shared root.</p> + +<h2><a class='u' +name="SYNOPSIS" +>SYNOPSIS</a></h2> + +<pre>my $stemmer = Lucy::Analysis::SnowballStemmer->new( language => 'es' ); + +my $polyanalyzer = Lucy::Analysis::PolyAnalyzer->new( + analyzers => [ $tokenizer, $normalizer, $stemmer ], +);</pre> + +<p>This class is a wrapper around the Snowball stemming library, +so it supports the same languages.</p> + +<h2><a class='u' +name="DESCRIPTION" +>DESCRIPTION</a></h2> + +<p>SnowballStemmer is an <a href="../../Lucy/Analysis/Analyzer.html" class="podlinkpod" +>Analyzer</a> which reduces related words to a root form (using the “Snowball” stemming library). +For instance, +“horse”, +“horses”, +and “horsing” all become “hors” – so that a search for ‘horse’ will also match documents containing ‘horses’ and ‘horsing’.</p> + +<h2><a class='u' +name="CONSTRUCTORS" +>CONSTRUCTORS</a></h2> + +<h3><a class='u' +name="new" +>new</a></h3> + +<pre>my $stemmer = Lucy::Analysis::SnowballStemmer->new( language => 'es' );</pre> + +<p>Create a new SnowballStemmer.</p> + +<ul> +<li><b>language</b> - A two-letter ISO code identifying a language supported by Snowball.</li> +</ul> + +<h2><a class='u' +name="METHODS" +>METHODS</a></h2> + +<h3><a class='u' +name="transform" +>transform</a></h3> + +<pre>my $inversion = $snowball_stemmer->transform($inversion);</pre> + +<p>Take a single <a href="../../Lucy/Analysis/Inversion.html" class="podlinkpod" +>Inversion</a> as input and returns an Inversion, +either the same one (presumably transformed in some way), +or a new one.</p> + +<ul> +<li><b>inversion</b> - An inversion.</li> +</ul> + +<h2><a class='u' +name="INHERITANCE" +>INHERITANCE</a></h2> + +<p>Lucy::Analysis::SnowballStemmer isa <a href="../../Lucy/Analysis/Analyzer.html" class="podlinkpod" +>Lucy::Analysis::Analyzer</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/Analysis/SnowballStopFilter.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/perl/Lucy/Analysis/SnowballStopFilter.html (added) +++ websites/staging/lucy/trunk/content/docs/perl/Lucy/Analysis/SnowballStopFilter.html Mon Apr 4 09:23:29 2016 @@ -0,0 +1,203 @@ +<!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::Analysis::SnowballStopFilter â 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/Analysis/">Analysis</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::Analysis::SnowballStopFilter - Suppress a “stoplist” of common words.</p> + +<h2><a class='u' +name="SYNOPSIS" +>SYNOPSIS</a></h2> + +<pre>my $stopfilter = Lucy::Analysis::SnowballStopFilter->new( + language => 'fr', +); +my $polyanalyzer = Lucy::Analysis::PolyAnalyzer->new( + analyzers => [ $tokenizer, $normalizer, $stopfilter, $stemmer ], +);</pre> + +<h2><a class='u' +name="DESCRIPTION" +>DESCRIPTION</a></h2> + +<p>A “stoplist” is collection of “stopwords”: words which are common enough to be of little value when determining search results. +For example, +so many documents in English contain “the”, +“if”, +and “maybe” that it may improve both performance and relevance to block them.</p> + +<p>Before filtering stopwords:</p> + +<pre>("i", "am", "the", "walrus")</pre> + +<p>After filtering stopwords:</p> + +<pre>("walrus")</pre> + +<p>SnowballStopFilter provides default stoplists for several languages, +courtesy of the <a href="http://snowball.tartarus.org" class="podlinkurl" +>Snowball project</a>, +or you may supply your own.</p> + +<pre>|-----------------------| +| ISO CODE | LANGUAGE | +|-----------------------| +| da | Danish | +| de | German | +| en | English | +| es | Spanish | +| fi | Finnish | +| fr | French | +| hu | Hungarian | +| it | Italian | +| nl | Dutch | +| no | Norwegian | +| pt | Portuguese | +| sv | Swedish | +| ru | Russian | +|-----------------------|</pre> + +<h2><a class='u' +name="CONSTRUCTORS" +>CONSTRUCTORS</a></h2> + +<h3><a class='u' +name="new" +>new</a></h3> + +<pre>my $stopfilter = Lucy::Analysis::SnowballStopFilter->new( + language => 'de', +); + +# or... +my $stopfilter = Lucy::Analysis::SnowballStopFilter->new( + stoplist => \%stoplist, +);</pre> + +<p>Create a new SnowballStopFilter.</p> + +<ul> +<li><b>stoplist</b> - A hash with stopwords as the keys.</li> + +<li><b>language</b> - The ISO code for a supported language.</li> +</ul> + +<h2><a class='u' +name="METHODS" +>METHODS</a></h2> + +<h3><a class='u' +name="transform" +>transform</a></h3> + +<pre>my $inversion = $snowball_stop_filter->transform($inversion);</pre> + +<p>Take a single <a href="../../Lucy/Analysis/Inversion.html" class="podlinkpod" +>Inversion</a> as input and returns an Inversion, +either the same one (presumably transformed in some way), +or a new one.</p> + +<ul> +<li><b>inversion</b> - An inversion.</li> +</ul> + +<h2><a class='u' +name="INHERITANCE" +>INHERITANCE</a></h2> + +<p>Lucy::Analysis::SnowballStopFilter isa <a href="../../Lucy/Analysis/Analyzer.html" class="podlinkpod" +>Lucy::Analysis::Analyzer</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/Analysis/StandardTokenizer.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/perl/Lucy/Analysis/StandardTokenizer.html (added) +++ websites/staging/lucy/trunk/content/docs/perl/Lucy/Analysis/StandardTokenizer.html Mon Apr 4 09:23:29 2016 @@ -0,0 +1,163 @@ +<!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::Analysis::StandardTokenizer â 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/Analysis/">Analysis</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::Analysis::StandardTokenizer - Split a string into tokens.</p> + +<h2><a class='u' +name="SYNOPSIS" +>SYNOPSIS</a></h2> + +<pre>my $tokenizer = Lucy::Analysis::StandardTokenizer->new; + +# Then... once you have a tokenizer, put it into a PolyAnalyzer: +my $polyanalyzer = Lucy::Analysis::PolyAnalyzer->new( + analyzers => [ $tokenizer, $normalizer, $stemmer ], );</pre> + +<h2><a class='u' +name="DESCRIPTION" +>DESCRIPTION</a></h2> + +<p>Generically, +“tokenizing” is a process of breaking up a string into an array of “tokens”. +For instance, +the string “three blind mice” might be tokenized into “three”, +“blind”, +“mice”.</p> + +<p>Lucy::Analysis::StandardTokenizer breaks up the text at the word boundaries defined in Unicode Standard Annex #29. +It then returns those words that contain alphabetic or numeric characters.</p> + +<h2><a class='u' +name="CONSTRUCTORS" +>CONSTRUCTORS</a></h2> + +<h3><a class='u' +name="new" +>new</a></h3> + +<pre>my $tokenizer = Lucy::Analysis::StandardTokenizer->new;</pre> + +<p>Constructor. +Takes no arguments.</p> + +<h2><a class='u' +name="METHODS" +>METHODS</a></h2> + +<h3><a class='u' +name="transform" +>transform</a></h3> + +<pre>my $inversion = $standard_tokenizer->transform($inversion);</pre> + +<p>Take a single <a href="../../Lucy/Analysis/Inversion.html" class="podlinkpod" +>Inversion</a> as input and returns an Inversion, +either the same one (presumably transformed in some way), +or a new one.</p> + +<ul> +<li><b>inversion</b> - An inversion.</li> +</ul> + +<h2><a class='u' +name="INHERITANCE" +>INHERITANCE</a></h2> + +<p>Lucy::Analysis::StandardTokenizer isa <a href="../../Lucy/Analysis/Analyzer.html" class="podlinkpod" +>Lucy::Analysis::Analyzer</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>