Search/Lucene/TermStreamsPriorityQueue.php
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 24593 2012-01-05 20:35:02Z matthew $
\Zend_Search_Lucene_TermStreamsPriorityQueue
- 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


array $_termStreams
- Type
- array
Methods


__construct(array $termStreams) : void
Object constructor
Name | Type | Description |
---|---|---|
$termStreams | array | array of term streams (Zend_Search_Lucene_Index_TermsStream_Interface objects) |


closeTermsStream() : void
Close terms stream
Should be used for resources clean up if stream is not read up to the end


currentTerm() : \Zend_Search_Lucene_Index_Term | null
Returns term in current position
Type | Description |
---|---|
\Zend_Search_Lucene_Index_Term | null |


nextTerm() : \Zend_Search_Lucene_Index_Term | null
Scans term streams and returns next term
Type | Description |
---|---|
\Zend_Search_Lucene_Index_Term | null |


skipTo(\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
Name | Type | Description |
---|---|---|
$prefix | \Zend_Search_Lucene_Index_Term |