API Documentation

Search/Lucene/TermStreamsPriorityQueue.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Search_Lucene
subpackage
Index
version
$Id: TermStreamsPriorityQueue.php 22988 2010-09-21 10:53:41Z alexander $
Classes
Zend_Search_Lucene_TermStreamsPriorityQueue

Description

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.

Zend_Search_Lucene_TermStreamsPriorityQueue
jump to top

Implements
Zend_Search_Lucene_Index_TermsStream_Interface
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Search_Lucene
subpackage
Index
Properties
$_termStreams
$_termsStreamQueue
$_lastTerm
Methods
__construct
resetTermsStream
skipTo
nextTerm
currentTerm
closeTermsStream

Description

Properties

$_lastTerm
jump to class

Zend_Search_Lucene_Index_Term $_lastTerm = 'null'

Last Term in a terms stream

Details

$_lastTerm
Zend_Search_Lucene_Index_Term
visibility
protected
default
null
final
false
static
false

$_termStreams
jump to class

array $_termStreams = ''

Array of term streams (Zend_Search_Lucene_Index_TermsStream_Interface objects)

Details

$_termStreams
array
visibility
protected
default
final
false
static
false

$_termsStreamQueue
jump to class

Zend_Search_Lucene_Index_TermsPriorityQueue $_termsStreamQueue = 'null'

Terms stream queue

Details

$_termsStreamQueue
Zend_Search_Lucene_Index_TermsPriorityQueue
visibility
protected
default
null
final
false
static
false

Methods

__construct
jump to class

__construct( array $termStreams ) :

Object constructor

Arguments
$termStreams
array
array of term streams (Zend_Search_Lucene_Index_TermsStream_Interface objects)
Details
visibility
public
final
false
static
false

closeTermsStream
jump to class

closeTermsStream( ) :

Close terms stream

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

Details
visibility
public
final
false
static
false

currentTerm
jump to class

currentTerm( ) : Zend_Search_Lucene_Index_Term|null

Returns term in current position

Output
Zend_Search_Lucene_Index_Term|null
Details
visibility
public
final
false
static
false

nextTerm
jump to class

nextTerm( ) : Zend_Search_Lucene_Index_Term|null

Scans term streams and returns next term

Output
Zend_Search_Lucene_Index_Term|null
Details
visibility
public
final
false
static
false

resetTermsStream
jump to class

resetTermsStream( ) :

Reset terms stream.

Details
visibility
public
final
false
static
false

skipTo
jump to class

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

Arguments
$prefix
Zend_Search_Lucene_Index_Term
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.