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.annotations;
18:
19: import java.lang.annotation.ElementType;
20: import java.lang.annotation.Retention;
21: import java.lang.annotation.RetentionPolicy;
22: import java.lang.annotation.Target;
23:
24: import org.compass.core.lucene.engine.analyzer.LuceneAnalyzerTokenFilterProvider;
25:
26: /**
27: * Configures a {@link LuceneAnalyzerTokenFilterProvider} to be used within Compass.
28: * Set on package definition (<code>package-info.java</code>).
29: * <p/>
30: * The {@link LuceneAnalyzerTokenFilterProvider} is registed under a lookup
31: * name ({@link #name()}), which can then be reference in in the analyzer definition
32: * (i.e. {@link org.compass.annotations.SearchAnalyzer#filters()}).
33: * <p/>
34: * Additional settings can be injected into the {@link LuceneAnalyzerTokenFilterProvider}
35: * implementation using {@link #settings()}.
36: *
37: * @author kimchy
38: * @see LuceneAnalyzerTokenFilterProvider
39: * @see org.compass.core.lucene.engine.analyzer.synonym.SynonymAnalyzerTokenFilterProvider
40: */
41: @Target(ElementType.PACKAGE)
42: @Retention(RetentionPolicy.RUNTIME)
43: public @interface SearchAnalyzerFilter {
44:
45: /**
46: * The name the analyzer token filter provider will be registered under.
47: */
48: String name();
49:
50: /**
51: * The {@link LuceneAnalyzerTokenFilterProvider} implementation.
52: */
53: Class<? extends LuceneAnalyzerTokenFilterProvider> type();
54:
55: /**
56: * Additional settings for the {@link LuceneAnalyzerTokenFilterProvider} implementation.
57: */
58: SearchSetting[] settings() default {};
59: }
|