| 1 | package de.uka.ipd.sdq.pipesandfilters.framework; |
| 2 | |
| 3 | import java.util.Vector; |
| 4 | |
| 5 | import de.uka.ipd.sdq.pipesandfilters.framework.recorder.launch.IRecorderConfiguration; |
| 6 | |
| 7 | /** |
| 8 | * The MetaDataInit class is used to provide all recorders with initializing |
| 9 | * meta information. It can be used by the specified WriteStrategy to store |
| 10 | * detailed information about the measurements. |
| 11 | * |
| 12 | * @author Baum |
| 13 | * |
| 14 | */ |
| 15 | public abstract class MetaDataInit { |
| 16 | |
| 17 | /** |
| 18 | * This vector should hold one MeasuredMetric with measurement information |
| 19 | * for each tuple that is inducted to the pipe by the calculators. |
| 20 | */ |
| 21 | private Vector<MeasurementMetric> measuredMetrics; |
| 22 | |
| 23 | /** |
| 24 | * TODO Comment |
| 25 | */ |
| 26 | private IRecorderConfiguration recorderConfiguration; |
| 27 | |
| 28 | /** |
| 29 | * The name of the measured metric. |
| 30 | */ |
| 31 | private String metricName; |
| 32 | |
| 33 | /** |
| 34 | * The name of the measurement. |
| 35 | */ |
| 36 | private String measurementName; |
| 37 | |
| 38 | /** |
| 39 | * The name of the experiment. |
| 40 | */ |
| 41 | private String experimentName; |
| 42 | |
| 43 | /** |
| 44 | * The name of the experiment run. |
| 45 | */ |
| 46 | private String experimentRunName; |
| 47 | |
| 48 | /** |
| 49 | * The id of the model element. |
| 50 | */ |
| 51 | private String modelElementID; |
| 52 | |
| 53 | /** |
| 54 | * The constructor of MetaDataInit |
| 55 | * |
| 56 | * @param measuredMetrics |
| 57 | * A vector of all measured metrics of a calculator. |
| 58 | */ |
| 59 | public MetaDataInit(Vector<MeasurementMetric> measuredMetrics, |
| 60 | IRecorderConfiguration recorderConfiguration) { |
| 61 | if (measuredMetrics.isEmpty()) |
| 62 | throw new IllegalArgumentException( |
| 63 | "Vector of measured objects must not be empty."); |
| 64 | this.measuredMetrics = measuredMetrics; |
| 65 | this.recorderConfiguration = recorderConfiguration; |
| 66 | } |
| 67 | |
| 68 | /** |
| 69 | * The constructor of MetaDataInit |
| 70 | * |
| 71 | * @param measuredMetrics |
| 72 | * A vector of all measured metrics of a calculator. |
| 73 | * @param metricName |
| 74 | * The name of the metric that is measured. |
| 75 | * @param measurementName |
| 76 | * The name of the performed measurement. |
| 77 | * @param experimentName |
| 78 | * The name of the performed experiment. |
| 79 | */ |
| 80 | public MetaDataInit(Vector<MeasurementMetric> measuredMetrics, |
| 81 | IRecorderConfiguration recorderConfiguration, String metricName, |
| 82 | String measurementName, String experimentName) { |
| 83 | this(measuredMetrics, recorderConfiguration); |
| 84 | this.metricName = metricName; |
| 85 | this.measurementName = measurementName; |
| 86 | this.experimentName = experimentName; |
| 87 | } |
| 88 | |
| 89 | /** |
| 90 | * TODO Comment |
| 91 | * |
| 92 | * @return |
| 93 | */ |
| 94 | public IRecorderConfiguration getRecorderConfiguration() { |
| 95 | return recorderConfiguration; |
| 96 | } |
| 97 | |
| 98 | /** |
| 99 | * Returns the name of the metric. |
| 100 | * |
| 101 | * @return The name of the metric. |
| 102 | */ |
| 103 | public String getMetricName() { |
| 104 | return metricName; |
| 105 | } |
| 106 | |
| 107 | /** |
| 108 | * Sets the name of the metric. |
| 109 | * |
| 110 | * @param metricName |
| 111 | * The name of the metric. |
| 112 | */ |
| 113 | public void setMetricName(String metricName) { |
| 114 | this.metricName = metricName; |
| 115 | } |
| 116 | |
| 117 | /** |
| 118 | * Returns the name of the experiment. |
| 119 | * |
| 120 | * @return The name of the experiment. |
| 121 | */ |
| 122 | public String getExperimentName() { |
| 123 | return experimentName; |
| 124 | } |
| 125 | |
| 126 | /** |
| 127 | * Sets the name of the experiment. |
| 128 | * |
| 129 | * @param experimentName |
| 130 | * The name of the experiment. |
| 131 | */ |
| 132 | public void setExperimentName(String experimentName) { |
| 133 | this.experimentName = experimentName; |
| 134 | } |
| 135 | |
| 136 | /** |
| 137 | * Returns the name of the experiment run. |
| 138 | * |
| 139 | * @return The name of the experiment run. |
| 140 | */ |
| 141 | public String getExperimentRunName() { |
| 142 | return experimentRunName; |
| 143 | } |
| 144 | |
| 145 | /** |
| 146 | * Sets the name of the experiment run. |
| 147 | * |
| 148 | * @param experimentRunName |
| 149 | * The name of the experiment run. |
| 150 | */ |
| 151 | public void setExperimentRunName(String experimentRunName) { |
| 152 | this.experimentRunName = experimentRunName; |
| 153 | } |
| 154 | |
| 155 | /** |
| 156 | * Returns the vector of all measured objects. |
| 157 | * |
| 158 | * @return A Vector of measured objects. |
| 159 | */ |
| 160 | public Vector<MeasurementMetric> getMeasuredMetrics() { |
| 161 | return measuredMetrics; |
| 162 | } |
| 163 | |
| 164 | /** |
| 165 | * Sets the vector of measured objects. |
| 166 | * |
| 167 | * @param measuredObjects |
| 168 | * A vector of measured objects. |
| 169 | */ |
| 170 | public void setMeasuredObjects(Vector<MeasurementMetric> measuredMetrics) { |
| 171 | this.measuredMetrics = measuredMetrics; |
| 172 | } |
| 173 | |
| 174 | /** |
| 175 | * Adds a measured object to the vector of measured objects. |
| 176 | * |
| 177 | * @param o |
| 178 | * The measured object to be added. |
| 179 | */ |
| 180 | public void addMeasuredObject(MeasurementMetric o) { |
| 181 | measuredMetrics.add(o); |
| 182 | } |
| 183 | |
| 184 | /** |
| 185 | * Returns the name of the measurement. |
| 186 | * |
| 187 | * @return The name of the measurement. |
| 188 | */ |
| 189 | public String getMeasurementName() { |
| 190 | return measurementName; |
| 191 | } |
| 192 | |
| 193 | /** |
| 194 | * Sets the name of the measurement. |
| 195 | * |
| 196 | * @param measurementName |
| 197 | * The name of the measurement. |
| 198 | */ |
| 199 | public void setMeasurementName(String measurementName) { |
| 200 | this.measurementName = measurementName; |
| 201 | } |
| 202 | |
| 203 | /** |
| 204 | * Sets the model element ID. |
| 205 | * |
| 206 | * @param modelElementID |
| 207 | * The model element ID. |
| 208 | */ |
| 209 | public void setModelElementID(String modelElementID) { |
| 210 | this.modelElementID = modelElementID; |
| 211 | } |
| 212 | |
| 213 | /** |
| 214 | * Returns the ID of the model element. |
| 215 | * |
| 216 | * @return The model element ID. |
| 217 | */ |
| 218 | public String getModelElementID() { |
| 219 | return modelElementID; |
| 220 | } |
| 221 | |
| 222 | } |