---
name: "Plucene::Search::HitCollector"
section: "3pm"
platform: "linux"
package: "libplucene-perl"
version: "1.25-5"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/Plucene::Search::HitCollector"
---

# Plucene::Search::HitCollector(3pm)

## NAME

Plucene::Search::HitCollector

## SYNOPSIS

```
        # used in conjunction with the IndexSearcher
        my $searcher = Plucene::Search::IndexSearcher->new($DIRECTORY);
        my $hc = Plucene::Search::HitCollector->new( collect =>
                sub {
                        my ($self, $doc, $score) = @_;
                        ...
        });
        $searcher->search_hc($QUERY, $hc);
```

## DESCRIPTION

This is used in conjunction with the IndexSearcher, in that whenever a  non-zero scoring document is found, the subref with with the HitCollector was made will get called.

## METHODS

### new

```
        my $hc = Plucene::Search::HitCollector->new( collect =>
                sub {
                        my ($self, $doc, $score) = @_;
                        ...
        });
```

This will create a new Plucene::Search::HitCollector with the passed subref.

### collect

This is called once for every non-zero scoring document, with the document  number and its score.