debian man page for plucene::search::indexsearcher

Plucene::Search::IndexSearcher(3pm)			User Contributed Perl Documentation		       Plucene::Search::IndexSearcher(3pm)

NAME
       Plucene::Search::IndexSearcher - The index searcher

SYNOPSIS
	       # isa Plucene::Search::Searcher

	       my $searcher = Plucene::Search::IndexSearcher
		       ->new(Plucene::Index::Reader $reader);

	       my Plucene::Index::Reader $reader = $searcher->reader;
	       my	  Plucene::Document $doc = $reader->doc($id);

	       $searcher->close;

DESCRIPTION
       Search over an IndexReader

METHODS
   new
	       my $searcher = Plucene::Search::IndexSearcher
		       ->new(Plucene::Index::Reader $reader);

       This will create a new Searcher object with the passed Plucene::Index::Reader or subclass thereof.

   reader
	       my Plucene::Index::Reader $reader = $searcher->reader;

       This will return the reader this searcher was made with.

   search_top
       The top search results.

   doc
	       my Plucene::Document $doc = $reader->doc($id);

       This will return the Plucene::Document $id.

   doc_freq / max_doc
       get / set these

   close
       This will close the reader(s) associated with the searcher.

perl v5.12.4							    2011-08-14				       Plucene::Search::IndexSearcher(3pm)