1 /*
2  * JasperReports - Free Java Reporting Library.
3  * Copyright (C) 2001 - 2019 TIBCO Software Inc. All rights reserved.
4  * http://www.jaspersoft.com
5  *
6  * Unless you have purchased a commercial license agreement from Jaspersoft,
7  * the following license terms apply:
8  *
9  * This program is part of JasperReports.
10  *
11  * JasperReports is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU Lesser General Public License as published by
13  * the Free Software Foundation, either version 3 of the License, or
14  * (at your option) any later version.
15  *
16  * JasperReports is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19  * GNU Lesser General Public License for more details.
20  *
21  * You should have received a copy of the GNU Lesser General Public License
22  * along with JasperReports. If not, see <http://www.gnu.org/licenses/>.
23  */
24 package net.sf.jasperreports.engine.type;
25
26 import net.sf.jasperreports.annotations.properties.Property;
27 import net.sf.jasperreports.annotations.properties.PropertyScope;
28 import net.sf.jasperreports.engine.DatasetPropertyExpression;
29 import net.sf.jasperreports.engine.JRPropertiesUtil;
30 import net.sf.jasperreports.properties.PropertyConstants;
31
32 /**
33  * Defines specific moments in time when the property expression of a dataset is supposed to be evaluated.
34  * @author Teodor Danciu (teodord@users.sourceforge.net)
35  */
36 public enum PropertyEvaluationTimeEnum implements NamedEnum
37 {
38     /**
39      * Evaluate the property expression before parameter contributors.
40      */
41     EARLY("Early"),
42     /**
43      * Evaluate the property expression after parameter contributors.
44      */
45     LATE("Late"),
46     /**
47      * Evaluate the property expression at the end of the report.
48      */
49     REPORT("Report");
50     
51     /**
52      * Provides a default value for the {@link DatasetPropertyExpression#getEvaluationTime()} setting of dataset property expressions and can be set either globally or at dataset level.
53      */
54     @Property(
55             category = PropertyConstants.CATEGORY_FILL,
56             defaultValue = "Early",
57             scopes = {PropertyScope.CONTEXT, PropertyScope.DATASET},
58             sinceVersion = PropertyConstants.VERSION_6_3_1,
59             valueType = PropertyEvaluationTimeEnum.class
60             )
61     public static final String PROPERTY_EVALUATION_TIME = JRPropertiesUtil.PROPERTY_PREFIX + "property.evaluation.time";
62
63     private final String name;
64     
65     private PropertyEvaluationTimeEnum(String name)
66     {
67         this.name = name;
68     }
69
70     @Override
71     public String getName()
72     {
73         return name;
74     }
75
76     public static PropertyEvaluationTimeEnum byName(String name)
77     {
78         return EnumUtil.getEnumByName(values(), name);
79     }
80 }
81