Scroll to navigation

Lucy::Search::RequiredOptionalQuery(3pm) User Contributed Perl Documentation Lucy::Search::RequiredOptionalQuery(3pm)

NAME

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

SYNOPSIS

    my $foo_and_maybe_bar = Lucy::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 = Lucy::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

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

2017-08-02 perl v5.26.0