View Javadoc

1   /**
2   The contents of this file are subject to the Mozilla Public License Version 1.1 
3   (the "License"); you may not use this file except in compliance with the License. 
4   You may obtain a copy of the License at http://www.mozilla.org/MPL/ 
5   Software distributed under the License is distributed on an "AS IS" basis, 
6   WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the 
7   specific language governing rights and limitations under the License. 
8   
9   The Original Code is "Validator.java".  Description: 
10  "Validates messages against message profiles." 
11  
12  The Initial Developer of the Original Code is University Health Network. Copyright (C) 
13  2003.  All Rights Reserved. 
14  
15  Contributor(s): ______________________________________. 
16  
17  Alternatively, the contents of this file may be used under the terms of the 
18  GNU General Public License (the "GPL"), in which case the provisions of the GPL are 
19  applicable instead of those above.  If you wish to allow use of your version of this 
20  file only under the terms of the GPL and not to allow others to use your version 
21  of this file under the MPL, indicate your decision by deleting  the provisions above 
22  and replace  them with the notice and other provisions required by the GPL License.  
23  If you do not delete the provisions above, a recipient may use your version of 
24  this file under either the MPL or the GPL. 
25  
26  */
27  
28  package ca.uhn.hl7v2.conf.check;
29  
30  import ca.uhn.hl7v2.conf.spec.message.StaticDef;
31  import ca.uhn.hl7v2.model.Message ;
32  import ca.uhn.hl7v2.conf.ProfileException;
33  import ca.uhn.hl7v2.HL7Exception;
34  
35  /**
36   * Validates messages against message profiles. In general you use this by
37   * formulating a ConformanceProfileRule and validating a message using this rule.
38   *  
39   * @author Bryan Tripp
40   */
41  public interface Validator {
42      
43      /**
44       * Validates the given message against the given static definition from 
45       * a conformance profile.  Conformance profiles are XML representations of   
46       * domain-specific constraints on a message (see HL7 2.5 section 2.12).  
47       * @throws ProfileException if a problem is encountered that interferes with evaluation 
48       * @return a list of exceptions representing points of non-conformance (may not be a complete list)
49       */
50      public HL7Exception[] validate(Message message, StaticDef profile) throws ProfileException, HL7Exception;
51      
52  }