View Javadoc
1   /*
2    * This class is an auto-generated source file for a HAPI
3    * HL7 v2.x standard structure class.
4    *
5    * For more information, visit: http://hl7api.sourceforge.net/
6    * 
7    * The contents of this file are subject to the Mozilla Public License Version 1.1 
8    * (the "License"); you may not use this file except in compliance with the License. 
9    * You may obtain a copy of the License at http://www.mozilla.org/MPL/ 
10   * Software distributed under the License is distributed on an "AS IS" basis, 
11   * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the 
12   * specific language governing rights and limitations under the License. 
13   * 
14   * The Original Code is "[file_name]".  Description: 
15   * "[one_line_description]" 
16   * 
17   * The Initial Developer of the Original Code is University Health Network. Copyright (C) 
18   * 2012.  All Rights Reserved. 
19   * 
20   * Contributor(s): ______________________________________. 
21   * 
22   * Alternatively, the contents of this file may be used under the terms of the 
23   * GNU General Public License (the  "GPL"), in which case the provisions of the GPL are 
24   * applicable instead of those above.  If you wish to allow use of your version of this 
25   * file only under the terms of the GPL and not to allow others to use your version 
26   * of this file under the MPL, indicate your decision by deleting  the provisions above 
27   * and replace  them with the notice and other provisions required by the GPL License.  
28   * If you do not delete the provisions above, a recipient may use your version of 
29   * this file under either the MPL or the GPL. 
30   * 
31   */
32  
33  
34  package ca.uhn.hl7v2.model.v21.segment;
35  
36  // import ca.uhn.hl7v2.model.v21.group.*;
37  import ca.uhn.hl7v2.model.v21.datatype.*;
38  import ca.uhn.hl7v2.HL7Exception;
39  import ca.uhn.hl7v2.parser.ModelClassFactory;
40  import ca.uhn.hl7v2.parser.DefaultModelClassFactory;
41  import ca.uhn.hl7v2.model.AbstractMessage;
42  import ca.uhn.hl7v2.model.Group;
43  import ca.uhn.hl7v2.model.Type;
44  import ca.uhn.hl7v2.model.AbstractSegment;
45  import ca.uhn.hl7v2.model.Varies;
46  
47  
48  /**
49   *<p>Represents an HL7 MSH message segment (MESSAGE HEADER). 
50   * This segment has the following fields:</p>
51   * <ul>
52       * <li>MSH-1: FIELD SEPARATOR (ST) <b> </b>
53       * <li>MSH-2: ENCODING CHARACTERS (ST) <b> </b>
54       * <li>MSH-3: SENDING APPLICATION (ST) <b>optional </b>
55       * <li>MSH-4: SENDING FACILITY (ST) <b>optional </b>
56       * <li>MSH-5: RECEIVING APPLICATION (ST) <b>optional </b>
57       * <li>MSH-6: RECEIVING FACILITY (ST) <b>optional </b>
58       * <li>MSH-7: DATE/TIME OF MESSAGE (TS) <b>optional </b>
59       * <li>MSH-8: Security (ST) <b>optional </b>
60       * <li>MSH-9: MESSAGE TYPE (CM_MSG) <b> </b>
61       * <li>MSH-10: MESSAGE CONTROL ID (ST) <b> </b>
62       * <li>MSH-11: PROCESSING ID (ID) <b> </b>
63       * <li>MSH-12: VERSION ID (NM) <b> </b>
64       * <li>MSH-13: SEQUENCE NUMBER (NM) <b>optional </b>
65       * <li>MSH-14: CONTINUATION POINTER (ST) <b>optional </b>
66   * </ul>
67   */
68  @SuppressWarnings("unused")
69  public class MSH extends AbstractSegment {
70  
71      /** 
72       * Creates a new MSH segment
73       */
74      public MSH(Group parent, ModelClassFactory factory) {
75         super(parent, factory);
76         init(factory);
77      }
78  
79      private void init(ModelClassFactory factory) {
80         try {
81                                    this.add(ST.class, true, 1, 1, new Object[]{ getMessage() }, "FIELD SEPARATOR");
82                                    this.add(ST.class, true, 1, 4, new Object[]{ getMessage() }, "ENCODING CHARACTERS");
83                                    this.add(ST.class, false, 1, 15, new Object[]{ getMessage() }, "SENDING APPLICATION");
84                                    this.add(ST.class, false, 1, 20, new Object[]{ getMessage() }, "SENDING FACILITY");
85                                    this.add(ST.class, false, 1, 15, new Object[]{ getMessage() }, "RECEIVING APPLICATION");
86                                    this.add(ST.class, false, 1, 30, new Object[]{ getMessage() }, "RECEIVING FACILITY");
87                                    this.add(TS.class, false, 1, 19, new Object[]{ getMessage() }, "DATE/TIME OF MESSAGE");
88                                    this.add(ST.class, false, 1, 40, new Object[]{ getMessage() }, "Security");
89                                    this.add(CM_MSG.class, true, 1, 7, new Object[]{ getMessage() }, "MESSAGE TYPE");
90                                    this.add(ST.class, true, 1, 20, new Object[]{ getMessage() }, "MESSAGE CONTROL ID");
91                                                this.add(ID.class, true, 1, 1, new Object[]{ getMessage(), new Integer(103) }, "PROCESSING ID");
92                                    this.add(NM.class, true, 1, 8, new Object[]{ getMessage() }, "VERSION ID");
93                                    this.add(NM.class, false, 1, 15, new Object[]{ getMessage() }, "SEQUENCE NUMBER");
94                                    this.add(ST.class, false, 1, 180, new Object[]{ getMessage() }, "CONTINUATION POINTER");
95         } catch(HL7Exception e) {
96            log.error("Unexpected error creating MSH - this is probably a bug in the source code generator.", e);
97         }
98      }
99  
100 
101 
102     /**
103      * Returns
104      * MSH-1: "FIELD SEPARATOR" - creates it if necessary
105      */
106     public ST getFIELDSEPARATOR() { 
107 		ST retVal = this.getTypedField(1, 0);
108 		return retVal;
109     }
110     
111     /**
112      * Returns
113      * MSH-1: "FIELD SEPARATOR" - creates it if necessary
114      */
115     public ST getMsh1_FIELDSEPARATOR() { 
116 		ST retVal = this.getTypedField(1, 0);
117 		return retVal;
118     }
119 
120 
121 
122     /**
123      * Returns
124      * MSH-2: "ENCODING CHARACTERS" - creates it if necessary
125      */
126     public ST getENCODINGCHARACTERS() { 
127 		ST retVal = this.getTypedField(2, 0);
128 		return retVal;
129     }
130     
131     /**
132      * Returns
133      * MSH-2: "ENCODING CHARACTERS" - creates it if necessary
134      */
135     public ST getMsh2_ENCODINGCHARACTERS() { 
136 		ST retVal = this.getTypedField(2, 0);
137 		return retVal;
138     }
139 
140 
141 
142     /**
143      * Returns
144      * MSH-3: "SENDING APPLICATION" - creates it if necessary
145      */
146     public ST getSENDINGAPPLICATION() { 
147 		ST retVal = this.getTypedField(3, 0);
148 		return retVal;
149     }
150     
151     /**
152      * Returns
153      * MSH-3: "SENDING APPLICATION" - creates it if necessary
154      */
155     public ST getMsh3_SENDINGAPPLICATION() { 
156 		ST retVal = this.getTypedField(3, 0);
157 		return retVal;
158     }
159 
160 
161 
162     /**
163      * Returns
164      * MSH-4: "SENDING FACILITY" - creates it if necessary
165      */
166     public ST getSENDINGFACILITY() { 
167 		ST retVal = this.getTypedField(4, 0);
168 		return retVal;
169     }
170     
171     /**
172      * Returns
173      * MSH-4: "SENDING FACILITY" - creates it if necessary
174      */
175     public ST getMsh4_SENDINGFACILITY() { 
176 		ST retVal = this.getTypedField(4, 0);
177 		return retVal;
178     }
179 
180 
181 
182     /**
183      * Returns
184      * MSH-5: "RECEIVING APPLICATION" - creates it if necessary
185      */
186     public ST getRECEIVINGAPPLICATION() { 
187 		ST retVal = this.getTypedField(5, 0);
188 		return retVal;
189     }
190     
191     /**
192      * Returns
193      * MSH-5: "RECEIVING APPLICATION" - creates it if necessary
194      */
195     public ST getMsh5_RECEIVINGAPPLICATION() { 
196 		ST retVal = this.getTypedField(5, 0);
197 		return retVal;
198     }
199 
200 
201 
202     /**
203      * Returns
204      * MSH-6: "RECEIVING FACILITY" - creates it if necessary
205      */
206     public ST getRECEIVINGFACILITY() { 
207 		ST retVal = this.getTypedField(6, 0);
208 		return retVal;
209     }
210     
211     /**
212      * Returns
213      * MSH-6: "RECEIVING FACILITY" - creates it if necessary
214      */
215     public ST getMsh6_RECEIVINGFACILITY() { 
216 		ST retVal = this.getTypedField(6, 0);
217 		return retVal;
218     }
219 
220 
221 
222     /**
223      * Returns
224      * MSH-7: "DATE/TIME OF MESSAGE" - creates it if necessary
225      */
226     public TS getDATETIMEOFMESSAGE() { 
227 		TS retVal = this.getTypedField(7, 0);
228 		return retVal;
229     }
230     
231     /**
232      * Returns
233      * MSH-7: "DATE/TIME OF MESSAGE" - creates it if necessary
234      */
235     public TS getMsh7_DATETIMEOFMESSAGE() { 
236 		TS retVal = this.getTypedField(7, 0);
237 		return retVal;
238     }
239 
240 
241 
242     /**
243      * Returns
244      * MSH-8: "Security" - creates it if necessary
245      */
246     public ST getSecurity() { 
247 		ST retVal = this.getTypedField(8, 0);
248 		return retVal;
249     }
250     
251     /**
252      * Returns
253      * MSH-8: "Security" - creates it if necessary
254      */
255     public ST getMsh8_Security() { 
256 		ST retVal = this.getTypedField(8, 0);
257 		return retVal;
258     }
259 
260 
261 
262     /**
263      * Returns
264      * MSH-9: "MESSAGE TYPE" - creates it if necessary
265      */
266     public CM_MSG getMESSAGETYPE() { 
267 		CM_MSG retVal = this.getTypedField(9, 0);
268 		return retVal;
269     }
270     
271     /**
272      * Returns
273      * MSH-9: "MESSAGE TYPE" - creates it if necessary
274      */
275     public CM_MSG getMsh9_MESSAGETYPE() { 
276 		CM_MSG retVal = this.getTypedField(9, 0);
277 		return retVal;
278     }
279 
280 
281 
282     /**
283      * Returns
284      * MSH-10: "MESSAGE CONTROL ID" - creates it if necessary
285      */
286     public ST getMESSAGECONTROLID() { 
287 		ST retVal = this.getTypedField(10, 0);
288 		return retVal;
289     }
290     
291     /**
292      * Returns
293      * MSH-10: "MESSAGE CONTROL ID" - creates it if necessary
294      */
295     public ST getMsh10_MESSAGECONTROLID() { 
296 		ST retVal = this.getTypedField(10, 0);
297 		return retVal;
298     }
299 
300 
301 
302     /**
303      * Returns
304      * MSH-11: "PROCESSING ID" - creates it if necessary
305      */
306     public ID getPROCESSINGID() { 
307 		ID retVal = this.getTypedField(11, 0);
308 		return retVal;
309     }
310     
311     /**
312      * Returns
313      * MSH-11: "PROCESSING ID" - creates it if necessary
314      */
315     public ID getMsh11_PROCESSINGID() { 
316 		ID retVal = this.getTypedField(11, 0);
317 		return retVal;
318     }
319 
320 
321 
322     /**
323      * Returns
324      * MSH-12: "VERSION ID" - creates it if necessary
325      */
326     public NM getVERSIONID() { 
327 		NM retVal = this.getTypedField(12, 0);
328 		return retVal;
329     }
330     
331     /**
332      * Returns
333      * MSH-12: "VERSION ID" - creates it if necessary
334      */
335     public NM getMsh12_VERSIONID() { 
336 		NM retVal = this.getTypedField(12, 0);
337 		return retVal;
338     }
339 
340 
341 
342     /**
343      * Returns
344      * MSH-13: "SEQUENCE NUMBER" - creates it if necessary
345      */
346     public NM getSEQUENCENUMBER() { 
347 		NM retVal = this.getTypedField(13, 0);
348 		return retVal;
349     }
350     
351     /**
352      * Returns
353      * MSH-13: "SEQUENCE NUMBER" - creates it if necessary
354      */
355     public NM getMsh13_SEQUENCENUMBER() { 
356 		NM retVal = this.getTypedField(13, 0);
357 		return retVal;
358     }
359 
360 
361 
362     /**
363      * Returns
364      * MSH-14: "CONTINUATION POINTER" - creates it if necessary
365      */
366     public ST getCONTINUATIONPOINTER() { 
367 		ST retVal = this.getTypedField(14, 0);
368 		return retVal;
369     }
370     
371     /**
372      * Returns
373      * MSH-14: "CONTINUATION POINTER" - creates it if necessary
374      */
375     public ST getMsh14_CONTINUATIONPOINTER() { 
376 		ST retVal = this.getTypedField(14, 0);
377 		return retVal;
378     }
379 
380 
381 
382 
383 
384     /** {@inheritDoc} */   
385     protected Type createNewTypeWithoutReflection(int field) {
386        switch (field) {
387           case 0: return new ST(getMessage());
388           case 1: return new ST(getMessage());
389           case 2: return new ST(getMessage());
390           case 3: return new ST(getMessage());
391           case 4: return new ST(getMessage());
392           case 5: return new ST(getMessage());
393           case 6: return new TS(getMessage());
394           case 7: return new ST(getMessage());
395           case 8: return new CM_MSG(getMessage());
396           case 9: return new ST(getMessage());
397           case 10: return new ID(getMessage(), new Integer( 103 ));
398           case 11: return new NM(getMessage());
399           case 12: return new NM(getMessage());
400           case 13: return new ST(getMessage());
401           default: return null;
402        }
403    }
404 
405 
406 }
407