.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "KinoSearch1::Search::BooleanQuery 3pm"
.TH KinoSearch1::Search::BooleanQuery 3pm 2024-03-10 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
KinoSearch1::Search::BooleanQuery \- match boolean combinations of Queries
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 3
\&    my $bool_query = KinoSearch1::Search::BooleanQuery\->new;
\&    $bool_query\->add_clause( query => $term_query, occur => \*(AqMUST\*(Aq );
\&    my $hits = $searcher\->search( query => $bool_query );
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
BooleanQueries are super-Query objects which match boolean combinations of
other Queries.
.PP
One way of producing a BooleanQuery is to feed a query string along the lines
of \f(CW\*(C`this AND NOT that\*(C'\fR to a
QueryParser object:
.PP
.Vb 1
\&    my $bool_query = $query_parser\->parse( \*(Aqthis AND NOT that\*(Aq );
.Ve
.PP
It's also possible to achieve the same end by manually constructing the query
piece by piece:
.PP
.Vb 1
\&    my $bool_query = KinoSearch1::Search::BooleanQuery\->new;
\&    
\&    my $this_query = KinoSearch1::Search::TermQuery\->new(
\&        term => KinoSearch1::Index::Term\->new( \*(Aqbodytext\*(Aq, \*(Aqthis\*(Aq ),
\&    );
\&    $bool_query\->add_clause( query => $this_query, occur => \*(AqMUST\*(Aq );
\&
\&    my $that_query = KinoSearch1::Search::TermQuery\->new(
\&        term => KinoSearch1::Index::Term\->new( \*(Aqbodytext\*(Aq, \*(Aqthat\*(Aq ),
\&    );
\&    $bool_query\->add_clause( query => $that_query, occur => \*(AqMUST_NOT\*(Aq );
.Ve
.PP
QueryParser objects and hand-rolled Queries can work together:
.PP
.Vb 6
\&    my $general_query = $query_parser\->parse($q);
\&    my $news_only     = KinoSearch1::Search::TermQuery\->new(
\&        term => KinoSearch1::Index::Term\->new( \*(Aqcategory\*(Aq, \*(Aqnews\*(Aq );
\&    );
\&    $bool_query\->add_clause( query => $general_query, occur => \*(AqMUST\*(Aq );
\&    $bool_query\->add_clause( query => $news_only,     occur => \*(AqMUST\*(Aq );
.Ve
.SH METHODS
.IX Header "METHODS"
.SS new
.IX Subsection "new"
.Vb 1
\&    my $bool_query = KinoSearch1::Search::BooleanQuery\->new;
.Ve
.PP
Constructor. Takes no arguments.
.SS add_clause
.IX Subsection "add_clause"
.Vb 4
\&    $bool_query\->add_clause(
\&        query => $query, # required
\&        occur => \*(AqMUST\*(Aq, # default: \*(AqSHOULD\*(Aq
\&    );
.Ve
.PP
Add a clause to the BooleanQuery.  Takes hash-style parameters:
.IP \(bu 4
\&\fBquery\fR \- an object which belongs to a subclass of
KinoSearch1::Search::Query.
.IP \(bu 4
\&\fBoccur\fR \- must be one of three possible values: 'SHOULD', 'MUST', or
\&'MUST_NOT'.
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright 2005\-2010 Marvin Humphrey
.SH "LICENSE, DISCLAIMER, BUGS, etc."
.IX Header "LICENSE, DISCLAIMER, BUGS, etc."
See KinoSearch1 version 1.01.