Search/Lucene/Analysis/Token.php

Show:

inherited

Classes
- \Zend_Search_Lucene_Analysis_Token

Table of Contents

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.

Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Search_Lucene
Subpackage: Analysis
Version: $Id$

\Zend_Search_Lucene_Analysis_Token
jump to top

Package: Zend_Search_Lucene\Analysis

Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

integer $_endOffset

End in source text

Details

Type: integer

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

Type: integer

integer $_startOffset

Start in source text.

Details

Type: integer

string $_termText

The text of the term.

Details

Type: string

Methods

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

Object constructor

Parameters

Name	Type	Description
$text	string
$start	integer
$end	integer

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.

Returns

Type	Description
integer

getPositionIncrement() : integer

Returns the position increment of this Token.

Returns

Type	Description
integer

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.

Returns

Type	Description
integer

getTermText() : string

Returns the Token's term text.

Returns

Type	Description
string

setPositionIncrement(integer $positionIncrement) : void

positionIncrement setter

Parameters

Name	Type	Description
$positionIncrement	integer

setTermText(string $text) : \this

Sets the Token's term text.

Parameters

Name	Type	Description
$text	string

Returns

Type	Description
\this

Search/Lucene/Analysis/Token.php

\Zend_Search_Lucene_Analysis_Tokenjump to top

Properties

Methods

\Zend_Search_Lucene_Analysis_Token
jump to top