API Documentation

Search/Lucene/Index/TermsStream/Interface.php

Interfaces
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: Interface.php 22988 2010-09-21 10:53:41Z alexander $
Interfaces
Zend_Search_Lucene_Index_TermsStream_Interface

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_Index_TermsStream_Interface
jump to top

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
Methods
resetTermsStream
skipTo
nextTerm
currentTerm
closeTermsStream

Description

Methods

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 terms dictionary 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.