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

   1 /*
   2  * Copyright (C) 2015 Roland Haeder
   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 Haeder<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          * Needs to be implemented as the Validator interface needs to be
  44          * implemented.
  45          * <p>
  46          * @param context
  47          * @param component
  48          * @param value
  49          * <p>
  50          * @throws ValidatorException
  51          */
  52         @Override
  53         abstract public void validate (final FacesContext context, final UIComponent component, final Object value) throws ValidatorException;
  54
  55         /**
  56          * The method pre-validates the given value. It makes sure that the
  57          * component's id is found in requiredFields and is not null. Once the
  58          * component's id has been found, it stops iteration on requiredFields
  59          * (which saves execution time).
  60          * <p>
  61          * @param context FacesContext instance
  62          * @param component UIComponent instance
  63          * @param value Value to check
  64          * @param requiredFields Array of required field names (ending with)
  65          * @param allowNull Wether null or empty values are allowed
  66          * <p>
  67          * @throws ValidatorException If something more horrible went wrong
  68          */
  69         protected void preValidate (final FacesContext context, final UIComponent component, final Object value, final String[] requiredFields, boolean allowNull) throws ValidatorException {
  70                 // Trace message
  71                 //this.getLogger().logTrace(MessageFormat.format("preValidate: context={0},component={1},value={2},requiredFields={3} - CALLED!", context, component, value, Arrays.toString(requiredFields))); //NOI18N
  72
  73                 // Init message and key
  74                 FacesMessage facesMessage = null;
  75
  76                 // Get client id
  77                 final String clientId = component.getClientId();
  78
  79                 // Default is no field is valid
  80                 boolean isValidField = false;
  81
  82                 // Check component's id against required fields and find a match
  83                 for (final String field : requiredFields) {
  84                         // Get logger
  85                         //this.getLogger().logDebug(MessageFormat.format("preValidate: field={0},clientId={1}", field, clientId)); //NOI18N
  86
  87                         // Is it the same?
  88                         if (clientId.endsWith(field)) {
  89                                 // Is valid field
  90                                 isValidField = true;
  91
  92                                 // Is it null?
  93                                 if ((!allowNull) && (null == value)) {
  94                                         // Value it null
  95                                         facesMessage = new FacesMessage(MessageFormat.format("Field {0} is null.", field)); //NOI18N
  96                                 }
  97
  98                                 // Abort here
  99                                 break;
 100                         }
 101                 }
 102
 103                 // Debug message
 104                 //this.getLogger().logDebug(MessageFormat.format("preValidate: isValidField={0}", isValidField)); //NOI18N
 105                 // Valid field?
 106                 if (!isValidField) {
 107                         // Invalid field
 108                         facesMessage = new FacesMessage(MessageFormat.format("Valure {0} for clientId={1} is not valid/unexpected.", value, clientId)); //NOI18N
 109                 }
 110
 111                 // Debug message
 112                 //this.getLogger().logDebug(MessageFormat.format("preValidate: facesMessage={0}", facesMessage)); //NOI18N
 113                 // Is it not null?
 114                 if (null != facesMessage) {
 115                         throw new ValidatorException(facesMessage);
 116                 }
 117
 118                 // Trace message
 119                 //this.getLogger().logTrace("preValidate: EXIT!"); //NOI18N
 120         }
 121 }