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 parent reference for {@link SearchableComponent}.
26: * <p/>
27: * If a {@link SearchableComponent} has a reference it it's parent,
28: * the annotation will make sure that this reference will be initalized
29: * when the {@link Searchable} class is loaded from the index.
30: *
31: * @author kimchy
32: */
33: @Target({ElementType.METHOD,ElementType.FIELD})
34: @Retention(RetentionPolicy.RUNTIME)
35: public @interface SearchableParent {
36:
37: /**
38: * The conveter lookup name that will convert the {@link org.compass.core.mapping.osem.ParentMapping}.
39: * Defaults to compass own intenral {@link org.compass.core.converter.mapping.osem.ParentMappingConverter}.
40: */
41: String converter() default "";
42:
43: /**
44: * The property accessor that will be fetch and write the property value.
45: * <p/>
46: * It is automatically set based on where the annotation is used, but can be
47: * explicitly set. Compass also supports custom property accessors, registered
48: * under a custom name, which can then be used here as well.
49: */
50: String accessor() default "";
51:
52: /**
53: * The operations that will cascade to the target association. Defaults to no operations
54: * being cascaded.
55: */
56: Cascade[] cascade() default {};
57: }
|