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 "TrimLeadingWhitespaceRule.java".  Description: 
010"Performs no validation but removes leading whitespace in the correct() method." 
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.Pattern;
029
030import ca.uhn.hl7v2.validation.PrimitiveTypeRule;
031
032/**
033 * Performs no validation but removes leading whitespace in the correct() method.
034 *   
035 * @author <a href="mailto:bryan.tripp@uhn.on.ca">Bryan Tripp</a>
036 * @author Christian Ohr
037 */
038@SuppressWarnings("serial")
039public class TrimLeadingWhitespace implements PrimitiveTypeRule {
040
041        private static final Pattern LEADING_WHITESPACE = Pattern.compile("^\\s+");
042        
043    /** 
044     * Removes leading whitespace. 
045     * 
046     * @see ca.uhn.hl7v2.validation.PrimitiveTypeRule#correct(java.lang.String)
047     */
048    public String correct(String value) {
049        return value != null ? LEADING_WHITESPACE.matcher(value).replaceAll("") : null;
050    }
051
052    /** 
053     * Returns true. 
054     * @see ca.uhn.hl7v2.validation.PrimitiveTypeRule#test(java.lang.String)
055     */
056    public boolean test(String value) {
057        return true;
058    }
059
060    /** 
061     * @see ca.uhn.hl7v2.validation.Rule#getDescription()
062     */
063    public String getDescription() {
064        return "Leading whitespace removed";
065    }
066
067    /** 
068     * @see ca.uhn.hl7v2.validation.Rule#getSectionReference()
069     */
070    public String getSectionReference() {
071        return null;
072    }
073
074}