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 "CWE.java".  Description:
015 * "Composite class CWE"
016 * 
017 * The Initial Developer of the Original Code is University Health Network. Copyright (C) 
018 * 2013.  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.v251.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/**
042 * <p>Represents an HL7 CWE (Coded with Exceptions) data type. 
043 * This type consists of the following components:</p>
044 * <ul>
045 * <li>Identifier (ST)
046 * <li>Text (ST)
047 * <li>Name of Coding System (ID)
048 * <li>Alternate Identifier (ST)
049 * <li>Alternate Text (ST)
050 * <li>Name of Alternate Coding System (ID)
051 * <li>Coding System Version ID (ST)
052 * <li>Alternate Coding System Version ID (ST)
053 * <li>Original Text (ST)
054 * </ul>
055 */
056@SuppressWarnings("unused")
057public class CWE extends AbstractComposite {
058
059    private Type[] data;
060
061    /** 
062     * Creates a new CWE type
063     */
064    public CWE(Message message) {
065        super(message);
066        init();
067    }
068
069    private void init() {
070        data = new Type[9];    
071        data[0] = new ST(getMessage());
072        data[1] = new ST(getMessage());
073        data[2] = new ID(getMessage(), 396);
074        data[3] = new ST(getMessage());
075        data[4] = new ST(getMessage());
076        data[5] = new ID(getMessage(), 396);
077        data[6] = new ST(getMessage());
078        data[7] = new ST(getMessage());
079        data[8] = new ST(getMessage());
080    }
081
082
083    /**
084     * Returns an array containing the data elements.
085     */
086    public Type[] getComponents() { 
087        return this.data; 
088    }
089
090    /**
091     * Returns an individual data component.
092     *
093     * @param number The component number (0-indexed)
094     * @throws DataTypeException if the given element number is out of range.
095     */
096    public Type getComponent(int number) throws DataTypeException { 
097
098        try { 
099            return this.data[number]; 
100        } catch (ArrayIndexOutOfBoundsException e) { 
101            throw new DataTypeException("Element " + number + " doesn't exist (Type " + getClass().getName() + " has only " + this.data.length + " components)"); 
102        } 
103    } 
104
105
106    /**
107     * Returns Identifier (component 1).  This is a convenience method that saves you from 
108     * casting and handling an exception.
109     */
110    public ST getIdentifier() {
111       return getTyped(0, ST.class);
112    }
113
114    
115    /**
116     * Returns Identifier (component 1).  This is a convenience method that saves you from 
117     * casting and handling an exception.
118     */
119    public ST getCwe1_Identifier() {
120       return getTyped(0, ST.class);
121    }
122
123
124    /**
125     * Returns Text (component 2).  This is a convenience method that saves you from 
126     * casting and handling an exception.
127     */
128    public ST getText() {
129       return getTyped(1, ST.class);
130    }
131
132    
133    /**
134     * Returns Text (component 2).  This is a convenience method that saves you from 
135     * casting and handling an exception.
136     */
137    public ST getCwe2_Text() {
138       return getTyped(1, ST.class);
139    }
140
141
142    /**
143     * Returns Name of Coding System (component 3).  This is a convenience method that saves you from 
144     * casting and handling an exception.
145     */
146    public ID getNameOfCodingSystem() {
147       return getTyped(2, ID.class);
148    }
149
150    
151    /**
152     * Returns Name of Coding System (component 3).  This is a convenience method that saves you from 
153     * casting and handling an exception.
154     */
155    public ID getCwe3_NameOfCodingSystem() {
156       return getTyped(2, ID.class);
157    }
158
159
160    /**
161     * Returns Alternate Identifier (component 4).  This is a convenience method that saves you from 
162     * casting and handling an exception.
163     */
164    public ST getAlternateIdentifier() {
165       return getTyped(3, ST.class);
166    }
167
168    
169    /**
170     * Returns Alternate Identifier (component 4).  This is a convenience method that saves you from 
171     * casting and handling an exception.
172     */
173    public ST getCwe4_AlternateIdentifier() {
174       return getTyped(3, ST.class);
175    }
176
177
178    /**
179     * Returns Alternate Text (component 5).  This is a convenience method that saves you from 
180     * casting and handling an exception.
181     */
182    public ST getAlternateText() {
183       return getTyped(4, ST.class);
184    }
185
186    
187    /**
188     * Returns Alternate Text (component 5).  This is a convenience method that saves you from 
189     * casting and handling an exception.
190     */
191    public ST getCwe5_AlternateText() {
192       return getTyped(4, ST.class);
193    }
194
195
196    /**
197     * Returns Name of Alternate Coding System (component 6).  This is a convenience method that saves you from 
198     * casting and handling an exception.
199     */
200    public ID getNameOfAlternateCodingSystem() {
201       return getTyped(5, ID.class);
202    }
203
204    
205    /**
206     * Returns Name of Alternate Coding System (component 6).  This is a convenience method that saves you from 
207     * casting and handling an exception.
208     */
209    public ID getCwe6_NameOfAlternateCodingSystem() {
210       return getTyped(5, ID.class);
211    }
212
213
214    /**
215     * Returns Coding System Version ID (component 7).  This is a convenience method that saves you from 
216     * casting and handling an exception.
217     */
218    public ST getCodingSystemVersionID() {
219       return getTyped(6, ST.class);
220    }
221
222    
223    /**
224     * Returns Coding System Version ID (component 7).  This is a convenience method that saves you from 
225     * casting and handling an exception.
226     */
227    public ST getCwe7_CodingSystemVersionID() {
228       return getTyped(6, ST.class);
229    }
230
231
232    /**
233     * Returns Alternate Coding System Version ID (component 8).  This is a convenience method that saves you from 
234     * casting and handling an exception.
235     */
236    public ST getAlternateCodingSystemVersionID() {
237       return getTyped(7, ST.class);
238    }
239
240    
241    /**
242     * Returns Alternate Coding System Version ID (component 8).  This is a convenience method that saves you from 
243     * casting and handling an exception.
244     */
245    public ST getCwe8_AlternateCodingSystemVersionID() {
246       return getTyped(7, ST.class);
247    }
248
249
250    /**
251     * Returns Original Text (component 9).  This is a convenience method that saves you from 
252     * casting and handling an exception.
253     */
254    public ST getOriginalText() {
255       return getTyped(8, ST.class);
256    }
257
258    
259    /**
260     * Returns Original Text (component 9).  This is a convenience method that saves you from 
261     * casting and handling an exception.
262     */
263    public ST getCwe9_OriginalText() {
264       return getTyped(8, ST.class);
265    }
266
267
268
269}
270