Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
Expression |
|
| 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 "Expression.java". Description: | |
10 | "Expressions used for validation rules" | |
11 | ||
12 | The Initial Developer of the Original Code is University Health Network. Copyright (C) | |
13 | 2012. 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 | package ca.uhn.hl7v2.validation.builder; | |
27 | ||
28 | ||
29 | import ca.uhn.hl7v2.HL7Exception; | |
30 | import ca.uhn.hl7v2.Location; | |
31 | import ca.uhn.hl7v2.model.Structure; | |
32 | ||
33 | /** | |
34 | * Expression used to obtain values from a message structure | |
35 | * | |
36 | * @param <T> | |
37 | */ | |
38 | public interface Expression<T extends Structure> { | |
39 | ||
40 | /** | |
41 | * Applies this expression on the structure | |
42 | * | |
43 | * @param structure HL7 structure to be evaluated | |
44 | * @return the result value | |
45 | * @throws HL7Exception | |
46 | */ | |
47 | Object evaluate(T structure) throws HL7Exception; | |
48 | ||
49 | /** | |
50 | * Returns the expression description used for describing the Rule this expression | |
51 | * is used in. | |
52 | * | |
53 | * @return description | |
54 | */ | |
55 | String getDescription(); | |
56 | ||
57 | /** | |
58 | * Returns the location of the structure to which is expression is applied to | |
59 | * | |
60 | * @param structure HL7 structure to be located | |
61 | * @return the location of the structure | |
62 | * @throws HL7Exception if the structure refers to an invalid location | |
63 | */ | |
64 | Location getLocation(T structure) throws HL7Exception; | |
65 | } |