1 /*
2 * Copyright (c) 2002-2023, City of Paris
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright notice
10 * and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright notice
13 * and the following disclaimer in the documentation and/or other materials
14 * provided with the distribution.
15 *
16 * 3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 *
32 * License 1.0
33 */
34 package fr.paris.lutece.plugins.document.business.rules;
35
36 import fr.paris.lutece.portal.service.i18n.I18nService;
37 import fr.paris.lutece.portal.service.util.AppLogService;
38 import fr.paris.lutece.util.ReferenceList;
39
40 import java.util.Collection;
41 import java.util.Locale;
42 import java.util.Map;
43
44 /**
45 * Rules Set
46 */
47 public class RuleTypesSet implements IRuleTypesSet
48 {
49 private Map<String, Rule> _mapRuleTypes;
50
51 /**
52 * Sets the rule types map
53 *
54 * @param mapRules
55 * The rule types map
56 */
57 public void setRuleTypesMap( Map<String, Rule> mapRules )
58 {
59 _mapRuleTypes = mapRules;
60 }
61
62 /**
63 * Create a new instance of a rule of a given type
64 *
65 * @param strRuleTypeKey
66 * The key name of the rule type
67 * @return A new Rule instance
68 */
69 public Rule newInstance( String strRuleTypeKey )
70 {
71 Rule rule = null;
72
73 try
74 {
75 rule = _mapRuleTypes.get( strRuleTypeKey ).getClass( ).newInstance( );
76 rule.setRuleTypeId( strRuleTypeKey );
77 }
78 catch( InstantiationException e )
79 {
80 AppLogService.error( e.getMessage( ), e );
81 }
82 catch( IllegalAccessException e )
83 {
84 AppLogService.error( e.getMessage( ), e );
85 }
86
87 return rule;
88 }
89
90 /**
91 * Returns the rule type of a given class type
92 *
93 * @return The rule type
94 */
95 public String getRuleTypeKey( Rule rule )
96 {
97 for ( String key : _mapRuleTypes.keySet( ) )
98 {
99 Rule ruleType;
100
101 try
102 {
103 ruleType = _mapRuleTypes.get( key ).getClass( ).newInstance( );
104
105 if ( ruleType.getClass( ).isInstance( rule ) )
106 {
107 return key;
108 }
109 }
110 catch( InstantiationException e )
111 {
112 AppLogService.error( e.getMessage( ), e );
113 }
114 catch( IllegalAccessException e )
115 {
116 AppLogService.error( e.getMessage( ), e );
117 }
118 }
119
120 return null;
121 }
122
123 /**
124 * Returns the rule types list
125 *
126 * @return The rule types list
127 */
128 public ReferenceList getRuleTypesList( Locale locale )
129 {
130 ReferenceList listRules = new ReferenceList( );
131
132 for ( String strRuleKey : _mapRuleTypes.keySet( ) )
133 {
134 String strRuleNameKey = newInstance( strRuleKey ).getNameKey( );
135 listRules.addItem( strRuleKey, I18nService.getLocalizedString( strRuleNameKey, locale ) );
136 }
137
138 return listRules;
139 }
140
141 /**
142 * Returns all rule types
143 *
144 * @return A collection of rule types
145 */
146 public Collection<Rule> getRuleTypes( )
147 {
148 return _mapRuleTypes.values( );
149 }
150 }