• NAME
• SYNOPSIS
• METHODS
• new
• seek
• skipping_doc
• next
• read
• skip_to

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);

=head1 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.

=head2 parent / freq_stream / freq_count / deleted_docs / doc / freq

Get / set these attributes.

=cut

sub new { my $self = shift; my $seg_reader = shift; return bless { parent => $seg_reader, freq_stream => $seg_reader->freq_stream, # listref deleted_docs => $seg_reader->deleted_docs, doc => 0, } => $self; }

seek

        $seg_term_docs->seek($term);

skipping_doc

By default this does nothing. You may wish to override it to do something.

next

        $seg_term_docs->next;

read

        $seg_term_docs->read;

skip_to

        $seg_term_docs->skip_to($target);