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 searchable component on property or field of the {@link Searchable} class.
26: *
27: * <p>A searchable component is a class field/property that reference another class, which
28: * content need to be embedded into the content of its {@link Searchable} class. It will
29: * results in searches performed on the component class to return the component field/property
30: * searchable class.
31: *
32: * <p>The referenced class must have searchable definitions, defined either using annotations
33: * or other means (like xml).
34: *
35: * <p>Compass will try to automatically identify the searchable class mapping definitions that
36: * map to the component class. If the mappings can not be automatically identified, the
37: * {@link #refAlias()} should be used to reference the alias that has the searchable class
38: * mapping definition.
39: *
40: * <p>The searchable component can annotate a {@link java.util.Collection} type field/property,
41: * supporting either {@link java.util.List} or {@link java.util.Set}. The searchable component
42: * will try and automatically identify the element type using generics, but if the collection
43: * is not defined with generics, {@link #refAlias()} should be used to reference the component
44: * searchable class mapping definitions.
45: *
46: * <p>The searchable component can annotate an array as well, with the array element type used for
47: * referenced searchable class mapping definitions.
48: *
49: * @author kimchy
50: * @see Searchable
51: * @see SearchableReference
52: */
53: @Target({ElementType.METHOD,ElementType.FIELD})
54: @Retention(RetentionPolicy.RUNTIME)
55: public @interface SearchableComponent {
56:
57: /**
58: * The reference alias that points to the searchable class (either defined using
59: * annotations or xml). Not required since most of the times it can be automatically
60: * detected.
61: */
62: String refAlias() default "";
63:
64: /**
65: * Should the component definitions override an already existing component definitions
66: * for the same field/property.
67: */
68: boolean override() default true;
69:
70: /**
71: * The operations that will cascade to the target association. Defaults to no operations
72: * being cascaded.
73: */
74: Cascade[] cascade() default {};
75:
76: /**
77: * The depth of cyclic component references allowed.
78: */
79: int maxDepth() default 1;
80:
81: /**
82: * The conveter lookup name that will convert the {@link org.compass.core.mapping.osem.ComponentMapping}.
83: * Defaults to compass own intenral {@link org.compass.core.converter.mapping.osem.ComponentMappingConverter}.
84: */
85: String converter() default "";
86:
87: /**
88: * The property accessor that will be fetch and write the property value.
89: * <p/>
90: * It is automatically set based on where the annotation is used, but can be
91: * explicitly set. Compass also supports custom property accessors, registered
92: * under a custom name, which can then be used here as well.
93: */
94: String accessor() default "";
95: }
|