plucene::search::phrasequery(3pm) [debian man page]
Plucene::Search::PhraseQuery(3pm) User Contributed Perl Documentation Plucene::Search::PhraseQuery(3pm)NAME
Plucene::Search::PhraseQuery - A query that matchs a phrase
SYNOPSIS
# isa Plucene::Search::Query
DESCRIPTION
A Query that matches documents containing a particular sequence of terms.
A phrase query represents a query that is matched against a consecutive sequence of terms in the field. For example, the phrase query
'winding road' should match 'winding road' but not 'road winding' (with the exception of more relaxed slop factors).
Phrase queries are represented in Plucene's API by instances of the PharseQuery class. These instances contain an ordered list of Term
objects that represent the terms to match. For obvious reasons, all terms in a PhraseQuery must refer to the same field.
A phrase query may have an optional boost factor and an optional slop parameter (default = 0). The slop parameter can be used to relax the
phrase matching by accepting somewhat out of order sequences of the terms.
METHODS
add
Adds a term to the end of the query phrase.
sum_squared_weights
The sum squared weights of this query.
normalize
Normalize the query.
to_string
Prints a user-readable version of this query.
perl v5.12.4 2011-08-14 Plucene::Search::PhraseQuery(3pm)
Check Out this Related Man Page
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)