Zend_Search_Lucene_Index_TermsStream_Interface Interface Reference

Public Member Functions
	resetTermsStream ()
	Reset terms stream.
	skipTo (Zend_Search_Lucene_Index_Term $prefix)
	Skip terms stream up to the specified term preffix.
	nextTerm ()
	Scans terms dictionary and returns next term.
	currentTerm ()
	Returns term in current position.
	closeTermsStream ()
	Close terms stream.

Member Function Documentation

closeTermsStream

(

)

Close terms stream.

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

Implemented in Zend_Search_Lucene_Index_SegmentInfo, Zend_Search_Lucene, Zend_Search_Lucene_MultiSearcher, Zend_Search_Lucene_Proxy, and Zend_Search_Lucene_TermStreamsPriorityQueue.

currentTerm

(

)

Returns term in current position.

Returns

Zend_Search_Lucene_Index_Term|null

Implemented in Zend_Search_Lucene_Index_SegmentInfo, Zend_Search_Lucene, Zend_Search_Lucene_MultiSearcher, Zend_Search_Lucene_Proxy, and Zend_Search_Lucene_TermStreamsPriorityQueue.

nextTerm

(

)

Scans terms dictionary and returns next term.

Returns

Zend_Search_Lucene_Index_Term|null

Implemented in Zend_Search_Lucene_Index_SegmentInfo, Zend_Search_Lucene, Zend_Search_Lucene_MultiSearcher, Zend_Search_Lucene_Proxy, and Zend_Search_Lucene_TermStreamsPriorityQueue.

resetTermsStream

(

)

Reset terms stream.

Implemented in Zend_Search_Lucene_Index_SegmentInfo, Zend_Search_Lucene, Zend_Search_Lucene_MultiSearcher, Zend_Search_Lucene_Proxy, and Zend_Search_Lucene_TermStreamsPriorityQueue.

skipTo

(

Zend_Search_Lucene_Index_Term

$prefix

)

Skip terms stream up to the specified term preffix.

Prefix contains fully specified field info and portion of searched term

Parameters

Zend_Search_Lucene_Index_Term

$prefix

Implemented in Zend_Search_Lucene_Index_SegmentInfo, Zend_Search_Lucene, Zend_Search_Lucene_MultiSearcher, Zend_Search_Lucene_Proxy, and Zend_Search_Lucene_TermStreamsPriorityQueue.