2 * Copyright (C) 2016 Roland Haeder
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.
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.
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/>.
17 package org.mxchange.jcoreee.validator;
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;
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.
33 * @author Roland Haeder<roland@mxchange.org>
35 public abstract class BaseObjectValidator implements Validator, Serializable {
40 private static final long serialVersionUID = 48_574_878_176_939_512L;
43 * Needs to be implemented as the Validator interface needs to be
49 * @throws ValidatorException
52 abstract public void validate (final FacesContext context, final UIComponent component, final Object value) throws ValidatorException;
55 * The method pre-validates the given value. It makes sure that the
56 * component's id is found in requiredFields and is not null. Once the
57 * component's id has been found, it stops iteration on requiredFields
58 * (which saves execution time).
60 * @param context FacesContext instance
61 * @param component UIComponent instance
62 * @param value Value to check
63 * @param requiredFields Array of required field names (ending with)
64 * @param allowNull Wether null or empty values are allowed
66 * @throws ValidatorException If something more horrible went wrong
68 protected void preValidate (final FacesContext context, final UIComponent component, final Object value, final String[] requiredFields, boolean allowNull) throws ValidatorException {
70 //* NOISY-DEBUG: */ System.out.println(MessageFormat.format("preValidate: context={0},component={1},value={2},requiredFields={3} - CALLED!", context, component, value, Arrays.toString(requiredFields))); //NOI18N
72 // Init message and key
73 FacesMessage facesMessage = null;
76 final String clientId = component.getClientId();
78 // Default is no field is valid
79 boolean isValidField = false;
81 // Check component's id against required fields and find a match
82 for (final String field : requiredFields) {
84 //this.getLogger().logDebug(MessageFormat.format("preValidate: field={0},clientId={1}", field, clientId)); //NOI18N
87 if (clientId.endsWith(field)) {
92 if ((!allowNull) && (null == value)) {
94 facesMessage = new FacesMessage(MessageFormat.format("Field {0} is null.", field)); //NOI18N
103 //this.getLogger().logDebug(MessageFormat.format("preValidate: isValidField={0}", isValidField)); //NOI18N
108 facesMessage = new FacesMessage(MessageFormat.format("Value {0} for clientId={1} is not valid/unexpected.", value, clientId)); //NOI18N
112 //this.getLogger().logDebug(MessageFormat.format("preValidate: facesMessage={0}", facesMessage)); //NOI18N
115 if (null != facesMessage) {
116 throw new ValidatorException(facesMessage);
120 //* NOISY-DEBUG: */ System.out.println("preValidate: EXIT!"); //NOI18N