Simon Cozens > Plucene-1.19 > Plucene::Index::SegmentTermDocs

Download:
Plucene-1.19.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  12
Open  5
View/Report Bugs
Source   Latest Release: Plucene-1.25

NAME ^

Plucene::Index::SegmentTermDocs - Segment term docs

SYNOPSIS ^

        my $seg_term_docs = Plucene::Index::SegmentTermDocs
                ->new(Plucene::Index::SegmentReader $seg_reader);
        
        $seg_term_docs->seek($term);
        $seg_term_docs->next;
        $seg_term_docs->read;
        $seg_term_docs->skip_to($target);

DESCRIPTION ^

This is the segment term docs class.

METHODS ^

new

        my $seg_term_docs = Plucene::Index::SegmentTermDocs
                ->new(Plucene::Index::SegmentReader $seg_reader);

This will create a new Plucene::Index::SegmentTermDocs object with the passed segment reader.

parent / freq_stream / freq_count / deleted_docs / doc / freq

Get / set these attributes.

seek

        $seg_term_docs->seek($term);

skipping_doc

Does nothing.

next

        $seg_term_docs->next;

read

        $seg_term_docs->read;

skip_to

        $seg_term_docs->skip_to($target);
syntax highlighting: