1 | // Copyright 2012 Georg-August-Universität Göttingen, Germany |
---|
2 | // |
---|
3 | // Licensed under the Apache License, Version 2.0 (the "License"); |
---|
4 | // you may not use this file except in compliance with the License. |
---|
5 | // You may obtain a copy of the License at |
---|
6 | // |
---|
7 | // http://www.apache.org/licenses/LICENSE-2.0 |
---|
8 | // |
---|
9 | // Unless required by applicable law or agreed to in writing, software |
---|
10 | // distributed under the License is distributed on an "AS IS" BASIS, |
---|
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
---|
12 | // See the License for the specific language governing permissions and |
---|
13 | // limitations under the License. |
---|
14 | |
---|
15 | package de.ugoe.cs.autoquest.tasktrees.treeifc; |
---|
16 | |
---|
17 | // TODO: Auto-generated Javadoc |
---|
18 | /** |
---|
19 | * <p> |
---|
20 | * Provides extended information about a specific task, such as statistics about |
---|
21 | * task occurrences, etc. It contains measures for different metrics determined |
---|
22 | * for a task. |
---|
23 | * </p> |
---|
24 | * |
---|
25 | * @author Patrick Harms |
---|
26 | */ |
---|
27 | public interface ITaskInfo { |
---|
28 | |
---|
29 | /** |
---|
30 | * <p> |
---|
31 | * represents a measure for a specific metric |
---|
32 | * </p>. |
---|
33 | * |
---|
34 | * @author Patrick Harms |
---|
35 | */ |
---|
36 | public interface IMeasure { |
---|
37 | |
---|
38 | /** |
---|
39 | * <p> |
---|
40 | * returns the metric of the measure |
---|
41 | * </p>. |
---|
42 | * |
---|
43 | * @return as described |
---|
44 | */ |
---|
45 | public TaskMetric getMetric(); |
---|
46 | |
---|
47 | /** |
---|
48 | * <p> |
---|
49 | * returns the value of the measure |
---|
50 | * </p>. |
---|
51 | * |
---|
52 | * @return as described |
---|
53 | */ |
---|
54 | public int getValue(); |
---|
55 | |
---|
56 | /** |
---|
57 | * <p> |
---|
58 | * returns the value of the measure if the task was observed in a |
---|
59 | * specific context, i.e. parent task |
---|
60 | * </p> |
---|
61 | * |
---|
62 | * @param context the context |
---|
63 | * @return as described |
---|
64 | */ |
---|
65 | public int getValue(ITask context); |
---|
66 | |
---|
67 | } |
---|
68 | |
---|
69 | /** |
---|
70 | * <p> |
---|
71 | * returns all available measures |
---|
72 | * </p>. |
---|
73 | * |
---|
74 | * @return as described |
---|
75 | */ |
---|
76 | public IMeasure[] getMeasures(); |
---|
77 | |
---|
78 | /** |
---|
79 | * <p> |
---|
80 | * returns the value of the measure identified through the given metric |
---|
81 | * </p>. |
---|
82 | * |
---|
83 | * @param metric the metric for which the value is to be returned |
---|
84 | * @return as described |
---|
85 | */ |
---|
86 | public int getMeasureValue(TaskMetric metric); |
---|
87 | |
---|
88 | /** |
---|
89 | * <p> |
---|
90 | * returns the value of the measure identified through the given metric if |
---|
91 | * the task is observed in the given context, i.e. parent task. The result |
---|
92 | * is Integer.MIN_VALUE if there is no value for this measure in a context. |
---|
93 | * </p> |
---|
94 | * |
---|
95 | * @param metric |
---|
96 | * the metric for which the value is to be returned |
---|
97 | * @param context |
---|
98 | * the context for which the measure value is to be returned |
---|
99 | * |
---|
100 | * @return as described |
---|
101 | */ |
---|
102 | public int getMeasureValue(TaskMetric metric, ITask context); |
---|
103 | |
---|
104 | /** |
---|
105 | * <p> |
---|
106 | * returns the task to which these infos belong |
---|
107 | * </p>. |
---|
108 | * |
---|
109 | * @return as described |
---|
110 | */ |
---|
111 | public ITask getTask(); |
---|
112 | |
---|
113 | } |
---|