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 "SizeRule.java".  Description: 
010"Checks that Primitive values conform to a certain size limit" 
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 ca.uhn.hl7v2.validation.PrimitiveTypeRule;
029
030/**
031 * Checks that Primitive values conform to a certain size limit.  
032 *  
033 * @author <a href="mailto:bryan.tripp@uhn.on.ca">Bryan Tripp</a>
034 * @version $Revision: 1.1 $ updated on $Date: 2007-02-19 02:24:40 $ by $Author: jamesagnew $
035 */
036@SuppressWarnings("serial")
037public class SizeRule implements PrimitiveTypeRule {
038
039    private int myMaxChars;
040    
041    /**
042     * @param theMaxChars the maximum number of characters this rule allows in a 
043     *      primitive value
044     */
045    public SizeRule(int theMaxChars) {
046        myMaxChars = theMaxChars;
047    }
048
049    /** 
050     * Does nothing.  If what you wanted was to trim the value to the max size, you should
051     * make a separate rule for that.  
052     * 
053     * @see ca.uhn.hl7v2.validation.PrimitiveTypeRule#correct(java.lang.String)
054     */
055    public String correct(String value) {
056        return value;
057    }
058
059    /** 
060     * @see ca.uhn.hl7v2.validation.PrimitiveTypeRule#test(java.lang.String)
061     */
062    public boolean test(String value) {
063        boolean ok = true;
064        if (value != null && value.length() > myMaxChars) {
065            ok = false;
066        }
067        return ok;
068    }
069
070    /** 
071     * @see ca.uhn.hl7v2.validation.Rule#getDescription()
072     */
073    public String getDescription() {
074        return "Maxumim size <= " + myMaxChars + " characters";
075    }
076
077    /** 
078     * @see ca.uhn.hl7v2.validation.Rule#getSectionReference()
079     */
080    public String getSectionReference() {
081        return null;
082    }
083
084}