final move of files

[web.mtrack] / Zend / Search / Lucene / TermStreamsPriorityQueue.php

diff --git a/Zend/Search/Lucene/TermStreamsPriorityQueue.php b/Zend/Search/Lucene/TermStreamsPriorityQueue.php
new file mode 100644 (file)
index 0000000..f8c4527
--- /dev/null
+++ b/Zend/Search/Lucene/TermStreamsPriorityQueue.php
@@ -0,0 +1,176 @@
+<?php\r
+/**\r
+ * Zend Framework\r
+ *\r
+ * LICENSE\r
+ *\r
+ * This source file is subject to the new BSD license that is bundled\r
+ * with this package in the file LICENSE.txt.\r
+ * It is also available through the world-wide-web at this URL:\r
+ * http://framework.zend.com/license/new-bsd\r
+ * If you did not receive a copy of the license and are unable to\r
+ * obtain it through the world-wide-web, please send an email\r
+ * to license@zend.com so we can send you a copy immediately.\r
+ *\r
+ * @category   Zend\r
+ * @package    Zend_Search_Lucene\r
+ * @subpackage Index\r
+ * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)\r
+ * @license    http://framework.zend.com/license/new-bsd     New BSD License\r
+ * @version    $Id: TermStreamsPriorityQueue.php 16971 2009-07-22 18:05:45Z mikaelkael $\r
+ */\r
+\r
+/** Zend_Search_Lucene_Index_TermsStream_Interface */\r
+require_once 'Zend/Search/Lucene/Index/TermsStream/Interface.php';\r
+\r
+/** Zend_Search_Lucene_Index_TermsPriorityQueue */\r
+require_once 'Zend/Search/Lucene/Index/TermsPriorityQueue.php';\r
+\r
+\r
+/**\r
+ * @category   Zend\r
+ * @package    Zend_Search_Lucene\r
+ * @subpackage Index\r
+ * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)\r
+ * @license    http://framework.zend.com/license/new-bsd     New BSD License\r
+ */\r
+class Zend_Search_Lucene_TermStreamsPriorityQueue implements Zend_Search_Lucene_Index_TermsStream_Interface\r
+{\r
+       /**\r
+        * Array of term streams (Zend_Search_Lucene_Index_TermsStream_Interface objects)\r
+        *\r
+        * @var array\r
+        */\r
+       protected $_termStreams;\r
+\r
+       /**\r
+     * Terms stream queue\r
+     *\r
+     * @var Zend_Search_Lucene_Index_TermsPriorityQueue\r
+     */\r
+    protected $_termsStreamQueue = null;\r
+\r
+    /**\r
+     * Last Term in a terms stream\r
+     *\r
+     * @var Zend_Search_Lucene_Index_Term\r
+     */\r
+    protected $_lastTerm = null;\r
+\r
+\r
+    /**\r
+     * Object constructor\r
+     *\r
+     * @param array $termStreams  array of term streams (Zend_Search_Lucene_Index_TermsStream_Interface objects)\r
+     */\r
+       public function __construct(array $termStreams)\r
+       {\r
+               $this->_termStreams = $termStreams;\r
+\r
+               $this->resetTermsStream();\r
+       }\r
+\r
+       /**\r
+     * Reset terms stream.\r
+     */\r
+    public function resetTermsStream()\r
+    {\r
+        $this->_termsStreamQueue = new Zend_Search_Lucene_Index_TermsPriorityQueue();\r
+\r
+        foreach ($this->_termStreams as $termStream) {\r
+            $termStream->resetTermsStream();\r
+\r
+            // Skip "empty" containers\r
+            if ($termStream->currentTerm() !== null) {\r
+                $this->_termsStreamQueue->put($termStream);\r
+            }\r
+        }\r
+\r
+        $this->nextTerm();\r
+    }\r
+\r
+    /**\r
+     * Skip terms stream up to specified term preffix.\r
+     *\r
+     * Prefix contains fully specified field info and portion of searched term\r
+     *\r
+     * @param Zend_Search_Lucene_Index_Term $prefix\r
+     */\r
+    public function skipTo(Zend_Search_Lucene_Index_Term $prefix)\r
+    {\r
+        $termStreams = array();\r
+\r
+        while (($termStream = $this->_termsStreamQueue->pop()) !== null) {\r
+            $termStreams[] = $termStream;\r
+        }\r
+\r
+        foreach ($termStreams as $termStream) {\r
+            $termStream->skipTo($prefix);\r
+\r
+            if ($termStream->currentTerm() !== null) {\r
+                $this->_termsStreamQueue->put($termStream);\r
+            }\r
+        }\r
+\r
+        $this->nextTerm();\r
+    }\r
+\r
+    /**\r
+     * Scans term streams and returns next term\r
+     *\r
+     * @return Zend_Search_Lucene_Index_Term|null\r
+     */\r
+    public function nextTerm()\r
+    {\r
+        while (($termStream = $this->_termsStreamQueue->pop()) !== null) {\r
+            if ($this->_termsStreamQueue->top() === null ||\r
+                $this->_termsStreamQueue->top()->currentTerm()->key() !=\r
+                            $termStream->currentTerm()->key()) {\r
+                // We got new term\r
+                $this->_lastTerm = $termStream->currentTerm();\r
+\r
+                if ($termStream->nextTerm() !== null) {\r
+                    // Put segment back into the priority queue\r
+                    $this->_termsStreamQueue->put($termStream);\r
+                }\r
+\r
+                return $this->_lastTerm;\r
+            }\r
+\r
+            if ($termStream->nextTerm() !== null) {\r
+                // Put segment back into the priority queue\r
+                $this->_termsStreamQueue->put($termStream);\r
+            }\r
+        }\r
+\r
+        // End of stream\r
+        $this->_lastTerm = null;\r
+\r
+        return null;\r
+    }\r
+\r
+    /**\r
+     * Returns term in current position\r
+     *\r
+     * @return Zend_Search_Lucene_Index_Term|null\r
+     */\r
+    public function currentTerm()\r
+    {\r
+        return $this->_lastTerm;\r
+    }\r
+\r
+    /**\r
+     * Close terms stream\r
+     *\r
+     * Should be used for resources clean up if stream is not read up to the end\r
+     */\r
+    public function closeTermsStream()\r
+    {\r
+        while (($termStream = $this->_termsStreamQueue->pop()) !== null) {\r
+            $termStream->closeTermsStream();\r
+        }\r
+\r
+        $this->_termsStreamQueue = null;\r
+        $this->_lastTerm         = null;\r
+    }\r
+}\r