Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
Composite |
|
| 1.0;1 |
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 "Composite.java". Description: | |
10 | "Represents the category of HL7 data types that contain more than one component (e.g" | |
11 | ||
12 | The Initial Developer of the Original Code is University Health Network. Copyright (C) | |
13 | 2001. All Rights Reserved. | |
14 | ||
15 | Contributor(s): ______________________________________. | |
16 | ||
17 | Alternatively, the contents of this file may be used under the terms of the | |
18 | GNU General Public License (the "GPL"), in which case the provisions of the GPL are | |
19 | applicable instead of those above. If you wish to allow use of your version of this | |
20 | file only under the terms of the GPL and not to allow others to use your version | |
21 | of this file under the MPL, indicate your decision by deleting the provisions above | |
22 | and replace them with the notice and other provisions required by the GPL License. | |
23 | If you do not delete the provisions above, a recipient may use your version of | |
24 | this file under either the MPL or the GPL. | |
25 | ||
26 | */ | |
27 | ||
28 | package ca.uhn.hl7v2.model; | |
29 | ||
30 | /** | |
31 | * <p>Represents the category of HL7 data types that contain more than one component (e.g. CE). | |
32 | * Implementing classes (i.e. composite data types) should initialize their components | |
33 | * either when they are initialized or when they are first accessed. Only leaf values | |
34 | * (values of primitives) should ever be returned as null.</p> | |
35 | * @author Bryan Tripp (bryan_tripp@sourceforge.net) | |
36 | */ | |
37 | public interface Composite extends Type { | |
38 | ||
39 | /** | |
40 | * Returns an array containing the components of this field. | |
41 | * | |
42 | * @return array of components of this composite type | |
43 | */ | |
44 | public Type[] getComponents(); | |
45 | ||
46 | /** | |
47 | * Returns the single component of this composite at the specified position (starting at 0). | |
48 | * | |
49 | * @param number index of the component to be retrieved (zero-based) | |
50 | * @return component at this index | |
51 | * @throws DataTypeException | |
52 | */ | |
53 | public Type getComponent(int number) throws DataTypeException; | |
54 | ||
55 | } |