git.roojs.org Git - web.mtrack/blob - inc/lib/Zend/Search/Lucene/Index/TermsStream/Interface.php

   1 <?php\r
   2 /**\r
   3  * Zend Framework\r
   4  *\r
   5  * LICENSE\r
   6  *\r
   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
  14  *\r
  15  * @category   Zend\r
  16  * @package    Zend_Search_Lucene\r
  17  * @subpackage Index\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: Interface.php 16971 2009-07-22 18:05:45Z mikaelkael $\r
  21  */\r
  22 \r
  23 /**\r
  24  * @category   Zend\r
  25  * @package    Zend_Search_Lucene\r
  26  * @subpackage Index\r
  27  * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)\r
  28  * @license    http://framework.zend.com/license/new-bsd     New BSD License\r
  29  */\r
  30 interface Zend_Search_Lucene_Index_TermsStream_Interface\r
  31 {\r
  32     /**\r
  33      * Reset terms stream.\r
  34      */\r
  35         public function resetTermsStream();\r
  36 \r
  37     /**\r
  38      * Skip terms stream up to specified term preffix.\r
  39      *\r
  40      * Prefix contains fully specified field info and portion of searched term\r
  41      *\r
  42      * @param Zend_Search_Lucene_Index_Term $prefix\r
  43      */\r
  44     public function skipTo(Zend_Search_Lucene_Index_Term $prefix);\r
  45 \r
  46     /**\r
  47      * Scans terms dictionary and returns next term\r
  48      *\r
  49      * @return Zend_Search_Lucene_Index_Term|null\r
  50      */\r
  51     public function nextTerm();\r
  52 \r
  53     /**\r
  54      * Returns term in current position\r
  55      *\r
  56      * @return Zend_Search_Lucene_Index_Term|null\r
  57      */\r
  58     public function currentTerm();\r
  59 \r
  60     /**\r
  61      * Close terms stream\r
  62      *\r
  63      * Should be used for resources clean up if stream is not read up to the end\r
  64      */\r
  65     public function closeTermsStream();\r
  66 }\r