Tony Bowden > Plucene > Plucene::Index::TermInfosWriter

Download:
Plucene-1.25.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  12
Open  5
View/Report Bugs
Source  

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.

syntax highlighting: