/usr/lib/x86_64-linux-gnu/perl5/5.24/Lucy/Search/Collector.pod is in liblucy-perl 0.3.3-7+b1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 | # Auto-generated file -- DO NOT EDIT!!!!!
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
=head1 NAME
Lucy::Search::Collector - Process hits.
=head1 SYNOPSIS
# Abstract base class.
=head1 DESCRIPTION
A Collector decides what to do with the hits that a
L<Matcher|Lucy::Search::Matcher> iterates through, based on how the
abstract collect() method is implemented.
Collectors operate on individual segments, but must operate within the
context of a larger collection. Each time the collector moves to a new
segment, set_reader(), set_base() and set_matcher() will be called, and the
collector must take the updated information into account.
=head1 CONSTRUCTORS
=head2 new()
package MyCollector;
use base qw( Lucy::Search::Collector );
our %foo;
sub new {
my $self = shift->SUPER::new;
my %args = @_;
$foo{$$self} = $args{foo};
return $self;
}
Abstract constructor. Takes no arguments.
=head1 ABSTRACT METHODS
=head2 collect(doc_id)
Do something with a doc id. (For instance, keep track of the docs
with the ten highest scores.)
=over
=item *
B<doc_id> - A segment document id.
=back
=head1 INHERITANCE
Lucy::Search::Collector isa L<Lucy::Object::Obj>.
=cut
|