API Documentation

Search/Lucene/Index/TermsStream/Interface.php

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Search_Lucene  
subpackage
Index  
version
$Id: Interface.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Search_Lucene_Index_TermsStream_Interface

category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Search_Lucene  
subpackage
Index  

Methods

methodpubliccloseTermsStream( ) : void

Close terms stream

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

methodpubliccurrentTerm( ) : \Zend_Search_Lucene_Index_Term|null

Returns term in current position

Returns
Type Description
\Zend_Search_Lucene_Index_Termnull
methodpublicnextTerm( ) : \Zend_Search_Lucene_Index_Term|null

Scans terms dictionary and returns next term

Returns
Type Description
\Zend_Search_Lucene_Index_Termnull
methodpublicresetTermsStream( ) : void

Reset terms stream.

methodpublicskipTo( \Zend_Search_Lucene_Index_Term $prefix ) : void

Skip terms stream up to the specified term preffix.

Prefix contains fully specified field info and portion of searched term

Parameters
Name Type Description
$prefix \Zend_Search_Lucene_Index_Term
Documentation was generated by DocBlox 0.13.3.