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 ED (encapsulated data) data type. 
042 * This type consists of the following components:</p>
043 * <ul>
044 * <li>source application (HD)
045 * <li>type of data (ID)
046 * <li>data subtype (ID)
047 * <li>encoding (ID)
048 * <li>data (ST)
049 * </ul>
050 */
051@SuppressWarnings("unused")
052public class ED extends AbstractComposite {
053
054    private Type[] data;
055
056    /** 
057     * Creates a new ED type
058     */
059    public ED(Message message) {
060        super(message);
061        init();
062    }
063
064    private void init() {
065        data = new Type[5];    
066        data[0] = new HD(getMessage());
067        data[1] = new ID(getMessage(), 191);
068        data[2] = new ID(getMessage(), 291);
069        data[3] = new ID(getMessage(), 299);
070        data[4] = new ST(getMessage());
071    }
072
073
074    /**
075     * Returns an array containing the data elements.
076     */
077    public Type[] getComponents() { 
078        return this.data; 
079    }
080
081    /**
082     * Returns an individual data component.
083     *
084     * @param number The component number (0-indexed)
085     * @throws DataTypeException if the given element number is out of range.
086     */
087    public Type getComponent(int number) throws DataTypeException { 
088
089        try { 
090            return this.data[number]; 
091        } catch (ArrayIndexOutOfBoundsException e) { 
092            throw new DataTypeException("Element " + number + " doesn't exist (Type " + getClass().getName() + " has only " + this.data.length + " components)"); 
093        } 
094    } 
095
096
097    /**
098     * Returns source application (component 1).  This is a convenience method that saves you from 
099     * casting and handling an exception.
100     */
101    public HD getSourceApplication() {
102       return getTyped(0, HD.class);
103    }
104
105    
106    /**
107     * Returns source application (component 1).  This is a convenience method that saves you from 
108     * casting and handling an exception.
109     */
110    public HD getEd1_SourceApplication() {
111       return getTyped(0, HD.class);
112    }
113
114
115    /**
116     * Returns type of data (component 2).  This is a convenience method that saves you from 
117     * casting and handling an exception.
118     */
119    public ID getTypeOfData() {
120       return getTyped(1, ID.class);
121    }
122
123    
124    /**
125     * Returns type of data (component 2).  This is a convenience method that saves you from 
126     * casting and handling an exception.
127     */
128    public ID getEd2_TypeOfData() {
129       return getTyped(1, ID.class);
130    }
131
132
133    /**
134     * Returns data subtype (component 3).  This is a convenience method that saves you from 
135     * casting and handling an exception.
136     */
137    public ID getDataSubtype() {
138       return getTyped(2, ID.class);
139    }
140
141    
142    /**
143     * Returns data subtype (component 3).  This is a convenience method that saves you from 
144     * casting and handling an exception.
145     */
146    public ID getEd3_DataSubtype() {
147       return getTyped(2, ID.class);
148    }
149
150
151    /**
152     * Returns encoding (component 4).  This is a convenience method that saves you from 
153     * casting and handling an exception.
154     */
155    public ID getEncoding() {
156       return getTyped(3, ID.class);
157    }
158
159    
160    /**
161     * Returns encoding (component 4).  This is a convenience method that saves you from 
162     * casting and handling an exception.
163     */
164    public ID getEd4_Encoding() {
165       return getTyped(3, ID.class);
166    }
167
168
169    /**
170     * Returns data (component 5).  This is a convenience method that saves you from 
171     * casting and handling an exception.
172     */
173    public ST getData() {
174       return getTyped(4, ST.class);
175    }
176
177    
178    /**
179     * Returns data (component 5).  This is a convenience method that saves you from 
180     * casting and handling an exception.
181     */
182    public ST getEd5_Data() {
183       return getTyped(4, ST.class);
184    }
185
186
187
188}
189