debian man page for plucene::index::terminfoswriter

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

NAME
       Plucene::Index::TermInfosWriter - write to the term infos file

SYNOPSIS
	       my $writer = Plucene::Index::TermInfosWriter->new(
		       $dir_name, $segment, $field_infos);

	       $writer->add(Plucene::Index::Term $term,
			       Plucene::Index::TermInfo $term_info);

	       $writer->write_term(Plucene::Index::Term $term);

DESCRIPTION
       This will allow for the writing and adding to a term infos file for a particular segment. It also writes the term infos index.

METHODS
   new
	       my $writer = Plucene::Index::TermInfosWriter->new(
		       $dir_name, $segment, $field_infos);

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

   break_ref
       This will break a circular reference.

   add
	       $writer->add(Plucene::Index::Term $term,
			       Plucene::Index::TermInfo $term_info);

       This will add the term and term info to the term infos file.

   write_term
	       $writer->write_term(Plucene::Index::Term $term);

       This will write the term to the term infos file.

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