plucene::search::indexsearcher(3pm) [debian man page]

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)

Plucene::Index::SegmentReader(3pm)			User Contributed Perl Documentation			Plucene::Index::SegmentReader(3pm)

NAME

       Plucene::Index::SegmentReader - the Segment reader

SYNOPSIS

	       my $seg_reader =
		 Plucene::Index::SegmentReader->new( Plucene::Index::SegmentInfo $si);

	       my @files = $seg_reader->files;
	       my @terms = $seg_reader->terms;
	       my $doc = $seg_reader->document($id);
	       my $doc_freq = $seg_reader->doc_freq($term);
	       my $max_doc = $seg_reader->max_doc;
	       my $norms = $seg_reader->norms($field, $offset);

	       my Plucene::Index::SegmentTermDocs $docs
		       = $seg_reader->term_docs($term);

	       my Plucene::Index::SegmentTermPositions $pos
		       = $seg_reader->term_positions($term);

	       my Plucene::Store::InputStream $stream
		       = $seg_reader->norm_stream($field);

	       if ($seg_reader->is_deleted($id)) {  .. }
	       if ($seg_reader->has_deletions(Plucene::Index::SegmentInfo $si))
		       {  ... }

DESCRIPTION

       The segment reader class.

METHODS

   new
	       my $seg_reader =
		 Plucene::Index::SegmentReader->new( Plucene::Index::SegmentInfo $si);

       This will create a new Plucene::Index::SegmentReader object.

   has_deletions
	       if ($seg_reader->has_deletions(Plucene::Index::SegmentInfo $si))
		       {  ... }

   files
	       my @files = $seg_reader->files;

   terms
	       my @terms = $seg_reader->terms;

   document
	       my $doc = $seg_reader->document($id);

   is_deleted
	       if ($seg_reader->is_deleted($id)) {  .. }

   term_docs
	       my Plucene::Index::SegmentTermDocs $docs
		       = $seg_reader->term_docs($term);

       This will return the Plucene::Index::SegmentTermDocs object for the given term.

   term_positions
	       my Plucene::Index::SegmentTermPositions $pos
		       = $seg_reader->term_positions($term);

       This will return the Plucene::Index::SegmentTermPositions object for the given term.

   doc_freq
	       my $doc_freq = $seg_reader->doc_freq($term);

       This returns the number of documents containing the passed term.

   num_docs
	       my $num_docs = $seg_reader->num_docs;

       This is the number of documents, excluding deleted ones.

   max_doc
	       my $max_doc = $seg_reader->max_doc;

   norms
	       my $norms = $seg_reader->norms($field, $offset);

       This returns the byte-encoded normalisation factor for the passed field. This is used by the search code to score documents.

       Note we are not using the 'offset' and 'bytes' arguments per the Java.  Instead, callers should use substr to put the result of "norms"
       into the appropriate place in a string.

   norm_stream
	       my Plucene::Store::InputStream $stream
		       = $seg_reader->norm_stream($field);

       This will return the Plucene::Store::InputStream for the passed field.

perl v5.12.4							    2011-08-14					Plucene::Index::SegmentReader(3pm)