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

 Methods

Object constructor

__construct(array $termStreams) 

Parameters

$termStreams

array

array of term streams (Zend_Search_Lucene_Index_TermsStream_Interface objects)

Close terms stream

closeTermsStream() 

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

inherited_from \Zend_Search_Lucene_Index_TermsStream_Interface::closeTermsStream()

Returns term in current position

currentTerm() : \Zend_Search_Lucene_Index_Term | null
inherited_from \Zend_Search_Lucene_Index_TermsStream_Interface::currentTerm()

Returns

\Zend_Search_Lucene_Index_Termnull

Scans term streams and returns next term

nextTerm() : \Zend_Search_Lucene_Index_Term | null
inherited_from \Zend_Search_Lucene_Index_TermsStream_Interface::nextTerm()

Returns

\Zend_Search_Lucene_Index_Termnull

Reset terms stream.

resetTermsStream() 
inherited_from \Zend_Search_Lucene_Index_TermsStream_Interface::resetTermsStream()

Skip terms stream up to the specified term preffix.

skipTo(\Zend_Search_Lucene_Index_Term $prefix) 

Prefix contains fully specified field info and portion of searched term

inherited_from \Zend_Search_Lucene_Index_TermsStream_Interface::skipTo()

Parameters

$prefix

\Zend_Search_Lucene_Index_Term

 Properties

 

Last Term in a terms stream

$_lastTerm : \Zend_Search_Lucene_Index_Term

Default

null
 

Array of term streams (Zend_Search_Lucene_Index_TermsStream_Interface objects)

$_termStreams : array

Default

 

Terms stream queue

$_termsStreamQueue : \Zend_Search_Lucene_Index_TermsPriorityQueue

Default

null