Simon Hunt | 5f6dbf8 | 2016-03-30 08:53:33 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | 5ab426f | 2016-04-09 01:19:45 -0700 | [diff] [blame] | 2 | * Copyright 2016-present Open Networking Laboratory |
Simon Hunt | 5f6dbf8 | 2016-03-30 08:53:33 -0700 | [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.model.topo; |
| 18 | |
Simon Hunt | 58a0dd0 | 2016-05-17 11:54:23 -0700 | [diff] [blame] | 19 | import com.google.common.collect.ImmutableSet; |
Simon Hunt | c0f20c1 | 2016-05-09 09:30:20 -0700 | [diff] [blame] | 20 | import org.onosproject.net.DeviceId; |
| 21 | import org.onosproject.net.HostId; |
Simon Hunt | 23fb135 | 2016-04-11 12:15:19 -0700 | [diff] [blame] | 22 | import org.onosproject.net.region.Region; |
Simon Hunt | 642bc45 | 2016-05-04 19:34:45 -0700 | [diff] [blame] | 23 | import org.onosproject.net.region.RegionId; |
Simon Hunt | 23fb135 | 2016-04-11 12:15:19 -0700 | [diff] [blame] | 24 | |
Simon Hunt | d5b9673 | 2016-07-08 13:22:27 -0700 | [diff] [blame] | 25 | import java.util.ArrayList; |
| 26 | import java.util.Collections; |
Simon Hunt | c0f20c1 | 2016-05-09 09:30:20 -0700 | [diff] [blame] | 27 | import java.util.HashSet; |
Simon Hunt | d5b9673 | 2016-07-08 13:22:27 -0700 | [diff] [blame] | 28 | import java.util.List; |
Simon Hunt | 23fb135 | 2016-04-11 12:15:19 -0700 | [diff] [blame] | 29 | import java.util.Set; |
Simon Hunt | c0f20c1 | 2016-05-09 09:30:20 -0700 | [diff] [blame] | 30 | |
| 31 | import static com.google.common.base.MoreObjects.toStringHelper; |
Simon Hunt | f836a87 | 2016-08-10 17:37:36 -0700 | [diff] [blame] | 32 | import static com.google.common.base.Strings.isNullOrEmpty; |
Simon Hunt | b1ce260 | 2016-07-23 14:04:31 -0700 | [diff] [blame] | 33 | import static org.onosproject.net.region.RegionId.regionId; |
Simon Hunt | 23fb135 | 2016-04-11 12:15:19 -0700 | [diff] [blame] | 34 | |
Simon Hunt | 5f6dbf8 | 2016-03-30 08:53:33 -0700 | [diff] [blame] | 35 | /** |
| 36 | * Represents a region. |
| 37 | */ |
| 38 | public class UiRegion extends UiNode { |
Simon Hunt | 23fb135 | 2016-04-11 12:15:19 -0700 | [diff] [blame] | 39 | |
Simon Hunt | f836a87 | 2016-08-10 17:37:36 -0700 | [diff] [blame] | 40 | private static final String NULL_NAME = "(root)"; |
| 41 | private static final String NO_NAME = "???"; |
Simon Hunt | b1ce260 | 2016-07-23 14:04:31 -0700 | [diff] [blame] | 42 | |
| 43 | /** |
| 44 | * The identifier for the null-region. That is, a container for devices, |
| 45 | * hosts, and links for those that belong to no region. |
| 46 | */ |
| 47 | public static final RegionId NULL_ID = regionId(NULL_NAME); |
| 48 | |
| 49 | private static final String[] DEFAULT_LAYER_TAGS = { |
| 50 | UiNode.LAYER_OPTICAL, |
| 51 | UiNode.LAYER_PACKET, |
| 52 | UiNode.LAYER_DEFAULT |
| 53 | }; |
| 54 | |
Simon Hunt | c0f20c1 | 2016-05-09 09:30:20 -0700 | [diff] [blame] | 55 | // loose bindings to things in this region |
| 56 | private final Set<DeviceId> deviceIds = new HashSet<>(); |
| 57 | private final Set<HostId> hostIds = new HashSet<>(); |
Simon Hunt | 23fb135 | 2016-04-11 12:15:19 -0700 | [diff] [blame] | 58 | |
Simon Hunt | d5b9673 | 2016-07-08 13:22:27 -0700 | [diff] [blame] | 59 | private final List<String> layerOrder = new ArrayList<>(); |
| 60 | |
Simon Hunt | c0f20c1 | 2016-05-09 09:30:20 -0700 | [diff] [blame] | 61 | private final UiTopology topology; |
Simon Hunt | 23fb135 | 2016-04-11 12:15:19 -0700 | [diff] [blame] | 62 | |
Simon Hunt | c0f20c1 | 2016-05-09 09:30:20 -0700 | [diff] [blame] | 63 | private final Region region; |
| 64 | |
Simon Hunt | 4f4ffc3 | 2016-08-03 18:30:47 -0700 | [diff] [blame] | 65 | // keep track of hierarchy (inferred from UiTopoLayoutService) |
| 66 | private RegionId parent; |
| 67 | private final Set<RegionId> kids = new HashSet<>(); |
| 68 | |
Simon Hunt | c0f20c1 | 2016-05-09 09:30:20 -0700 | [diff] [blame] | 69 | /** |
| 70 | * Constructs a UI region, with a reference to the specified backing region. |
| 71 | * |
| 72 | * @param topology parent topology |
| 73 | * @param region backing region |
| 74 | */ |
| 75 | public UiRegion(UiTopology topology, Region region) { |
Simon Hunt | b1ce260 | 2016-07-23 14:04:31 -0700 | [diff] [blame] | 76 | // Implementation Note: if region is null, this UiRegion is being used |
| 77 | // as a container for devices, hosts, links that belong to no region. |
Simon Hunt | c0f20c1 | 2016-05-09 09:30:20 -0700 | [diff] [blame] | 78 | this.topology = topology; |
| 79 | this.region = region; |
Simon Hunt | b1ce260 | 2016-07-23 14:04:31 -0700 | [diff] [blame] | 80 | |
| 81 | setLayerOrder(DEFAULT_LAYER_TAGS); |
Simon Hunt | c0f20c1 | 2016-05-09 09:30:20 -0700 | [diff] [blame] | 82 | } |
Simon Hunt | 23fb135 | 2016-04-11 12:15:19 -0700 | [diff] [blame] | 83 | |
| 84 | @Override |
| 85 | protected void destroy() { |
Simon Hunt | c0f20c1 | 2016-05-09 09:30:20 -0700 | [diff] [blame] | 86 | deviceIds.clear(); |
| 87 | hostIds.clear(); |
Simon Hunt | 23fb135 | 2016-04-11 12:15:19 -0700 | [diff] [blame] | 88 | } |
| 89 | |
Simon Hunt | 642bc45 | 2016-05-04 19:34:45 -0700 | [diff] [blame] | 90 | /** |
Simon Hunt | d5b9673 | 2016-07-08 13:22:27 -0700 | [diff] [blame] | 91 | * Sets the layer order for this region. |
| 92 | * Typically, the {@code UiNode.LAYER_*} constants will be used here. |
| 93 | * |
| 94 | * @param layers the layers |
| 95 | */ |
| 96 | public void setLayerOrder(String... layers) { |
| 97 | layerOrder.clear(); |
| 98 | Collections.addAll(layerOrder, layers); |
| 99 | } |
| 100 | |
| 101 | /** |
Simon Hunt | 642bc45 | 2016-05-04 19:34:45 -0700 | [diff] [blame] | 102 | * Returns the identity of the region. |
| 103 | * |
| 104 | * @return region ID |
| 105 | */ |
| 106 | public RegionId id() { |
Simon Hunt | b1ce260 | 2016-07-23 14:04:31 -0700 | [diff] [blame] | 107 | return region == null ? NULL_ID : region.id(); |
Simon Hunt | 642bc45 | 2016-05-04 19:34:45 -0700 | [diff] [blame] | 108 | } |
| 109 | |
Simon Hunt | 4f4ffc3 | 2016-08-03 18:30:47 -0700 | [diff] [blame] | 110 | /** |
| 111 | * Returns the identity of the parent region. |
| 112 | * |
| 113 | * @return parent region ID |
| 114 | */ |
| 115 | public RegionId parent() { |
| 116 | return parent; |
| 117 | } |
| 118 | |
| 119 | /** |
| 120 | * Returns true if this is the root (default) region. |
| 121 | * |
| 122 | * @return true if root region |
| 123 | */ |
| 124 | public boolean isRoot() { |
| 125 | return id().equals(parent); |
| 126 | } |
| 127 | |
| 128 | /** |
| 129 | * Returns the identities of the child regions. |
| 130 | * |
| 131 | * @return child region IDs |
| 132 | */ |
| 133 | public Set<RegionId> children() { |
| 134 | return ImmutableSet.copyOf(kids); |
| 135 | } |
| 136 | |
| 137 | /** |
Simon Hunt | c13082f | 2016-08-03 21:20:23 -0700 | [diff] [blame] | 138 | * Returns the UI region that is the parent of this region. |
| 139 | * |
| 140 | * @return the parent region |
| 141 | */ |
| 142 | public UiRegion parentRegion() { |
| 143 | return topology.findRegion(parent); |
| 144 | } |
| 145 | |
| 146 | /** |
Simon Hunt | 4f4ffc3 | 2016-08-03 18:30:47 -0700 | [diff] [blame] | 147 | * Sets the parent ID for this region. |
| 148 | * |
| 149 | * @param parentId parent ID |
| 150 | */ |
| 151 | public void setParent(RegionId parentId) { |
| 152 | parent = parentId; |
| 153 | } |
| 154 | |
| 155 | /** |
| 156 | * Sets the children IDs for this region. |
| 157 | * |
| 158 | * @param children children IDs |
| 159 | */ |
| 160 | public void setChildren(Set<RegionId> children) { |
| 161 | kids.clear(); |
| 162 | kids.addAll(children); |
| 163 | } |
| 164 | |
Simon Hunt | 642bc45 | 2016-05-04 19:34:45 -0700 | [diff] [blame] | 165 | @Override |
| 166 | public String idAsString() { |
| 167 | return id().toString(); |
| 168 | } |
Simon Hunt | c0f20c1 | 2016-05-09 09:30:20 -0700 | [diff] [blame] | 169 | |
| 170 | @Override |
| 171 | public String name() { |
Simon Hunt | b1ce260 | 2016-07-23 14:04:31 -0700 | [diff] [blame] | 172 | return region == null ? NULL_NAME : region.name(); |
Simon Hunt | c0f20c1 | 2016-05-09 09:30:20 -0700 | [diff] [blame] | 173 | } |
| 174 | |
| 175 | /** |
Simon Hunt | b1ce260 | 2016-07-23 14:04:31 -0700 | [diff] [blame] | 176 | * Returns the region instance backing this UI region. If this instance |
| 177 | * represents the "null-region", the value returned will be null. |
Simon Hunt | c0f20c1 | 2016-05-09 09:30:20 -0700 | [diff] [blame] | 178 | * |
| 179 | * @return the backing region instance |
| 180 | */ |
| 181 | public Region backingRegion() { |
| 182 | return region; |
| 183 | } |
| 184 | |
| 185 | /** |
| 186 | * Make sure we have only these devices in the region. |
| 187 | * |
| 188 | * @param devices devices in the region |
| 189 | */ |
| 190 | public void reconcileDevices(Set<DeviceId> devices) { |
| 191 | deviceIds.clear(); |
| 192 | deviceIds.addAll(devices); |
| 193 | } |
| 194 | |
| 195 | @Override |
| 196 | public String toString() { |
| 197 | return toStringHelper(this) |
| 198 | .add("id", id()) |
| 199 | .add("name", name()) |
Simon Hunt | 4f4ffc3 | 2016-08-03 18:30:47 -0700 | [diff] [blame] | 200 | .add("parent", parent) |
| 201 | .add("kids", kids) |
Simon Hunt | c0f20c1 | 2016-05-09 09:30:20 -0700 | [diff] [blame] | 202 | .add("devices", deviceIds) |
| 203 | .add("#hosts", hostIds.size()) |
Simon Hunt | c0f20c1 | 2016-05-09 09:30:20 -0700 | [diff] [blame] | 204 | .toString(); |
| 205 | } |
| 206 | |
| 207 | /** |
| 208 | * Returns the region's type. |
| 209 | * |
| 210 | * @return region type |
| 211 | */ |
| 212 | public Region.Type type() { |
Simon Hunt | b1ce260 | 2016-07-23 14:04:31 -0700 | [diff] [blame] | 213 | return region == null ? null : region.type(); |
| 214 | } |
| 215 | |
| 216 | |
| 217 | /** |
| 218 | * Returns the count of devices in this region. |
| 219 | * |
| 220 | * @return the device count |
| 221 | */ |
| 222 | public int deviceCount() { |
| 223 | return deviceIds.size(); |
Simon Hunt | c0f20c1 | 2016-05-09 09:30:20 -0700 | [diff] [blame] | 224 | } |
| 225 | |
| 226 | /** |
Simon Hunt | 58a0dd0 | 2016-05-17 11:54:23 -0700 | [diff] [blame] | 227 | * Returns the set of device identifiers for this region. |
| 228 | * |
| 229 | * @return device identifiers for this region |
| 230 | */ |
| 231 | public Set<DeviceId> deviceIds() { |
| 232 | return ImmutableSet.copyOf(deviceIds); |
| 233 | } |
| 234 | |
| 235 | /** |
Simon Hunt | c0f20c1 | 2016-05-09 09:30:20 -0700 | [diff] [blame] | 236 | * Returns the devices in this region. |
| 237 | * |
| 238 | * @return the devices in this region |
| 239 | */ |
| 240 | public Set<UiDevice> devices() { |
| 241 | return topology.deviceSet(deviceIds); |
| 242 | } |
| 243 | |
Steven Burrows | 19e6e4f | 2016-10-05 13:27:07 -0500 | [diff] [blame] | 244 | |
| 245 | /** |
| 246 | * Make sure we have only these hosts in the region. |
| 247 | * |
| 248 | * @param hosts hosts in the region |
| 249 | */ |
| 250 | public void reconcileHosts(Set<HostId> hosts) { |
| 251 | hostIds.clear(); |
| 252 | hostIds.addAll(hosts); |
| 253 | } |
| 254 | |
Simon Hunt | c0f20c1 | 2016-05-09 09:30:20 -0700 | [diff] [blame] | 255 | /** |
Simon Hunt | 58a0dd0 | 2016-05-17 11:54:23 -0700 | [diff] [blame] | 256 | * Returns the set of host identifiers for this region. |
| 257 | * |
| 258 | * @return host identifiers for this region |
| 259 | */ |
| 260 | public Set<HostId> hostIds() { |
| 261 | return ImmutableSet.copyOf(hostIds); |
| 262 | } |
| 263 | |
| 264 | /** |
Simon Hunt | c0f20c1 | 2016-05-09 09:30:20 -0700 | [diff] [blame] | 265 | * Returns the hosts in this region. |
| 266 | * |
| 267 | * @return the hosts in this region |
| 268 | */ |
| 269 | public Set<UiHost> hosts() { |
| 270 | return topology.hostSet(hostIds); |
| 271 | } |
| 272 | |
| 273 | /** |
Steven Burrows | 19e6e4f | 2016-10-05 13:27:07 -0500 | [diff] [blame] | 274 | * Returns the count of devices in this region. |
| 275 | * |
| 276 | * @return the device count |
| 277 | */ |
| 278 | public int hostCount() { |
| 279 | return hostIds.size(); |
| 280 | } |
| 281 | |
| 282 | /** |
Simon Hunt | d5b9673 | 2016-07-08 13:22:27 -0700 | [diff] [blame] | 283 | * Returns the order in which layers should be rendered. Lower layers |
| 284 | * come earlier in the list. For example, to indicate that nodes in the |
| 285 | * optical layer should be rendered "below" nodes in the packet layer, |
| 286 | * this method should return: |
| 287 | * <pre> |
Simon Hunt | b1ce260 | 2016-07-23 14:04:31 -0700 | [diff] [blame] | 288 | * [UiNode.LAYER_OPTICAL, UiNode.LAYER_PACKET, UiNode.LAYER_DEFAULT] |
Simon Hunt | d5b9673 | 2016-07-08 13:22:27 -0700 | [diff] [blame] | 289 | * </pre> |
| 290 | * |
| 291 | * @return layer ordering |
| 292 | */ |
| 293 | public List<String> layerOrder() { |
| 294 | return Collections.unmodifiableList(layerOrder); |
| 295 | } |
Simon Hunt | f836a87 | 2016-08-10 17:37:36 -0700 | [diff] [blame] | 296 | |
| 297 | /** |
| 298 | * Guarantees to return a string for the name of the specified region. |
| 299 | * If region is null, we return the null region name, else we return |
| 300 | * the name as configured on the region. |
| 301 | * |
| 302 | * @param region the region whose name we require |
| 303 | * @return the region's name |
| 304 | */ |
| 305 | public static String safeName(Region region) { |
| 306 | if (region == null) { |
| 307 | return NULL_NAME; |
| 308 | } |
| 309 | String name = region.name(); |
| 310 | return isNullOrEmpty(name) ? NO_NAME : name; |
| 311 | } |
Simon Hunt | 5f6dbf8 | 2016-03-30 08:53:33 -0700 | [diff] [blame] | 312 | } |