Index/TermsStream/Interface.php

0001 <?php
0002 /**
0003  * Zend Framework
0004  *
0005  * LICENSE
0006  *
0007  * This source file is subject to the new BSD license that is bundled
0008  * with this package in the file LICENSE.txt.
0009  * It is also available through the world-wide-web at this URL:
0010  * http://framework.zend.com/license/new-bsd
0011  * If you did not receive a copy of the license and are unable to
0012  * obtain it through the world-wide-web, please send an email
0013  * to license@zend.com so we can send you a copy immediately.
0014  *
0015  * @category   Zend
0016  * @package    Zend_Search_Lucene
0017  * @subpackage Index
0018  * @copyright  Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
0019  * @license    http://framework.zend.com/license/new-bsd     New BSD License
0020  * @version    $Id$
0021  */
0022
0023 /**
0024  * @category   Zend
0025  * @package    Zend_Search_Lucene
0026  * @subpackage Index
0027  * @copyright  Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
0028  * @license    http://framework.zend.com/license/new-bsd     New BSD License
0029  */
0030 interface Zend_Search_Lucene_Index_TermsStream_Interface
0031 {
0032     /**
0033      * Reset terms stream.
0034      */
0035     public function resetTermsStream();
0036
0037     /**
0038      * Skip terms stream up to the specified term preffix.
0039      *
0040      * Prefix contains fully specified field info and portion of searched term
0041      *
0042      * @param Zend_Search_Lucene_Index_Term $prefix
0043      */
0044     public function skipTo(Zend_Search_Lucene_Index_Term $prefix);
0045
0046     /**
0047      * Scans terms dictionary and returns next term
0048      *
0049      * @return Zend_Search_Lucene_Index_Term|null
0050      */
0051     public function nextTerm();
0052
0053     /**
0054      * Returns term in current position
0055      *
0056      * @return Zend_Search_Lucene_Index_Term|null
0057      */
0058     public function currentTerm();
0059
0060     /**
0061      * Close terms stream
0062      *
0063      * Should be used for resources clean up if stream is not read up to the end
0064      */
0065     public function closeTermsStream();
0066 }