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.v25.segment; 35 36 // import ca.uhn.hl7v2.model.v25.group.*; 37 import ca.uhn.hl7v2.model.v25.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 repeating</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, 0, 250, new Object[]{ getMessage() }, "Variance Originator"); 77 this.add(CE.class, false, 1, 250, 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 * Returns all repetitions of Variance Originator (VAR-4). 147 */ 148 public XCN[] getVarianceOriginator() { 149 XCN[] retVal = this.getTypedField(4, new XCN[0]); 150 return retVal; 151 } 152 153 154 /** 155 * Returns all repetitions of Variance Originator (VAR-4). 156 */ 157 public XCN[] getVar4_VarianceOriginator() { 158 XCN[] retVal = this.getTypedField(4, new XCN[0]); 159 return retVal; 160 } 161 162 163 /** 164 * Returns a count of the current number of repetitions of Variance Originator (VAR-4). 165 * This method does not create a repetition, so if no repetitions have currently been defined or accessed, 166 * it will return zero. 167 */ 168 public int getVarianceOriginatorReps() { 169 return this.getReps(4); 170 } 171 172 173 /** 174 * Returns a specific repetition of 175 * VAR-4: "Variance Originator" - creates it if necessary 176 * 177 * @param rep The repetition index (0-indexed) 178 */ 179 public XCN getVarianceOriginator(int rep) { 180 XCN retVal = this.getTypedField(4, rep); 181 return retVal; 182 } 183 184 /** 185 * Returns a specific repetition of 186 * VAR-4: "Variance Originator" - creates it if necessary 187 * 188 * @param rep The repetition index (0-indexed) 189 */ 190 public XCN getVar4_VarianceOriginator(int rep) { 191 XCN retVal = this.getTypedField(4, rep); 192 return retVal; 193 } 194 195 /** 196 * Returns a count of the current number of repetitions of Variance Originator (VAR-4). 197 * This method does not create a repetition, so if no repetitions have currently been defined or accessed, 198 * it will return zero. 199 */ 200 public int getVar4_VarianceOriginatorReps() { 201 return this.getReps(4); 202 } 203 204 205 /** 206 * Inserts a repetition of 207 * VAR-4: "Variance Originator" at a specific index 208 * 209 * @param rep The repetition index (0-indexed) 210 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 211 */ 212 public XCN insertVarianceOriginator(int rep) throws HL7Exception { 213 return (XCN) super.insertRepetition(4, rep); 214 } 215 216 217 /** 218 * Inserts a repetition of 219 * VAR-4: "Variance Originator" at a specific index 220 * 221 * @param rep The repetition index (0-indexed) 222 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 223 */ 224 public XCN insertVar4_VarianceOriginator(int rep) throws HL7Exception { 225 return (XCN) super.insertRepetition(4, rep); 226 } 227 228 229 /** 230 * Removes a repetition of 231 * VAR-4: "Variance Originator" at a specific index 232 * 233 * @param rep The repetition index (0-indexed) 234 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 235 */ 236 public XCN removeVarianceOriginator(int rep) throws HL7Exception { 237 return (XCN) super.removeRepetition(4, rep); 238 } 239 240 241 /** 242 * Removes a repetition of 243 * VAR-4: "Variance Originator" at a specific index 244 * 245 * @param rep The repetition index (0-indexed) 246 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 247 */ 248 public XCN removeVar4_VarianceOriginator(int rep) throws HL7Exception { 249 return (XCN) super.removeRepetition(4, rep); 250 } 251 252 253 254 255 /** 256 * Returns 257 * VAR-5: "Variance Classification" - creates it if necessary 258 */ 259 public CE getVarianceClassification() { 260 CE retVal = this.getTypedField(5, 0); 261 return retVal; 262 } 263 264 /** 265 * Returns 266 * VAR-5: "Variance Classification" - creates it if necessary 267 */ 268 public CE getVar5_VarianceClassification() { 269 CE retVal = this.getTypedField(5, 0); 270 return retVal; 271 } 272 273 274 /** 275 * Returns all repetitions of Variance Description (VAR-6). 276 */ 277 public ST[] getVarianceDescription() { 278 ST[] retVal = this.getTypedField(6, new ST[0]); 279 return retVal; 280 } 281 282 283 /** 284 * Returns all repetitions of Variance Description (VAR-6). 285 */ 286 public ST[] getVar6_VarianceDescription() { 287 ST[] retVal = this.getTypedField(6, new ST[0]); 288 return retVal; 289 } 290 291 292 /** 293 * Returns a count of the current number of repetitions of Variance Description (VAR-6). 294 * This method does not create a repetition, so if no repetitions have currently been defined or accessed, 295 * it will return zero. 296 */ 297 public int getVarianceDescriptionReps() { 298 return this.getReps(6); 299 } 300 301 302 /** 303 * Returns a specific repetition of 304 * VAR-6: "Variance Description" - creates it if necessary 305 * 306 * @param rep The repetition index (0-indexed) 307 */ 308 public ST getVarianceDescription(int rep) { 309 ST retVal = this.getTypedField(6, rep); 310 return retVal; 311 } 312 313 /** 314 * Returns a specific repetition of 315 * VAR-6: "Variance Description" - creates it if necessary 316 * 317 * @param rep The repetition index (0-indexed) 318 */ 319 public ST getVar6_VarianceDescription(int rep) { 320 ST retVal = this.getTypedField(6, rep); 321 return retVal; 322 } 323 324 /** 325 * Returns a count of the current number of repetitions of Variance Description (VAR-6). 326 * This method does not create a repetition, so if no repetitions have currently been defined or accessed, 327 * it will return zero. 328 */ 329 public int getVar6_VarianceDescriptionReps() { 330 return this.getReps(6); 331 } 332 333 334 /** 335 * Inserts a repetition of 336 * VAR-6: "Variance Description" at a specific index 337 * 338 * @param rep The repetition index (0-indexed) 339 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 340 */ 341 public ST insertVarianceDescription(int rep) throws HL7Exception { 342 return (ST) super.insertRepetition(6, rep); 343 } 344 345 346 /** 347 * Inserts a repetition of 348 * VAR-6: "Variance Description" at a specific index 349 * 350 * @param rep The repetition index (0-indexed) 351 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 352 */ 353 public ST insertVar6_VarianceDescription(int rep) throws HL7Exception { 354 return (ST) super.insertRepetition(6, rep); 355 } 356 357 358 /** 359 * Removes a repetition of 360 * VAR-6: "Variance Description" at a specific index 361 * 362 * @param rep The repetition index (0-indexed) 363 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 364 */ 365 public ST removeVarianceDescription(int rep) throws HL7Exception { 366 return (ST) super.removeRepetition(6, rep); 367 } 368 369 370 /** 371 * Removes a repetition of 372 * VAR-6: "Variance Description" at a specific index 373 * 374 * @param rep The repetition index (0-indexed) 375 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 376 */ 377 public ST removeVar6_VarianceDescription(int rep) throws HL7Exception { 378 return (ST) super.removeRepetition(6, rep); 379 } 380 381 382 383 384 385 386 /** {@inheritDoc} */ 387 protected Type createNewTypeWithoutReflection(int field) { 388 switch (field) { 389 case 0: return new EI(getMessage()); 390 case 1: return new TS(getMessage()); 391 case 2: return new TS(getMessage()); 392 case 3: return new XCN(getMessage()); 393 case 4: return new CE(getMessage()); 394 case 5: return new ST(getMessage()); 395 default: return null; 396 } 397 } 398 399 400 } 401