import
[web.mtrack] / inc / lib / 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) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
19  * @license    http://framework.zend.com/license/new-bsd     New BSD License
20  * @version    $Id: TermInfo.php 16541 2009-07-07 06:59:03Z bkarwin $
21  */
22
23
24 /**
25  * A Zend_Search_Lucene_Index_TermInfo represents a record of information stored for a term.
26  *
27  * @category   Zend
28  * @package    Zend_Search_Lucene
29  * @subpackage Index
30  * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
31  * @license    http://framework.zend.com/license/new-bsd     New BSD License
32  */
33 class Zend_Search_Lucene_Index_TermInfo
34 {
35     /**
36      * The number of documents which contain the term.
37      *
38      * @var integer
39      */
40     public $docFreq;
41
42     /**
43      * Data offset in a Frequencies file.
44      *
45      * @var integer
46      */
47     public $freqPointer;
48
49     /**
50      * Data offset in a Positions file.
51      *
52      * @var integer
53      */
54     public $proxPointer;
55
56     /**
57      * ScipData offset in a Frequencies file.
58      *
59      * @var integer
60      */
61     public $skipOffset;
62
63     /**
64      * Term offset of the _next_ term in a TermDictionary file.
65      * Used only for Term Index
66      *
67      * @var integer
68      */
69     public $indexPointer;
70
71     public function __construct($docFreq, $freqPointer, $proxPointer, $skipOffset, $indexPointer = null)
72     {
73         $this->docFreq      = $docFreq;
74         $this->freqPointer  = $freqPointer;
75         $this->proxPointer  = $proxPointer;
76         $this->skipOffset   = $skipOffset;
77         $this->indexPointer = $indexPointer;
78     }
79 }
80