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
033
034package ca.uhn.hl7v2.model.v25.segment;
035
036// import ca.uhn.hl7v2.model.v25.group.*;
037import ca.uhn.hl7v2.model.v25.datatype.*;
038import ca.uhn.hl7v2.HL7Exception;
039import ca.uhn.hl7v2.parser.ModelClassFactory;
040import ca.uhn.hl7v2.parser.DefaultModelClassFactory;
041import ca.uhn.hl7v2.model.AbstractMessage;
042import ca.uhn.hl7v2.model.Group;
043import ca.uhn.hl7v2.model.Type;
044import ca.uhn.hl7v2.model.AbstractSegment;
045import ca.uhn.hl7v2.model.Varies;
046
047/**
048 *<p>Represents an HL7 NTE message segment (Notes and Comments). 
049 * This segment has the following fields:</p>
050 * <ul>
051     * <li>NTE-1: Set ID - NTE (SI) <b>optional </b>
052     * <li>NTE-2: Source of Comment (ID) <b>optional </b>
053     * <li>NTE-3: Comment (FT) <b>optional repeating</b>
054     * <li>NTE-4: Comment Type (CE) <b>optional </b>
055 * </ul>
056 */
057@SuppressWarnings("unused")
058public class NTE extends AbstractSegment {
059
060    /** 
061     * Creates a new NTE segment
062     */
063    public NTE(Group parent, ModelClassFactory factory) {
064       super(parent, factory);
065       init(factory);
066    }
067
068    private void init(ModelClassFactory factory) {
069       try {
070                                  this.add(SI.class, false, 1, 4, new Object[]{ getMessage() }, "Set ID - NTE");
071                                              this.add(ID.class, false, 1, 8, new Object[]{ getMessage(), new Integer(105) }, "Source of Comment");
072                                  this.add(FT.class, false, 0, 65536, new Object[]{ getMessage() }, "Comment");
073                                  this.add(CE.class, false, 1, 250, new Object[]{ getMessage() }, "Comment Type");
074       } catch(HL7Exception e) {
075          log.error("Unexpected error creating NTE - this is probably a bug in the source code generator.", e);
076       }
077    }
078
079
080
081    /**
082     * Returns
083     * NTE-1: "Set ID - NTE" - creates it if necessary
084     */
085    public SI getSetIDNTE() { 
086                SI retVal = this.getTypedField(1, 0);
087                return retVal;
088    }
089    
090    /**
091     * Returns
092     * NTE-1: "Set ID - NTE" - creates it if necessary
093     */
094    public SI getNte1_SetIDNTE() { 
095                SI retVal = this.getTypedField(1, 0);
096                return retVal;
097    }
098
099
100
101    /**
102     * Returns
103     * NTE-2: "Source of Comment" - creates it if necessary
104     */
105    public ID getSourceOfComment() { 
106                ID retVal = this.getTypedField(2, 0);
107                return retVal;
108    }
109    
110    /**
111     * Returns
112     * NTE-2: "Source of Comment" - creates it if necessary
113     */
114    public ID getNte2_SourceOfComment() { 
115                ID retVal = this.getTypedField(2, 0);
116                return retVal;
117    }
118
119
120    /**
121     * Returns all repetitions of Comment (NTE-3).
122     */
123    public FT[] getComment() {
124        FT[] retVal = this.getTypedField(3, new FT[0]);
125        return retVal;
126    }
127
128
129    /**
130     * Returns all repetitions of Comment (NTE-3).
131     */
132    public FT[] getNte3_Comment() {
133        FT[] retVal = this.getTypedField(3, new FT[0]);
134        return retVal;
135    }
136
137
138    /**
139     * Returns a count of the current number of repetitions of Comment (NTE-3).
140     * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
141     * it will return zero.
142     */
143    public int getCommentReps() {
144        return this.getReps(3);
145    }
146
147
148    /**
149     * Returns a specific repetition of
150     * NTE-3: "Comment" - creates it if necessary
151     *
152     * @param rep The repetition index (0-indexed)
153     */
154    public FT getComment(int rep) { 
155                FT retVal = this.getTypedField(3, rep);
156                return retVal;
157    }
158
159    /**
160     * Returns a specific repetition of
161     * NTE-3: "Comment" - creates it if necessary
162     *
163     * @param rep The repetition index (0-indexed)
164     */
165    public FT getNte3_Comment(int rep) { 
166                FT retVal = this.getTypedField(3, rep);
167                return retVal;
168    }
169
170    /**
171     * Returns a count of the current number of repetitions of Comment (NTE-3).
172     * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
173     * it will return zero.
174     */
175    public int getNte3_CommentReps() {
176        return this.getReps(3);
177    }
178
179
180    /**
181     * Inserts a repetition of
182     * NTE-3: "Comment" at a specific index
183     *
184     * @param rep The repetition index (0-indexed)
185     * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
186     */
187    public FT insertComment(int rep) throws HL7Exception { 
188        return (FT) super.insertRepetition(3, rep);
189    }
190
191
192    /**
193     * Inserts a repetition of
194     * NTE-3: "Comment" at a specific index
195     *
196     * @param rep The repetition index (0-indexed)
197     * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
198     */
199    public FT insertNte3_Comment(int rep) throws HL7Exception { 
200        return (FT) super.insertRepetition(3, rep);
201    }
202
203
204    /**
205     * Removes a repetition of
206     * NTE-3: "Comment" at a specific index
207     *
208     * @param rep The repetition index (0-indexed)
209     * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
210     */
211    public FT removeComment(int rep) throws HL7Exception { 
212        return (FT) super.removeRepetition(3, rep);
213    }
214
215
216    /**
217     * Removes a repetition of
218     * NTE-3: "Comment" at a specific index
219     *
220     * @param rep The repetition index (0-indexed)
221     * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
222     */
223    public FT removeNte3_Comment(int rep) throws HL7Exception { 
224        return (FT) super.removeRepetition(3, rep);
225    }
226
227
228
229
230    /**
231     * Returns
232     * NTE-4: "Comment Type" - creates it if necessary
233     */
234    public CE getCommentType() { 
235                CE retVal = this.getTypedField(4, 0);
236                return retVal;
237    }
238    
239    /**
240     * Returns
241     * NTE-4: "Comment Type" - creates it if necessary
242     */
243    public CE getNte4_CommentType() { 
244                CE retVal = this.getTypedField(4, 0);
245                return retVal;
246    }
247
248
249
250
251
252    /** {@inheritDoc} */   
253    protected Type createNewTypeWithoutReflection(int field) {
254       switch (field) {
255          case 0: return new SI(getMessage());
256          case 1: return new ID(getMessage(), new Integer( 105 ));
257          case 2: return new FT(getMessage());
258          case 3: return new CE(getMessage());
259          default: return null;
260       }
261   }
262
263
264}
265