plucene::index::reader(3pm) [debian man page]

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

NAME

       Plucene::Index::Reader - Abstract class for accessing an index

DESCRIPTION

       IndexReader is an abstract class, providing an interface for accessing an index.  Search of an index is done entirely through this abstract
       interface, so that any subclass which implements it is searchable.

       Concrete subclasses of IndexReader are usually constructed with a call to the static method "open".

       For efficiency, in this API documents are often referred to via document numbers, non-negative integers which each name a unique document
       in the index.  These document numbers are ephemeral--they may change as documents are added to and deleted from an index.  Clients should
       thus not rely on a given document having the same number between sessions.

METHODS

   new
	       my $reader = Plucene::Index::Reader->new($dir_name);

       This will create a new Plucene::Index::Reader with the passed in directory.

   open
	       # If there is only one segment
	       my Plucene::Index::SegmentReader $seg_read = $reader->open;

	       # If there are many segments
	       my Plucene::Index::SegmentsReader $seg_read = $reader->open;

       Returns an IndexReader reading the index in the given Directory.

   last_modified
	       my $last_modified = Plucene::Index::Reader->last_modified($directory);

   index_exists
	       if (Plucene::Index::Reader->index_exists($directory)){ ... }

   is_locked
	       if (Plucene::Index::Reader->is_locked($directory)){ ... }

   delete
	       $reader->delete($doc);

   delete_term
	       $reader->delete_term($term);

       This will delete all the documents which contain the passed term.

   close
	       $reader->close;

   unlock
	       $reader->unlock($directory);

   num_docs / max_doc / document / is_deleted / norms / terms / doc_freq / term_docs / term_positions / _do_delete / _do_close
       These must be defined in a subclass

perl v5.12.4							    2011-08-14					       Plucene::Index::Reader(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)