Marvin Humphrey > KinoSearch1 > KinoSearch1::Search::QueryFilter

Download:
KinoSearch1-1.01.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Source  

NAME ^

KinoSearch1::Search::QueryFilter - build a filter based on results of a query

SYNOPSIS ^

    my $books_only_query  = KinoSearch1::Search::TermQuery->new(
        term => KinoSearch1::Index::Term->new( 'category', 'books' );
    );
    my $filter = KinoSearch1::Search::QueryFilter->new(
        query => $books_only_query;
    );
    my $hits = $searcher->search(
        query  => $query_string,
        filter => $filter,
    );

DESCRIPTION ^

A QueryFilter spawns a result set that can be used to filter the results of another query. The effect is very similar to adding a required clause to a BooleanQuery -- however, a QueryFilter caches its results, so it is more efficient if you use it more than once.

METHODS ^

new

    my $filter = KinoSearch1::Search::QueryFilter->new(
        query => $query;
    );

Constructor. Takes one hash-style parameter, query, which must be an object belonging to a subclass of KinoSearch1::Search::Query.

COPYRIGHT ^

Copyright 2005-2010 Marvin Humphrey

LICENSE, DISCLAIMER, BUGS, etc. ^

See KinoSearch1 version 1.01.

syntax highlighting: