Source code

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 VAR message segment (Variance). 
049 * This segment has the following fields:</p>
050 * <ul>
051     * <li>VAR-1: Variance Instance ID (EI) <b> </b>
052     * <li>VAR-2: Documented Date/Time (TS) <b> </b>
053     * <li>VAR-3: Stated Variance Date/Time (TS) <b>optional </b>
054     * <li>VAR-4: Variance Originator (XCN) <b>optional </b>
055     * <li>VAR-5: Variance Classification (CE) <b>optional </b>
056     * <li>VAR-6: Variance Description (ST) <b>optional repeating</b>
057 * </ul>
058 */
059@SuppressWarnings("unused")
060public class VAR extends AbstractSegment {
061
062    /** 
063     * Creates a new VAR segment
064     */
065    public VAR(Group parent, ModelClassFactory factory) {
066       super(parent, factory);
067       init(factory);
068    }
069
070    private void init(ModelClassFactory factory) {
071       try {
072                                  this.add(EI.class, true, 1, 60, new Object[]{ getMessage() }, "Variance Instance ID");
073                                  this.add(TS.class, true, 1, 26, new Object[]{ getMessage() }, "Documented Date/Time");
074                                  this.add(TS.class, false, 1, 26, new Object[]{ getMessage() }, "Stated Variance Date/Time");
075                                  this.add(XCN.class, false, 1, 860, new Object[]{ getMessage() }, "Variance Originator");
076                                  this.add(CE.class, false, 1, 60, new Object[]{ getMessage() }, "Variance Classification");
077                                  this.add(ST.class, false, 0, 512, new Object[]{ getMessage() }, "Variance Description");
078       } catch(HL7Exception e) {
079          log.error("Unexpected error creating VAR - this is probably a bug in the source code generator.", e);
080       }
081    }
082
083
084
085    /**
086     * Returns
087     * VAR-1: "Variance Instance ID" - creates it if necessary
088     */
089    public EI getVarianceInstanceID() { 
090                EI retVal = this.getTypedField(1, 0);
091                return retVal;
092    }
093    
094    /**
095     * Returns
096     * VAR-1: "Variance Instance ID" - creates it if necessary
097     */
098    public EI getVar1_VarianceInstanceID() { 
099                EI retVal = this.getTypedField(1, 0);
100                return retVal;
101    }
102
103
104
105    /**
106     * Returns
107     * VAR-2: "Documented Date/Time" - creates it if necessary
108     */
109    public TS getDocumentedDateTime() { 
110                TS retVal = this.getTypedField(2, 0);
111                return retVal;
112    }
113    
114    /**
115     * Returns
116     * VAR-2: "Documented Date/Time" - creates it if necessary
117     */
118    public TS getVar2_DocumentedDateTime() { 
119                TS retVal = this.getTypedField(2, 0);
120                return retVal;
121    }
122
123
124
125    /**
126     * Returns
127     * VAR-3: "Stated Variance Date/Time" - creates it if necessary
128     */
129    public TS getStatedVarianceDateTime() { 
130                TS retVal = this.getTypedField(3, 0);
131                return retVal;
132    }
133    
134    /**
135     * Returns
136     * VAR-3: "Stated Variance Date/Time" - creates it if necessary
137     */
138    public TS getVar3_StatedVarianceDateTime() { 
139                TS retVal = this.getTypedField(3, 0);
140                return retVal;
141    }
142
143
144
145    /**
146     * Returns
147     * VAR-4: "Variance Originator" - creates it if necessary
148     */
149    public XCN getVarianceOriginator() { 
150                XCN retVal = this.getTypedField(4, 0);
151                return retVal;
152    }
153    
154    /**
155     * Returns
156     * VAR-4: "Variance Originator" - creates it if necessary
157     */
158    public XCN getVar4_VarianceOriginator() { 
159                XCN retVal = this.getTypedField(4, 0);
160                return retVal;
161    }
162
163
164
165    /**
166     * Returns
167     * VAR-5: "Variance Classification" - creates it if necessary
168     */
169    public CE getVarianceClassification() { 
170                CE retVal = this.getTypedField(5, 0);
171                return retVal;
172    }
173    
174    /**
175     * Returns
176     * VAR-5: "Variance Classification" - creates it if necessary
177     */
178    public CE getVar5_VarianceClassification() { 
179                CE retVal = this.getTypedField(5, 0);
180                return retVal;
181    }
182
183
184    /**
185     * Returns all repetitions of Variance Description (VAR-6).
186     */
187    public ST[] getVarianceDescription() {
188        ST[] retVal = this.getTypedField(6, new ST[0]);
189        return retVal;
190    }
191
192
193    /**
194     * Returns all repetitions of Variance Description (VAR-6).
195     */
196    public ST[] getVar6_VarianceDescription() {
197        ST[] retVal = this.getTypedField(6, new ST[0]);
198        return retVal;
199    }
200
201
202    /**
203     * Returns a count of the current number of repetitions of Variance Description (VAR-6).
204     * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
205     * it will return zero.
206     */
207    public int getVarianceDescriptionReps() {
208        return this.getReps(6);
209    }
210
211
212    /**
213     * Returns a specific repetition of
214     * VAR-6: "Variance Description" - creates it if necessary
215     *
216     * @param rep The repetition index (0-indexed)
217     */
218    public ST getVarianceDescription(int rep) { 
219                ST retVal = this.getTypedField(6, rep);
220                return retVal;
221    }
222
223    /**
224     * Returns a specific repetition of
225     * VAR-6: "Variance Description" - creates it if necessary
226     *
227     * @param rep The repetition index (0-indexed)
228     */
229    public ST getVar6_VarianceDescription(int rep) { 
230                ST retVal = this.getTypedField(6, rep);
231                return retVal;
232    }
233
234    /**
235     * Returns a count of the current number of repetitions of Variance Description (VAR-6).
236     * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
237     * it will return zero.
238     */
239    public int getVar6_VarianceDescriptionReps() {
240        return this.getReps(6);
241    }
242
243
244    /**
245     * Inserts a repetition of
246     * VAR-6: "Variance Description" at a specific index
247     *
248     * @param rep The repetition index (0-indexed)
249     * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
250     */
251    public ST insertVarianceDescription(int rep) throws HL7Exception { 
252        return (ST) super.insertRepetition(6, rep);
253    }
254
255
256    /**
257     * Inserts a repetition of
258     * VAR-6: "Variance Description" at a specific index
259     *
260     * @param rep The repetition index (0-indexed)
261     * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
262     */
263    public ST insertVar6_VarianceDescription(int rep) throws HL7Exception { 
264        return (ST) super.insertRepetition(6, rep);
265    }
266
267
268    /**
269     * Removes a repetition of
270     * VAR-6: "Variance Description" at a specific index
271     *
272     * @param rep The repetition index (0-indexed)
273     * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
274     */
275    public ST removeVarianceDescription(int rep) throws HL7Exception { 
276        return (ST) super.removeRepetition(6, rep);
277    }
278
279
280    /**
281     * Removes a repetition of
282     * VAR-6: "Variance Description" at a specific index
283     *
284     * @param rep The repetition index (0-indexed)
285     * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
286     */
287    public ST removeVar6_VarianceDescription(int rep) throws HL7Exception { 
288        return (ST) super.removeRepetition(6, rep);
289    }
290
291
292
293
294
295
296    /** {@inheritDoc} */   
297    protected Type createNewTypeWithoutReflection(int field) {
298       switch (field) {
299          case 0: return new EI(getMessage());
300          case 1: return new TS(getMessage());
301          case 2: return new TS(getMessage());
302          case 3: return new XCN(getMessage());
303          case 4: return new CE(getMessage());
304          case 5: return new ST(getMessage());
305          default: return null;
306       }
307   }
308
309
310}
311