TermStreamsPriorityQueue
in package
implements
TermsStreamInterface
Tags
Table of Contents
Interfaces
Properties
- $_lastTerm : Term
- Last Term in a terms stream
- $_termsStreamQueue : TermsPriorityQueue
- Terms stream queue
- $_termStreams : array<string|int, mixed>
- Array of term streams (ZendSearch\Lucene\Index\TermsStreamInterface objects)
Methods
- __construct() : mixed
- Object constructor
- closeTermsStream() : void
- Close terms stream
- currentTerm() : Term|null
- Returns term in current position
- nextTerm() : Term|null
- Scans term streams and returns next term
- resetTermsStream() : void
- Reset terms stream.
- skipTo() : void
- Skip terms stream up to specified term preffix.
Properties
$_lastTerm
Last Term in a terms stream
protected
Term
$_lastTerm
= null
$_termsStreamQueue
Terms stream queue
protected
TermsPriorityQueue
$_termsStreamQueue
= null
$_termStreams
Array of term streams (ZendSearch\Lucene\Index\TermsStreamInterface objects)
protected
array<string|int, mixed>
$_termStreams
Methods
__construct()
Object constructor
public
__construct(array<string|int, mixed> $termStreams) : mixed
Parameters
- $termStreams : array<string|int, mixed>
-
array of term streams (\ZendSearch\Lucene\Index\TermsStreamInterface objects)
closeTermsStream()
Close terms stream
public
closeTermsStream() : void
Should be used for resources clean up if stream is not read up to the end
currentTerm()
Returns term in current position
public
currentTerm() : Term|null
Return values
Term|nullnextTerm()
Scans term streams and returns next term
public
nextTerm() : Term|null
Return values
Term|nullresetTermsStream()
Reset terms stream.
public
resetTermsStream() : void
skipTo()
Skip terms stream up to specified term preffix.
public
skipTo(Term $prefix) : void
Prefix contains fully specified field info and portion of searched term
Parameters
- $prefix : Term