| 1 | package de.uka.ipd.sdq.pipesandfilters.framework.recorder; |
| 2 | |
| 3 | /** |
| 4 | * This class holds meta data that an aggregation recorder should use to provide |
| 5 | * it's write strategy with initializing meta information. |
| 6 | * |
| 7 | * @author Baum |
| 8 | * |
| 9 | */ |
| 10 | public class AggregationMetaDataInit { |
| 11 | |
| 12 | private int aggregatedMetricIndex; |
| 13 | private boolean isValid; |
| 14 | private String aggregationFunctionName; |
| 15 | private String aggregationFunctionDescription; |
| 16 | |
| 17 | /** |
| 18 | * The constructor of AggregatiomMetaDataInit |
| 19 | * |
| 20 | * @param aggregatedMetricIndex |
| 21 | * The index of the metric that the aggregation is performed on |
| 22 | * in the measurement metric vector. |
| 23 | * |
| 24 | */ |
| 25 | public AggregationMetaDataInit(int aggregatedMetricIndex) { |
| 26 | this.aggregatedMetricIndex = aggregatedMetricIndex; |
| 27 | } |
| 28 | |
| 29 | /** |
| 30 | * Returns the index of the aggregated metric in the measurement metric |
| 31 | * vector. |
| 32 | * |
| 33 | * @return The index of the aggregated metric in the measurement metric. |
| 34 | */ |
| 35 | public int getAggregatedMetricIndex() { |
| 36 | return aggregatedMetricIndex; |
| 37 | } |
| 38 | |
| 39 | /** |
| 40 | * Returns whether the aggregation is valid, i.e. consistent with raw |
| 41 | * measurements. |
| 42 | * |
| 43 | * @return A boolean value indicating whether the aggregation is valid. |
| 44 | */ |
| 45 | public boolean isValid() { |
| 46 | return isValid; |
| 47 | } |
| 48 | |
| 49 | /** |
| 50 | * Sets whether the aggregation is valid, i.e. consistent with raw |
| 51 | * measurements. |
| 52 | * |
| 53 | * @param isValid |
| 54 | * A boolean value indicating whether the aggregation is valid. |
| 55 | */ |
| 56 | public void setValid(boolean isValid) { |
| 57 | this.isValid = isValid; |
| 58 | } |
| 59 | |
| 60 | /** |
| 61 | * Returns the name of the aggregation function. |
| 62 | * |
| 63 | * @return The name of the aggregation function. |
| 64 | */ |
| 65 | public String getAggregationFunctionName() { |
| 66 | return aggregationFunctionName; |
| 67 | } |
| 68 | |
| 69 | /** |
| 70 | * Sets the name of the aggregation function. |
| 71 | * |
| 72 | * @param aggregationFunctionName |
| 73 | * The name of the aggregation function. |
| 74 | */ |
| 75 | public void setAggregationFunctionName(String aggregationFunctionName) { |
| 76 | this.aggregationFunctionName = aggregationFunctionName; |
| 77 | } |
| 78 | |
| 79 | /** |
| 80 | * Returns the description of the aggregation function. |
| 81 | * |
| 82 | * @param aggregationFunctionName |
| 83 | * The description of the aggregation function. |
| 84 | */ |
| 85 | public String getAggregationFunctionDescription() { |
| 86 | return aggregationFunctionDescription; |
| 87 | } |
| 88 | |
| 89 | /** |
| 90 | * Sets the description of the aggregation function. |
| 91 | * |
| 92 | * @param aggregationFunctionDescription |
| 93 | * The description of the aggregation function. |
| 94 | */ |
| 95 | public void setAggregationFunctionDescription( |
| 96 | String aggregationFunctionDescription) { |
| 97 | this.aggregationFunctionDescription = aggregationFunctionDescription; |
| 98 | } |
| 99 | } |