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
008 package ca.uhn.hl7v2.model.v24.segment;
009
010 // import ca.uhn.hl7v2.model.v24.group.*;
011 import ca.uhn.hl7v2.model.v24.datatype.*;
012 import ca.uhn.log.HapiLogFactory;
013 import ca.uhn.hl7v2.HL7Exception;
014 import ca.uhn.hl7v2.parser.ModelClassFactory;
015 import ca.uhn.hl7v2.parser.DefaultModelClassFactory;
016 import ca.uhn.hl7v2.model.AbstractMessage;
017 import ca.uhn.hl7v2.model.Group;
018 import ca.uhn.hl7v2.model.Type;
019 import ca.uhn.hl7v2.model.AbstractSegment;
020 import ca.uhn.hl7v2.model.Varies;
021
022 /**
023 *<p>Represents an HL7 SPR message segment (Stored Procedure Request Definition).
024 * This segment has the following fields:</p>
025 * <ul>
026 * <li>SPR-1: Query Tag (ST) <b>optional </b>
027 * <li>SPR-2: Query/Response Format Code (ID) <b> </b>
028 * <li>SPR-3: Stored Procedure Name (CE) <b> </b>
029 * <li>SPR-4: Input Parameter List (QIP) <b>optional repeating</b>
030 * </ul>
031 */
032 public class SPR extends AbstractSegment {
033
034 /**
035 * Creates a new SPR segment
036 */
037 public SPR(Group parent, ModelClassFactory factory) {
038 super(parent, factory);
039 init(factory);
040 }
041
042 private void init(ModelClassFactory factory) {
043 try {
044 this.add(ST.class, false, 1, 32, new Object[]{ getMessage(), new Integer(0) }, "Query Tag");
045 this.add(ID.class, true, 1, 1, new Object[]{ getMessage() }, "Query/Response Format Code");
046 this.add(CE.class, true, 1, 250, new Object[]{ getMessage(), new Integer(0) }, "Stored Procedure Name");
047 this.add(QIP.class, false, 0, 256, new Object[]{ getMessage(), new Integer(0) }, "Input Parameter List");
048 } catch(HL7Exception e) {
049 HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected error creating SPR - this is probably a bug in the source code generator.", e);
050 }
051 }
052
053
054
055 /**
056 * Returns
057 * SPR-1: "Query Tag" - creates it if necessary
058 */
059 public ST getQueryTag() {
060 ST ret = null;
061 try {
062 Type t = this.getField(1, 0);
063 ret = (ST)t;
064 } catch (ClassCastException cce) {
065 HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce);
066 throw new RuntimeException(cce);
067 } catch (HL7Exception he) {
068 HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", he);
069 throw new RuntimeException(he);
070 }
071 return ret;
072 }
073
074
075 /**
076 * Returns
077 * SPR-1: "Query Tag" - creates it if necessary
078 */
079 public ST getSpr1_QueryTag() {
080 ST ret = null;
081 try {
082 Type t = this.getField(1, 0);
083 ret = (ST)t;
084 } catch (ClassCastException cce) {
085 HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce);
086 throw new RuntimeException(cce);
087 } catch (HL7Exception he) {
088 HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", he);
089 throw new RuntimeException(he);
090 }
091 return ret;
092 }
093
094
095
096 /**
097 * Returns
098 * SPR-2: "Query/Response Format Code" - creates it if necessary
099 */
100 public ID getQueryResponseFormatCode() {
101 ID ret = null;
102 try {
103 Type t = this.getField(2, 0);
104 ret = (ID)t;
105 } catch (ClassCastException cce) {
106 HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce);
107 throw new RuntimeException(cce);
108 } catch (HL7Exception he) {
109 HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", he);
110 throw new RuntimeException(he);
111 }
112 return ret;
113 }
114
115
116 /**
117 * Returns
118 * SPR-2: "Query/Response Format Code" - creates it if necessary
119 */
120 public ID getSpr2_QueryResponseFormatCode() {
121 ID ret = null;
122 try {
123 Type t = this.getField(2, 0);
124 ret = (ID)t;
125 } catch (ClassCastException cce) {
126 HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce);
127 throw new RuntimeException(cce);
128 } catch (HL7Exception he) {
129 HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", he);
130 throw new RuntimeException(he);
131 }
132 return ret;
133 }
134
135
136
137 /**
138 * Returns
139 * SPR-3: "Stored Procedure Name" - creates it if necessary
140 */
141 public CE getStoredProcedureName() {
142 CE ret = null;
143 try {
144 Type t = this.getField(3, 0);
145 ret = (CE)t;
146 } catch (ClassCastException cce) {
147 HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce);
148 throw new RuntimeException(cce);
149 } catch (HL7Exception he) {
150 HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", he);
151 throw new RuntimeException(he);
152 }
153 return ret;
154 }
155
156
157 /**
158 * Returns
159 * SPR-3: "Stored Procedure Name" - creates it if necessary
160 */
161 public CE getSpr3_StoredProcedureName() {
162 CE ret = null;
163 try {
164 Type t = this.getField(3, 0);
165 ret = (CE)t;
166 } catch (ClassCastException cce) {
167 HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce);
168 throw new RuntimeException(cce);
169 } catch (HL7Exception he) {
170 HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", he);
171 throw new RuntimeException(he);
172 }
173 return ret;
174 }
175
176
177 /**
178 * Returns all repetitions of Input Parameter List (SPR-4).
179 */
180 public QIP[] getInputParameterList() {
181 QIP[] ret = null;
182 try {
183 Type[] t = this.getField(4);
184 ret = new QIP[t.length];
185 for (int i = 0; i < ret.length; i++) {
186 ret[i] = (QIP)t[i];
187 }
188 } catch (ClassCastException cce) {
189 HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce);
190 throw new RuntimeException(cce);
191 } catch (HL7Exception he) {
192 HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", he);
193 throw new RuntimeException(he);
194 }
195 return ret;
196 }
197
198
199 /**
200 * Returns a count of the current number of repetitions of Input Parameter List (SPR-4).
201 * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
202 * it will return zero.
203 */
204 public int getInputParameterListReps() {
205 QIP[] ret = null;
206 try {
207 Type[] t = this.getField(4);
208 return t.length;
209 } catch (ClassCastException cce) {
210 HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce);
211 throw new RuntimeException(cce);
212 } catch (HL7Exception he) {
213 HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", he);
214 throw new RuntimeException(he);
215 }
216 }
217
218
219 /**
220 * Returns a specific repetition of
221 * SPR-4: "Input Parameter List" - creates it if necessary
222 *
223 * @param rep The repetition index (0-indexed)
224 */
225 public QIP getInputParameterList(int rep) {
226 QIP ret = null;
227 try {
228 Type t = this.getField(4, rep);
229 ret = (QIP)t;
230 } catch (ClassCastException cce) {
231 HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce);
232 throw new RuntimeException(cce);
233 } catch (HL7Exception he) {
234 HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", he);
235 throw new RuntimeException(he);
236 }
237 return ret;
238 }
239
240 /**
241 * Returns a specific repetition of
242 * SPR-4: "Input Parameter List" - creates it if necessary
243 *
244 * @param rep The repetition index (0-indexed)
245 */
246 public QIP getSpr4_InputParameterList(int rep) {
247 QIP ret = null;
248 try {
249 Type t = this.getField(4, rep);
250 ret = (QIP)t;
251 } catch (ClassCastException cce) {
252 HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce);
253 throw new RuntimeException(cce);
254 } catch (HL7Exception he) {
255 HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", he);
256 throw new RuntimeException(he);
257 }
258 return ret;
259 }
260
261
262 /**
263 * Returns a count of the current number of repetitions of Input Parameter List (SPR-4).
264 * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
265 * it will return zero.
266 */
267 public int getSpr4_InputParameterListReps() {
268 QIP[] ret = null;
269 try {
270 Type[] t = this.getField(4);
271 return t.length;
272 } catch (ClassCastException cce) {
273 HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", cce);
274 throw new RuntimeException(cce);
275 } catch (HL7Exception he) {
276 HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected problem obtaining field value. This is a bug.", he);
277 throw new RuntimeException(he);
278 }
279 }
280
281
282
283 /**
284 * Inserts a repetition of
285 * SPR-4: "Input Parameter List" at a specific index
286 *
287 * @param rep The repetition index (0-indexed)
288 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
289 */
290 public QIP insertInputParameterList(int rep) throws HL7Exception {
291 return (QIP) super.insertRepetition(4, rep);
292 }
293
294
295
296 /**
297 * Inserts a repetition of
298 * SPR-4: "Input Parameter List" at a specific index
299 *
300 * @param rep The repetition index (0-indexed)
301 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
302 */
303 public QIP insertSpr4_InputParameterList(int rep) throws HL7Exception {
304 return (QIP) super.insertRepetition(4, rep);
305 }
306
307
308 /**
309 * Removes a repetition of
310 * SPR-4: "Input Parameter List" at a specific index
311 *
312 * @param rep The repetition index (0-indexed)
313 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
314 */
315 public QIP removeInputParameterList(int rep) throws HL7Exception {
316 return (QIP) super.removeRepetition(4, rep);
317 }
318
319
320 /**
321 * Removes a repetition of
322 * SPR-4: "Input Parameter List" at a specific index
323 *
324 * @param rep The repetition index (0-indexed)
325 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
326 */
327 public QIP removeSpr4_InputParameterList(int rep) throws HL7Exception {
328 return (QIP) super.removeRepetition(4, rep);
329 }
330
331
332
333
334
335
336 /** {@inheritDoc} */
337 protected Type createNewTypeWithoutReflection(int field) {
338 switch (field) {
339 case 0: return new ST(getMessage());
340 case 1: return new ID(getMessage(), new Integer( 106 ));
341 case 2: return new CE(getMessage());
342 case 3: return new QIP(getMessage());
343 default: return null;
344 }
345 }
346
347
348 }
349