Plucene::Index::SegmentTermDocs - Segment term docs


Plucene documentation  | view source Contained in the Plucene distribution.

Index


NAME

Top

Plucene::Index::SegmentTermDocs - Segment term docs

SYNOPSIS

Top

	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

Top

This is the segment term docs class.

METHODS

Top

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

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


Plucene documentation  | view source Contained in the Plucene distribution.