Marvin Humphrey
and 1 contributors

NAME

KinoSearch::Search::RequiredOptionalQuery - Join results for two Queries, one required, one optional.

DEPRECATED

The KinoSearch code base has been assimilated by the Apache Lucy project. The "KinoSearch" namespace has been deprecated, but development continues under our new name at our new home: http://lucy.apache.org/

SYNOPSIS

    my $foo_and_maybe_bar = KinoSearch::Search::RequiredOptionalQuery->new(
        required_query => $foo_query,
        optional_query => $bar_query,
    );
    my $hits = $searcher->hits( query => $foo_and_maybe_bar );
    ...

DESCRIPTION

RequiredOptionalQuery joins the result sets of one Query which MUST match, and one Query which SHOULD match. When only the required Query matches, its score is passed along; when both match, the scores are summed.

CONSTRUCTORS

new( [labeled params] )

    my $reqopt_query = KinoSearch::Search::RequiredOptionalQuery->new(
        required_query => $foo_query,    # required
        optional_query => $bar_query,    # required
    );
  • required_query - Query must must match.

  • optional_query - Query which should match.

METHODS

get_required_query()

Getter for the required Query.

set_required_query(required_query)

Setter for the required Query.

get_optional_query()

Getter for the optional Query.

set_optional_query(optional_query)

Setter for the optional Query.

INHERITANCE

KinoSearch::Search::RequiredOptionalQuery isa KinoSearch::Search::PolyQuery isa KinoSearch::Search::Query isa KinoSearch::Object::Obj.

COPYRIGHT AND LICENSE

Copyright 2005-2011 Marvin Humphrey

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