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.v25.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 SN (Structured Numeric) data type. 
042 * This type consists of the following components:</p>
043 * <ul>
044 * <li>Comparator (ST)
045 * <li>Num1 (NM)
046 * <li>Separator/Suffix (ST)
047 * <li>Num2 (NM)
048 * </ul>
049 */
050@SuppressWarnings("unused")
051public class SN extends AbstractComposite {
052
053    private Type[] data;
054
055    /** 
056     * Creates a new SN type
057     */
058    public SN(Message message) {
059        super(message);
060        init();
061    }
062
063    private void init() {
064        data = new Type[4];    
065        data[0] = new ST(getMessage());
066        data[1] = new NM(getMessage());
067        data[2] = new ST(getMessage());
068        data[3] = new NM(getMessage());
069    }
070
071
072    /**
073     * Returns an array containing the data elements.
074     */
075    public Type[] getComponents() { 
076        return this.data; 
077    }
078
079    /**
080     * Returns an individual data component.
081     *
082     * @param number The component number (0-indexed)
083     * @throws DataTypeException if the given element number is out of range.
084     */
085    public Type getComponent(int number) throws DataTypeException { 
086
087        try { 
088            return this.data[number]; 
089        } catch (ArrayIndexOutOfBoundsException e) { 
090            throw new DataTypeException("Element " + number + " doesn't exist (Type " + getClass().getName() + " has only " + this.data.length + " components)"); 
091        } 
092    } 
093
094
095    /**
096     * Returns Comparator (component 1).  This is a convenience method that saves you from 
097     * casting and handling an exception.
098     */
099    public ST getComparator() {
100       return getTyped(0, ST.class);
101    }
102
103    
104    /**
105     * Returns Comparator (component 1).  This is a convenience method that saves you from 
106     * casting and handling an exception.
107     */
108    public ST getSn1_Comparator() {
109       return getTyped(0, ST.class);
110    }
111
112
113    /**
114     * Returns Num1 (component 2).  This is a convenience method that saves you from 
115     * casting and handling an exception.
116     */
117    public NM getNum1() {
118       return getTyped(1, NM.class);
119    }
120
121    
122    /**
123     * Returns Num1 (component 2).  This is a convenience method that saves you from 
124     * casting and handling an exception.
125     */
126    public NM getSn2_Num1() {
127       return getTyped(1, NM.class);
128    }
129
130
131    /**
132     * Returns Separator/Suffix (component 3).  This is a convenience method that saves you from 
133     * casting and handling an exception.
134     */
135    public ST getSeparatorSuffix() {
136       return getTyped(2, ST.class);
137    }
138
139    
140    /**
141     * Returns Separator/Suffix (component 3).  This is a convenience method that saves you from 
142     * casting and handling an exception.
143     */
144    public ST getSn3_SeparatorSuffix() {
145       return getTyped(2, ST.class);
146    }
147
148
149    /**
150     * Returns Num2 (component 4).  This is a convenience method that saves you from 
151     * casting and handling an exception.
152     */
153    public NM getNum2() {
154       return getTyped(3, NM.class);
155    }
156
157    
158    /**
159     * Returns Num2 (component 4).  This is a convenience method that saves you from 
160     * casting and handling an exception.
161     */
162    public NM getSn4_Num2() {
163       return getTyped(3, NM.class);
164    }
165
166
167
168}
169