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/** 049 *<p>Represents an HL7 RDF message segment (Table Row Definition). 050 * This segment has the following fields:</p> 051 * <ul> 052 * <li>RDF-1: Number of Columns per Row (NM) <b> </b> 053 * <li>RDF-2: Column Description (RCD) <b> repeating</b> 054 * </ul> 055 */ 056@SuppressWarnings("unused") 057public class RDF extends AbstractSegment { 058 059 /** 060 * Creates a new RDF segment 061 */ 062 public RDF(Group parent, ModelClassFactory factory) { 063 super(parent, factory); 064 init(factory); 065 } 066 067 private void init(ModelClassFactory factory) { 068 try { 069 this.add(NM.class, true, 1, 3, new Object[]{ getMessage() }, "Number of Columns per Row"); 070 this.add(RCD.class, true, 0, 40, new Object[]{ getMessage() }, "Column Description"); 071 } catch(HL7Exception e) { 072 log.error("Unexpected error creating RDF - this is probably a bug in the source code generator.", e); 073 } 074 } 075 076 077 078 /** 079 * Returns 080 * RDF-1: "Number of Columns per Row" - creates it if necessary 081 */ 082 public NM getNumberOfColumnsPerRow() { 083 NM retVal = this.getTypedField(1, 0); 084 return retVal; 085 } 086 087 /** 088 * Returns 089 * RDF-1: "Number of Columns per Row" - creates it if necessary 090 */ 091 public NM getRdf1_NumberOfColumnsPerRow() { 092 NM retVal = this.getTypedField(1, 0); 093 return retVal; 094 } 095 096 097 /** 098 * Returns all repetitions of Column Description (RDF-2). 099 */ 100 public RCD[] getColumnDescription() { 101 RCD[] retVal = this.getTypedField(2, new RCD[0]); 102 return retVal; 103 } 104 105 106 /** 107 * Returns all repetitions of Column Description (RDF-2). 108 */ 109 public RCD[] getRdf2_ColumnDescription() { 110 RCD[] retVal = this.getTypedField(2, new RCD[0]); 111 return retVal; 112 } 113 114 115 /** 116 * Returns a count of the current number of repetitions of Column Description (RDF-2). 117 * This method does not create a repetition, so if no repetitions have currently been defined or accessed, 118 * it will return zero. 119 */ 120 public int getColumnDescriptionReps() { 121 return this.getReps(2); 122 } 123 124 125 /** 126 * Returns a specific repetition of 127 * RDF-2: "Column Description" - creates it if necessary 128 * 129 * @param rep The repetition index (0-indexed) 130 */ 131 public RCD getColumnDescription(int rep) { 132 RCD retVal = this.getTypedField(2, rep); 133 return retVal; 134 } 135 136 /** 137 * Returns a specific repetition of 138 * RDF-2: "Column Description" - creates it if necessary 139 * 140 * @param rep The repetition index (0-indexed) 141 */ 142 public RCD getRdf2_ColumnDescription(int rep) { 143 RCD retVal = this.getTypedField(2, rep); 144 return retVal; 145 } 146 147 /** 148 * Returns a count of the current number of repetitions of Column Description (RDF-2). 149 * This method does not create a repetition, so if no repetitions have currently been defined or accessed, 150 * it will return zero. 151 */ 152 public int getRdf2_ColumnDescriptionReps() { 153 return this.getReps(2); 154 } 155 156 157 /** 158 * Inserts a repetition of 159 * RDF-2: "Column Description" at a specific index 160 * 161 * @param rep The repetition index (0-indexed) 162 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 163 */ 164 public RCD insertColumnDescription(int rep) throws HL7Exception { 165 return (RCD) super.insertRepetition(2, rep); 166 } 167 168 169 /** 170 * Inserts a repetition of 171 * RDF-2: "Column Description" at a specific index 172 * 173 * @param rep The repetition index (0-indexed) 174 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 175 */ 176 public RCD insertRdf2_ColumnDescription(int rep) throws HL7Exception { 177 return (RCD) super.insertRepetition(2, rep); 178 } 179 180 181 /** 182 * Removes a repetition of 183 * RDF-2: "Column Description" at a specific index 184 * 185 * @param rep The repetition index (0-indexed) 186 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 187 */ 188 public RCD removeColumnDescription(int rep) throws HL7Exception { 189 return (RCD) super.removeRepetition(2, rep); 190 } 191 192 193 /** 194 * Removes a repetition of 195 * RDF-2: "Column Description" at a specific index 196 * 197 * @param rep The repetition index (0-indexed) 198 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 199 */ 200 public RCD removeRdf2_ColumnDescription(int rep) throws HL7Exception { 201 return (RCD) super.removeRepetition(2, rep); 202 } 203 204 205 206 207 208 209 /** {@inheritDoc} */ 210 protected Type createNewTypeWithoutReflection(int field) { 211 switch (field) { 212 case 0: return new NM(getMessage()); 213 case 1: return new RCD(getMessage()); 214 default: return null; 215 } 216 } 217 218 219} 220