001/*
002 * This class is an auto-generated source file for a HAPI
003 * HL7 v2.x standard structure class.
004 *
005 * For more information, visit: http://hl7api.sourceforge.net/
006 * 
007 * The contents of this file are subject to the Mozilla Public License Version 1.1 
008 * (the "License"); you may not use this file except in compliance with the License. 
009 * You may obtain a copy of the License at http://www.mozilla.org/MPL/ 
010 * Software distributed under the License is distributed on an "AS IS" basis, 
011 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the 
012 * specific language governing rights and limitations under the License. 
013 * 
014 * The Original Code is "[file_name]".  Description: 
015 * "[one_line_description]" 
016 * 
017 * The Initial Developer of the Original Code is University Health Network. Copyright (C) 
018 * 2012.  All Rights Reserved. 
019 * 
020 * Contributor(s): ______________________________________. 
021 * 
022 * Alternatively, the contents of this file may be used under the terms of the 
023 * GNU General Public License (the  "GPL"), in which case the provisions of the GPL are 
024 * applicable instead of those above.  If you wish to allow use of your version of this 
025 * file only under the terms of the GPL and not to allow others to use your version 
026 * of this file under the MPL, indicate your decision by deleting  the provisions above 
027 * and replace  them with the notice and other provisions required by the GPL License.  
028 * If you do not delete the provisions above, a recipient may use your version of 
029 * this file under either the MPL or the GPL. 
030 * 
031 */
032
033
034package ca.uhn.hl7v2.model.v23.segment;
035
036// import ca.uhn.hl7v2.model.v23.group.*;
037import ca.uhn.hl7v2.model.v23.datatype.*;
038import ca.uhn.hl7v2.HL7Exception;
039import ca.uhn.hl7v2.parser.ModelClassFactory;
040import ca.uhn.hl7v2.parser.DefaultModelClassFactory;
041import ca.uhn.hl7v2.model.AbstractMessage;
042import ca.uhn.hl7v2.model.Group;
043import ca.uhn.hl7v2.model.Type;
044import ca.uhn.hl7v2.model.AbstractSegment;
045import ca.uhn.hl7v2.model.Varies;
046
047/**
048 *<p>Represents an HL7 FHS message segment (File header segment). 
049 * This segment has the following fields:</p>
050 * <ul>
051     * <li>FHS-1: File Field Separator (ST) <b> </b>
052     * <li>FHS-2: File Encoding Characters (ST) <b> </b>
053     * <li>FHS-3: File Sending Application (ST) <b>optional </b>
054     * <li>FHS-4: File Sending Facility (ST) <b>optional </b>
055     * <li>FHS-5: File Receiving Application (ST) <b>optional </b>
056     * <li>FHS-6: File Receiving Facility (ST) <b>optional </b>
057     * <li>FHS-7: File Creation Date/Time (TS) <b>optional </b>
058     * <li>FHS-8: File Security (ST) <b>optional </b>
059     * <li>FHS-9: File Name/ID (ST) <b>optional </b>
060     * <li>FHS-10: File Header Comment (ST) <b>optional </b>
061     * <li>FHS-11: File Control ID (ST) <b>optional </b>
062     * <li>FHS-12: Reference File Control ID (ST) <b>optional </b>
063 * </ul>
064 */
065@SuppressWarnings("unused")
066public class FHS extends AbstractSegment {
067
068    /** 
069     * Creates a new FHS segment
070     */
071    public FHS(Group parent, ModelClassFactory factory) {
072       super(parent, factory);
073       init(factory);
074    }
075
076    private void init(ModelClassFactory factory) {
077       try {
078                                  this.add(ST.class, true, 1, 1, new Object[]{ getMessage() }, "File Field Separator");
079                                  this.add(ST.class, true, 1, 4, new Object[]{ getMessage() }, "File Encoding Characters");
080                                  this.add(ST.class, false, 1, 15, new Object[]{ getMessage() }, "File Sending Application");
081                                  this.add(ST.class, false, 1, 20, new Object[]{ getMessage() }, "File Sending Facility");
082                                  this.add(ST.class, false, 1, 15, new Object[]{ getMessage() }, "File Receiving Application");
083                                  this.add(ST.class, false, 1, 20, new Object[]{ getMessage() }, "File Receiving Facility");
084                                  this.add(TS.class, false, 1, 26, new Object[]{ getMessage() }, "File Creation Date/Time");
085                                  this.add(ST.class, false, 1, 40, new Object[]{ getMessage() }, "File Security");
086                                  this.add(ST.class, false, 1, 20, new Object[]{ getMessage() }, "File Name/ID");
087                                  this.add(ST.class, false, 1, 80, new Object[]{ getMessage() }, "File Header Comment");
088                                  this.add(ST.class, false, 1, 20, new Object[]{ getMessage() }, "File Control ID");
089                                  this.add(ST.class, false, 1, 20, new Object[]{ getMessage() }, "Reference File Control ID");
090       } catch(HL7Exception e) {
091          log.error("Unexpected error creating FHS - this is probably a bug in the source code generator.", e);
092       }
093    }
094
095
096
097    /**
098     * Returns
099     * FHS-1: "File Field Separator" - creates it if necessary
100     */
101    public ST getFileFieldSeparator() { 
102                ST retVal = this.getTypedField(1, 0);
103                return retVal;
104    }
105    
106    /**
107     * Returns
108     * FHS-1: "File Field Separator" - creates it if necessary
109     */
110    public ST getFhs1_FileFieldSeparator() { 
111                ST retVal = this.getTypedField(1, 0);
112                return retVal;
113    }
114
115
116
117    /**
118     * Returns
119     * FHS-2: "File Encoding Characters" - creates it if necessary
120     */
121    public ST getFileEncodingCharacters() { 
122                ST retVal = this.getTypedField(2, 0);
123                return retVal;
124    }
125    
126    /**
127     * Returns
128     * FHS-2: "File Encoding Characters" - creates it if necessary
129     */
130    public ST getFhs2_FileEncodingCharacters() { 
131                ST retVal = this.getTypedField(2, 0);
132                return retVal;
133    }
134
135
136
137    /**
138     * Returns
139     * FHS-3: "File Sending Application" - creates it if necessary
140     */
141    public ST getFileSendingApplication() { 
142                ST retVal = this.getTypedField(3, 0);
143                return retVal;
144    }
145    
146    /**
147     * Returns
148     * FHS-3: "File Sending Application" - creates it if necessary
149     */
150    public ST getFhs3_FileSendingApplication() { 
151                ST retVal = this.getTypedField(3, 0);
152                return retVal;
153    }
154
155
156
157    /**
158     * Returns
159     * FHS-4: "File Sending Facility" - creates it if necessary
160     */
161    public ST getFileSendingFacility() { 
162                ST retVal = this.getTypedField(4, 0);
163                return retVal;
164    }
165    
166    /**
167     * Returns
168     * FHS-4: "File Sending Facility" - creates it if necessary
169     */
170    public ST getFhs4_FileSendingFacility() { 
171                ST retVal = this.getTypedField(4, 0);
172                return retVal;
173    }
174
175
176
177    /**
178     * Returns
179     * FHS-5: "File Receiving Application" - creates it if necessary
180     */
181    public ST getFileReceivingApplication() { 
182                ST retVal = this.getTypedField(5, 0);
183                return retVal;
184    }
185    
186    /**
187     * Returns
188     * FHS-5: "File Receiving Application" - creates it if necessary
189     */
190    public ST getFhs5_FileReceivingApplication() { 
191                ST retVal = this.getTypedField(5, 0);
192                return retVal;
193    }
194
195
196
197    /**
198     * Returns
199     * FHS-6: "File Receiving Facility" - creates it if necessary
200     */
201    public ST getFileReceivingFacility() { 
202                ST retVal = this.getTypedField(6, 0);
203                return retVal;
204    }
205    
206    /**
207     * Returns
208     * FHS-6: "File Receiving Facility" - creates it if necessary
209     */
210    public ST getFhs6_FileReceivingFacility() { 
211                ST retVal = this.getTypedField(6, 0);
212                return retVal;
213    }
214
215
216
217    /**
218     * Returns
219     * FHS-7: "File Creation Date/Time" - creates it if necessary
220     */
221    public TS getFileCreationDateTime() { 
222                TS retVal = this.getTypedField(7, 0);
223                return retVal;
224    }
225    
226    /**
227     * Returns
228     * FHS-7: "File Creation Date/Time" - creates it if necessary
229     */
230    public TS getFhs7_FileCreationDateTime() { 
231                TS retVal = this.getTypedField(7, 0);
232                return retVal;
233    }
234
235
236
237    /**
238     * Returns
239     * FHS-8: "File Security" - creates it if necessary
240     */
241    public ST getFileSecurity() { 
242                ST retVal = this.getTypedField(8, 0);
243                return retVal;
244    }
245    
246    /**
247     * Returns
248     * FHS-8: "File Security" - creates it if necessary
249     */
250    public ST getFhs8_FileSecurity() { 
251                ST retVal = this.getTypedField(8, 0);
252                return retVal;
253    }
254
255
256
257    /**
258     * Returns
259     * FHS-9: "File Name/ID" - creates it if necessary
260     */
261    public ST getFileNameID() { 
262                ST retVal = this.getTypedField(9, 0);
263                return retVal;
264    }
265    
266    /**
267     * Returns
268     * FHS-9: "File Name/ID" - creates it if necessary
269     */
270    public ST getFhs9_FileNameID() { 
271                ST retVal = this.getTypedField(9, 0);
272                return retVal;
273    }
274
275
276
277    /**
278     * Returns
279     * FHS-10: "File Header Comment" - creates it if necessary
280     */
281    public ST getFileHeaderComment() { 
282                ST retVal = this.getTypedField(10, 0);
283                return retVal;
284    }
285    
286    /**
287     * Returns
288     * FHS-10: "File Header Comment" - creates it if necessary
289     */
290    public ST getFhs10_FileHeaderComment() { 
291                ST retVal = this.getTypedField(10, 0);
292                return retVal;
293    }
294
295
296
297    /**
298     * Returns
299     * FHS-11: "File Control ID" - creates it if necessary
300     */
301    public ST getFileControlID() { 
302                ST retVal = this.getTypedField(11, 0);
303                return retVal;
304    }
305    
306    /**
307     * Returns
308     * FHS-11: "File Control ID" - creates it if necessary
309     */
310    public ST getFhs11_FileControlID() { 
311                ST retVal = this.getTypedField(11, 0);
312                return retVal;
313    }
314
315
316
317    /**
318     * Returns
319     * FHS-12: "Reference File Control ID" - creates it if necessary
320     */
321    public ST getReferenceFileControlID() { 
322                ST retVal = this.getTypedField(12, 0);
323                return retVal;
324    }
325    
326    /**
327     * Returns
328     * FHS-12: "Reference File Control ID" - creates it if necessary
329     */
330    public ST getFhs12_ReferenceFileControlID() { 
331                ST retVal = this.getTypedField(12, 0);
332                return retVal;
333    }
334
335
336
337
338
339    /** {@inheritDoc} */   
340    protected Type createNewTypeWithoutReflection(int field) {
341       switch (field) {
342          case 0: return new ST(getMessage());
343          case 1: return new ST(getMessage());
344          case 2: return new ST(getMessage());
345          case 3: return new ST(getMessage());
346          case 4: return new ST(getMessage());
347          case 5: return new ST(getMessage());
348          case 6: return new TS(getMessage());
349          case 7: return new ST(getMessage());
350          case 8: return new ST(getMessage());
351          case 9: return new ST(getMessage());
352          case 10: return new ST(getMessage());
353          case 11: return new ST(getMessage());
354          default: return null;
355       }
356   }
357
358
359}
360