Initial commit
[moodle.git] / search / Zend / Search / Lucene / Analysis / TokenFilter.php
1 <?php
2 /**
3  * Zend Framework
4  *
5  * LICENSE
6  *
7  * This source file is subject to the new BSD license that is bundled
8  * with this package in the file LICENSE.txt.
9  * It is also available through the world-wide-web at this URL:
10  * http://framework.zend.com/license/new-bsd
11  * If you did not receive a copy of the license and are unable to
12  * obtain it through the world-wide-web, please send an email
13  * to license@zend.com so we can send you a copy immediately.
14  *
15  * @category   Zend
16  * @package    Zend_Search_Lucene
17  * @subpackage Analysis
18  * @copyright  Copyright (c) 2006 Zend Technologies USA Inc. (http://www.zend.com)
19  * @license    http://framework.zend.com/license/new-bsd     New BSD License
20  */
23 /** Zend_Search_Lucene_Analysis_Token */
24 require_once 'Zend/Search/Lucene/Analysis/Token.php';
27 /**
28  * Token filter converts (normalizes) Token ore removes it from a token stream.
29  *
30  * @category   Zend
31  * @package    Zend_Search_Lucene
32  * @subpackage Analysis
33  * @copyright  Copyright (c) 2006 Zend Technologies USA Inc. (http://www.zend.com)
34  * @license    http://framework.zend.com/license/new-bsd     New BSD License
35  */
37 abstract class Zend_Search_Lucene_Analysis_TokenFilter
38 {
39     /**
40      * Normalize Token or remove it (if null is returned)
41      *
42      * @param Zend_Search_Lucene_Analysis_Token $srcToken
43      * @return Zend_Search_Lucene_Analysis_Token
44      */
45     abstract public function normalize(Zend_Search_Lucene_Analysis_Token $srcToken);
46 }