7 * This source file is subject to the new BSD license that is bundled
\r
8 * with this package in the file LICENSE.txt.
\r
9 * It is also available through the world-wide-web at this URL:
\r
10 * http://framework.zend.com/license/new-bsd
\r
11 * If you did not receive a copy of the license and are unable to
\r
12 * obtain it through the world-wide-web, please send an email
\r
13 * to license@zend.com so we can send you a copy immediately.
\r
16 * @package Zend_Search_Lucene
\r
18 * @copyright Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
\r
19 * @license http://framework.zend.com/license/new-bsd New BSD License
\r
20 * @version $Id: TermStreamsPriorityQueue.php 16971 2009-07-22 18:05:45Z mikaelkael $
\r
23 /** Zend_Search_Lucene_Index_TermsStream_Interface */
\r
24 require_once 'Zend/Search/Lucene/Index/TermsStream/Interface.php';
\r
26 /** Zend_Search_Lucene_Index_TermsPriorityQueue */
\r
27 require_once 'Zend/Search/Lucene/Index/TermsPriorityQueue.php';
\r
32 * @package Zend_Search_Lucene
\r
34 * @copyright Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
\r
35 * @license http://framework.zend.com/license/new-bsd New BSD License
\r
37 class Zend_Search_Lucene_TermStreamsPriorityQueue implements Zend_Search_Lucene_Index_TermsStream_Interface
\r
40 * Array of term streams (Zend_Search_Lucene_Index_TermsStream_Interface objects)
\r
44 protected $_termStreams;
\r
47 * Terms stream queue
\r
49 * @var Zend_Search_Lucene_Index_TermsPriorityQueue
\r
51 protected $_termsStreamQueue = null;
\r
54 * Last Term in a terms stream
\r
56 * @var Zend_Search_Lucene_Index_Term
\r
58 protected $_lastTerm = null;
\r
62 * Object constructor
\r
64 * @param array $termStreams array of term streams (Zend_Search_Lucene_Index_TermsStream_Interface objects)
\r
66 public function __construct(array $termStreams)
\r
68 $this->_termStreams = $termStreams;
\r
70 $this->resetTermsStream();
\r
74 * Reset terms stream.
\r
76 public function resetTermsStream()
\r
78 $this->_termsStreamQueue = new Zend_Search_Lucene_Index_TermsPriorityQueue();
\r
80 foreach ($this->_termStreams as $termStream) {
\r
81 $termStream->resetTermsStream();
\r
83 // Skip "empty" containers
\r
84 if ($termStream->currentTerm() !== null) {
\r
85 $this->_termsStreamQueue->put($termStream);
\r
93 * Skip terms stream up to specified term preffix.
\r
95 * Prefix contains fully specified field info and portion of searched term
\r
97 * @param Zend_Search_Lucene_Index_Term $prefix
\r
99 public function skipTo(Zend_Search_Lucene_Index_Term $prefix)
\r
101 $termStreams = array();
\r
103 while (($termStream = $this->_termsStreamQueue->pop()) !== null) {
\r
104 $termStreams[] = $termStream;
\r
107 foreach ($termStreams as $termStream) {
\r
108 $termStream->skipTo($prefix);
\r
110 if ($termStream->currentTerm() !== null) {
\r
111 $this->_termsStreamQueue->put($termStream);
\r
119 * Scans term streams and returns next term
\r
121 * @return Zend_Search_Lucene_Index_Term|null
\r
123 public function nextTerm()
\r
125 while (($termStream = $this->_termsStreamQueue->pop()) !== null) {
\r
126 if ($this->_termsStreamQueue->top() === null ||
\r
127 $this->_termsStreamQueue->top()->currentTerm()->key() !=
\r
128 $termStream->currentTerm()->key()) {
\r
130 $this->_lastTerm = $termStream->currentTerm();
\r
132 if ($termStream->nextTerm() !== null) {
\r
133 // Put segment back into the priority queue
\r
134 $this->_termsStreamQueue->put($termStream);
\r
137 return $this->_lastTerm;
\r
140 if ($termStream->nextTerm() !== null) {
\r
141 // Put segment back into the priority queue
\r
142 $this->_termsStreamQueue->put($termStream);
\r
147 $this->_lastTerm = null;
\r
153 * Returns term in current position
\r
155 * @return Zend_Search_Lucene_Index_Term|null
\r
157 public function currentTerm()
\r
159 return $this->_lastTerm;
\r
163 * Close terms stream
\r
165 * Should be used for resources clean up if stream is not read up to the end
\r
167 public function closeTermsStream()
\r
169 while (($termStream = $this->_termsStreamQueue->pop()) !== null) {
\r
170 $termStream->closeTermsStream();
\r
173 $this->_termsStreamQueue = null;
\r
174 $this->_lastTerm = null;
\r