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 "CE.java".  Description:
015 * "Composite class CE"
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.v22.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 CE (coded element) data type. 
043 * This type consists of the following components:</p>
044 * <ul>
045 * <li>identifier (ID)
046 * <li>text (ST)
047 * <li>name of coding system (ST)
048 * <li>alternate identifier (ST)
049 * <li>alternate text (ST)
050 * <li>name of alternate coding system (ST)
051 * </ul>
052 */
053@SuppressWarnings("unused")
054public class CE extends AbstractComposite {
055
056    private Type[] data;
057
058    /** 
059     * Creates a new CE type
060     */
061    public CE(Message message) {
062        super(message);
063        init();
064    }
065
066    private void init() {
067        data = new Type[6];    
068        data[0] = new ID(getMessage(), 0);
069        data[1] = new ST(getMessage());
070        data[2] = new ST(getMessage());
071        data[3] = new ST(getMessage());
072        data[4] = new ST(getMessage());
073        data[5] = new ST(getMessage());
074    }
075
076
077    /**
078     * Returns an array containing the data elements.
079     */
080    public Type[] getComponents() { 
081        return this.data; 
082    }
083
084    /**
085     * Returns an individual data component.
086     *
087     * @param number The component number (0-indexed)
088     * @throws DataTypeException if the given element number is out of range.
089     */
090    public Type getComponent(int number) throws DataTypeException { 
091
092        try { 
093            return this.data[number]; 
094        } catch (ArrayIndexOutOfBoundsException e) { 
095            throw new DataTypeException("Element " + number + " doesn't exist (Type " + getClass().getName() + " has only " + this.data.length + " components)"); 
096        } 
097    } 
098
099
100    /**
101     * Returns identifier (component 1).  This is a convenience method that saves you from 
102     * casting and handling an exception.
103     */
104    public ID getIdentifier() {
105       return getTyped(0, ID.class);
106    }
107
108    
109    /**
110     * Returns identifier (component 1).  This is a convenience method that saves you from 
111     * casting and handling an exception.
112     */
113    public ID getCe1_Identifier() {
114       return getTyped(0, ID.class);
115    }
116
117
118    /**
119     * Returns text (component 2).  This is a convenience method that saves you from 
120     * casting and handling an exception.
121     */
122    public ST getText() {
123       return getTyped(1, ST.class);
124    }
125
126    
127    /**
128     * Returns text (component 2).  This is a convenience method that saves you from 
129     * casting and handling an exception.
130     */
131    public ST getCe2_Text() {
132       return getTyped(1, ST.class);
133    }
134
135
136    /**
137     * Returns name of coding system (component 3).  This is a convenience method that saves you from 
138     * casting and handling an exception.
139     */
140    public ST getNameOfCodingSystem() {
141       return getTyped(2, ST.class);
142    }
143
144    
145    /**
146     * Returns name of coding system (component 3).  This is a convenience method that saves you from 
147     * casting and handling an exception.
148     */
149    public ST getCe3_NameOfCodingSystem() {
150       return getTyped(2, ST.class);
151    }
152
153
154    /**
155     * Returns alternate identifier (component 4).  This is a convenience method that saves you from 
156     * casting and handling an exception.
157     */
158    public ST getAlternateIdentifier() {
159       return getTyped(3, ST.class);
160    }
161
162    
163    /**
164     * Returns alternate identifier (component 4).  This is a convenience method that saves you from 
165     * casting and handling an exception.
166     */
167    public ST getCe4_AlternateIdentifier() {
168       return getTyped(3, ST.class);
169    }
170
171
172    /**
173     * Returns alternate text (component 5).  This is a convenience method that saves you from 
174     * casting and handling an exception.
175     */
176    public ST getAlternateText() {
177       return getTyped(4, ST.class);
178    }
179
180    
181    /**
182     * Returns alternate text (component 5).  This is a convenience method that saves you from 
183     * casting and handling an exception.
184     */
185    public ST getCe5_AlternateText() {
186       return getTyped(4, ST.class);
187    }
188
189
190    /**
191     * Returns name of alternate coding system (component 6).  This is a convenience method that saves you from 
192     * casting and handling an exception.
193     */
194    public ST getNameOfAlternateCodingSystem() {
195       return getTyped(5, ST.class);
196    }
197
198    
199    /**
200     * Returns name of alternate coding system (component 6).  This is a convenience method that saves you from 
201     * casting and handling an exception.
202     */
203    public ST getCe6_NameOfAlternateCodingSystem() {
204       return getTyped(5, ST.class);
205    }
206
207
208
209}
210