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
16 * @package Zend_Search_Lucene
\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
25 * @package Zend_Search_Lucene
\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
30 interface Zend_Search_Lucene_Index_TermsStream_Interface
\r
33 * Reset terms stream.
\r
35 public function resetTermsStream();
\r
38 * Skip terms stream up to specified term preffix.
\r
40 * Prefix contains fully specified field info and portion of searched term
\r
42 * @param Zend_Search_Lucene_Index_Term $prefix
\r
44 public function skipTo(Zend_Search_Lucene_Index_Term $prefix);
\r
47 * Scans terms dictionary and returns next term
\r
49 * @return Zend_Search_Lucene_Index_Term|null
\r
51 public function nextTerm();
\r
54 * Returns term in current position
\r
56 * @return Zend_Search_Lucene_Index_Term|null
\r
58 public function currentTerm();
\r
61 * Close terms stream
\r
63 * Should be used for resources clean up if stream is not read up to the end
\r
65 public function closeTermsStream();
\r