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