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.text.MessageFormat;
  20 import javax.faces.application.FacesMessage;
  21 import javax.faces.component.UIComponent;
  22 import javax.faces.context.FacesContext;
  23 import javax.faces.validator.Validator;
  24 import javax.faces.validator.ValidatorException;
  25
  26 /**
  27  * A general object validation class. Please implement
  28  * javax.faces.validator.Validator (with import line!) and call preValidate().
  29  * You also may want to try out some other BaseFooValidator classes before
  30  * directly inheriting from this class.
  31  * <p>
  32  * @author Roland Haeder<roland@mxchange.org>
  33  */
  34 public abstract class BaseObjectValidator implements Validator {
  35
  36         /**
  37          * Serial number
  38          */
  39         private static final long serialVersionUID = 48_574_878_176_939_512L;
  40
  41         /**
  42          * Needs to be implemented as the Validator interface needs to be
  43          * implemented.
  44          * <p>
  45          * @param context
  46          * @param component
  47          * @param value
  48          * @throws ValidatorException
  49          */
  50         @Override
  51         abstract public void validate (final FacesContext context, final UIComponent component, final Object value) throws ValidatorException;
  52
  53         /**
  54          * The method pre-validates the given value. It makes sure that the
  55          * component's id is found in requiredFields and is not null. Once the
  56          * component's id has been found, it stops iteration on requiredFields
  57          * (which saves execution time).
  58          * <p>
  59          * @param context FacesContext instance
  60          * @param component UIComponent instance
  61          * @param value Value to check
  62          * @param requiredFields Array of required field names (ending with)
  63          * @throws ValidatorException If something more horrible went wrong
  64          */
  65         protected void preValidate (final FacesContext context, final UIComponent component, final Object value, final String[] requiredFields) throws ValidatorException {
  66                 // Trace message
  67                 //this.getLogger().logTrace(MessageFormat.format("preValidate: context={0},component={1},value={2},requiredFields={3} - CALLED!", context, component, value, Arrays.toString(requiredFields))); //NOI18N
  68
  69                 // Init message and key
  70                 FacesMessage facesMessage = null;
  71
  72                 // Get client id
  73                 final String clientId = component.getClientId();
  74
  75                 // Default is no field is valid
  76                 boolean isValidField = false;
  77
  78                 // Check component's id against required fields and find a match
  79                 for (final String field : requiredFields) {
  80                         // Get logger
  81                         //this.getLogger().logDebug(MessageFormat.format("preValidate: field={0},clientId={1}", field, clientId)); //NOI18N
  82
  83                         // Is it the same?
  84                         if (clientId.endsWith(field)) {
  85                                 // Is valid field
  86                                 isValidField = true;
  87
  88                                 // Is it null?
  89                                 if (null == value) {
  90                                         // Value it null
  91                                         facesMessage = new FacesMessage(MessageFormat.format("Field {0} is null.", field)); //NOI18N
  92                                 }
  93
  94                                 // Abort here
  95                                 break;
  96                         }
  97                 }
  98
  99                 // Debug message
 100                 //this.getLogger().logDebug(MessageFormat.format("preValidate: isValidField={0}", isValidField)); //NOI18N
 101                 // Valid field?
 102                 if (!isValidField) {
 103                         // Invalid field
 104                         facesMessage = new FacesMessage(MessageFormat.format("Valure {0} for clientId={1} is not valid/unexpected.", value, clientId)); //NOI18N
 105                 }
 106
 107                 // Debug message
 108                 //this.getLogger().logDebug(MessageFormat.format("preValidate: facesMessage={0}", facesMessage)); //NOI18N
 109                 // Is it not null?
 110                 if (null != facesMessage) {
 111                         throw new ValidatorException(facesMessage);
 112                 }
 113
 114                 // Trace message
 115                 //this.getLogger().logTrace("preValidate: EXIT!"); //NOI18N
 116         }
 117 }