2 * Copyright (C) 2015 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.text.MessageFormat;
20 import java.util.Arrays;
22 import javax.faces.application.FacesMessage;
23 import javax.faces.component.UIComponent;
24 import javax.faces.context.FacesContext;
25 import javax.faces.validator.Validator;
26 import javax.faces.validator.ValidatorException;
27 import org.mxchange.jcoreee.BaseEeSystem;
28 import org.mxchange.jcoreeelogger.beans.local.logger.Log;
29 import org.mxchange.jcoreeelogger.beans.local.logger.LoggerBeanLocal;
32 * A general object validation class. Please implement javax.faces.validator.Validator
33 * (with import line!) and call preValidate(). You also may want to try out some
34 * other BaseFooValidator classes before directly inheriting from this class.
36 * @author Roland Haeder
38 public abstract class BaseObjectValidator extends BaseEeSystem implements Validator {
45 private LoggerBeanLocal logger;
48 * Needs to be implemented as the Validator interface needs to be implemented.
53 * @throws ValidatorException
56 abstract public void validate (final FacesContext context, final UIComponent component, final Object value) throws ValidatorException;
59 * The method pre-validates the given value. It makes sure that the component's id is found in
60 * requiredFields and is not null. Once the component's id has been found, it stops iteration on
61 * requiredFields (which saves execution time).
63 * @param context FacesContext instance
64 * @param component UIComponent instance
65 * @param value Value to check
66 * @param requiredFields Array of required field names (ending with)
67 * @throws ValidatorException If something more horrible went wrong
69 protected void preValidate (final FacesContext context, final UIComponent component, final Object value, final String[] requiredFields) throws ValidatorException {
71 this.getLogger().logTrace(MessageFormat.format("preValidate: context={0},component={1},value={2},requiredFields={3} - CALLED!", context, component, value, Arrays.toString(requiredFields))); //NOI18N
73 // Init message and key
74 FacesMessage facesMessage = null;
75 String errKey = "error.unknown_id"; //NOI18N
78 final String clientId = component.getClientId();
80 // Default is no field is valid
81 boolean isValidField = false;
83 // Check component's id against required fields and find a match
84 for (final String field : requiredFields) {
86 this.getLogger().logDebug(MessageFormat.format("preValidate: field={0},clientId={1}", field, clientId)); //NOI18N
89 if (clientId.endsWith(field)) {
95 errKey = String.format("error.%s.is_null", field); //NOI18N
98 facesMessage = new FacesMessage(getMessageStringFromKey(errKey));
107 this.getLogger().logDebug(MessageFormat.format("preValidate: isValidField={0}", isValidField)); //NOI18N
112 facesMessage = new FacesMessage(MessageFormat.format(errKey, clientId));
116 this.getLogger().logDebug(MessageFormat.format("preValidate: facesMessage={0}", facesMessage)); //NOI18N
119 if (null != facesMessage) {
120 throw new ValidatorException(facesMessage);
124 this.getLogger().logTrace("preValidate: EXIT!"); //NOI18N
128 * Getter for local bean logger
130 * @return Local bean logger
132 protected LoggerBeanLocal getLogger () {