001/**
002The contents of this file are subject to the Mozilla Public License Version 1.1 
003(the "License"); you may not use this file except in compliance with the License. 
004You may obtain a copy of the License at http://www.mozilla.org/MPL/ 
005Software distributed under the License is distributed on an "AS IS" basis, 
006WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the 
007specific language governing rights and limitations under the License. 
008
009The Original Code is "RegexPrimitiveRule.java".  Description: 
010"A PrimitiveTypeRule that validates primitive values using a regular expression" 
011
012The Initial Developer of the Original Code is University Health Network. Copyright (C) 
0132004.  All Rights Reserved. 
014
015Contributor(s): ______________________________________. 
016
017Alternatively, the contents of this file may be used under the terms of the 
018GNU General Public License (the "GPL"), in which case the provisions of the GPL are 
019applicable instead of those above.  If you wish to allow use of your version of this 
020file only under the terms of the GPL and not to allow others to use your version 
021of this file under the MPL, indicate your decision by deleting  the provisions above 
022and replace  them with the notice and other provisions required by the GPL License.  
023If you do not delete the provisions above, a recipient may use your version of 
024this file under either the MPL or the GPL. 
025 */
026package ca.uhn.hl7v2.validation.impl;
027
028import java.util.regex.Matcher;
029import java.util.regex.Pattern;
030
031import ca.uhn.hl7v2.validation.ValidationException;
032
033/**
034 * A <code>PrimitiveTypeRule</code> that validates primitive values using a regular expression.
035 * 
036 * @author Bryan Tripp
037 * @version $Revision: 1.1 $ updated on $Date: 2007-02-19 02:24:40 $ by $Author: jamesagnew $
038 * 
039 * @deprecated use {@link ca.uhn.hl7v2.validation.builder.BuilderSupport#matches(String)} instead
040 */
041@SuppressWarnings("serial")
042public class RegexPrimitiveRule extends AbstractPrimitiveTypeRule {
043
044        private final Pattern myPattern;
045        private final String mySectionReference;
046
047        /**
048         * @param theRegex a regular expression against which to validate primitive values
049         * @param theSectionReference to be returned by <code>getSectionReference()</code>
050         */
051        public RegexPrimitiveRule(String theRegex, String theSectionReference) {
052                myPattern = Pattern.compile(theRegex);
053                mySectionReference = theSectionReference;
054        }
055
056        /**
057         * Empty string, null, and the HL7 explicit null (two double-quotes) are passed.
058         */
059        public ValidationException[] apply(String value) {
060                if (value == null || value.equals("\"\"") || value.equals("")) {
061                        return passed();
062                }
063                Matcher matcher = myPattern.matcher(value);
064                return result(matcher.matches(), value);
065
066        }
067
068        /**
069         * @see ca.uhn.hl7v2.validation.Rule#getDescription()
070         */
071        public String getDescription() {
072                return "%s does not match the regular expression " + myPattern.pattern();
073        }
074
075        /**
076         * @see ca.uhn.hl7v2.validation.Rule#getSectionReference()
077         */
078        public String getSectionReference() {
079                return mySectionReference;
080        }
081
082}