Author image Marvin Humphrey
and 1 contributors


KinoSearch::Search::Query - A specification for a search query.


    # Query is an abstract base class.
    package MyQuery;
    use base qw( KinoSearch::Search::Query );
    sub make_compiler {
        my $self = shift;
        return MyCompiler->new( @_, parent => $self );
    package MyCompiler;
    use base ( KinoSearch::Search::Compiler );


A specification for a search query.

Query objects are simple containers which contain the minimum information necessary to define a search query.

The most common way to generate Query objects is to feed a search string such as 'foo AND bar' to a QueryParser's parse() method, which outputs an abstract syntax tree built up from various Query subclasses such as ANDQuery and TermQuery. However, it is also possible to use custom Query objects to build a search specification which cannot be easily represented using a search string.

Subclasses of Query must implement make_compiler(), which is the first step in compiling a Query down to a Matcher which can actually match and score documents.


new( [labeled params] )

    my $query = MyQuery->SUPER::new(
        boost => 2.5,

Abstract constructor.

  • boost - A scoring multiplier, affecting the Query's relative contribution to each document's score. Typically defaults to 1.0, but subclasses which do not contribute to document scores such as NOTQuery and MatchAllQuery default to 0.0 instead.



Set the Query's boost.


Get the Query's boost.


make_compiler( [labeled params] )

Abstract factory method returning a Compiler derived from this Query.

  • searchable - A Searchable.

  • boost - A scoring multiplier. Defaults to the Query's own boost.


KinoSearch::Search::Query isa KinoSearch::Obj.


Copyright 2005-2009 Marvin Humphrey

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.