01: /*
02: * Copyright 2004-2006 the original author or authors.
03: *
04: * Licensed under the Apache License, Version 2.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.apache.org/licenses/LICENSE-2.0
09: *
10: * Unless required by applicable law or agreed to in writing, software
11: * distributed under the License is distributed on an "AS IS" BASIS,
12: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13: * See the License for the specific language governing permissions and
14: * limitations under the License.
15: */
16:
17: package org.compass.core.lucene.engine.analyzer;
18:
19: import org.apache.lucene.analysis.TokenFilter;
20: import org.apache.lucene.analysis.TokenStream;
21: import org.compass.core.config.CompassConfigurable;
22:
23: /**
24: * A Lucene token filter provider. Can be used with Lucene analyzers in order to
25: * further filter out (or add additional tokens) during the analysis process.
26: *
27: * @author kimchy
28: * @see TokenFilter
29: * @see org.compass.core.lucene.engine.analyzer.synonym.SynonymFilter
30: * @see org.compass.core.lucene.engine.analyzer.synonym.SynonymAnalyzerTokenFilterProvider
31: */
32: public interface LuceneAnalyzerTokenFilterProvider extends
33: CompassConfigurable {
34:
35: /**
36: * Creates a new token filter based on the token stream. Called every time an
37: * analysis should occur, so it would be nice to create any global level
38: * data during the configuration process.
39: */
40: TokenFilter createTokenFilter(TokenStream tokenStream);
41: }
|