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.v23.segment;
35  
36  // import ca.uhn.hl7v2.model.v23.group.*;
37  import ca.uhn.hl7v2.model.v23.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 VAR message segment (Variance). 
50   * This segment has the following fields:</p>
51   * <ul>
52       * <li>VAR-1: Variance Instance ID (EI) <b> </b>
53       * <li>VAR-2: Documented Date/Time (TS) <b> </b>
54       * <li>VAR-3: Stated Variance Date/Time (TS) <b>optional </b>
55       * <li>VAR-4: Variance Originator (XCN) <b>optional </b>
56       * <li>VAR-5: Variance Classification (CE) <b>optional </b>
57       * <li>VAR-6: Variance Description (ST) <b>optional repeating</b>
58   * </ul>
59   */
60  @SuppressWarnings("unused")
61  public class VAR extends AbstractSegment {
62  
63      /** 
64       * Creates a new VAR segment
65       */
66      public VAR(Group parent, ModelClassFactory factory) {
67         super(parent, factory);
68         init(factory);
69      }
70  
71      private void init(ModelClassFactory factory) {
72         try {
73                                    this.add(EI.class, true, 1, 60, new Object[]{ getMessage() }, "Variance Instance ID");
74                                    this.add(TS.class, true, 1, 26, new Object[]{ getMessage() }, "Documented Date/Time");
75                                    this.add(TS.class, false, 1, 26, new Object[]{ getMessage() }, "Stated Variance Date/Time");
76                                    this.add(XCN.class, false, 1, 860, new Object[]{ getMessage() }, "Variance Originator");
77                                    this.add(CE.class, false, 1, 60, new Object[]{ getMessage() }, "Variance Classification");
78                                    this.add(ST.class, false, 0, 512, new Object[]{ getMessage() }, "Variance Description");
79         } catch(HL7Exception e) {
80            log.error("Unexpected error creating VAR - this is probably a bug in the source code generator.", e);
81         }
82      }
83  
84  
85  
86      /**
87       * Returns
88       * VAR-1: "Variance Instance ID" - creates it if necessary
89       */
90      public EI getVarianceInstanceID() { 
91  		EI retVal = this.getTypedField(1, 0);
92  		return retVal;
93      }
94      
95      /**
96       * Returns
97       * VAR-1: "Variance Instance ID" - creates it if necessary
98       */
99      public EI getVar1_VarianceInstanceID() { 
100 		EI retVal = this.getTypedField(1, 0);
101 		return retVal;
102     }
103 
104 
105 
106     /**
107      * Returns
108      * VAR-2: "Documented Date/Time" - creates it if necessary
109      */
110     public TS getDocumentedDateTime() { 
111 		TS retVal = this.getTypedField(2, 0);
112 		return retVal;
113     }
114     
115     /**
116      * Returns
117      * VAR-2: "Documented Date/Time" - creates it if necessary
118      */
119     public TS getVar2_DocumentedDateTime() { 
120 		TS retVal = this.getTypedField(2, 0);
121 		return retVal;
122     }
123 
124 
125 
126     /**
127      * Returns
128      * VAR-3: "Stated Variance Date/Time" - creates it if necessary
129      */
130     public TS getStatedVarianceDateTime() { 
131 		TS retVal = this.getTypedField(3, 0);
132 		return retVal;
133     }
134     
135     /**
136      * Returns
137      * VAR-3: "Stated Variance Date/Time" - creates it if necessary
138      */
139     public TS getVar3_StatedVarianceDateTime() { 
140 		TS retVal = this.getTypedField(3, 0);
141 		return retVal;
142     }
143 
144 
145 
146     /**
147      * Returns
148      * VAR-4: "Variance Originator" - creates it if necessary
149      */
150     public XCN getVarianceOriginator() { 
151 		XCN retVal = this.getTypedField(4, 0);
152 		return retVal;
153     }
154     
155     /**
156      * Returns
157      * VAR-4: "Variance Originator" - creates it if necessary
158      */
159     public XCN getVar4_VarianceOriginator() { 
160 		XCN retVal = this.getTypedField(4, 0);
161 		return retVal;
162     }
163 
164 
165 
166     /**
167      * Returns
168      * VAR-5: "Variance Classification" - creates it if necessary
169      */
170     public CE getVarianceClassification() { 
171 		CE retVal = this.getTypedField(5, 0);
172 		return retVal;
173     }
174     
175     /**
176      * Returns
177      * VAR-5: "Variance Classification" - creates it if necessary
178      */
179     public CE getVar5_VarianceClassification() { 
180 		CE retVal = this.getTypedField(5, 0);
181 		return retVal;
182     }
183 
184 
185     /**
186      * Returns all repetitions of Variance Description (VAR-6).
187      */
188     public ST[] getVarianceDescription() {
189     	ST[] retVal = this.getTypedField(6, new ST[0]);
190     	return retVal;
191     }
192 
193 
194     /**
195      * Returns all repetitions of Variance Description (VAR-6).
196      */
197     public ST[] getVar6_VarianceDescription() {
198     	ST[] retVal = this.getTypedField(6, new ST[0]);
199     	return retVal;
200     }
201 
202 
203     /**
204      * Returns a count of the current number of repetitions of Variance Description (VAR-6).
205      * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
206      * it will return zero.
207      */
208     public int getVarianceDescriptionReps() {
209     	return this.getReps(6);
210     }
211 
212 
213     /**
214      * Returns a specific repetition of
215      * VAR-6: "Variance Description" - creates it if necessary
216      *
217      * @param rep The repetition index (0-indexed)
218      */
219     public ST getVarianceDescription(int rep) { 
220 		ST retVal = this.getTypedField(6, rep);
221 		return retVal;
222     }
223 
224     /**
225      * Returns a specific repetition of
226      * VAR-6: "Variance Description" - creates it if necessary
227      *
228      * @param rep The repetition index (0-indexed)
229      */
230     public ST getVar6_VarianceDescription(int rep) { 
231 		ST retVal = this.getTypedField(6, rep);
232 		return retVal;
233     }
234 
235     /**
236      * Returns a count of the current number of repetitions of Variance Description (VAR-6).
237      * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
238      * it will return zero.
239      */
240     public int getVar6_VarianceDescriptionReps() {
241     	return this.getReps(6);
242     }
243 
244 
245     /**
246      * Inserts a repetition of
247      * VAR-6: "Variance Description" at a specific index
248      *
249      * @param rep The repetition index (0-indexed)
250      * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
251      */
252     public ST insertVarianceDescription(int rep) throws HL7Exception { 
253         return (ST) super.insertRepetition(6, rep);
254     }
255 
256 
257     /**
258      * Inserts a repetition of
259      * VAR-6: "Variance Description" at a specific index
260      *
261      * @param rep The repetition index (0-indexed)
262      * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
263      */
264     public ST insertVar6_VarianceDescription(int rep) throws HL7Exception { 
265         return (ST) super.insertRepetition(6, rep);
266     }
267 
268 
269     /**
270      * Removes a repetition of
271      * VAR-6: "Variance Description" at a specific index
272      *
273      * @param rep The repetition index (0-indexed)
274      * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
275      */
276     public ST removeVarianceDescription(int rep) throws HL7Exception { 
277         return (ST) super.removeRepetition(6, rep);
278     }
279 
280 
281     /**
282      * Removes a repetition of
283      * VAR-6: "Variance Description" at a specific index
284      *
285      * @param rep The repetition index (0-indexed)
286      * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
287      */
288     public ST removeVar6_VarianceDescription(int rep) throws HL7Exception { 
289         return (ST) super.removeRepetition(6, rep);
290     }
291 
292 
293 
294 
295 
296 
297     /** {@inheritDoc} */   
298     protected Type createNewTypeWithoutReflection(int field) {
299        switch (field) {
300           case 0: return new EI(getMessage());
301           case 1: return new TS(getMessage());
302           case 2: return new TS(getMessage());
303           case 3: return new XCN(getMessage());
304           case 4: return new CE(getMessage());
305           case 5: return new ST(getMessage());
306           default: return null;
307        }
308    }
309 
310 
311 }
312