Free Knowledge Resources


Linux Manual Pages


Free Software * Books

Source Code

Free Media

Linux

Plucene(3pm)


NAME

   Plucene - A Perl port of the Lucene search engine

SYNOPSIS

   Create Documents by adding Fields:
           my $doc = Plucene::Document->new;
           $doc->add(Plucene::Document::Field->Text(content => $content));
           $doc->add(Plucene::Document::Field->Text(author => "Your Name"));

   Choose Your Analyser and add documents to an Index Writer
           my $analyzer = Plucene::Analysis::SimpleAnalyzer->new();
           my $writer = Plucene::Index::Writer->new("my_index", $analyzer, 1);

           $writer->add_document($doc);
           undef $writer; # close

   Search by building a Query

           my $parser = Plucene::QueryParser->new({
                   analyzer => Plucene::Analysis::SimpleAnalyzer->new(),
                   default  => "text" # Default field for non-specified queries
           });
           my $query = $parser->parse('author:"Your Name"');

   Then pass the Query to an IndexSearcher and collect hits

           my $searcher = Plucene::Search::IndexSearcher->new("my_index");

           my @docs;
           my $hc = Plucene::Search::HitCollector->new(collect => sub {
                   my ($self, $doc, $score) = @_;
                   push @docs, $searcher->doc($doc);
           });

           $searcher->search_hc($query => $hc);

DESCRIPTION

   Plucene is a fully-featured and highly customizable search engine
   toolkit based on the Lucene API. (<http://jakarta.apache.org/lucene>)

   It is not, in and of itself, a functional search engine - you are
   expected to subclass and tie all the pieces together to suit your own
   needs.  The synopsis above gives a rough indication of how to use the
   engine in simple cases. See Plucene::Simple for one example of tying it
   all together.

   The tests shipped with Plucene provide a variety of other examples of
   how use this.

EXTENSIONS

   Plucene comes shipped with some default Analyzers. However it is
   expected that users will want to create Analyzers to meet their own
   needs. To avoid namespace corruption, anyone releasing such Analyzers
   to CPAN (which is encouraged!) should place them in the namespace
   Plucene::Plugin::Analyzer::.

DOCUMENTATION

   Although most of the Perl modules should be well documented, the Perl
   API mirrors Lucene's to such an extent that reading Lucene's
   documentation will give you a good idea of how to do more advanced
   stuff with Plucene. See particularly the ONJava articles
   <http://www.onjava.com/pub/a/onjava/2003/01/15/lucene.html> and
   <http://www.onjava.com/pub/a/onjava/2003/03/05/lucene.html>. These are
   brilliant introductions to the concepts surrounding Lucene, how it
   works, and how to extend it.

COMPATIBILITY

   For the most part Lucene and Plucene indexes are created in the same
   manner. However, due to current implementation details, the indexes
   will generally not be compatible. It should theoretically be possible
   to convert index files in either direction between Plucene and Lucene,
   but no tools are currently provided to do so.

   As Plucene is still undergoing development, we cannot guarantee index
   format compatibility across releases. If you're using Plucene in
   production code, you need to ensure that you can recreate the indexes.

MISSING FEATURES

   The following features have not yet been fully implemented:

   *   Wildcard searches

   *   Range searches

MAILING LIST

   Bug reports, patches, queries, discussion etc should be addressed to
   the mailing list. More information on the list can be found at:

   <http://www.kasei.com/mailman/listinfo/plucene>

AUTHORS

   Initially ported by Simon Cozens and Marc Kerr.

   Currently maintained by Tony Bowden and Marty Pauley.

   Original Java Lucene by Doug Cutting and others.

THANKS

   The initial development and ongoing maintenance of Plucene has been
   funded and supported by Kasei <http://www.kasei.com/>

LICENSE

   This software is licensed under the same terms as Perl itself.



Opportunity


Personal Opportunity - Free software gives you access to billions of dollars of software at no cost. Use this software for your business, personal use or to develop a profitable skill. Access to source code provides access to a level of capabilities/information that companies protect though copyrights. Open source is a core component of the Internet and it is available to you. Leverage the billions of dollars in resources and capabilities to build a career, establish a business or change the world. The potential is endless for those who understand the opportunity.

Business Opportunity - Goldman Sachs, IBM and countless large corporations are leveraging open source to reduce costs, develop products and increase their bottom lines. Learn what these companies know about open source and how open source can give you the advantage.



Free Software


Free Software provides computer programs and capabilities at no cost but more importantly, it provides the freedom to run, edit, contribute to, and share the software. The importance of free software is a matter of access, not price. Software at no cost is a benefit but ownership rights to the software and source code is far more significant.

Free Office Software - The Libre Office suite provides top desktop productivity tools for free. This includes, a word processor, spreadsheet, presentation engine, drawing and flowcharting, database and math applications. Libre Office is available for Linux or Windows.



Free Books


The Free Books Library is a collection of thousands of the most popular public domain books in an online readable format. The collection includes great classical literature and more recent works where the U.S. copyright has expired. These books are yours to read and use without restrictions.

Source Code - Want to change a program or know how it works? Open Source provides the source code for its programs so that anyone can use, modify or learn how to write those programs themselves. Visit the GNU source code repositories to download the source.



Education


Study at Harvard, Stanford or MIT - Open edX provides free online courses from Harvard, MIT, Columbia, UC Berkeley and other top Universities. Hundreds of courses for almost all major subjects and course levels. Open edx also offers some paid courses and selected certifications.

Linux Manual Pages - A man or manual page is a form of software documentation found on Linux/Unix operating systems. Topics covered include computer programs (including library and system calls), formal standards and conventions, and even abstract concepts.


birds banner