src/org/mxchange/jcoreee/validator/BaseObjectValidator.java

   1 /*
   2  * Copyright (C) 2016, 2017 Roland Häder
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17 package org.mxchange.jcoreee.validator;
  18
  19 import java.io.Serializable;
  20 import java.text.MessageFormat;
  21 import javax.faces.application.FacesMessage;
  22 import javax.faces.component.UIComponent;
  23 import javax.faces.context.FacesContext;
  24 import javax.faces.validator.Validator;
  25 import javax.faces.validator.ValidatorException;
  26
  27 /**
  28  * A general object validation class. Please implement
  29  * javax.faces.validator.Validator (with import line!) and call preValidate().
  30  * You also may want to try out some other BaseFooValidator classes before
  31  * directly inheriting from this class.
  32  * <p>
  33  * @author Roland Häder<roland@mxchange.org>
  34  */
  35 public abstract class BaseObjectValidator implements Validator, Serializable {
  36
  37         /**
  38          * Serial number
  39          */
  40         private static final long serialVersionUID = 48_574_878_176_939_512L;
  41
  42         /**
  43          * The method pre-validates the given value. It makes sure that the
  44          * component's id is found in requiredFields and is not null. Once the
  45          * component's id has been found, it stops iteration on requiredFields
  46          * (which saves execution time).
  47          * <p>
  48          * @param context        FacesContext instance
  49          * @param component      UIComponent instance
  50          * @param value          Value to check
  51          * @param requiredFields Array of required field names (ending with)
  52          * @param allowNull      Wether null or empty values are allowed
  53          * <p>
  54          * @throws ValidatorException If something more horrible went wrong
  55          */
  56         protected void preValidate (final FacesContext context, final UIComponent component, final Object value, final String[] requiredFields, Boolean allowNull) throws ValidatorException {
  57                 // Trace message
  58                 //* NOISY-DEBUG: */ System.out.println(MessageFormat.format("preValidate: context={0},component={1},value={2},requiredFields={3} - CALLED!", context, component, value, Arrays.toString(requiredFields))); //NOI18N
  59
  60                 // Init message and key
  61                 String requiredMessage = null;
  62
  63                 // Get client id
  64                 final String clientId = component.getClientId();
  65
  66                 // Check component's id against required fields and find a match
  67                 for (final String field : requiredFields) {
  68                         // Get logger
  69                         //this.getLogger().logDebug(MessageFormat.format("preValidate: field={0},clientId={1}", field, clientId)); //NOI18N
  70
  71                         // Is it the same?
  72                         if (clientId.endsWith(field)) {
  73                                 // Is it null?
  74                                 if ((!allowNull) && (null == value)) {
  75                                         // Value it null
  76                                         requiredMessage = MessageFormat.format("Field {0} is null.", field); //NOI18N
  77                                 }
  78
  79                                 // Abort here
  80                                 break;
  81                         }
  82                 }
  83
  84                 // Debug message
  85                 //* NOISY-DEBUG: */ this.getLogger().logDebug(MessageFormat.format("preValidate: requiredMessage={0}", requiredMessage)); //NOI18N
  86                 // Is it not null?
  87                 if (null != requiredMessage) {
  88                         throw new ValidatorException(new FacesMessage(MessageFormat.format("Value {0} for clientId={1} is not valid/unexpected.", value, clientId)));
  89                 }
  90
  91                 // Trace message
  92                 //* NOISY-DEBUG: */ System.out.println("preValidate: EXIT!"); //NOI18N
  93         }
  94
  95 }