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

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

NAME

       Plucene::Index::FieldInfos - a collection of FieldInfo objects

SYNOPSIS

	       my $fis = Plucene::Index::FieldInfos->new($dir_name);
	       my $fis = Plucene::Index::FieldInfos->new($dir_name, $file);

	       $fis->add(Plucene::Document $doc, $indexed);
	       $fis->add(Plucene::Index::FieldInfos $other_fis, $indexed);
	       $fis->add($name, $indexed);

	       $fis->write($path);

	       my @fields = $fis->fields;

	       my $field_number = $fis->field_number($name);
	       my   $field_info = $fis->field_info($name);
	       my   $field_name = $fis->field_name($number);
	       my   $num_fields = $fis->size;

DESCRIPTION

       This is a collection of field info objects, which happen to live in the field infos file.

METHODS

   new
	       my $fis = Plucene::Index::FieldInfos->new($dir_name);
	       my $fis = Plucene::Index::FieldInfos->new($dir_name, $file);

       This will create a new Plucene::Index::FieldInfos object with the passed directory and optional filename.

   add
	       $fis->add(Plucene::Document $doc, $indexed);
	       $fis->add(Plucene::Index::FieldInfos $other_fis, $indexed);
	       $fis->add($name, $indexed);

       This will add the fields from a Plucene::Document or a Plucene::Index::FieldsInfos to the field infos file.

       It is also possible to pass the name of a field and have it added to the file.

   field_number
	       my $field_number = $fis->field_number($name);

       This will return the field number of the field with $name. If there is no match, then -1 is returned.

   fields
	       my @fields = $fis->fields;

       This will return all the fields.

   field_info
	       my $field_info = $fis->field_info($name);

       This will return the field info for the field called $name.

   field_name
	       my $field_name = $fis->field_name($number);

       This will return the field name for the field whose number is $number.

   size
	       my $num_fields = $fis->size;

       This returns the number of field info objects.

   write
	       $fis->write($path);

       This will write the field info objects to $path.

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