Jian Li | b6859e1 | 2016-03-01 09:29:24 -0800 | [diff] [blame] | 1 | /* |
Brian O'Connor | 5ab426f | 2016-04-09 01:19:45 -0700 | [diff] [blame] | 2 | * Copyright 2016-present Open Networking Laboratory |
Jian Li | b6859e1 | 2016-03-01 09:29:24 -0800 | [diff] [blame] | 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | package org.onosproject.ui.chart; |
| 18 | |
Jian Li | 1546882 | 2016-04-15 16:28:11 -0700 | [diff] [blame] | 19 | import com.google.common.collect.Lists; |
Jian Li | b6859e1 | 2016-03-01 09:29:24 -0800 | [diff] [blame] | 20 | import com.google.common.collect.Maps; |
Jian Li | 1546882 | 2016-04-15 16:28:11 -0700 | [diff] [blame] | 21 | import com.google.common.collect.Sets; |
Jian Li | b6859e1 | 2016-03-01 09:29:24 -0800 | [diff] [blame] | 22 | |
| 23 | import java.util.Arrays; |
Jian Li | 1546882 | 2016-04-15 16:28:11 -0700 | [diff] [blame] | 24 | import java.util.List; |
Jian Li | b6859e1 | 2016-03-01 09:29:24 -0800 | [diff] [blame] | 25 | import java.util.Map; |
Jian Li | 1546882 | 2016-04-15 16:28:11 -0700 | [diff] [blame] | 26 | import java.util.Set; |
Jian Li | b6859e1 | 2016-03-01 09:29:24 -0800 | [diff] [blame] | 27 | |
| 28 | import static com.google.common.base.Preconditions.checkArgument; |
| 29 | import static com.google.common.base.Preconditions.checkNotNull; |
| 30 | |
| 31 | /** |
Jian Li | 1546882 | 2016-04-15 16:28:11 -0700 | [diff] [blame] | 32 | * A simple model of time series chart data. |
Jian Li | b6859e1 | 2016-03-01 09:29:24 -0800 | [diff] [blame] | 33 | * |
| 34 | * <p> |
| 35 | * Note that this is not a full MVC type model; the expected usage pattern |
| 36 | * is to create an empty chart, add data points (by consulting the business model), |
| 37 | * and produce the list of data points which contain a label and a set of data |
| 38 | * values for all serials. |
| 39 | */ |
| 40 | public class ChartModel { |
| 41 | |
Jian Li | 1546882 | 2016-04-15 16:28:11 -0700 | [diff] [blame] | 42 | private final Set<String> seriesSet; |
| 43 | private final String[] seriesArray; |
| 44 | private final List<Long> labels = Lists.newArrayList(); |
| 45 | private final List<DataPoint> dataPoints = Lists.newArrayList(); |
Jian Li | b6859e1 | 2016-03-01 09:29:24 -0800 | [diff] [blame] | 46 | |
| 47 | /** |
| 48 | * Constructs a chart model with initialized series set. |
| 49 | * |
Jian Li | b6859e1 | 2016-03-01 09:29:24 -0800 | [diff] [blame] | 50 | * @param series a set of series |
| 51 | */ |
Jian Li | 1546882 | 2016-04-15 16:28:11 -0700 | [diff] [blame] | 52 | public ChartModel(String... series) { |
Jian Li | b6859e1 | 2016-03-01 09:29:24 -0800 | [diff] [blame] | 53 | checkNotNull(series, "series cannot be null"); |
| 54 | checkArgument(series.length > 0, "must be at least one series"); |
Jian Li | b6859e1 | 2016-03-01 09:29:24 -0800 | [diff] [blame] | 55 | |
Jian Li | 1546882 | 2016-04-15 16:28:11 -0700 | [diff] [blame] | 56 | seriesSet = Sets.newHashSet(series); |
| 57 | |
| 58 | if (seriesSet.size() != series.length) { |
| 59 | throw new IllegalArgumentException("duplicate series detected"); |
Jian Li | b6859e1 | 2016-03-01 09:29:24 -0800 | [diff] [blame] | 60 | } |
| 61 | |
Jian Li | 1546882 | 2016-04-15 16:28:11 -0700 | [diff] [blame] | 62 | this.seriesArray = Arrays.copyOf(series, series.length); |
Jian Li | b6859e1 | 2016-03-01 09:29:24 -0800 | [diff] [blame] | 63 | } |
| 64 | |
| 65 | private void checkDataPoint(DataPoint dataPoint) { |
Jian Li | 1546882 | 2016-04-15 16:28:11 -0700 | [diff] [blame] | 66 | checkArgument(dataPoint.size() == seriesCount(), |
Jian Li | b6859e1 | 2016-03-01 09:29:24 -0800 | [diff] [blame] | 67 | "data size should be equal to number of series"); |
| 68 | } |
| 69 | |
| 70 | /** |
Jian Li | 1546882 | 2016-04-15 16:28:11 -0700 | [diff] [blame] | 71 | * Checks the validity of the given series. |
| 72 | * |
| 73 | * @param series series name |
| 74 | */ |
| 75 | private void checkSeries(String series) { |
| 76 | checkNotNull(series, "must provide a series name"); |
| 77 | if (!seriesSet.contains(series)) { |
| 78 | throw new IllegalArgumentException("unknown series: " + series); |
| 79 | } |
| 80 | } |
| 81 | |
| 82 | /** |
Jian Li | b6859e1 | 2016-03-01 09:29:24 -0800 | [diff] [blame] | 83 | * Returns the number of series in this chart model. |
| 84 | * |
| 85 | * @return number of series |
| 86 | */ |
| 87 | public int seriesCount() { |
Jian Li | 1546882 | 2016-04-15 16:28:11 -0700 | [diff] [blame] | 88 | return seriesSet.size(); |
Jian Li | b6859e1 | 2016-03-01 09:29:24 -0800 | [diff] [blame] | 89 | } |
| 90 | |
| 91 | /** |
Jian Li | 1546882 | 2016-04-15 16:28:11 -0700 | [diff] [blame] | 92 | * Adds a data point to the chart model. |
Jian Li | b6859e1 | 2016-03-01 09:29:24 -0800 | [diff] [blame] | 93 | * |
Jian Li | 1546882 | 2016-04-15 16:28:11 -0700 | [diff] [blame] | 94 | * @return the data point, for chaining |
Jian Li | b6859e1 | 2016-03-01 09:29:24 -0800 | [diff] [blame] | 95 | */ |
Jian Li | 1546882 | 2016-04-15 16:28:11 -0700 | [diff] [blame] | 96 | public DataPoint addDataPoint(Long label) { |
| 97 | DataPoint dp = new DataPoint(); |
| 98 | labels.add(label); |
| 99 | dataPoints.add(dp); |
| 100 | return dp; |
Jian Li | b6859e1 | 2016-03-01 09:29:24 -0800 | [diff] [blame] | 101 | } |
| 102 | |
| 103 | /** |
| 104 | * Returns all of series. |
| 105 | * |
| 106 | * @return an array of series |
| 107 | */ |
| 108 | public String[] getSeries() { |
Jian Li | 1546882 | 2016-04-15 16:28:11 -0700 | [diff] [blame] | 109 | return seriesArray; |
Jian Li | b6859e1 | 2016-03-01 09:29:24 -0800 | [diff] [blame] | 110 | } |
| 111 | |
| 112 | /** |
Jian Li | 1546882 | 2016-04-15 16:28:11 -0700 | [diff] [blame] | 113 | * Returns all of data points in order. |
Jian Li | b6859e1 | 2016-03-01 09:29:24 -0800 | [diff] [blame] | 114 | * |
| 115 | * @return an array of data points |
| 116 | */ |
| 117 | public DataPoint[] getDataPoints() { |
Jian Li | 1546882 | 2016-04-15 16:28:11 -0700 | [diff] [blame] | 118 | return dataPoints.toArray(new DataPoint[dataPoints.size()]); |
| 119 | } |
| 120 | |
| 121 | /** |
| 122 | * Returns all of labels in order. |
| 123 | * |
| 124 | * @return an array of labels |
| 125 | */ |
| 126 | public Object[] getLabels() { |
| 127 | return labels.toArray(new Long[labels.size()]); |
| 128 | } |
| 129 | |
| 130 | /** |
| 131 | * Returns the number of data points in this chart model. |
| 132 | * |
| 133 | * @return number of data points |
| 134 | */ |
| 135 | public int dataPointCount() { |
| 136 | return dataPoints.size(); |
Jian Li | b6859e1 | 2016-03-01 09:29:24 -0800 | [diff] [blame] | 137 | } |
| 138 | |
| 139 | /** |
| 140 | * Returns the last element inside all of data points. |
| 141 | * |
| 142 | * @return data point |
| 143 | */ |
| 144 | public DataPoint getLastDataPoint() { |
Jian Li | 1546882 | 2016-04-15 16:28:11 -0700 | [diff] [blame] | 145 | return dataPoints.get(dataPoints.size() - 1); |
Jian Li | b6859e1 | 2016-03-01 09:29:24 -0800 | [diff] [blame] | 146 | } |
| 147 | |
| 148 | /** |
| 149 | * A class of data point. |
| 150 | */ |
| 151 | public class DataPoint { |
| 152 | // values for all series |
Jian Li | 1546882 | 2016-04-15 16:28:11 -0700 | [diff] [blame] | 153 | private final Map<String, Double> data = Maps.newHashMap(); |
Jian Li | b6859e1 | 2016-03-01 09:29:24 -0800 | [diff] [blame] | 154 | |
| 155 | /** |
Jian Li | 1546882 | 2016-04-15 16:28:11 -0700 | [diff] [blame] | 156 | * Sets the data value for the given series of this data point. |
Jian Li | b6859e1 | 2016-03-01 09:29:24 -0800 | [diff] [blame] | 157 | * |
Jian Li | 1546882 | 2016-04-15 16:28:11 -0700 | [diff] [blame] | 158 | * @param series series name |
| 159 | * @param value value to set |
| 160 | * @return self, for chaining |
Jian Li | b6859e1 | 2016-03-01 09:29:24 -0800 | [diff] [blame] | 161 | */ |
Jian Li | 1546882 | 2016-04-15 16:28:11 -0700 | [diff] [blame] | 162 | public DataPoint data(String series, Double value) { |
| 163 | checkSeries(series); |
| 164 | data.put(series, value); |
| 165 | return this; |
Jian Li | b6859e1 | 2016-03-01 09:29:24 -0800 | [diff] [blame] | 166 | } |
| 167 | |
| 168 | /** |
Jian Li | 1546882 | 2016-04-15 16:28:11 -0700 | [diff] [blame] | 169 | * Returns the data value with the given series for this data point. |
Jian Li | b6859e1 | 2016-03-01 09:29:24 -0800 | [diff] [blame] | 170 | * |
Jian Li | 1546882 | 2016-04-15 16:28:11 -0700 | [diff] [blame] | 171 | * @return data value |
Jian Li | b6859e1 | 2016-03-01 09:29:24 -0800 | [diff] [blame] | 172 | */ |
Jian Li | 1546882 | 2016-04-15 16:28:11 -0700 | [diff] [blame] | 173 | public Double get(String series) { |
| 174 | return data.get(series); |
| 175 | } |
| 176 | |
| 177 | /** |
| 178 | * Return the data value with the same order of series. |
| 179 | * |
| 180 | * @return an array of ordered data values |
| 181 | */ |
| 182 | public Double[] getAll() { |
| 183 | Double[] value = new Double[getSeries().length]; |
| 184 | int idx = 0; |
| 185 | for (String s : getSeries()) { |
| 186 | value[idx] = get(s); |
| 187 | idx++; |
| 188 | } |
| 189 | return value; |
Jian Li | b6859e1 | 2016-03-01 09:29:24 -0800 | [diff] [blame] | 190 | } |
| 191 | |
| 192 | /** |
| 193 | * Returns the size of data point. |
Jian Li | b6859e1 | 2016-03-01 09:29:24 -0800 | [diff] [blame] | 194 | * |
Jian Li | 1546882 | 2016-04-15 16:28:11 -0700 | [diff] [blame] | 195 | * @return the size of data point |
Jian Li | b6859e1 | 2016-03-01 09:29:24 -0800 | [diff] [blame] | 196 | */ |
Jian Li | 1546882 | 2016-04-15 16:28:11 -0700 | [diff] [blame] | 197 | public int size() { |
| 198 | return data.size(); |
Jian Li | b6859e1 | 2016-03-01 09:29:24 -0800 | [diff] [blame] | 199 | } |
| 200 | } |
| 201 | } |