1 /**
2 * The contents of this file are subject to the Mozilla Public License Version 1.1
3 * (the "License"); you may not use this file except in compliance with the License.
4 * You may obtain a copy of the License at http://www.mozilla.org/MPL/
5 * Software distributed under the License is distributed on an "AS IS" basis,
6 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the
7 * specific language governing rights and limitations under the License.
8 *
9 * The Original Code is "ID.java". Description:
10 * "This class contains functionality used by the ID class
11 * in the version 2.3.0, 2.3.1, 2.4, and 2.5 packages"
12 *
13 * The Initial Developer of the Original Code is University Health Network. Copyright (C)
14 * 2005. All Rights Reserved.
15 *
16 * Contributor(s): ______________________________________.
17 *
18 * Alternatively, the contents of this file may be used under the terms of the
19 * GNU General Public License (the "GPL"), in which case the provisions of the GPL are
20 * applicable instead of those above. If you wish to allow use of your version of this
21 * file only under the terms of the GPL and not to allow others to use your version
22 * of this file under the MPL, indicate your decision by deleting the provisions above
23 * and replace them with the notice and other provisions required by the GPL License.
24 * If you do not delete the provisions above, a recipient may use your version of
25 * this file under either the MPL or the GPL.
26 *
27 */
28 package ca.uhn.hl7v2.model.primitive;
29
30 import ca.uhn.hl7v2.model.Message;
31
32 /**
33 * This class contains functionality used by the ID class
34 * in the version 2.3.0, 2.3.1, 2.4, and 2.5 packages
35 *
36 * Note: The class description below has been excerpted from the Hl7 2.4 documentation. Sectional
37 * references made below also refer to the same documentation.
38 *
39 * The value of such a field follows the formatting rules for an ST field except
40 * that it is drawn from a table of legal values. There shall be an HL7 table number
41 * associated with ID data types. An example of an ID field is OBR-25-result status.
42 * This data type should be used only for HL7 tables (see Section 2.7.6, "Table").
43 * The reverse is not true, since in some circumstances it is more appropriate to use
44 * the CE data type for HL7 tables.
45 *
46 * @author <a href="mailto:neal.acharya@uhn.on.ca">Neal Acharya</a>
47 * @author <a href="mailto:bryan.tripp@uhn.on.ca">Bryan Tripp</a>
48 * @version $Revision: 1.1 $ updated on $Date: 2007-02-19 02:24:51 $ by $Author: jamesagnew $
49 */
50 @SuppressWarnings("serial")
51 public abstract class ID extends AbstractTextPrimitive {
52
53 private int myTable = 0;
54
55 /**
56 * @param theMessage message to which this Type belongs
57 */
58 public ID(Message theMessage) {
59 super(theMessage);
60 }
61
62 /**
63 * @param theMessage message to which this Type belongs
64 * @param theTable HL7 table from which values are to be drawn
65 */
66 public ID(Message theMessage, int theTable) {
67 super(theMessage);
68 myTable = theTable;
69 }
70
71 /**
72 * @param message message to which this Type belongs
73 * @param theTable HL7 table from which values are to be drawn
74 */
75 public ID(Message message, Integer theTable) {
76 super(message);
77 myTable = theTable;
78 }
79
80 /**
81 * @return number of HL7 table from which values should be drawn (defaults to 0)
82 */
83 public int getTable() {
84 return myTable;
85 }
86
87 /**
88 * @param theTable HL7 table from which values are to be drawn
89 */
90 public void setTable(int theTable) {
91 myTable = theTable;
92 }
93
94 }