Initial commit
[moodle.git] / search / Zend / Search / Lucene / Index / TermInfo.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 Index
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 /**
24  * A Zend_Search_Lucene_Index_TermInfo represents a record of information stored for a term.
25  *
26  * @category   Zend
27  * @package    Zend_Search_Lucene
28  * @subpackage Index
29  * @copyright  Copyright (c) 2006 Zend Technologies USA Inc. (http://www.zend.com)
30  * @license    http://framework.zend.com/license/new-bsd     New BSD License
31  */
32 class Zend_Search_Lucene_Index_TermInfo
33 {
34     /**
35      * The number of documents which contain the term.
36      *
37      * @var integer
38      */
39     public $docFreq;
41     /**
42      * Data offset in a Frequencies file.
43      *
44      * @var integer
45      */
46     public $freqPointer;
48     /**
49      * Data offset in a Positions file.
50      *
51      * @var integer
52      */
53     public $proxPointer;
55     /**
56      * ScipData offset in a Frequencies file.
57      *
58      * @var integer
59      */
60     public $skipOffset;
62     /**
63      * Term offset of the _next_ term in a TermDictionary file.
64      * Used only for Term Index
65      *
66      * @var integer
67      */
68     public $indexPointer;
70     public function __construct($docFreq, $freqPointer, $proxPointer, $skipOffset, $indexPointer = null)
71     {
72         $this->docFreq      = $docFreq;
73         $this->freqPointer  = $freqPointer;
74         $this->proxPointer  = $proxPointer;
75         $this->skipOffset   = $skipOffset;
76         $this->indexPointer = $indexPointer;
77     }
78 }