debian man page for plucene::search::booleanquery

Plucene::Search::BooleanQuery(3pm)			User Contributed Perl Documentation			Plucene::Search::BooleanQuery(3pm)

NAME
       Plucene::Search::BooleanQuery - a boolean query

SYNOPSIS
	       # 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);

DESCRIPTION
       A query that matches documents matching boolean combinations of other queries, typically TermQuerys or PhraseQuery

       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'.

       Boolean queries are represented in Plucene API 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.

       Each sub query of a boolean query has two binary qualifiers that controls how its super query is matched. These qualifiers are

       o   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.

       o   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.

METHODS
   add
	       $query->add(Plucene::Search::Query $query, $required, $prohibited);

       Adds a clause to a boolean query.  Clauses may be:

       required
	   which means that documents which do not match this sub-query will not match the boolean query;

       prohibited
	   which means that documents which do match this sub-query will not match the boolean query; or

	   neither, in which case matched documents are neither prohibited from nor required to match the sub-query.

       It is an error to specify a clause as both required and prohibited.

   add_clause
	       $self->add_clause(Plucene::Search::BooleanClause $c);

       Adds an already-formed clause onto the query.

   clauses
	       my @clauses = $query->clauses;

   sum_squared_weights
	       my $sum_sq_weights = $query->sum_squared_weights($searcher);

   normalize
	       $query->normalize($norm);

   to_string
	       my $as_string = $query->to_string($field);

perl v5.12.4							    2011-08-14					Plucene::Search::BooleanQuery(3pm)