final move of files

[web.mtrack] / Zend / Search / Lucene / Index / TermsStream / Interface.php

diff --git a/Zend/Search/Lucene/Index/TermsStream/Interface.php b/Zend/Search/Lucene/Index/TermsStream/Interface.php
new file mode 100644 (file)
index 0000000..900b34e
--- /dev/null
+++ b/Zend/Search/Lucene/Index/TermsStream/Interface.php
@@ -0,0 +1,66 @@
+<?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: Interface.php 16971 2009-07-22 18:05:45Z mikaelkael $\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
+interface Zend_Search_Lucene_Index_TermsStream_Interface\r
+{\r
+    /**\r
+     * Reset terms stream.\r
+     */\r
+       public function resetTermsStream();\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
+    /**\r
+     * Scans terms dictionary and returns next term\r
+     *\r
+     * @return Zend_Search_Lucene_Index_Term|null\r
+     */\r
+    public function nextTerm();\r
+\r
+    /**\r
+     * Returns term in current position\r
+     *\r
+     * @return Zend_Search_Lucene_Index_Term|null\r
+     */\r
+    public function currentTerm();\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