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
033package ca.uhn.hl7v2.model.v24.datatype;
034
035import ca.uhn.hl7v2.model.DataTypeException;
036import ca.uhn.hl7v2.model.Message;
037import ca.uhn.hl7v2.model.Type;
038import ca.uhn.hl7v2.model.AbstractComposite;
039
040/**
041 * <p>Represents an HL7 CN (composite ID number and name) data type. 
042 * This type consists of the following components:</p>
043 * <ul>
044 * <li>ID number (ST) (ST)
045 * <li>family name (FN)
046 * <li>given name (ST)
047 * <li>second and further given names or initials thereof (ST)
048 * <li>suffix (e.g., JR or III) (ST)
049 * <li>prefix (e.g., DR) (ST)
050 * <li>degree (e.g., MD) (IS)
051 * <li>source table (IS)
052 * <li>assigning authority (HD)
053 * </ul>
054 */
055@SuppressWarnings("unused")
056public class CN extends AbstractComposite {
057
058    private Type[] data;
059
060    /** 
061     * Creates a new CN type
062     */
063    public CN(Message message) {
064        super(message);
065        init();
066    }
067
068    private void init() {
069        data = new Type[9];    
070        data[0] = new ST(getMessage());
071        data[1] = new FN(getMessage());
072        data[2] = new ST(getMessage());
073        data[3] = new ST(getMessage());
074        data[4] = new ST(getMessage());
075        data[5] = new ST(getMessage());
076        data[6] = new IS(getMessage(), 0);
077        data[7] = new IS(getMessage(), 0);
078        data[8] = new HD(getMessage());
079    }
080
081
082    /**
083     * Returns an array containing the data elements.
084     */
085    public Type[] getComponents() { 
086        return this.data; 
087    }
088
089    /**
090     * Returns an individual data component.
091     *
092     * @param number The component number (0-indexed)
093     * @throws DataTypeException if the given element number is out of range.
094     */
095    public Type getComponent(int number) throws DataTypeException { 
096
097        try { 
098            return this.data[number]; 
099        } catch (ArrayIndexOutOfBoundsException e) { 
100            throw new DataTypeException("Element " + number + " doesn't exist (Type " + getClass().getName() + " has only " + this.data.length + " components)"); 
101        } 
102    } 
103
104
105    /**
106     * Returns ID number (ST) (component 1).  This is a convenience method that saves you from 
107     * casting and handling an exception.
108     */
109    public ST getIDNumber() {
110       return getTyped(0, ST.class);
111    }
112
113    
114    /**
115     * Returns ID number (ST) (component 1).  This is a convenience method that saves you from 
116     * casting and handling an exception.
117     */
118    public ST getCn1_IDNumber() {
119       return getTyped(0, ST.class);
120    }
121
122
123    /**
124     * Returns family name (component 2).  This is a convenience method that saves you from 
125     * casting and handling an exception.
126     */
127    public FN getFamilyName() {
128       return getTyped(1, FN.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 FN getCn2_FamilyName() {
137       return getTyped(1, FN.class);
138    }
139
140
141    /**
142     * Returns given name (component 3).  This is a convenience method that saves you from 
143     * casting and handling an exception.
144     */
145    public ST getGivenName() {
146       return getTyped(2, 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 getCn3_GivenName() {
155       return getTyped(2, ST.class);
156    }
157
158
159    /**
160     * Returns second and further given names or initials thereof (component 4).  This is a convenience method that saves you from 
161     * casting and handling an exception.
162     */
163    public ST getSecondAndFurtherGivenNamesOrInitialsThereof() {
164       return getTyped(3, ST.class);
165    }
166
167    
168    /**
169     * Returns second and further given names or initials thereof (component 4).  This is a convenience method that saves you from 
170     * casting and handling an exception.
171     */
172    public ST getCn4_SecondAndFurtherGivenNamesOrInitialsThereof() {
173       return getTyped(3, ST.class);
174    }
175
176
177    /**
178     * Returns suffix (e.g., JR or III) (component 5).  This is a convenience method that saves you from 
179     * casting and handling an exception.
180     */
181    public ST getSuffixEgJRorIII() {
182       return getTyped(4, 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 getCn5_SuffixEgJRorIII() {
191       return getTyped(4, ST.class);
192    }
193
194
195    /**
196     * Returns prefix (e.g., DR) (component 6).  This is a convenience method that saves you from 
197     * casting and handling an exception.
198     */
199    public ST getPrefixEgDR() {
200       return getTyped(5, 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 getCn6_PrefixEgDR() {
209       return getTyped(5, ST.class);
210    }
211
212
213    /**
214     * Returns degree (e.g., MD) (component 7).  This is a convenience method that saves you from 
215     * casting and handling an exception.
216     */
217    public IS getDegreeEgMD() {
218       return getTyped(6, IS.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 IS getCn7_DegreeEgMD() {
227       return getTyped(6, IS.class);
228    }
229
230
231    /**
232     * Returns source table (component 8).  This is a convenience method that saves you from 
233     * casting and handling an exception.
234     */
235    public IS getSourceTable() {
236       return getTyped(7, IS.class);
237    }
238
239    
240    /**
241     * Returns source table (component 8).  This is a convenience method that saves you from 
242     * casting and handling an exception.
243     */
244    public IS getCn8_SourceTable() {
245       return getTyped(7, IS.class);
246    }
247
248
249    /**
250     * Returns assigning authority (component 9).  This is a convenience method that saves you from 
251     * casting and handling an exception.
252     */
253    public HD getAssigningAuthority() {
254       return getTyped(8, HD.class);
255    }
256
257    
258    /**
259     * Returns assigning authority (component 9).  This is a convenience method that saves you from 
260     * casting and handling an exception.
261     */
262    public HD getCn9_AssigningAuthority() {
263       return getTyped(8, HD.class);
264    }
265
266
267
268}
269