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.converter.Converter;
25:
26: /**
27: * Configure {@link Converter} to be used within Compass.
28: * Set on package definition (<code>package-info.java</code>).
29: * <p/>
30: * The {@link Converter} is registed under a lookup name ({@link #name()}), which can then
31: * be reference in the different mapping definitions.
32: *
33: * @author kimchy
34: */
35: @Target(ElementType.PACKAGE)
36: @Retention(RetentionPolicy.RUNTIME)
37: public @interface SearchConverter {
38:
39: /**
40: * The name the {@link Converter} will be registered under.
41: */
42: String name();
43:
44: /**
45: * The {@link Converter} implementation.
46: */
47: Class<? extends Converter> type();
48:
49: /**
50: * Settings for the {@link Converter} implemenation. If set,
51: * the {@link Converter} should implement the {@link org.compass.core.config.CompassConfigurable}
52: * interface.
53: */
54: SearchSetting[] settings() default {};
55: }
|