perldoc > Plucene::Search::IndexSearcher

man perldoc info pydoc3 ri search

🏷️ NAME

Plucene::Search::IndexSearcher - The index searcher

🚀 Quick Reference

Use Case	Command	Description
Create a searcher	Plucene::Search::IndexSearcher->new($reader)	Instantiate a new searcher over an IndexReader
Get the underlying reader	$searcher->reader	Returns the IndexReader
Fetch a document by ID	$reader->doc($id)	Retrieves a Plucene::Document
Get top search results	$searcher->search_top	Returns top search results
Get/set document frequency	$searcher->doc_freq	Document frequency (get/set)
Get/set maximum document count	$searcher->max_doc	Maximum document count (get/set)
Close the searcher	$searcher->close	Closes associated reader(s)

📜 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 - get / set document frequency
• max_doc - get / set maximum document count
• close

  $searcher->close;

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

🏷️ NAME 🚀 Quick Reference 📜 SYNOPSIS 📖 DESCRIPTION 🔧 METHODS