1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.myfaces.orchestra.dynaForm.annot.ui;
20
21 import java.lang.annotation.ElementType;
22 import java.lang.annotation.Retention;
23 import java.lang.annotation.RetentionPolicy;
24 import java.lang.annotation.Target;
25
26 /**
27 * Where to get the data for a relation between entities.
28 * <p>
29 * This annotation can be added to the declaration of a property of a
30 * persistent entity in order to ???
31 * <p>
32 * TODO: this class is very jsf-specific, but is not under a jsf package.
33 */
34 @Target(value = {ElementType.METHOD, ElementType.FIELD})
35 @Retention(value = RetentionPolicy.RUNTIME)
36 public @interface DataProvider
37 {
38 /**
39 * An EL expression which evaluates to a list of objects of the same type
40 * as the annotated property.
41 */
42 public String value();
43
44 /**
45 * The properties to use as description.
46 */
47 public String description();
48
49 /**
50 * An EL expression which evaluates to an instance of a {@link java.util.Comparator} which could
51 * be used to handle sorting in data-tables with frameworks supporting it.
52 */
53 public String comparator() default "";
54
55 /**
56 * A converter to use to convert the object from/to a string value.
57 */
58 public String converterBean() default "";
59 }