Zend_Search_Lucene_TermStreamsPriorityQueue Class Reference

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

Protected Attributes
	$_termStreams
	$_termsStreamQueue = null
	$_lastTerm = null

Constructor & Destructor Documentation

__construct

(

array

$termStreams

)

Object constructor.

Parameters

array

$termStreams

array of term streams (Zend_Search_Lucene_Index_TermsStream_Interface objects)

Member Function Documentation

closeTermsStream

(

)

Close terms stream.

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

Implements Zend_Search_Lucene_Index_TermsStream_Interface.

currentTerm

(

)

Returns term in current position.

Returns

Zend_Search_Lucene_Index_Term|null

Implements Zend_Search_Lucene_Index_TermsStream_Interface.

nextTerm

(

)

Scans term streams and returns next term.

Returns

Zend_Search_Lucene_Index_Term|null

Implements Zend_Search_Lucene_Index_TermsStream_Interface.

resetTermsStream

(

)

Reset terms stream.

Zend_Search_Lucene_Index_TermsPriorityQueue

Implements Zend_Search_Lucene_Index_TermsStream_Interface.

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

Implements Zend_Search_Lucene_Index_TermsStream_Interface.

Member Data Documentation

$_lastTerm = null

protected

$_termsStreamQueue = null

protected

$_termStreams

protected