API Documentation

Search/Lucene/Analysis/Token.php

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
Analysis
version
$Id: Token.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Search_Lucene_Analysis_Token

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_Analysis_Token

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
Analysis
Properties
$_termText
$_startOffset
$_endOffset
$_positionIncrement
Methods
__construct
setPositionIncrement
getPositionIncrement
getTermText
getStartOffset
getEndOffset

Description

Properties

$_endOffset

integer $_endOffset = ''

End in source text

Details

$_endOffset
integer
visibility
private
default
final
false
static
false

$_positionIncrement

integer $_positionIncrement = ''

The position of this token relative to the previous Token.

The default value is one.

Some common uses for this are: Set it to zero to put multiple terms in the same position. This is useful if, e.g., a word has multiple stems. Searches for phrases including either stem will match. In this case, all but the first stem's increment should be set to zero: the increment of the first instance should be one. Repeating a token with an increment of zero can also be used to boost the scores of matches on that token.

Set it to values greater than one to inhibit exact phrase matches. If, for example, one does not want phrases to match across removed stop words, then one could build a stop word filter that removes stop words and also sets the increment to the number of stop words removed before each non-stop word. Then exact phrase queries will only match when the terms occur with no intervening stop words.

Details

$_positionIncrement
integer
visibility
private
default
final
false
static
false

$_startOffset

integer $_startOffset = ''

Start in source text.

Details

$_startOffset
integer
visibility
private
default
final
false
static
false

$_termText

string $_termText = ''

The text of the term.

Details

$_termText
string
visibility
private
default
final
false
static
false

Methods

__construct

__construct( string $text, integer $start, integer $end ) :

Object constructor

Arguments
$text
string
$start
integer
$end
integer
Details
visibility
public
final
false
static
false

getEndOffset

getEndOffset( ) : integer

Returns this Token's ending offset, one greater than the position of the last character corresponding to this token in the source text.

Output
integer
Details
visibility
public
final
false
static
false

getPositionIncrement

getPositionIncrement( ) : integer

Returns the position increment of this Token.

Output
integer
Details
visibility
public
final
false
static
false

getStartOffset

getStartOffset( ) : integer

Returns this Token's starting offset, the position of the first character corresponding to this token in the source text.

Note: The difference between getEndOffset() and getStartOffset() may not be equal to strlen(Zend_Search_Lucene_Analysis_Token::getTermText()), as the term text may have been altered by a stemmer or some other filter.

Output
integer
Details
visibility
public
final
false
static
false

getTermText

getTermText( ) : string

Returns the Token's term text.

Output
string
Details
visibility
public
final
false
static
false

setPositionIncrement

setPositionIncrement( integer $positionIncrement ) :

positionIncrement setter

Arguments
$positionIncrement
integer
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.