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.v24.segment;
035
036// import ca.uhn.hl7v2.model.v24.group.*;
037import ca.uhn.hl7v2.model.v24.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 RDF message segment (Table Row Definition). 
049 * This segment has the following fields:</p>
050 * <ul>
051     * <li>RDF-1: Number of Columns per Row (NM) <b> </b>
052     * <li>RDF-2: Column Description (RCD) <b> repeating</b>
053 * </ul>
054 */
055@SuppressWarnings("unused")
056public class RDF extends AbstractSegment {
057
058    /** 
059     * Creates a new RDF segment
060     */
061    public RDF(Group parent, ModelClassFactory factory) {
062       super(parent, factory);
063       init(factory);
064    }
065
066    private void init(ModelClassFactory factory) {
067       try {
068                                  this.add(NM.class, true, 1, 3, new Object[]{ getMessage() }, "Number of Columns per Row");
069                                  this.add(RCD.class, true, 0, 40, new Object[]{ getMessage() }, "Column Description");
070       } catch(HL7Exception e) {
071          log.error("Unexpected error creating RDF - this is probably a bug in the source code generator.", e);
072       }
073    }
074
075
076
077    /**
078     * Returns
079     * RDF-1: "Number of Columns per Row" - creates it if necessary
080     */
081    public NM getNumberOfColumnsPerRow() { 
082                NM retVal = this.getTypedField(1, 0);
083                return retVal;
084    }
085    
086    /**
087     * Returns
088     * RDF-1: "Number of Columns per Row" - creates it if necessary
089     */
090    public NM getRdf1_NumberOfColumnsPerRow() { 
091                NM retVal = this.getTypedField(1, 0);
092                return retVal;
093    }
094
095
096    /**
097     * Returns all repetitions of Column Description (RDF-2).
098     */
099    public RCD[] getColumnDescription() {
100        RCD[] retVal = this.getTypedField(2, new RCD[0]);
101        return retVal;
102    }
103
104
105    /**
106     * Returns all repetitions of Column Description (RDF-2).
107     */
108    public RCD[] getRdf2_ColumnDescription() {
109        RCD[] retVal = this.getTypedField(2, new RCD[0]);
110        return retVal;
111    }
112
113
114    /**
115     * Returns a count of the current number of repetitions of Column Description (RDF-2).
116     * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
117     * it will return zero.
118     */
119    public int getColumnDescriptionReps() {
120        return this.getReps(2);
121    }
122
123
124    /**
125     * Returns a specific repetition of
126     * RDF-2: "Column Description" - creates it if necessary
127     *
128     * @param rep The repetition index (0-indexed)
129     */
130    public RCD getColumnDescription(int rep) { 
131                RCD retVal = this.getTypedField(2, rep);
132                return retVal;
133    }
134
135    /**
136     * Returns a specific repetition of
137     * RDF-2: "Column Description" - creates it if necessary
138     *
139     * @param rep The repetition index (0-indexed)
140     */
141    public RCD getRdf2_ColumnDescription(int rep) { 
142                RCD retVal = this.getTypedField(2, rep);
143                return retVal;
144    }
145
146    /**
147     * Returns a count of the current number of repetitions of Column Description (RDF-2).
148     * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
149     * it will return zero.
150     */
151    public int getRdf2_ColumnDescriptionReps() {
152        return this.getReps(2);
153    }
154
155
156    /**
157     * Inserts a repetition of
158     * RDF-2: "Column Description" at a specific index
159     *
160     * @param rep The repetition index (0-indexed)
161     * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
162     */
163    public RCD insertColumnDescription(int rep) throws HL7Exception { 
164        return (RCD) super.insertRepetition(2, rep);
165    }
166
167
168    /**
169     * Inserts a repetition of
170     * RDF-2: "Column Description" at a specific index
171     *
172     * @param rep The repetition index (0-indexed)
173     * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
174     */
175    public RCD insertRdf2_ColumnDescription(int rep) throws HL7Exception { 
176        return (RCD) super.insertRepetition(2, rep);
177    }
178
179
180    /**
181     * Removes a repetition of
182     * RDF-2: "Column Description" 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 RCD removeColumnDescription(int rep) throws HL7Exception { 
188        return (RCD) super.removeRepetition(2, rep);
189    }
190
191
192    /**
193     * Removes a repetition of
194     * RDF-2: "Column Description" 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 RCD removeRdf2_ColumnDescription(int rep) throws HL7Exception { 
200        return (RCD) super.removeRepetition(2, rep);
201    }
202
203
204
205
206
207
208    /** {@inheritDoc} */   
209    protected Type createNewTypeWithoutReflection(int field) {
210       switch (field) {
211          case 0: return new NM(getMessage());
212          case 1: return new RCD(getMessage());
213          default: return null;
214       }
215   }
216
217
218}
219