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 "ChoiceElementsRespectedRule.java ".  Description:
10   "Message rule enforcing that one choice element is present"
11  
12   The Initial Developer of the Original Code is University Health Network. Copyright (C)
13   2013.  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  package ca.uhn.hl7v2.validation.builder.support;
28  
29  import java.util.ArrayList;
30  import java.util.HashSet;
31  import java.util.List;
32  import java.util.Set;
33  
34  import ca.uhn.hl7v2.HL7Exception;
35  import ca.uhn.hl7v2.model.Group;
36  import ca.uhn.hl7v2.model.Message;
37  import ca.uhn.hl7v2.model.Structure;
38  import ca.uhn.hl7v2.validation.MessageRule;
39  import ca.uhn.hl7v2.validation.ValidationException;
40  import ca.uhn.hl7v2.validation.impl.AbstractMessageRule;
41  
42  /**
43   * Message rule which enforces that only one "choice element" within any groups
44   * in the message must only have content within one of the possible choices.
45   */
46  public class ChoiceElementsRespectedRule extends AbstractMessageRule {
47  
48  	/** Singleton instance */
49  	public static final MessageRule CHOICE_ELEMENTS_RESPECTED = new ChoiceElementsRespectedRule();
50  
51  	public ValidationException[] apply(Message theValue) {
52  		List<ValidationException> exceptions = new ArrayList<ValidationException>();
53  		apply(theValue, exceptions);
54  		return exceptions.toArray(new ValidationException[exceptions.size()]);
55  	}
56  
57  	private void apply(Group theStructure, List<ValidationException> theExceptions) {
58  		Set<String> choicesWithContent = null;
59  
60  		for (String nextName : theStructure.getNames()) {
61  			try {
62  				boolean nextIsChoiceElement = theStructure.isChoiceElement(nextName);
63  				for (Structure nextStruct : theStructure.getAll(nextName)) {
64  
65  					if (nextIsChoiceElement && !nextStruct.isEmpty()) {
66  						if (choicesWithContent == null) {
67  							choicesWithContent = new HashSet<String>();
68  						}
69  						choicesWithContent.add(nextName);
70  					}
71  
72  					if (nextStruct instanceof Group) {
73  						apply((Group) nextStruct, theExceptions);
74  					}
75  				}
76  			} catch (HL7Exception e) {
77  				throw new Error("Failed to find " + nextName + " in structure. This is probably a HAPI bug.");
78  			}
79  		}
80  
81  		if (choicesWithContent != null && choicesWithContent.size() > 1) {
82  			theExceptions.add(new ValidationException("Structure '" + theStructure.getName() + "' must have content only in one of the following choices: " + choicesWithContent.toString()));
83  		}
84  
85  	}
86  
87  }