1 <?xml version="1.0" encoding="utf-8"?>
2 <!-- EN-Revision: 21829 -->
4 <sect1 id="zend.search.lucene.query-api">
5 <title>API de construction de requêtes</title>
7 En plus du parsage automatique d'une requête en chaîne de caractères, il est également possible de construire
8 cette requête à l'aide de l'<acronym>API</acronym> de requête.
11 Les requêtes utilisateur peuvent être combinées avec les requêtes créées à travers l'API de requêtes.
12 Utilisez simplement le parseur de requêtes pour construire une requête à partir d'une chaîne :
13 <programlisting language="php"><![CDATA[
14 $query = Zend_Search_Lucene_Search_QueryParser::parse($queryString);
17 <sect2 id="zend.search.lucene.queries.exceptions">
18 <title>Les Exceptions du parseur de requêtes</title>
20 Le parseur de requêtes peut générer deux types d'exceptions :
24 Une <classname>Zend_Search_Lucene_Exception</classname> est levée si quelque-chose d'anormal se produit dans le
30 Une <classname>Zend_Search_Lucene_Search_QueryParserException</classname> est levée s'il y a une erreur dans la syntaxe de la requête.
34 C'est une bonne idée d'attraper les <classname>Zend_Search_Lucene_Search_QueryParserException</classname>s et
35 de les traiter de manière appropriée :
36 <programlisting language="php"><![CDATA[
38 $query = Zend_Search_Lucene_Search_QueryParser::parse($queryString);
39 } catch (Zend_Search_Lucene_Search_QueryParserException $e) {
40 echo "Query syntax error: " . $e->getMessage() . "\n";
45 La même technique devrait être utilisée pour la méthode find() d'un objet <classname>Zend_Search_Lucene</classname>.
48 Depuis la version 1.5, les exceptions de parsage de requête sont supprimées par défaut. Si la requête ne
49 respecte pas le langage de requêtes, elle est "tokenizée" à l'aide de l'analyseur par défaut et tous les
50 termes "tokenizés" sont utilisés dans la recherche.
51 Pour activer les exceptions, utilisez <methodname>Zend_Search_Lucene_Search_QueryParser::dontSuppressQueryParsingExceptions()</methodname>.
52 Les méthodes <methodname>Zend_Search_Lucene_Search_QueryParser::suppressQueryParsingExceptions()</methodname> et
53 <methodname>Zend_Search_Lucene_Search_QueryParser::queryParsingExceptionsSuppressed()</methodname>
54 sont également destinées à gérer le comportement de gestion des exceptions.
57 <sect2 id="zend.search.lucene.queries.term-query">
58 <title>Requête sur un terme</title>
60 Les requêtes de termes peuvent être utilisées pour une recherche
64 Requête par chaîne de caractères:
66 <programlisting language="querystring"><![CDATA[
71 Construction de la requête via l'<acronym>API</acronym>:
73 <programlisting language="php"><![CDATA[
74 $term = new Zend_Search_Lucene_Index_Term('word1', 'field1');
75 $query = new Zend_Search_Lucene_Search_Query_Term($term);
76 $hits = $index->find($query);
79 L'argument field est optionnel. <classname>Zend_Search_Lucene</classname> cherche dans
80 tous les champs indexés si aucun champ n'a été spécifié :
81 <programlisting language="php"><![CDATA[
82 // Recherche de 'word1' dans tous les champs indexés.
83 $term = new Zend_Search_Lucene_Index_Term('word1');
84 $query = new Zend_Search_Lucene_Search_Query_Term($term);
85 $hits = $index->find($query);
89 <sect2 id="zend.search.lucene.queries.multiterm-query">
90 <title>Requête multi-termes</title>
92 Les requêtes multi-termes peuvent être utilisées pour chercher sur une
96 Chaque terme dans une collection peut être défini comme <emphasis>requis</emphasis>,
97 <emphasis>interdit</emphasis>, ou <emphasis>aucun des deux</emphasis>.
101 <emphasis>requis</emphasis> signifie que les documents ne correspondant pas
102 au terme ne correspondront pas à la requête;
107 <emphasis>interdit</emphasis> signifie que les documents correspondant
108 au terme ne correspondront pas à la requête;
113 <emphasis>aucun des deux</emphasis>, dans ce cas les documents n'ont pas
114 l'interdiction, ni l'obligation de correspondre au terme. Cela dit, un document
115 devra correspondre au moins à l'un des termes pour correspondre à la requête.
121 Si des termes optionnels sont ajoutés à une requête possédant des termes requis,
122 les deux requêtes auront les mêmes résultats, mais les termes optionnels pourraient
123 influer sur le score des documents retournés.
126 Les deux méthodes de recherche peuvent être utilisées pour les requêtes multi-termes.
129 Requête par chaîne de caractères:
131 <programlisting language="querystring"><![CDATA[
132 +word1 author:word2 -word3
137 '+' est utilisé pour définir un terme requis.
142 '-' est utilisé pour définir un terme interdit.
147 Le préfixe 'field:' est utilisé pour indiqué un champ sur lequel on veut chercher.
148 S'il est omis, la recherche se fera sur tous les champs.
154 Construction de la requête via l'<acronym>API</acronym>:
156 <programlisting language="php"><![CDATA[
157 $query = new Zend_Search_Lucene_Search_Query_MultiTerm();
158 $query->addTerm(new Zend_Search_Lucene_Index_Term('word1'), true);
159 $query->addTerm(new Zend_Search_Lucene_Index_Term('word2', 'author'),
161 $query->addTerm(new Zend_Search_Lucene_Index_Term('word3'), false);
162 $hits = $index->find($query);
165 Il est également possible de spécifier des listes de termes dans le contructeur de la requête multi-termes :
166 <programlisting language="php"><![CDATA[
167 $terms = array(new Zend_Search_Lucene_Index_Term('word1'),
168 new Zend_Search_Lucene_Index_Term('word2', 'author'),
169 new Zend_Search_Lucene_Index_Term('word3'));
170 $signs = array(true, null, false);
171 $query = new Zend_Search_Lucene_Search_Query_MultiTerm($terms, $signs);
172 $hits = $index->find($query);
176 Le tableau <varname>$signs</varname> contient des informations sur le type de chaque terme :
180 <constant>TRUE</constant> est utilisé pour définir un terme requis.
185 <constant>FALSE</constant> est utilisé pour définir un terme interdit.
190 <constant>NULL</constant> est utilisé pour définir un terme qui n'est ni
197 <sect2 id="zend.search.lucene.queries.boolean-query">
198 <title>Requête booléene</title>
200 Les requêtes booléenes permettent de construire une requête qui utilise d'autres requêtes
201 et des opérateurs booléens.
204 Chaque sous-requête dans une collection peut être définie comme <emphasis>requis</emphasis>,
205 <emphasis>interdit</emphasis>, ou <emphasis>optionnel</emphasis>.
209 <emphasis>requis</emphasis> signifie que les documents ne correspondant pas
210 à la sous-requête ne correspondront pas à la requête;
215 <emphasis>interdit</emphasis> signifie que les documents correspondant
216 à la sous-requête ne correspondront pas à la requête;
221 <emphasis>optionel</emphasis>, dans ce cas les documents n'ont pas
222 l'interdiction, ni l'obligation de correspondre à la sous-requête. Cela dit, un document
223 devra correspondre au moins à l'une des sous-requêtes pour correspondre à la requête.
229 Si des sous-requêtes optionnelles sont ajoutées à une requête possédant des sous-requêtes requises,
230 les deux requêtes auront les mêmes résultats, mais les sous-requêtes optionnelles pourraient
231 influer sur le score des documents retournés.
234 Les deux méthodes de recherche peuvent être utilisées pour les requêtes booléenes.
237 Requête par chaîne de caractères:
239 <programlisting language="querystring"><![CDATA[
240 +(word1 word2 word3) (author:word4 author:word5) -(word6)
245 '+' est utilisé pour définir une sous-requêtes requise.
250 '-' est utilisé pour définir une sous-requêtes interdite.
255 Le préfixe 'field:' est utilisé pour indiqué un champ sur lequel on veut chercher.
256 S'il est omis, la recherche se fera sur tous les champs.
262 Construction de la requête via l'<acronym>API</acronym>:
264 <programlisting language="php"><![CDATA[
265 $query = new Zend_Search_Lucene_Search_Query_Boolean();
266 $subquery1 = new Zend_Search_Lucene_Search_Query_MultiTerm();
267 $subquery1->addTerm(new Zend_Search_Lucene_Index_Term('word1'));
268 $subquery1->addTerm(new Zend_Search_Lucene_Index_Term('word2'));
269 $subquery1->addTerm(new Zend_Search_Lucene_Index_Term('word3'));
270 $subquery2 = new Zend_Search_Lucene_Search_Query_MultiTerm();
271 $subquery2->addTerm(new Zend_Search_Lucene_Index_Term('word4', 'author'));
272 $subquery2->addTerm(new Zend_Search_Lucene_Index_Term('word5', 'author'));
273 $term6 = new Zend_Search_Lucene_Index_Term('word6');
274 $subquery3 = new Zend_Search_Lucene_Search_Query_Term($term6);
275 $query->addSubquery($subquery1, true /* required */);
276 $query->addSubquery($subquery2, null /* optional */);
277 $query->addSubquery($subquery3, false /* prohibited */);
278 $hits = $index->find($query);
281 Il est également possible de spécifier des listes de sous-requêtes dans le constructeur
282 d'une requêtes booléene :
283 <programlisting language="php"><![CDATA[
285 $subqueries = array($subquery1, $subquery2, $subquery3);
286 $signs = array(true, null, false);
287 $query = new Zend_Search_Lucene_Search_Query_Boolean($subqueries, $signs);
288 $hits = $index->find($query);
292 Le tableau <varname>$signs</varname> contient des informations sur le type de chaque sous-requête :
296 <constant>TRUE</constant> est utilisé pour définir une sous-requête requise.
301 <constant>FALSE</constant> est utilisé pour définir une sous-requête interdite.
306 <constant>NULL</constant> est utilisé pour définir une sous-requête qui n'est
307 ni requise, ni interdite.
313 Chaque requête qui utilise des opérateurs booléens peut être réécrite en utilisant les notations
314 de signes et construites à l'aide de l'API. Par exemple :
315 <programlisting language="querystring"><![CDATA[
316 word1 AND (word2 AND word3 AND NOT word4) OR word5
319 <programlisting language="querystring"><![CDATA[
320 (+(word1) +(+word2 +word3 -word4)) (word5)
324 <sect2 id="zend.search.lucene.queries.wildcard">
325 <title>Requête Joker (wildcard)</title>
327 Les requêtes Joker peuvent être utilisées pour chercher des documents contenant
328 des chaînes de caractères qui correspondent aux modèles (pattern) spécifiés.
331 Le symbole '?' est utilisé comme un joker d'un seul caractère.
334 Le symbole '*' est utilisé comme un joker pour plusieurs caractères.
337 Requête par chaîne de caractères:
338 <programlisting language="querystring"><![CDATA[
344 Construction de la requête via l'<acronym>API</acronym>:
345 <programlisting language="php"><![CDATA[
346 $pattern = new Zend_Search_Lucene_Index_Term('test*', 'field1');
347 $query = new Zend_Search_Lucene_Search_Query_Wildcard($pattern);
348 $hits = $index->find($query);
352 L'argument field est optionnel. <classname>Zend_Search_Lucene</classname> cherche dans
353 tous les champs indexés si aucun champ n'a été spécifié :
354 <programlisting language="php"><![CDATA[
355 $pattern = new Zend_Search_Lucene_Index_Term('test*');
356 $query = new Zend_Search_Lucene_Search_Query_Wildcard($pattern);
357 $hits = $index->find($query);
361 <sect2 id="zend.search.lucene.queries.fuzzy">
362 <title>Requête floue (fuzzy query)</title>
364 Les requêtes floues peuvent être utilisées pour chercher des documents contenant
365 des chaînes de caractères qui correspondent à des termes similaires au terme cherché.
368 Requête par chaîne de caractères:
369 <programlisting language="querystring"><![CDATA[
372 Cette requête va correspondre à des documents contenant 'test', 'text', 'best' ou d'autres mots similaires.
376 Construction de la requête via l'<acronym>API</acronym>:
377 <programlisting language="php"><![CDATA[
378 $term = new Zend_Search_Lucene_Index_Term('test', 'field1');
379 $query = new Zend_Search_Lucene_Search_Query_Fuzzy($term);
380 $hits = $index->find($query);
384 Un indice de similarité (optional similarity) peut être spécifié après le signe "~".
387 Requête par chaîne de caractères:
388 <programlisting language="querystring"><![CDATA[
394 Construction de la requête via l'<acronym>API</acronym>:
395 <programlisting language="php"><![CDATA[
396 $term = new Zend_Search_Lucene_Index_Term('test', 'field1');
397 $query = new Zend_Search_Lucene_Search_Query_Fuzzy($term, 0.4);
398 $hits = $index->find($query);
402 L'argument field est optionnel. <classname>Zend_Search_Lucene</classname> cherche dans
403 tous les champs indexés si aucun champ n'a été spécifié :
404 <programlisting language="php"><![CDATA[
405 $term = new Zend_Search_Lucene_Index_Term('test');
406 $query = new Zend_Search_Lucene_Search_Query_Fuzzy($term);
407 $hits = $index->find($query);
411 <sect2 id="zend.search.lucene.queries.phrase-query">
412 <title>Requête de phrase</title>
414 Les requêtes de phrase peuvent être utilisées pour chercher une phrase dans des documents.
417 Les requêtes de phrase sont très flexible et permettent à l'utilisateur ou au développeur de chercher
418 des phrases exactes aussi bien que des phrases 'imprécises'.
421 Les phrases peuvent aussi contenir des trous ou des termes aux mêmes places; elles peuvent
422 être générées par l'analyseur dans différents buts. Par exemple, un terme peut être dupliqué
423 pour augmenter son poids, ou plusieurs synonymes peuvent être placés sur une seule et unique position.
425 <programlisting language="php"><![CDATA[
426 $query1 = new Zend_Search_Lucene_Search_Query_Phrase();
427 // Ajoute 'word1' à la position relative 0.
428 $query1->addTerm(new Zend_Search_Lucene_Index_Term('word1'));
429 // Ajoute 'word2' à la position relative 1.
430 $query1->addTerm(new Zend_Search_Lucene_Index_Term('word2'));
431 // Ajoute 'word3' à la position relative 3.
432 $query1->addTerm(new Zend_Search_Lucene_Index_Term('word3'), 3);
434 $query2 = new Zend_Search_Lucene_Search_Query_Phrase(
435 array('word1', 'word2', 'word3'), array(0,1,3));
437 // Requête sans trou.
438 $query3 = new Zend_Search_Lucene_Search_Query_Phrase(
439 array('word1', 'word2', 'word3'));
441 $query4 = new Zend_Search_Lucene_Search_Query_Phrase(
442 array('word1', 'word2'), array(0,1), 'annotation');
445 Une requête de phrase peut être construite en une seule étape à l'aide du constructeur ou
446 étape par étape avec des appels à la méthode <methodname>Zend_Search_Lucene_Search_Query_Phrase::addTerm()</methodname>.
449 Le constructeur de la classe <classname>Zend_Search_Lucene_Search_Query_Phrase</classname> prends trois arguments optionnels :
451 <programlisting language="php"><![CDATA[
452 Zend_Search_Lucene_Search_Query_Phrase(
453 [array $terms[, array $offsets[, string $field]]]
457 Le paramètre <varname>$terms</varname> est un tableau de chaînes de caractères qui
458 contient une collection de termes pour une phrase. S'il est omis ou égal à <constant>NULL</constant>,
459 une requête vide sera construite.
462 Le paramètre <varname>$offsets</varname> est un tableau d'entiers qui contient les positions
463 des termes dans la phrase. S'il est omis ou égale à <constant>NULL</constant>, les positions
464 des termes seront implicitement séquentielles sans trou.
467 Le paramètre <varname>$field</varname> est un chaîne de caractères qui indique le
468 champ dans lequel chercher. S'il est omis ou égal à <constant>NULL</constant>, la
469 recherche se fera dans le champ par défaut.
474 <programlisting language="php"><![CDATA[
476 new Zend_Search_Lucene_Search_Query_Phrase(array('zend', 'framework'));
479 va chercher la phrase 'zend framework' dans tous les champs.
481 <programlisting language="php"><![CDATA[
482 $query = new Zend_Search_Lucene_Search_Query_Phrase(
483 array('zend', 'download'), array(0, 2)
487 va chercher la phrase 'zend ????? download' et correspondra à 'zend platform download', 'zend studio
488 download', 'zend core download', 'zend framework download', etc.
490 <programlisting language="php"><![CDATA[
491 $query = new Zend_Search_Lucene_Search_Query_Phrase(
492 array('zend', 'framework'), null, 'title'
496 va chercher la phrase 'zend framework' dans le champ 'title'.
499 La méthode <methodname>Zend_Search_Lucene_Search_Query_Phrase::addTerm()</methodname> prends deux
500 arguments, un <classname>Zend_Search_Lucene_Index_Term</classname> requis et une position optionnelle :
502 <programlisting language="php"><![CDATA[
503 Zend_Search_Lucene_Search_Query_Phrase::addTerm(
504 Zend_Search_Lucene_Index_Term $term[, integer $position]
508 Le paramètre <varname>$term</varname> décrit le prochain terme dans la phrase. Il doit
509 indiquer le même champ que les termes précédents, sinon une exception sera levée.
512 Le paramètre <varname>$position</varname> indique la position du terme dans la phrase.
517 <programlisting language="php"><![CDATA[
518 $query = new Zend_Search_Lucene_Search_Query_Phrase();
519 $query->addTerm(new Zend_Search_Lucene_Index_Term('zend'));
520 $query->addTerm(new Zend_Search_Lucene_Index_Term('framework'));
523 va chercher la phrase 'zend framework'.
525 <programlisting language="php"><![CDATA[
526 $query = new Zend_Search_Lucene_Search_Query_Phrase();
527 $query->addTerm(new Zend_Search_Lucene_Index_Term('zend'), 0);
528 $query->addTerm(new Zend_Search_Lucene_Index_Term('framework'), 2);
531 va chercher la phrase 'zend ????? download' et correspondra à 'zend platform download', 'zend studio
532 download', 'zend core download', 'zend framework download', etc.
534 <programlisting language="php"><![CDATA[
535 $query = new Zend_Search_Lucene_Search_Query_Phrase();
536 $query->addTerm(new Zend_Search_Lucene_Index_Term('zend', 'title'));
537 $query->addTerm(new Zend_Search_Lucene_Index_Term('framework', 'title'));
540 va chercher la phrase 'zend framework' dans le champ 'title'.
543 Le 'slop factor' établit le nombre d'autres mots autorisés entre les mots spécifiés dans la requête de phrase.
544 S'il est défini à zéro, la requête correspondante sera une recherche d'une phrase exacte. Pour des valeurs
545 supérieures à zéro, cela fonctionne comme les opérateurs WITHIN ou NEAR.
548 Le 'slop factor' est en fait une distance d'édition, où les éditions consistent à déplacer les termes dans
549 la phrase recherchée. Par exemple, inverser l'ordre de deux mots requiert deux déplacements (le premier
550 déplacement positionne les mots l'un sur l'autre), donc pour permettre le réarrangement de phrase, le
551 'slop factor' doit être d'au moins deux.
554 Les correspondances les plus exactes possèdent un meilleur score que celles ayant eu recours au 'slop factor';
555 ainsi les résultats de recherche sont classés par exactitude. Le 'slop factor' est à zéro par défaut, requérant des
556 correspondances exactes.
559 Le 'slop factor' peut être assigné après la création de la requête :
561 <programlisting language="php"><![CDATA[
562 // Requêtes sans trou.
564 new Zend_Search_Lucene_Search_Query_Phrase(array('word1', 'word2'));
565 // Search for 'word1 word2', 'word1 ... word2'
567 $hits1 = $index->find($query);
568 // Recherche pour 'word1 word2', 'word1 ... word2',
569 // 'word1 ... ... word2', 'word2 word1'
571 $hits2 = $index->find($query);
574 <sect2 id="zend.search.lucene.queries.range">
575 <title>Requête d'intervalle</title>
577 Les <link linkend="zend.search.lucene.query-language.range">requêtes d'intervalle</link> sont dédiées à la recherche de termes dans un intervalle spécifié.
580 Requête par chaîne de caractères:
581 <programlisting language="querystring"><![CDATA[
582 mod_date:[20020101 TO 20030101]
583 title:{Aida TO Carmen}
588 Construction de la requête via l'<acronym>API</acronym>:
589 <programlisting language="php"><![CDATA[
590 $from = new Zend_Search_Lucene_Index_Term('20020101', 'mod_date');
591 $to = new Zend_Search_Lucene_Index_Term('20030101', 'mod_date');
592 $query = new Zend_Search_Lucene_Search_Query_Range(
593 $from, $to, true // inclusive
595 $hits = $index->find($query);
599 L'argument field est optionnel. <classname>Zend_Search_Lucene</classname> cherche dans
600 tous les champs indexés si aucun champ n'a été spécifié :
601 <programlisting language="php"><![CDATA[
602 $from = new Zend_Search_Lucene_Index_Term('Aida');
603 $to = new Zend_Search_Lucene_Index_Term('Carmen');
604 $query = new Zend_Search_Lucene_Search_Query_Range(
605 $from, $to, false // non-inclusive
607 $hits = $index->find($query);
611 L'une ou l'autre (mais pas les deux) des bornes peut être définie à <constant>NULL</constant>.
612 Dans ce cas, <classname>Zend_Search_Lucene</classname> cherche depuis le début ou jusqu'à la
613 fin du dictionnaire pour le(s) champs spécifié(s) :
614 <programlisting language="php"><![CDATA[
615 // recherche pour ['20020101' TO ...]
616 $from = new Zend_Search_Lucene_Index_Term('20020101', 'mod_date');
617 $query = new Zend_Search_Lucene_Search_Query_Range(
618 $from, null, true // inclusive
620 $hits = $index->find($query);