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 "RPT.java".  Description:
15   * "Composite class RPT"
16   * 
17   * The Initial Developer of the Original Code is University Health Network. Copyright (C) 
18   * 2013.  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  package ca.uhn.hl7v2.model.v27.datatype;
34  
35  import ca.uhn.hl7v2.model.DataTypeException;
36  import ca.uhn.hl7v2.model.Message;
37  import ca.uhn.hl7v2.model.Type;
38  import ca.uhn.hl7v2.model.AbstractComposite;
39  
40  
41  /**
42   * <p>Represents an HL7 RPT (Repeat Pattern) data type. 
43   * This type consists of the following components:</p>
44   * <ul>
45   * <li>Repeat Pattern Code (CWE)
46   * <li>Calendar Alignment (ID)
47   * <li>Phase Range Begin Value (NM)
48   * <li>Phase Range End Value (NM)
49   * <li>Period Quantity (NM)
50   * <li>Period Units (CWE)
51   * <li>Institution Specified Time (ID)
52   * <li>Event (ID)
53   * <li>Event Offset Quantity (NM)
54   * <li>Event Offset Units (CWE)
55   * <li>General Timing Specification (GTS)
56   * </ul>
57   */
58  @SuppressWarnings("unused")
59  public class RPT extends AbstractComposite {
60  
61      private Type[] data;
62  
63      /** 
64       * Creates a new RPT type
65       */
66      public RPT(Message message) {
67          super(message);
68          init();
69      }
70  
71      private void init() {
72          data = new Type[11];    
73          data[0] = new CWE(getMessage());
74          data[1] = new ID(getMessage(), 527);
75          data[2] = new NM(getMessage());
76          data[3] = new NM(getMessage());
77          data[4] = new NM(getMessage());
78          data[5] = new CWE(getMessage());
79          data[6] = new ID(getMessage(), 136);
80          data[7] = new ID(getMessage(), 528);
81          data[8] = new NM(getMessage());
82          data[9] = new CWE(getMessage());
83          data[10] = new GTS(getMessage());
84      }
85  
86  
87      /**
88       * Returns an array containing the data elements.
89       */
90      public Type[] getComponents() { 
91          return this.data; 
92      }
93  
94      /**
95       * Returns an individual data component.
96       *
97       * @param number The component number (0-indexed)
98       * @throws DataTypeException if the given element number is out of range.
99       */
100     public Type getComponent(int number) throws DataTypeException { 
101 
102         try { 
103             return this.data[number]; 
104         } catch (ArrayIndexOutOfBoundsException e) { 
105             throw new DataTypeException("Element " + number + " doesn't exist (Type " + getClass().getName() + " has only " + this.data.length + " components)"); 
106         } 
107     } 
108 
109 
110     /**
111      * Returns Repeat Pattern Code (component 1).  This is a convenience method that saves you from 
112      * casting and handling an exception.
113      */
114     public CWE getRepeatPatternCode() {
115        return getTyped(0, CWE.class);
116     }
117 
118     
119     /**
120      * Returns Repeat Pattern Code (component 1).  This is a convenience method that saves you from 
121      * casting and handling an exception.
122      */
123     public CWE getRpt1_RepeatPatternCode() {
124        return getTyped(0, CWE.class);
125     }
126 
127 
128     /**
129      * Returns Calendar Alignment (component 2).  This is a convenience method that saves you from 
130      * casting and handling an exception.
131      */
132     public ID getCalendarAlignment() {
133        return getTyped(1, ID.class);
134     }
135 
136     
137     /**
138      * Returns Calendar Alignment (component 2).  This is a convenience method that saves you from 
139      * casting and handling an exception.
140      */
141     public ID getRpt2_CalendarAlignment() {
142        return getTyped(1, ID.class);
143     }
144 
145 
146     /**
147      * Returns Phase Range Begin Value (component 3).  This is a convenience method that saves you from 
148      * casting and handling an exception.
149      */
150     public NM getPhaseRangeBeginValue() {
151        return getTyped(2, NM.class);
152     }
153 
154     
155     /**
156      * Returns Phase Range Begin Value (component 3).  This is a convenience method that saves you from 
157      * casting and handling an exception.
158      */
159     public NM getRpt3_PhaseRangeBeginValue() {
160        return getTyped(2, NM.class);
161     }
162 
163 
164     /**
165      * Returns Phase Range End Value (component 4).  This is a convenience method that saves you from 
166      * casting and handling an exception.
167      */
168     public NM getPhaseRangeEndValue() {
169        return getTyped(3, NM.class);
170     }
171 
172     
173     /**
174      * Returns Phase Range End Value (component 4).  This is a convenience method that saves you from 
175      * casting and handling an exception.
176      */
177     public NM getRpt4_PhaseRangeEndValue() {
178        return getTyped(3, NM.class);
179     }
180 
181 
182     /**
183      * Returns Period Quantity (component 5).  This is a convenience method that saves you from 
184      * casting and handling an exception.
185      */
186     public NM getPeriodQuantity() {
187        return getTyped(4, NM.class);
188     }
189 
190     
191     /**
192      * Returns Period Quantity (component 5).  This is a convenience method that saves you from 
193      * casting and handling an exception.
194      */
195     public NM getRpt5_PeriodQuantity() {
196        return getTyped(4, NM.class);
197     }
198 
199 
200     /**
201      * Returns Period Units (component 6).  This is a convenience method that saves you from 
202      * casting and handling an exception.
203      */
204     public CWE getPeriodUnits() {
205        return getTyped(5, CWE.class);
206     }
207 
208     
209     /**
210      * Returns Period Units (component 6).  This is a convenience method that saves you from 
211      * casting and handling an exception.
212      */
213     public CWE getRpt6_PeriodUnits() {
214        return getTyped(5, CWE.class);
215     }
216 
217 
218     /**
219      * Returns Institution Specified Time (component 7).  This is a convenience method that saves you from 
220      * casting and handling an exception.
221      */
222     public ID getInstitutionSpecifiedTime() {
223        return getTyped(6, ID.class);
224     }
225 
226     
227     /**
228      * Returns Institution Specified Time (component 7).  This is a convenience method that saves you from 
229      * casting and handling an exception.
230      */
231     public ID getRpt7_InstitutionSpecifiedTime() {
232        return getTyped(6, ID.class);
233     }
234 
235 
236     /**
237      * Returns Event (component 8).  This is a convenience method that saves you from 
238      * casting and handling an exception.
239      */
240     public ID getEvent() {
241        return getTyped(7, ID.class);
242     }
243 
244     
245     /**
246      * Returns Event (component 8).  This is a convenience method that saves you from 
247      * casting and handling an exception.
248      */
249     public ID getRpt8_Event() {
250        return getTyped(7, ID.class);
251     }
252 
253 
254     /**
255      * Returns Event Offset Quantity (component 9).  This is a convenience method that saves you from 
256      * casting and handling an exception.
257      */
258     public NM getEventOffsetQuantity() {
259        return getTyped(8, NM.class);
260     }
261 
262     
263     /**
264      * Returns Event Offset Quantity (component 9).  This is a convenience method that saves you from 
265      * casting and handling an exception.
266      */
267     public NM getRpt9_EventOffsetQuantity() {
268        return getTyped(8, NM.class);
269     }
270 
271 
272     /**
273      * Returns Event Offset Units (component 10).  This is a convenience method that saves you from 
274      * casting and handling an exception.
275      */
276     public CWE getEventOffsetUnits() {
277        return getTyped(9, CWE.class);
278     }
279 
280     
281     /**
282      * Returns Event Offset Units (component 10).  This is a convenience method that saves you from 
283      * casting and handling an exception.
284      */
285     public CWE getRpt10_EventOffsetUnits() {
286        return getTyped(9, CWE.class);
287     }
288 
289 
290     /**
291      * Returns General Timing Specification (component 11).  This is a convenience method that saves you from 
292      * casting and handling an exception.
293      */
294     public GTS getGeneralTimingSpecification() {
295        return getTyped(10, GTS.class);
296     }
297 
298     
299     /**
300      * Returns General Timing Specification (component 11).  This is a convenience method that saves you from 
301      * casting and handling an exception.
302      */
303     public GTS getRpt11_GeneralTimingSpecification() {
304        return getTyped(10, GTS.class);
305     }
306 
307 
308 
309 }
310