API Documentation

Zend/Search/Lucene/TermStreamsPriorityQueue.php

Show: inherited
Table of Contents

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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Search_Lucene  
Subpackage
Index  
Version
$Id: TermStreamsPriorityQueue.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Search_Lucene_TermStreamsPriorityQueue

Package: Zend\Search\Lucene\Index

Implements
\Zend_Search_Lucene_Index_TermsStream_Interface
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotected\Zend_Search_Lucene_Index_Term  $_lastTerm= 'null'

Last Term in a terms stream

Default valuenullDetails
Type
\Zend_Search_Lucene_Index_Term
Propertyprotectedarray  $_termStreams= ''

Array of term streams (Zend_Search_Lucene_Index_TermsStream_Interface objects)

Details
Type
array
Propertyprotected\Zend_Search_Lucene_Index_TermsPriorityQueue  $_termsStreamQueue= 'null'

Terms stream queue

Default valuenullDetails
Type
\Zend_Search_Lucene_Index_TermsPriorityQueue

Methods

methodpublic__construct( array $termStreams ) : void

Object constructor

Parameters
Name Type Description
$termStreams array

array of term streams (Zend_Search_Lucene_Index_TermsStream_Interface objects)

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_Term|null
methodpublicnextTerm( ) : \Zend_Search_Lucene_Index_Term|null

Scans term streams and returns next term

Returns
Type Description
\Zend_Search_Lucene_Index_Term|null
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.15.1.