Dave Cross: Still Munging Data With Perl: Online event - Mar 27 Learn more

NWELLNHOF / Lucy-0.4.99_2 / lib / Lucy / Search / PhraseQuery.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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

              
# ***********************************************
# 
# !!!! DO NOT EDIT !!!!
# 
# This file was auto-generated by Build.PL.
# 
# ***********************************************
# 
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements.  See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License.  You may obtain a copy of the License at
# 
#     http://www.apache.org/licenses/LICENSE-2.0
# 
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
=encoding utf8
=head1 NAME
Lucy::Search::PhraseQuery - Query matching an ordered list of terms.
=head1 SYNOPSIS
    my $phrase_query = Lucy::Search::PhraseQuery->new( 
        field => 'content',
        terms => [qw( the who )],
    );
    my $hits = $searcher->hits( query => $phrase_query );
=head1 DESCRIPTION
PhraseQuery is a subclass of L<Query|Lucy::Search::Query> for matching
against an ordered sequence of terms.
=head1 CONSTRUCTORS
=head2 new
    my $phrase_query = Lucy::Search::PhraseQuery->new(
        field => $field  # required
        terms => $terms  # required
    );
Create a new PhraseQuery.
=over
=item *
B<field> - The field that the phrase must occur in.
=item *
B<terms> - The ordered array of terms that must match.
=back
=head1 METHODS
=head2 get_field
    my $retval = $phrase_query->get_field();
Accessor for object’s field attribute.
=head2 get_terms
    my $retval = $phrase_query->get_terms();
Accessor for object’s array of terms.
=head2 make_compiler
    my $retval = $phrase_query->make_compiler(
        searcher    => $searcher     # required
        boost       => $boost        # required
        subordinate => $subordinate  # default: false
    );
Abstract factory method returning a Compiler derived from this Query.
=over
=item *
B<searcher> - A Searcher.
=item *
B<boost> - A scoring multiplier.
=item *
B<subordinate> - Indicates whether the Query is a subquery (as
opposed to a top-level query).  If false, the implementation must
invoke L<normalize()|Lucy::Search::Compiler/normalize> on the newly minted Compiler object before returning
it.
=back
=head1 INHERITANCE
Lucy::Search::PhraseQuery isa L<Lucy::Search::Query> isa Clownfish::Obj.
=cut