Initial commit
[moodle.git] / search / Zend / Search / Lucene / Search / Query / Term.php
1 <?php
2 /**
3  * Zend Framework
4  *
5  * LICENSE
6  *
7  * This source file is subject to the new BSD license that is bundled
8  * with this package in the file LICENSE.txt.
9  * It is also available through the world-wide-web at this URL:
10  * http://framework.zend.com/license/new-bsd
11  * If you did not receive a copy of the license and are unable to
12  * obtain it through the world-wide-web, please send an email
13  * to license@zend.com so we can send you a copy immediately.
14  *
15  * @category   Zend
16  * @package    Zend_Search_Lucene
17  * @subpackage Search
18  * @copyright  Copyright (c) 2006 Zend Technologies USA Inc. (http://www.zend.com)
19  * @license    http://framework.zend.com/license/new-bsd     New BSD License
20  */
23 /** Zend_Search_Lucene_Search_Query */
24 require_once 'Zend/Search/Lucene/Search/Query.php';
26 /** Zend_Search_Lucene_Search_Weight_Term */
27 require_once 'Zend/Search/Lucene/Search/Weight/Term.php';
30 /**
31  * @category   Zend
32  * @package    Zend_Search_Lucene
33  * @subpackage Search
34  * @copyright  Copyright (c) 2006 Zend Technologies USA Inc. (http://www.zend.com)
35  * @license    http://framework.zend.com/license/new-bsd     New BSD License
36  */
37 class Zend_Search_Lucene_Search_Query_Term extends Zend_Search_Lucene_Search_Query
38 {
39     /**
40      * Term to find.
41      *
42      * @var Zend_Search_Lucene_Index_Term
43      */
44     private $_term;
46     /**
47      * Term sign.
48      * If true then term is required
49      * If false then term is prohibited.
50      *
51      * @var bool
52      */
53     private $_sign;
55     /**
56      * Documents vector.
57      * Bitset or array of document IDs
58      * (depending from Bitset extension availability).
59      *
60      * @var mixed
61      */
62     private $_docVector = null;
64     /**
65      * Term positions vector.
66      * Array: docId => array( pos1, pos2, ... )
67      *
68      * @var array
69      */
70     private $_termPositions;
73     /**
74      * Zend_Search_Lucene_Search_Query_Term constructor
75      *
76      * @param Zend_Search_Lucene_Index_Term $term
77      * @param boolean $sign
78      */
79     public function __construct( $term, $sign = true )
80     {
81         $this->_term = $term;
82         $this->_sign = $sign;
83     }
86     /**
87      * Constructs an appropriate Weight implementation for this query.
88      *
89      * @param Zend_Search_Lucene $reader
90      * @return Zend_Search_Lucene_Search_Weight
91      */
92     protected function _createWeight($reader)
93     {
94         return new Zend_Search_Lucene_Search_Weight_Term($this->_term, $this, $reader);
95     }
97     /**
98      * Score specified document
99      *
100      * @param integer $docId
101      * @param Zend_Search_Lucene $reader
102      * @return float
103      */
104     public function score( $docId, $reader )
105     {
106         if($this->_docVector===null) {
107             if (extension_loaded('bitset')) {
108                 $this->_docVector = bitset_from_array( $reader->termDocs($this->_term) );
109             } else {
110                 $this->_docVector = array_flip($reader->termDocs($this->_term));
111             }
113             $this->_termPositions = $reader->termPositions($this->_term);
114             $this->_initWeight($reader);
115         }
117         $match = extension_loaded('bitset') ?  bitset_in($this->_docVector, $docId) :
118                                                isset($this->_docVector[$docId]);
119         if ($this->_sign && $match) {
120             return $reader->getSimilarity()->tf(count($this->_termPositions[$docId]) ) *
121                    $this->_weight->getValue() *
122                    $reader->norm($docId, $this->_term->field);
123         } else {
124             return 0;
125         }
126     }