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: /**
25: * Specifies a {@link Searchable} class field/property that dynamically
26: * controls the anlayzer that will be used to analyze the class content.
27: * <p/>
28: * The value of the field/property will be used as analyzer lookup name
29: * of the different analyzers defined within Compass.
30: *
31: * @author kimchy
32: */
33: @Target({ElementType.METHOD,ElementType.FIELD})
34: @Retention(RetentionPolicy.RUNTIME)
35: public @interface SearchableAnalyzerProperty {
36:
37: /**
38: * The lookup name for the analyzer in case the value of
39: * the field/proeprty is <code>null</code>.
40: */
41: String nullAnalyzer() default "";
42:
43: /**
44: * The converter lookup name that will be used to convert the
45: * field/property into a String analyzer lookup name.
46: */
47: String converter() default "";
48:
49: /**
50: * The property accessor that will be fetch and write the property value.
51: * <p/>
52: * It is automatically set based on where the annotation is used, but can be
53: * explicitly set. Compass also supports custom property accessors, registered
54: * under a custom name, which can then be used here as well.
55: */
56: String accessor() default "";
57: }
|