NAME

Plucene::Search::DateFilter - Restrict searches to given time periods

SYNOPSIS

        my $filter = Plucene::Search::DateFilter->new({
                field => "date",
                from  => Time::Piece $from,
                to    => Time::Piece $to
        })
        my $hits = $searcher->search($query, $filter);

DESCRIPTION

This class can restrict the results of a search to a set of dates. This requires a field to have been indexed using Plucene::Document::DateSerializer. See the documentation for that module for how to do this.

METHODS

new

        my $filter = Plucene::Search::DateFilter->new({
                field => "date",
                from  => Time::Piece $from,
                to    => Time::Piece $to
        })

This creates a new filter. Either of from or to are optional.

bits

This is used by the searcher to iterate over the documents and return a bitfield specifying which documents are included in the range.