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 "CN.java".  Description:
15   * "Composite class CN"
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.v22.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 CN (CN für Ärzte) data type. 
43   * This type consists of the following components:</p>
44   * <ul>
45   * <li>ID number (ID)
46   * <li>family name (ST)
47   * <li>given name (ST)
48   * <li>middle initial or name (ST)
49   * <li>suffix (e.g. JR or III) (ST)
50   * <li>prefix (e.g. DR) (ST)
51   * <li>degree (e.g. MD) (ST)
52   * <li>source table id (ID)
53   * <li>Adresse (AD)
54   * <li>Telefon (TN)
55   * <li>Faxnummer (TN)
56   * <li>Online-Nummer (TN)
57   * <li>E-Mail (ST)
58   * </ul>
59   */
60  @SuppressWarnings("unused")
61  public class CN extends AbstractComposite {
62  
63      private Type[] data;
64  
65      /** 
66       * Creates a new CN type
67       */
68      public CN(Message message) {
69          super(message);
70          init();
71      }
72  
73      private void init() {
74          data = new Type[13];    
75          data[0] = new ID(getMessage(), 0);
76          data[1] = new ST(getMessage());
77          data[2] = new ST(getMessage());
78          data[3] = new ST(getMessage());
79          data[4] = new ST(getMessage());
80          data[5] = new ST(getMessage());
81          data[6] = new ST(getMessage());
82          data[7] = new ID(getMessage(), 0);
83          data[8] = new AD(getMessage());
84          data[9] = new TN(getMessage());
85          data[10] = new TN(getMessage());
86          data[11] = new TN(getMessage());
87          data[12] = new ST(getMessage());
88      }
89  
90  
91      /**
92       * Returns an array containing the data elements.
93       */
94      public Type[] getComponents() { 
95          return this.data; 
96      }
97  
98      /**
99       * Returns an individual data component.
100      *
101      * @param number The component number (0-indexed)
102      * @throws DataTypeException if the given element number is out of range.
103      */
104     public Type getComponent(int number) throws DataTypeException { 
105 
106         try { 
107             return this.data[number]; 
108         } catch (ArrayIndexOutOfBoundsException e) { 
109             throw new DataTypeException("Element " + number + " doesn't exist (Type " + getClass().getName() + " has only " + this.data.length + " components)"); 
110         } 
111     } 
112 
113 
114     /**
115      * Returns ID number (component 1).  This is a convenience method that saves you from 
116      * casting and handling an exception.
117      */
118     public ID getIDNumber() {
119        return getTyped(0, ID.class);
120     }
121 
122     
123     /**
124      * Returns ID number (component 1).  This is a convenience method that saves you from 
125      * casting and handling an exception.
126      */
127     public ID getCn1_IDNumber() {
128        return getTyped(0, ID.class);
129     }
130 
131 
132     /**
133      * Returns family name (component 2).  This is a convenience method that saves you from 
134      * casting and handling an exception.
135      */
136     public ST getFamilyName() {
137        return getTyped(1, ST.class);
138     }
139 
140     
141     /**
142      * Returns family name (component 2).  This is a convenience method that saves you from 
143      * casting and handling an exception.
144      */
145     public ST getCn2_FamilyName() {
146        return getTyped(1, ST.class);
147     }
148 
149 
150     /**
151      * Returns given name (component 3).  This is a convenience method that saves you from 
152      * casting and handling an exception.
153      */
154     public ST getGivenName() {
155        return getTyped(2, ST.class);
156     }
157 
158     
159     /**
160      * Returns given name (component 3).  This is a convenience method that saves you from 
161      * casting and handling an exception.
162      */
163     public ST getCn3_GivenName() {
164        return getTyped(2, ST.class);
165     }
166 
167 
168     /**
169      * Returns middle initial or name (component 4).  This is a convenience method that saves you from 
170      * casting and handling an exception.
171      */
172     public ST getMiddleInitialOrName() {
173        return getTyped(3, ST.class);
174     }
175 
176     
177     /**
178      * Returns middle initial or name (component 4).  This is a convenience method that saves you from 
179      * casting and handling an exception.
180      */
181     public ST getCn4_MiddleInitialOrName() {
182        return getTyped(3, ST.class);
183     }
184 
185 
186     /**
187      * Returns suffix (e.g. JR or III) (component 5).  This is a convenience method that saves you from 
188      * casting and handling an exception.
189      */
190     public ST getSuffixEgJRorIII() {
191        return getTyped(4, ST.class);
192     }
193 
194     
195     /**
196      * Returns suffix (e.g. JR or III) (component 5).  This is a convenience method that saves you from 
197      * casting and handling an exception.
198      */
199     public ST getCn5_SuffixEgJRorIII() {
200        return getTyped(4, ST.class);
201     }
202 
203 
204     /**
205      * Returns prefix (e.g. DR) (component 6).  This is a convenience method that saves you from 
206      * casting and handling an exception.
207      */
208     public ST getPrefixEgDR() {
209        return getTyped(5, ST.class);
210     }
211 
212     
213     /**
214      * Returns prefix (e.g. DR) (component 6).  This is a convenience method that saves you from 
215      * casting and handling an exception.
216      */
217     public ST getCn6_PrefixEgDR() {
218        return getTyped(5, ST.class);
219     }
220 
221 
222     /**
223      * Returns degree (e.g. MD) (component 7).  This is a convenience method that saves you from 
224      * casting and handling an exception.
225      */
226     public ST getDegreeEgMD() {
227        return getTyped(6, ST.class);
228     }
229 
230     
231     /**
232      * Returns degree (e.g. MD) (component 7).  This is a convenience method that saves you from 
233      * casting and handling an exception.
234      */
235     public ST getCn7_DegreeEgMD() {
236        return getTyped(6, ST.class);
237     }
238 
239 
240     /**
241      * Returns source table id (component 8).  This is a convenience method that saves you from 
242      * casting and handling an exception.
243      */
244     public ID getSourceTableId() {
245        return getTyped(7, ID.class);
246     }
247 
248     
249     /**
250      * Returns source table id (component 8).  This is a convenience method that saves you from 
251      * casting and handling an exception.
252      */
253     public ID getCn8_SourceTableId() {
254        return getTyped(7, ID.class);
255     }
256 
257 
258     /**
259      * Returns Adresse (component 9).  This is a convenience method that saves you from 
260      * casting and handling an exception.
261      */
262     public AD getAdresse() {
263        return getTyped(8, AD.class);
264     }
265 
266     
267     /**
268      * Returns Adresse (component 9).  This is a convenience method that saves you from 
269      * casting and handling an exception.
270      */
271     public AD getCn9_Adresse() {
272        return getTyped(8, AD.class);
273     }
274 
275 
276     /**
277      * Returns Telefon (component 10).  This is a convenience method that saves you from 
278      * casting and handling an exception.
279      */
280     public TN getTelefon() {
281        return getTyped(9, TN.class);
282     }
283 
284     
285     /**
286      * Returns Telefon (component 10).  This is a convenience method that saves you from 
287      * casting and handling an exception.
288      */
289     public TN getCn10_Telefon() {
290        return getTyped(9, TN.class);
291     }
292 
293 
294     /**
295      * Returns Faxnummer (component 11).  This is a convenience method that saves you from 
296      * casting and handling an exception.
297      */
298     public TN getFaxnummer() {
299        return getTyped(10, TN.class);
300     }
301 
302     
303     /**
304      * Returns Faxnummer (component 11).  This is a convenience method that saves you from 
305      * casting and handling an exception.
306      */
307     public TN getCn11_Faxnummer() {
308        return getTyped(10, TN.class);
309     }
310 
311 
312     /**
313      * Returns Online-Nummer (component 12).  This is a convenience method that saves you from 
314      * casting and handling an exception.
315      */
316     public TN getOnlineNummer() {
317        return getTyped(11, TN.class);
318     }
319 
320     
321     /**
322      * Returns Online-Nummer (component 12).  This is a convenience method that saves you from 
323      * casting and handling an exception.
324      */
325     public TN getCn12_OnlineNummer() {
326        return getTyped(11, TN.class);
327     }
328 
329 
330     /**
331      * Returns E-Mail (component 13).  This is a convenience method that saves you from 
332      * casting and handling an exception.
333      */
334     public ST getEMail() {
335        return getTyped(12, ST.class);
336     }
337 
338     
339     /**
340      * Returns E-Mail (component 13).  This is a convenience method that saves you from 
341      * casting and handling an exception.
342      */
343     public ST getCn13_EMail() {
344        return getTyped(12, ST.class);
345     }
346 
347 
348 
349 }
350