/
ValidateMultiple.java
145 lines (127 loc) · 5.16 KB
/
ValidateMultiple.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
/*
* Copyright OmniFaces
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
* specific language governing permissions and limitations under the License.
*/
package org.omnifaces.component.validator;
import java.util.List;
import jakarta.el.ELContext;
import jakarta.el.MethodExpression;
import jakarta.faces.component.FacesComponent;
import jakarta.faces.component.UIInput;
import jakarta.faces.context.FacesContext;
import jakarta.faces.validator.ValidatorException;
import org.omnifaces.validator.MultiFieldValidator;
/**
* <p>
* The <code><o:validateMultiple></code> allows the developer to validate multiple fields by either a custom
* validator method:
* <pre>
* <o:validateMultiple id="myId" components="foo bar baz" validator="#{bean.someMethod}" />
* <h:message for="myId" />
* <h:inputText id="foo" />
* <h:inputText id="bar" />
* <h:inputText id="baz" />
* </pre>
* <p>whereby the method has the following signature (method name is free to your choice):
* <pre>
* public boolean someMethod(FacesContext context, List<UIInput> components, List<Object> values) {
* // ...
* }
* </pre>
* <p>Or, by a managed bean instance which implements the {@link MultiFieldValidator} interface:
* <pre>
* <o:validateMultiple id="myId" components="foo bar baz" validator="#{validateValuesBean}" />
* <h:message for="myId" />
* <h:inputText id="foo" />
* <h:inputText id="bar" />
* <h:inputText id="baz" />
* </pre>
* <pre>
* @ManagedBean
* @RequestScoped
* public class ValidateValuesBean implements MultiFieldValidator {
* @Override
* public boolean validateValues(FacesContext context, List<UIInput> components, List<Object> values) {
* // ...
* }
* }
* </pre>
*
* <h2>Design notice</h2>
* <p>
* Note that this validator does <strong>not</strong> throw {@link ValidatorException}, but returns a boolean! Message
* handling and invalidation job is up to the {@link ValidateMultipleFields} implementation who will call this method.
* You can customize the message by the <code>message</code> attribute of the tag. Refer {@link ValidateMultipleFields}
* documentation for general usage instructions.
*
* @author Juliano Marques
* @author Bauke Scholtz
* @since 1.7
* @see ValidateMultipleHandler
* @see ValidateMultipleFields
* @see ValidatorFamily
* @see MultiFieldValidator
*/
@FacesComponent(ValidateMultiple.COMPONENT_TYPE)
public class ValidateMultiple extends ValidateMultipleFields {
// Public constants -----------------------------------------------------------------------------------------------
/** The component type, which is {@value org.omnifaces.component.validator.ValidateMultiple#COMPONENT_TYPE}. */
public static final String COMPONENT_TYPE = "org.omnifaces.component.validator.ValidateMultiple";
// Private constants ----------------------------------------------------------------------------------------------
private enum PropertyKeys {
validateMethod
}
// Vars -----------------------------------------------------------------------------------------------------------
private MultiFieldValidator validator;
// Actions --------------------------------------------------------------------------------------------------------
/**
* Invoke the validator and return its outcome.
*/
@Override
public boolean validateValues(FacesContext context, List<UIInput> components, List<Object> values) {
if (validator != null) {
return validator.validateValues(context, components, values);
}
else {
ELContext elContext = context.getELContext();
return (Boolean) getValidateMethod().invoke(elContext, new Object[] { context, components, values });
}
}
// Getters/setters ------------------------------------------------------------------------------------------------
/**
* Returns the validator instance.
* @return The validator instance.
*/
public MultiFieldValidator getValidator() {
return validator;
}
/**
* Sets the validator instance.
* @param validator The validator instance.
*/
public void setValidator(MultiFieldValidator validator) {
this.validator = validator;
}
/**
* Returns the validator method expression.
* @return The validator method expression.
*/
public MethodExpression getValidateMethod() {
return (MethodExpression) getStateHelper().eval(PropertyKeys.validateMethod);
}
/**
* Sets the validator method expression.
* @param validateMethod The validator method expression.
*/
public void setValidateMethod(MethodExpression validateMethod) {
getStateHelper().put(PropertyKeys.validateMethod, validateMethod);
}
}