1 <?php

     2 /**

     3  * Zend Framework

     4  *

     5  * LICENSE

     6  *

     7  * This source file is subject to the new BSD license that is bundled

     8  * with this package in the file LICENSE.txt.

     9  * It is also available through the world-wide-web at this URL:

    10  * http://framework.zend.com/license/new-bsd

    11  * If you did not receive a copy of the license and are unable to

    12  * obtain it through the world-wide-web, please send an email

    13  * to license@zend.com so we can send you a copy immediately.

    14  *

    15  * @category   Zend

    16  * @package    Zend_Search_Lucene

    17  * @subpackage Index

    18  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)

    19  * @license    http://framework.zend.com/license/new-bsd     New BSD License

    20  * @version    $Id: Interface.php 22987 2010-09-21 10:39:53Z alexander $

    21  */

    22 

    23 /**

    24  * @category   Zend

    25  * @package    Zend_Search_Lucene

    26  * @subpackage Index

    27  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)

    28  * @license    http://framework.zend.com/license/new-bsd     New BSD License

    29  */

    30 interface Zend_Search_Lucene_Index_TermsStream_Interface

    31 {

    32     /**

    33      * Reset terms stream.

    34      */

    35     public function resetTermsStream();

    36 

    37     /**

    38      * Skip terms stream up to the specified term preffix.

    39      *

    40      * Prefix contains fully specified field info and portion of searched term

    41      *

    42      * @param Zend_Search_Lucene_Index_Term $prefix

    43      */

    44     public function skipTo(Zend_Search_Lucene_Index_Term $prefix);

    45 

    46     /**

    47      * Scans terms dictionary and returns next term

    48      *

    49      * @return Zend_Search_Lucene_Index_Term|null

    50      */

    51     public function nextTerm();

    52 

    53     /**

    54      * Returns term in current position

    55      *

    56      * @return Zend_Search_Lucene_Index_Term|null

    57      */

    58     public function currentTerm();

    59 

    60     /**

    61      * Close terms stream

    62      *

    63      * Should be used for resources clean up if stream is not read up to the end

    64      */

    65     public function closeTermsStream();

    66 }