Zend Framework  1.12
Public Member Functions | List of all members
Zend_Search_Lucene_Analysis_Token Class Reference

Public Member Functions

 __construct ($text, $start, $end)
 Object constructor.
 
 setPositionIncrement ($positionIncrement)
 positionIncrement setter
 
 getPositionIncrement ()
 Returns the position increment of this Token.
 
 getTermText ()
 Returns the Token's term text.
 
 setTermText ($text)
 Sets the Token's term text.
 
 getStartOffset ()
 Returns this Token's starting offset, the position of the first character corresponding to this token in the source text.
 
 getEndOffset ()
 Returns this Token's ending offset, one greater than the position of the last character corresponding to this token in the source text.
 

Constructor & Destructor Documentation

__construct (   $text,
  $start,
  $end 
)

Object constructor.

Parameters
string$text
integer$start
integer$end
string$type

Member Function Documentation

getEndOffset ( )

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

Returns
integer
getPositionIncrement ( )

Returns the position increment of this Token.

Returns
integer
getStartOffset ( )

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
integer
getTermText ( )

Returns the Token's term text.

Returns
string
setPositionIncrement (   $positionIncrement)

positionIncrement setter

Parameters
integer$positionIncrement
setTermText (   $text)

Sets the Token's term text.

Parameters
string$text
Returns
this