CREAMYG / KinoSearch-0.30_082 / lib / KinoSearch / Search / RequiredOptionalQuery.pod 

            

              
1
2
—
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

              
# Auto-generated file -- DO NOT EDIT!!!!!
=head1 NAME
KinoSearch::Search::RequiredOptionalQuery - Join results for two Queries, one required, one optional.
=head1 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 );
    ...
=head1 DESCRIPTION
Join results for two Queries, one required, one optional.
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.
=head1 CONSTRUCTORS
=head2 new( I<[labeled params]> )
    my $reqopt_query = KinoSearch::Search::RequiredOptionalQuery->new(
        required_query => $foo_query,    # required
        optional_query => $bar_query,    # required
    );
=over
=item *
B<required_query> - Query must must match.
=item *
B<optional_query> - Query which should match.
=back
=head1 METHODS
=head2 get_required_query()
Getter for the required Query.
=head2 set_required_query(required_query)
Setter for the required Query.
=head2 get_optional_query()
Getter for the optional Query.
=head2 set_optional_query(optional_query)
Setter for the optional Query.
=head1 INHERITANCE
KinoSearch::Search::RequiredOptionalQuery isa L<KinoSearch::Search::PolyQuery> isa L<KinoSearch::Search::Query> isa L<KinoSearch::Object::Obj>.
=head1 COPYRIGHT AND LICENSE
Copyright 2005-2010 Marvin Humphrey
This program is free software; you can redistribute it and/or modify it under
the same terms as Perl itself.
=cut