View Javadoc

1   /*
2    * Copyright (c) 2002-2014, Mairie de 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.formengine.service.validator;
35  
36  import fr.paris.lutece.plugins.formengine.business.jaxb.formdefinition.CheckRule;
37  import fr.paris.lutece.portal.service.util.AppException;
38  import fr.paris.lutece.portal.service.util.AppPropertiesService;
39  
40  
41  /**
42   * This class is responsible for calling the appropriate validator for a check rule.
43   */
44  public class ValidatorFactory
45  {
46      private static final String PROPERTY_VALIDATOR_PREFIX = "formengine.validator.";
47      private static final String PROPERTY_VALIDATOR_SPECIFIC_TYPE_NAME = "formengine.validator.specific.type.name";
48  
49      /**
50       * Constructor
51       */
52      public ValidatorFactory(  )
53      {
54      }
55  
56      /**
57       * This method can be called to get a validator for a given checkrule
58       * @param rule the rule to check
59       * @return An instance of the validator that will be able to check the given rule.
60       */
61      public static Validator getValidator( CheckRule rule )
62      {
63          Validator validator = null;
64          String strValidatorClass;
65  
66          String strValidatorSpecificRuleType = AppPropertiesService.getProperty( PROPERTY_VALIDATOR_SPECIFIC_TYPE_NAME );
67  
68          String strType = rule.getType(  );
69          String strParameter = rule.getParameter(  );
70  
71          try
72          {
73              // if the rule is "specific", the parameter is the class name
74              if ( ( strType != null ) && ( strType.trim(  ).equals( strValidatorSpecificRuleType ) ) )
75              {
76                  strValidatorClass = strParameter;
77                  validator = (Validator) Class.forName( strValidatorClass ).newInstance(  );
78              }
79  
80              // else : get the class name from the property
81              else
82              {
83                  strValidatorClass = AppPropertiesService.getProperty( PROPERTY_VALIDATOR_PREFIX + strType );
84                  validator = (Validator) Class.forName( strValidatorClass ).newInstance(  );
85                  validator.setRuleParameter( rule.getParameter(  ) );
86              }
87  
88              // set the min/max parameters
89              validator.setMin( rule.getMin(  ) );
90              validator.setMax( rule.getMax(  ) );
91  
92              // set the message if one is given
93              if ( ( rule.getErrorMessage(  ) != null ) && ( !rule.getErrorMessage(  ).trim(  ).equals( "" ) ) )
94              {
95                  validator.setErrorMessage( rule.getErrorMessage(  ) );
96              }
97              else if ( ( rule.getErrorKey(  ) != null ) && ( !rule.getErrorKey(  ).trim(  ).equals( "" ) ) )
98              {
99                  String strErrorMessage = AppPropertiesService.getProperty( rule.getErrorKey(  ) );
100                 validator.setErrorMessage( strErrorMessage );
101             }
102         }
103         catch ( InstantiationException e )
104         {
105             throw new AppException( "Formengine : an error occurred while instancing a validator", e );
106         }
107         catch ( IllegalAccessException e )
108         {
109             throw new AppException( "Formengine : an error occurred while instancing a validator", e );
110         }
111         catch ( ClassNotFoundException e )
112         {
113             throw new AppException( "Formengine : an error occurred while instancing a validator", e );
114         }
115 
116         return validator;
117     }
118 }