1Lucy::Index::LexiconReaUdseerr(3C)ontributed Perl DocumeLnutcayt:i:oInndex::LexiconReader(3)
2
3
4

NAME

6       Lucy::Index::LexiconReader - Read Lexicon data.
7

SYNOPSIS

9           my $lex_reader = $seg_reader->obtain("Lucy::Index::LexiconReader");
10           my $lexicon    = $lex_reader->lexicon( field => 'title' );
11

DESCRIPTION

13       LexiconReader reads term dictionary information.
14

ABSTRACT METHODS

16   lexicon
17           my $lexicon = $lexicon_reader->lexicon(
18               field => $field,  # required
19               term  => $term,   # default: undef
20           );
21
22       Return a new Lexicon for the given "field".  Will return undef if
23       either the field is not indexed, or if no documents contain a value for
24       the field.
25
26       •   field - Field name.
27
28       •   term - Pre-locate the Lexicon to this term.
29
30   doc_freq
31           my $int = $lexicon_reader->doc_freq(
32               field => $field,  # required
33               term  => $term,   # required
34           );
35
36       Return the number of documents where the specified term is present.
37

METHODS

39   aggregator
40           my $result = $lexicon_reader->aggregator(
41               readers => $readers,  # required
42               offsets => $offsets,  # required
43           );
44
45       Return a LexiconReader which merges the output of other LexiconReaders.
46
47       •   readers - An array of LexiconReaders.
48
49       •   offsets - Doc id start offsets for each reader.
50

INHERITANCE

52       Lucy::Index::LexiconReader isa Lucy::Index::DataReader isa
53       Clownfish::Obj.
54
55
56
57perl v5.34.0                      2021-07-22     Lucy::Index::LexiconReader(3)