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.v231.segment;
035
036// import ca.uhn.hl7v2.model.v231.group.*;
037import ca.uhn.hl7v2.model.v231.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 LCH message segment (LCH - location characteristic segment). 
049 * This segment has the following fields:</p>
050 * <ul>
051     * <li>LCH-1: Primary Key Value - LCH (PL) <b> </b>
052     * <li>LCH-2: Segment Action Code (ID) <b>optional </b>
053     * <li>LCH-3: Segment Unique Key (EI) <b>optional </b>
054     * <li>LCH-4: Location Characteristic ID (CE) <b> </b>
055     * <li>LCH-5: Location Characteristic Value (CE) <b>optional </b>
056 * </ul>
057 */
058@SuppressWarnings("unused")
059public class LCH extends AbstractSegment {
060
061    /** 
062     * Creates a new LCH segment
063     */
064    public LCH(Group parent, ModelClassFactory factory) {
065       super(parent, factory);
066       init(factory);
067    }
068
069    private void init(ModelClassFactory factory) {
070       try {
071                                  this.add(PL.class, true, 1, 200, new Object[]{ getMessage() }, "Primary Key Value - LCH");
072                                              this.add(ID.class, false, 1, 3, new Object[]{ getMessage(), new Integer(206) }, "Segment Action Code");
073                                  this.add(EI.class, false, 1, 80, new Object[]{ getMessage() }, "Segment Unique Key");
074                                  this.add(CE.class, true, 1, 80, new Object[]{ getMessage() }, "Location Characteristic ID");
075                                  this.add(CE.class, false, 1, 80, new Object[]{ getMessage() }, "Location Characteristic Value");
076       } catch(HL7Exception e) {
077          log.error("Unexpected error creating LCH - this is probably a bug in the source code generator.", e);
078       }
079    }
080
081
082
083    /**
084     * Returns
085     * LCH-1: "Primary Key Value - LCH" - creates it if necessary
086     */
087    public PL getPrimaryKeyValueLCH() { 
088                PL retVal = this.getTypedField(1, 0);
089                return retVal;
090    }
091    
092    /**
093     * Returns
094     * LCH-1: "Primary Key Value - LCH" - creates it if necessary
095     */
096    public PL getLch1_PrimaryKeyValueLCH() { 
097                PL retVal = this.getTypedField(1, 0);
098                return retVal;
099    }
100
101
102
103    /**
104     * Returns
105     * LCH-2: "Segment Action Code" - creates it if necessary
106     */
107    public ID getSegmentActionCode() { 
108                ID retVal = this.getTypedField(2, 0);
109                return retVal;
110    }
111    
112    /**
113     * Returns
114     * LCH-2: "Segment Action Code" - creates it if necessary
115     */
116    public ID getLch2_SegmentActionCode() { 
117                ID retVal = this.getTypedField(2, 0);
118                return retVal;
119    }
120
121
122
123    /**
124     * Returns
125     * LCH-3: "Segment Unique Key" - creates it if necessary
126     */
127    public EI getSegmentUniqueKey() { 
128                EI retVal = this.getTypedField(3, 0);
129                return retVal;
130    }
131    
132    /**
133     * Returns
134     * LCH-3: "Segment Unique Key" - creates it if necessary
135     */
136    public EI getLch3_SegmentUniqueKey() { 
137                EI retVal = this.getTypedField(3, 0);
138                return retVal;
139    }
140
141
142
143    /**
144     * Returns
145     * LCH-4: "Location Characteristic ID" - creates it if necessary
146     */
147    public CE getLocationCharacteristicID() { 
148                CE retVal = this.getTypedField(4, 0);
149                return retVal;
150    }
151    
152    /**
153     * Returns
154     * LCH-4: "Location Characteristic ID" - creates it if necessary
155     */
156    public CE getLch4_LocationCharacteristicID() { 
157                CE retVal = this.getTypedField(4, 0);
158                return retVal;
159    }
160
161
162
163    /**
164     * Returns
165     * LCH-5: "Location Characteristic Value" - creates it if necessary
166     */
167    public CE getLocationCharacteristicValue() { 
168                CE retVal = this.getTypedField(5, 0);
169                return retVal;
170    }
171    
172    /**
173     * Returns
174     * LCH-5: "Location Characteristic Value" - creates it if necessary
175     */
176    public CE getLch5_LocationCharacteristicValue() { 
177                CE retVal = this.getTypedField(5, 0);
178                return retVal;
179    }
180
181
182
183
184
185    /** {@inheritDoc} */   
186    protected Type createNewTypeWithoutReflection(int field) {
187       switch (field) {
188          case 0: return new PL(getMessage());
189          case 1: return new ID(getMessage(), new Integer( 206 ));
190          case 2: return new EI(getMessage());
191          case 3: return new CE(getMessage());
192          case 4: return new CE(getMessage());
193          default: return null;
194       }
195   }
196
197
198}
199