.\" Automatically generated by Pod::Man 4.14 (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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Plucene::Search::BooleanQuery 3pm"
.TH Plucene::Search::BooleanQuery 3pm "2022-12-04" "perl v5.36.0" "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"
Plucene::Search::BooleanQuery \- a boolean query
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&        # isa Plucene::Search::Query
\&
\&        $query\->add(Plucene::Search::Query $query, $required, $prohibited);
\&        $query\->normalize($norm);
\&        
\&        my        @clauses = $query\->clauses;
\&        my $sum_sq_weights = $query\->sum_squared_weights($searcher);
\&        my      $as_string = $query\->to_string($field);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
A query that matches documents matching boolean combinations of 
other queries, typically TermQuerys or PhraseQuery
.PP
A boolean query represents a composite query that may contains subqueries 
of arbitrary nesting level and with composition rules such as 'and', 
\&'or' or 'not'.
.PP
Boolean queries are represented in Plucene \s-1API\s0 by instances of the 
BooleanQuery class. Each BooleanQuery object contains a list of subqueries 
that are linked using instances of the adaptor class BooleanClause. The 
subqueries may be of any Query type such as term query, phrase query and 
nested boolean queries.
.PP
Each sub query of a boolean query has two binary qualifiers that controls 
how its super query is matched. These qualifiers are
.IP "\(bu" 4
prohibited \- when this flag is set, the matching status of the 
subquery is negated such that the query is considered as a match only 
when the sub query does not match.
.IP "\(bu" 4
required \- when this flag is set, the sub query is required to match 
(or not to match if its 'prohibited' flag is set) for the super query 
to match.  This this is a necessary but not sufficient condition for the 
super query to match.
.SH "METHODS"
.IX Header "METHODS"
.SS "add"
.IX Subsection "add"
.Vb 1
\&        $query\->add(Plucene::Search::Query $query, $required, $prohibited);
.Ve
.PP
Adds a clause to a boolean query.  Clauses may be:
.IP "required" 4
.IX Item "required"
which means that documents which \fIdo not\fR match this sub-query will
\&\fInot\fR match the boolean query;
.IP "prohibited" 4
.IX Item "prohibited"
which means that documents which \fIdo\fR match this sub-query will \fInot\fR match
the boolean query; or
.IP "" 4
neither, in which case matched documents are neither prohibited from
nor required to match the sub-query.
.PP
It is an error to specify a clause as both required and prohibited.
.SS "add_clause"
.IX Subsection "add_clause"
.Vb 1
\&        $self\->add_clause(Plucene::Search::BooleanClause $c);
.Ve
.PP
Adds an already-formed clause onto the query.
.SS "clauses"
.IX Subsection "clauses"
.Vb 1
\&        my @clauses = $query\->clauses;
.Ve
.SS "sum_squared_weights"
.IX Subsection "sum_squared_weights"
.Vb 1
\&        my $sum_sq_weights = $query\->sum_squared_weights($searcher);
.Ve
.SS "normalize"
.IX Subsection "normalize"
.Vb 1
\&        $query\->normalize($norm);
.Ve
.SS "to_string"
.IX Subsection "to_string"
.Vb 1
\&        my $as_string = $query\->to_string($field);
.Ve
.SH "POD ERRORS"
.IX Header "POD ERRORS"
Hey! \fBThe above document had some coding errors, which are explained below:\fR
.IP "Around line 83:" 4
.IX Item "Around line 83:"
Expected text after =item, not a bullet