/*
* Copyright 2002-2006,2009 The Apache Software Foundation.
*
* 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
*
* http://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 com.opensymphony.xwork2.validator.validators;
import com.opensymphony.xwork2.validator.ValidationException;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
/**
* <!-- START SNIPPET: javadoc -->
* Validates a string field using a regular expression.
* <!-- END SNIPPET: javadoc -->
* <p/>
*
*
* <!-- START SNIPPET: parameters -->
* <ul>
* <li>fieldName - The field name this validator is validating. Required if using Plain-Validator Syntax otherwise not required</li>
* <li>expression - The RegExp expression REQUIRED</li>
* <li>caseSensitive - Boolean (Optional). Sets whether the expression should be matched against in a case-sensitive way. Default is <code>true</code>.</li>
* <li>trim - Boolean (Optional). Sets whether the expression should be trimed before matching. Default is <code>true</code>.</li>
* </ul>
* <!-- END SNIPPET: parameters -->
*
*
* <pre>
* <!-- START SNIPPET: example -->
* <validators>
* <!-- Plain Validator Syntax -->
* <validator type="regex">
* <param name="fieldName">myStrangePostcode</param>
* <param name="expression"><![CDATA[([aAbBcCdD][123][eEfFgG][456])]]<>/param>
* </validator>
*
* <!-- Field Validator Syntax -->
* <field name="myStrangePostcode">
* <field-validator type="regex">
* <param name="expression"><![CDATA[([aAbBcCdD][123][eEfFgG][456])]]></param>
* </field-validator>
* </field>
* </validators>
* <!-- END SNIPPET: example -->
* </pre>
*
* @author Quake Wang
* @version $Date$ $Revision$
*/
public class RegexFieldValidator extends FieldValidatorSupport {
private String expression;
private boolean caseSensitive = true;
private boolean trim = true;
public void validate(Object object) throws ValidationException {
String fieldName = getFieldName();
Object value = this.getFieldValue(fieldName, object);
// if there is no value - don't do comparison
// if a value is required, a required validator should be added to the field
if (value == null || expression == null) {
return;
}
// XW-375 - must be a string
if (!(value instanceof String)) {
return;
}
// string must not be empty
String str = ((String) value).trim();
if (str.length() == 0) {
return;
}
// match against expression
Pattern pattern;
if (isCaseSensitive()) {
pattern = Pattern.compile(expression);
} else {
pattern = Pattern.compile(expression, Pattern.CASE_INSENSITIVE);
}
String compare = (String) value;
if ( trim ) {
compare = compare.trim();
}
Matcher matcher = pattern.matcher( compare );
if (!matcher.matches()) {
addFieldError(fieldName, object);
}
}
/**
* @return Returns the regular expression to be matched.
*/
public String getExpression() {
return expression;
}
/**
* Sets the regular expression to be matched.
*/
public void setExpression(String expression) {
this.expression = expression;
}
/**
* @return Returns whether the expression should be matched against in
* a case-sensitive way. Default is <code>true</code>.
*/
public boolean isCaseSensitive() {
return caseSensitive;
}
/**
* Sets whether the expression should be matched against in
* a case-sensitive way. Default is <code>true</code>.
*/
public void setCaseSensitive(boolean caseSensitive) {
this.caseSensitive = caseSensitive;
}
/**
* @return Returns whether the expression should be trimed before matching.
* Default is <code>true</code>.
*/
public boolean isTrimed() {
return trim;
}
/**
* Sets whether the expression should be trimed before matching.
* Default is <code>true</code>.
*/
public void setTrim(boolean trim) {
this.trim = trim;
}
}