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: * Allows to define cascading annotation which will result in certain operations done on the object
26: * that holds the property to be cascaded to its referenced objects.
27: *
28: * @author kimchy
29: */
30: @Target({ElementType.METHOD,ElementType.FIELD})
31: @Retention(RetentionPolicy.RUNTIME)
32: public @interface SearchableCascading {
33:
34: /**
35: * The conveter lookup name that will convert the {@link org.compass.core.mapping.osem.PlainCascadeMapping}.
36: * Defaults to compass own intenral {@link org.compass.core.converter.mapping.osem.PlainCascadeMappingConverter}.
37: */
38: public abstract String converter() default "";
39:
40: /**
41: * The property accessor that will be fetch and write the property value.
42: *
43: * <p>It is automatically set based on where the annotation is used, but can be
44: * explicitly set. Compass also supports custom property accessors, registered
45: * under a custom name, which can then be used here as well.
46: */
47: public abstract String accessor() default "";
48:
49: /**
50: * The operations that will cascade to the target association. Defaults to no operations
51: * being cascaded.
52: */
53: public abstract Cascade[] cascade() default {};
54: }
|