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.PrimitiveTypeRule;
032
033/**
034 * A <code>PrimitiveTypeRule</code> that validates primitive values 
035 * using a regular expression.  
036 *  
037 * @author <a href="mailto:bryan.tripp@uhn.on.ca">Bryan Tripp</a>
038 * @version $Revision: 1.1 $ updated on $Date: 2007-02-19 02:24:40 $ by $Author: jamesagnew $
039 */
040@SuppressWarnings("serial")
041public class RegexPrimitiveRule implements PrimitiveTypeRule {
042
043    private final Pattern myPattern; 
044    private final String mySectionReference;
045    
046    /**
047     * @param theRegex a regular expression against which to validate primitive
048     *      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     * @see ca.uhn.hl7v2.validation.PrimitiveTypeRule#test(java.lang.String)
060     */
061    public boolean test(String value) {
062        if (value == null || value.equals("\"\"") || value.equals("")) {
063            return true;
064        } else {
065            Matcher matcher = myPattern.matcher(value);
066            return matcher.matches();            
067        }
068    }
069
070    /** 
071     * @see ca.uhn.hl7v2.validation.Rule#getDescription()
072     */
073    public String getDescription() {
074        return "Matches the regular expression " + myPattern.pattern();
075    }
076
077    /** 
078     * @see ca.uhn.hl7v2.validation.Rule#getSectionReference()
079     */
080    public String getSectionReference() {
081        return mySectionReference;
082    }
083
084    /** 
085     * @see ca.uhn.hl7v2.validation.PrimitiveTypeRule#correct(java.lang.String)
086     */
087    public String correct(String value) {
088        return value;
089    }
090
091}