category Zend
package Zend_Search_Lucene
subpackage Analysis
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License

 Methods

Object constructor

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

Parameters

$text

string

$start

integer

$end

integer

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

getEndOffset() : integer

Returns

integer

Returns the position increment of this Token.

getPositionIncrement() : integer

Returns

integer

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

getStartOffset() : integer

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.

Returns

integer

Returns the Token's term text.

getTermText() : string

Returns

string

positionIncrement setter

setPositionIncrement(integer $positionIncrement) 

Parameters

$positionIncrement

integer

Sets the Token's term text.

setTermText(string $text) : \this

Parameters

$text

string

Returns

\this

 Properties

 

End in source text

$_endOffset : integer

Default

 

The position of this token relative to the previous Token.

$_positionIncrement : integer

Default

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.

 

Start in source text.

$_startOffset : integer

Default

 

The text of the term.

$_termText : string

Default