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 "HaveFieldsMessageVisitor.java". Description:
10 "Visitor that checks if configured segments and fields are available in the message"
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.examples;
28
29 import java.util.HashSet;
30 import java.util.Map;
31 import java.util.Set;
32
33 import ca.uhn.hl7v2.HL7Exception;
34 import ca.uhn.hl7v2.Location;
35 import ca.uhn.hl7v2.model.Field;
36 import ca.uhn.hl7v2.model.Message;
37 import ca.uhn.hl7v2.model.Segment;
38 import ca.uhn.hl7v2.validation.ValidationException;
39 import ca.uhn.hl7v2.validation.builder.support.ValidatingMessageVisitor;
40
41 /**
42 * Example for a validating visitor that check availability of mandatory fields
43 */
44 public class MandatoryFieldsVisitor extends ValidatingMessageVisitor {
45
46 private final Map<String, Integer[]> requiredFields;
47
48 public MandatoryFieldsVisitor(Map<String, Integer[]> requiredFields) {
49 this.requiredFields = requiredFields;
50 }
51
52 // required fields left to be checked
53 private Set<Location> fieldsLeft;
54
55 @Override
56 public boolean start(Message message) {
57 fieldsLeft = new HashSet<>();
58 // Initialize the field expressions to be visited
59 for (Map.Entry<String, Integer[]> entry : requiredFields.entrySet()) {
60 if (!(entry.getValue().length == 0)) {
61 for (int fieldId : entry.getValue()) {
62 fieldsLeft.add(
63 new Location()
64 .withSegmentName(entry.getKey())
65 .withField(fieldId));
66 }
67 }
68 }
69 return true;
70 }
71
72 @Override
73 public boolean end(Message message) {
74 for (Location l : fieldsLeft) {
75 ValidationExceptioneption.html#ValidationException">ValidationException ve = new ValidationException("Mandatory field is empty");
76 ve.setLocation(l);
77 addValidationException(ve);
78 }
79 fieldsLeft.clear();
80 return true;
81 }
82
83 @Override
84 public boolean start(Segment segment, Location location) {
85 // If we don't require a fields for this segment, there is no need to
86 // visit the fields
87 return requiredFields.containsKey(segment.getName());
88 }
89
90 @Override
91 public boolean start(Field field, Location location) throws HL7Exception {
92 if (!field.isEmpty()) fieldsLeft.remove(location);
93 return false; // no need to go deeper
94 }
95
96
97 }