final move of files
[web.mtrack] / Zend / Search / Lucene / Search / Query / Preprocessing.php
diff --git a/Zend/Search/Lucene/Search/Query/Preprocessing.php b/Zend/Search/Lucene/Search/Query/Preprocessing.php
new file mode 100644 (file)
index 0000000..4a0f4aa
--- /dev/null
@@ -0,0 +1,134 @@
+<?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 Search\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: Preprocessing.php 16971 2009-07-22 18:05:45Z mikaelkael $\r
+ */\r
+\r
+\r
+/**\r
+ * Zend_Search_Lucene_Search_Query\r
+ */\r
+require_once 'Zend/Search/Lucene/Search/Query.php';\r
+\r
+/**\r
+ * Zend_Search_Lucene_Search_Weight\r
+ */\r
+require_once 'Zend/Search/Lucene/Search/Weight.php';\r
+\r
+\r
+/**\r
+ * It's an internal abstract class intended to finalize ase a query processing after query parsing.\r
+ * This type of query is not actually involved into query execution.\r
+ *\r
+ * @category   Zend\r
+ * @package    Zend_Search_Lucene\r
+ * @subpackage Search\r
+ * @internal\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
+abstract class Zend_Search_Lucene_Search_Query_Preprocessing extends Zend_Search_Lucene_Search_Query\r
+{\r
+    /**\r
+     * Matched terms.\r
+     *\r
+     * Matched terms list.\r
+     * It's filled during rewrite operation and may be used for search result highlighting\r
+     *\r
+     * Array of Zend_Search_Lucene_Index_Term objects\r
+     *\r
+     * @var array\r
+     */\r
+    protected $_matches = null;\r
+\r
+    /**\r
+     * Optimize query in the context of specified index\r
+     *\r
+     * @param Zend_Search_Lucene_Interface $index\r
+     * @return Zend_Search_Lucene_Search_Query\r
+     */\r
+    public function optimize(Zend_Search_Lucene_Interface $index)\r
+    {\r
+        require_once 'Zend/Search/Lucene/Exception.php';\r
+        throw new Zend_Search_Lucene_Exception('This query is not intended to be executed.');\r
+    }\r
+\r
+    /**\r
+     * Constructs an appropriate Weight implementation for this query.\r
+     *\r
+     * @param Zend_Search_Lucene_Interface $reader\r
+     * @return Zend_Search_Lucene_Search_Weight\r
+     */\r
+    public function createWeight(Zend_Search_Lucene_Interface $reader)\r
+    {\r
+        require_once 'Zend/Search/Lucene/Exception.php';\r
+        throw new Zend_Search_Lucene_Exception('This query is not intended to be executed.');\r
+    }\r
+\r
+    /**\r
+     * Execute query in context of index reader\r
+     * It also initializes necessary internal structures\r
+     *\r
+     * @param Zend_Search_Lucene_Interface $reader\r
+     * @param Zend_Search_Lucene_Index_DocsFilter|null $docsFilter\r
+     */\r
+    public function execute(Zend_Search_Lucene_Interface $reader, $docsFilter = null)\r
+    {\r
+        require_once 'Zend/Search/Lucene/Exception.php';\r
+        throw new Zend_Search_Lucene_Exception('This query is not intended to be executed.');\r
+    }\r
+\r
+    /**\r
+     * Get document ids likely matching the query\r
+     *\r
+     * It's an array with document ids as keys (performance considerations)\r
+     *\r
+     * @return array\r
+     */\r
+    public function matchedDocs()\r
+    {\r
+        require_once 'Zend/Search/Lucene/Exception.php';\r
+        throw new Zend_Search_Lucene_Exception('This query is not intended to be executed.');\r
+    }\r
+\r
+    /**\r
+     * Score specified document\r
+     *\r
+     * @param integer $docId\r
+     * @param Zend_Search_Lucene_Interface $reader\r
+     * @return float\r
+     */\r
+    public function score($docId, Zend_Search_Lucene_Interface $reader)\r
+    {\r
+        require_once 'Zend/Search/Lucene/Exception.php';\r
+        throw new Zend_Search_Lucene_Exception('This query is not intended to be executed.');\r
+    }\r
+\r
+    /**\r
+     * Return query terms\r
+     *\r
+     * @return array\r
+     */\r
+    public function getQueryTerms()\r
+    {\r
+        require_once 'Zend/Search/Lucene/Exception.php';\r
+        throw new Zend_Search_Lucene_Exception('Rewrite operation has to be done before retrieving query terms.');\r
+    }\r
+}\r
+\r