View Javadoc
1   /*
2    * This class is an auto-generated source file for a HAPI
3    * HL7 v2.x standard structure class.
4    *
5    * For more information, visit: http://hl7api.sourceforge.net/
6    * 
7    * The contents of this file are subject to the Mozilla Public License Version 1.1 
8    * (the "License"); you may not use this file except in compliance with the License. 
9    * You may obtain a copy of the License at http://www.mozilla.org/MPL/ 
10   * Software distributed under the License is distributed on an "AS IS" basis, 
11   * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the 
12   * specific language governing rights and limitations under the License. 
13   * 
14   * The Original Code is "[file_name]".  Description: 
15   * "[one_line_description]" 
16   * 
17   * The Initial Developer of the Original Code is University Health Network. Copyright (C) 
18   * 2012.  All Rights Reserved. 
19   * 
20   * Contributor(s): ______________________________________. 
21   * 
22   * Alternatively, the contents of this file may be used under the terms of the 
23   * GNU General Public License (the  "GPL"), in which case the provisions of the GPL are 
24   * applicable instead of those above.  If you wish to allow use of your version of this 
25   * file only under the terms of the GPL and not to allow others to use your version 
26   * of this file under the MPL, indicate your decision by deleting  the provisions above 
27   * and replace  them with the notice and other provisions required by the GPL License.  
28   * If you do not delete the provisions above, a recipient may use your version of 
29   * this file under either the MPL or the GPL. 
30   * 
31   */
32  
33  
34  package ca.uhn.hl7v2.model.v25.segment;
35  
36  // import ca.uhn.hl7v2.model.v25.group.*;
37  import ca.uhn.hl7v2.model.v25.datatype.*;
38  import ca.uhn.hl7v2.HL7Exception;
39  import ca.uhn.hl7v2.parser.ModelClassFactory;
40  import ca.uhn.hl7v2.parser.DefaultModelClassFactory;
41  import ca.uhn.hl7v2.model.AbstractMessage;
42  import ca.uhn.hl7v2.model.Group;
43  import ca.uhn.hl7v2.model.Type;
44  import ca.uhn.hl7v2.model.AbstractSegment;
45  import ca.uhn.hl7v2.model.Varies;
46  
47  
48  /**
49   *<p>Represents an HL7 NTE message segment (Notes and Comments). 
50   * This segment has the following fields:</p>
51   * <ul>
52       * <li>NTE-1: Set ID - NTE (SI) <b>optional </b>
53       * <li>NTE-2: Source of Comment (ID) <b>optional </b>
54       * <li>NTE-3: Comment (FT) <b>optional repeating</b>
55       * <li>NTE-4: Comment Type (CE) <b>optional </b>
56   * </ul>
57   */
58  @SuppressWarnings("unused")
59  public class NTE extends AbstractSegment {
60  
61      /** 
62       * Creates a new NTE segment
63       */
64      public NTE(Group parent, ModelClassFactory factory) {
65         super(parent, factory);
66         init(factory);
67      }
68  
69      private void init(ModelClassFactory factory) {
70         try {
71                                    this.add(SI.class, false, 1, 4, new Object[]{ getMessage() }, "Set ID - NTE");
72                                                this.add(ID.class, false, 1, 8, new Object[]{ getMessage(), new Integer(105) }, "Source of Comment");
73                                    this.add(FT.class, false, 0, 65536, new Object[]{ getMessage() }, "Comment");
74                                    this.add(CE.class, false, 1, 250, new Object[]{ getMessage() }, "Comment Type");
75         } catch(HL7Exception e) {
76            log.error("Unexpected error creating NTE - this is probably a bug in the source code generator.", e);
77         }
78      }
79  
80  
81  
82      /**
83       * Returns
84       * NTE-1: "Set ID - NTE" - creates it if necessary
85       */
86      public SI getSetIDNTE() { 
87  		SI retVal = this.getTypedField(1, 0);
88  		return retVal;
89      }
90      
91      /**
92       * Returns
93       * NTE-1: "Set ID - NTE" - creates it if necessary
94       */
95      public SI getNte1_SetIDNTE() { 
96  		SI retVal = this.getTypedField(1, 0);
97  		return retVal;
98      }
99  
100 
101 
102     /**
103      * Returns
104      * NTE-2: "Source of Comment" - creates it if necessary
105      */
106     public ID getSourceOfComment() { 
107 		ID retVal = this.getTypedField(2, 0);
108 		return retVal;
109     }
110     
111     /**
112      * Returns
113      * NTE-2: "Source of Comment" - creates it if necessary
114      */
115     public ID getNte2_SourceOfComment() { 
116 		ID retVal = this.getTypedField(2, 0);
117 		return retVal;
118     }
119 
120 
121     /**
122      * Returns all repetitions of Comment (NTE-3).
123      */
124     public FT[] getComment() {
125     	FT[] retVal = this.getTypedField(3, new FT[0]);
126     	return retVal;
127     }
128 
129 
130     /**
131      * Returns all repetitions of Comment (NTE-3).
132      */
133     public FT[] getNte3_Comment() {
134     	FT[] retVal = this.getTypedField(3, new FT[0]);
135     	return retVal;
136     }
137 
138 
139     /**
140      * Returns a count of the current number of repetitions of Comment (NTE-3).
141      * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
142      * it will return zero.
143      */
144     public int getCommentReps() {
145     	return this.getReps(3);
146     }
147 
148 
149     /**
150      * Returns a specific repetition of
151      * NTE-3: "Comment" - creates it if necessary
152      *
153      * @param rep The repetition index (0-indexed)
154      */
155     public FT getComment(int rep) { 
156 		FT retVal = this.getTypedField(3, rep);
157 		return retVal;
158     }
159 
160     /**
161      * Returns a specific repetition of
162      * NTE-3: "Comment" - creates it if necessary
163      *
164      * @param rep The repetition index (0-indexed)
165      */
166     public FT getNte3_Comment(int rep) { 
167 		FT retVal = this.getTypedField(3, rep);
168 		return retVal;
169     }
170 
171     /**
172      * Returns a count of the current number of repetitions of Comment (NTE-3).
173      * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
174      * it will return zero.
175      */
176     public int getNte3_CommentReps() {
177     	return this.getReps(3);
178     }
179 
180 
181     /**
182      * Inserts a repetition of
183      * NTE-3: "Comment" at a specific index
184      *
185      * @param rep The repetition index (0-indexed)
186      * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
187      */
188     public FT insertComment(int rep) throws HL7Exception { 
189         return (FT) super.insertRepetition(3, rep);
190     }
191 
192 
193     /**
194      * Inserts a repetition of
195      * NTE-3: "Comment" at a specific index
196      *
197      * @param rep The repetition index (0-indexed)
198      * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
199      */
200     public FT insertNte3_Comment(int rep) throws HL7Exception { 
201         return (FT) super.insertRepetition(3, rep);
202     }
203 
204 
205     /**
206      * Removes a repetition of
207      * NTE-3: "Comment" at a specific index
208      *
209      * @param rep The repetition index (0-indexed)
210      * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
211      */
212     public FT removeComment(int rep) throws HL7Exception { 
213         return (FT) super.removeRepetition(3, rep);
214     }
215 
216 
217     /**
218      * Removes a repetition of
219      * NTE-3: "Comment" at a specific index
220      *
221      * @param rep The repetition index (0-indexed)
222      * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
223      */
224     public FT removeNte3_Comment(int rep) throws HL7Exception { 
225         return (FT) super.removeRepetition(3, rep);
226     }
227 
228 
229 
230 
231     /**
232      * Returns
233      * NTE-4: "Comment Type" - creates it if necessary
234      */
235     public CE getCommentType() { 
236 		CE retVal = this.getTypedField(4, 0);
237 		return retVal;
238     }
239     
240     /**
241      * Returns
242      * NTE-4: "Comment Type" - creates it if necessary
243      */
244     public CE getNte4_CommentType() { 
245 		CE retVal = this.getTypedField(4, 0);
246 		return retVal;
247     }
248 
249 
250 
251 
252 
253     /** {@inheritDoc} */   
254     protected Type createNewTypeWithoutReflection(int field) {
255        switch (field) {
256           case 0: return new SI(getMessage());
257           case 1: return new ID(getMessage(), new Integer( 105 ));
258           case 2: return new FT(getMessage());
259           case 3: return new CE(getMessage());
260           default: return null;
261        }
262    }
263 
264 
265 }
266