Vinod Kumar S | 2ff139c | 2016-02-16 01:37:16 +0530 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2016 Open Networking Laboratory |
| 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 | package org.onosproject.yangutils.datamodel; |
| 17 | |
Vinod Kumar S | 2ff139c | 2016-02-16 01:37:16 +0530 | [diff] [blame] | 18 | import org.onosproject.yangutils.datamodel.exceptions.DataModelException; |
| 19 | import org.onosproject.yangutils.parser.Parsable; |
Bharat saraswal | 594bc6d | 2016-02-22 22:15:21 +0530 | [diff] [blame] | 20 | import org.onosproject.yangutils.translator.CachedFileHandle; |
Gaurav Agrawal | 8e8770a | 2016-02-27 03:57:50 +0530 | [diff] [blame] | 21 | import org.onosproject.yangutils.utils.YangConstructType; |
| 22 | import static org.onosproject.yangutils.utils.YangConstructType.CHOICE_DATA; |
Vinod Kumar S | 2ff139c | 2016-02-16 01:37:16 +0530 | [diff] [blame] | 23 | |
| 24 | /*- |
| 25 | * Reference RFC 6020. |
| 26 | * |
| 27 | * The "choice" statement defines a set of alternatives, only one of |
| 28 | * which may exist at any one time. The argument is an identifier, |
| 29 | * followed by a block of sub-statements that holds detailed choice |
| 30 | * information. The identifier is used to identify the choice node in |
| 31 | * the schema tree. A choice node does not exist in the data tree. |
| 32 | * |
| 33 | * A choice consists of a number of branches, defined with the "case" |
| 34 | * sub-statement. Each branch contains a number of child nodes. The |
| 35 | * nodes from at most one of the choice's branches exist at the same |
| 36 | * time. |
| 37 | * |
| 38 | * The choice's sub-statements |
| 39 | * |
| 40 | * +--------------+---------+-------------+------------------+ |
| 41 | * | substatement | section | cardinality |data model mapping| |
| 42 | * +--------------+---------+-------------+------------------+ |
| 43 | * | anyxml | 7.10 | 0..n |-not supported | |
| 44 | * | case | 7.9.2 | 0..n |-YangChoice | |
| 45 | * | config | 7.19.1 | 0..1 |-boolean | |
| 46 | * | container | 7.5 | 0..n |-child case nodes | |
| 47 | * | default | 7.9.3 | 0..1 |-string | |
| 48 | * | description | 7.19.3 | 0..1 |-string | |
| 49 | * | if-feature | 7.18.2 | 0..n |-TODO | |
| 50 | * | leaf | 7.6 | 0..n |-child case nodes | |
| 51 | * | leaf-list | 7.7 | 0..n |-child case nodes | |
| 52 | * | list | 7.8 | 0..n |-child case nodes | |
| 53 | * | mandatory | 7.9.4 | 0..1 |-string | |
| 54 | * | reference | 7.19.4 | 0..1 |-string | |
| 55 | * | status | 7.19.2 | 0..1 |-string | |
| 56 | * | when | 7.19.5 | 0..1 |-TODO | |
| 57 | * +--------------+---------+-------------+------------------+ |
| 58 | */ |
| 59 | /** |
| 60 | * Data model node to maintain information defined in YANG choice. |
| 61 | */ |
Gaurav Agrawal | 8e8770a | 2016-02-27 03:57:50 +0530 | [diff] [blame] | 62 | public class YangChoice extends YangNode implements YangCommonInfo, Parsable, CollisionDetector { |
Vinod Kumar S | 2ff139c | 2016-02-16 01:37:16 +0530 | [diff] [blame] | 63 | |
| 64 | /** |
| 65 | * Name of choice. |
| 66 | */ |
| 67 | private String name; |
| 68 | |
| 69 | /** |
Vinod Kumar S | 2ff139c | 2016-02-16 01:37:16 +0530 | [diff] [blame] | 70 | * If the choice represents config data. |
| 71 | */ |
| 72 | private boolean isConfig; |
| 73 | |
| 74 | /** |
| 75 | * Reference RFC 6020. |
| 76 | * |
| 77 | * The "default" statement indicates if a case should be considered as the |
| 78 | * default if no child nodes from any of the choice's cases exist. The |
| 79 | * argument is the identifier of the "case" statement. If the "default" |
| 80 | * statement is missing, there is no default case. |
| 81 | * |
| 82 | * The "default" statement MUST NOT be present on choices where "mandatory" |
| 83 | * is true. |
| 84 | * |
| 85 | * The default case is only important when considering the default values of |
| 86 | * nodes under the cases. The default values for nodes under the default |
| 87 | * case are used if none of the nodes under any of the cases are present. |
| 88 | * |
| 89 | * There MUST NOT be any mandatory nodes directly under the default case. |
| 90 | * |
| 91 | * Default values for child nodes under a case are only used if one of the |
| 92 | * nodes under that case is present, or if that case is the default case. If |
| 93 | * none of the nodes under a case are present and the case is not the |
| 94 | * default case, the default values of the cases' child nodes are ignored. |
| 95 | * |
| 96 | * the default case to be used if no case members is present. |
| 97 | */ |
| 98 | private String defaultCase; |
| 99 | |
| 100 | /** |
Gaurav Agrawal | 8e8770a | 2016-02-27 03:57:50 +0530 | [diff] [blame] | 101 | * Description of choice. |
Vinod Kumar S | 2ff139c | 2016-02-16 01:37:16 +0530 | [diff] [blame] | 102 | */ |
| 103 | private String description; |
| 104 | |
| 105 | /** |
| 106 | * Reference RFC 6020. |
| 107 | * |
| 108 | * The "mandatory" statement, which is optional, takes as an argument the |
| 109 | * string "true" or "false", and puts a constraint on valid data. If |
| 110 | * "mandatory" is "true", at least one node from exactly one of the choice's |
| 111 | * case branches MUST exist. |
| 112 | * |
| 113 | * If not specified, the default is "false". |
| 114 | * |
| 115 | * The behavior of the constraint depends on the type of the choice's |
| 116 | * closest ancestor node in the schema tree which is not a non-presence |
| 117 | * container: |
| 118 | * |
| 119 | * o If this ancestor is a case node, the constraint is enforced if any |
| 120 | * other node from the case exists. |
| 121 | * |
| 122 | * o Otherwise, it is enforced if the ancestor node exists. |
| 123 | */ |
| 124 | private String mandatory; |
| 125 | |
| 126 | /** |
Gaurav Agrawal | 8e8770a | 2016-02-27 03:57:50 +0530 | [diff] [blame] | 127 | * Reference of the choice. |
Vinod Kumar S | 2ff139c | 2016-02-16 01:37:16 +0530 | [diff] [blame] | 128 | */ |
| 129 | private String reference; |
| 130 | |
| 131 | /** |
| 132 | * Status of the node. |
| 133 | */ |
| 134 | private YangStatusType status; |
| 135 | |
| 136 | /** |
Gaurav Agrawal | 8e8770a | 2016-02-27 03:57:50 +0530 | [diff] [blame] | 137 | * Create a choice node. |
Vinod Kumar S | 2ff139c | 2016-02-16 01:37:16 +0530 | [diff] [blame] | 138 | */ |
| 139 | public YangChoice() { |
| 140 | super(YangNodeType.CHOICE_NODE); |
| 141 | } |
| 142 | |
Vinod Kumar S | 2ff139c | 2016-02-16 01:37:16 +0530 | [diff] [blame] | 143 | @Override |
| 144 | public String getName() { |
| 145 | return name; |
| 146 | } |
| 147 | |
Vinod Kumar S | 2ff139c | 2016-02-16 01:37:16 +0530 | [diff] [blame] | 148 | @Override |
| 149 | public void setName(String name) { |
| 150 | this.name = name; |
| 151 | } |
| 152 | |
| 153 | /** |
Vinod Kumar S | 2ff139c | 2016-02-16 01:37:16 +0530 | [diff] [blame] | 154 | * Get config flag. |
| 155 | * |
Gaurav Agrawal | 8e8770a | 2016-02-27 03:57:50 +0530 | [diff] [blame] | 156 | * @return the config flag |
Vinod Kumar S | 2ff139c | 2016-02-16 01:37:16 +0530 | [diff] [blame] | 157 | */ |
| 158 | public boolean isConfig() { |
| 159 | return isConfig; |
| 160 | } |
| 161 | |
| 162 | /** |
| 163 | * Set config flag. |
| 164 | * |
Gaurav Agrawal | 8e8770a | 2016-02-27 03:57:50 +0530 | [diff] [blame] | 165 | * @param isCfg the config flag |
Vinod Kumar S | 2ff139c | 2016-02-16 01:37:16 +0530 | [diff] [blame] | 166 | */ |
| 167 | public void setConfig(boolean isCfg) { |
| 168 | isConfig = isCfg; |
| 169 | } |
| 170 | |
| 171 | /** |
| 172 | * Get the default case. |
| 173 | * |
Gaurav Agrawal | 8e8770a | 2016-02-27 03:57:50 +0530 | [diff] [blame] | 174 | * @return the default case |
Vinod Kumar S | 2ff139c | 2016-02-16 01:37:16 +0530 | [diff] [blame] | 175 | */ |
| 176 | public String getDefaultCase() { |
| 177 | return defaultCase; |
| 178 | } |
| 179 | |
| 180 | /** |
| 181 | * Set the default case. |
| 182 | * |
| 183 | * @param defaultCase the default case to set |
| 184 | */ |
| 185 | public void setDefaultCase(String defaultCase) { |
| 186 | this.defaultCase = defaultCase; |
| 187 | } |
| 188 | |
| 189 | /** |
| 190 | * Get the mandatory status. |
| 191 | * |
Gaurav Agrawal | 8e8770a | 2016-02-27 03:57:50 +0530 | [diff] [blame] | 192 | * @return the mandatory status |
Vinod Kumar S | 2ff139c | 2016-02-16 01:37:16 +0530 | [diff] [blame] | 193 | */ |
| 194 | public String getMandatory() { |
| 195 | return mandatory; |
| 196 | } |
| 197 | |
| 198 | /** |
| 199 | * Set the mandatory status. |
| 200 | * |
Gaurav Agrawal | 8e8770a | 2016-02-27 03:57:50 +0530 | [diff] [blame] | 201 | * @param mandatory the mandatory status |
Vinod Kumar S | 2ff139c | 2016-02-16 01:37:16 +0530 | [diff] [blame] | 202 | */ |
| 203 | public void setMandatory(String mandatory) { |
| 204 | this.mandatory = mandatory; |
| 205 | } |
| 206 | |
| 207 | /** |
| 208 | * Get the description. |
| 209 | * |
Gaurav Agrawal | 8e8770a | 2016-02-27 03:57:50 +0530 | [diff] [blame] | 210 | * @return the description |
Vinod Kumar S | 2ff139c | 2016-02-16 01:37:16 +0530 | [diff] [blame] | 211 | */ |
Bharat saraswal | 594bc6d | 2016-02-22 22:15:21 +0530 | [diff] [blame] | 212 | @Override |
Vinod Kumar S | 2ff139c | 2016-02-16 01:37:16 +0530 | [diff] [blame] | 213 | public String getDescription() { |
| 214 | return description; |
| 215 | } |
| 216 | |
| 217 | /** |
| 218 | * Set the description. |
| 219 | * |
Gaurav Agrawal | 8e8770a | 2016-02-27 03:57:50 +0530 | [diff] [blame] | 220 | * @param description set the description |
Vinod Kumar S | 2ff139c | 2016-02-16 01:37:16 +0530 | [diff] [blame] | 221 | */ |
Bharat saraswal | 594bc6d | 2016-02-22 22:15:21 +0530 | [diff] [blame] | 222 | @Override |
Vinod Kumar S | 2ff139c | 2016-02-16 01:37:16 +0530 | [diff] [blame] | 223 | public void setDescription(String description) { |
| 224 | this.description = description; |
| 225 | } |
| 226 | |
| 227 | /** |
| 228 | * Get the textual reference. |
| 229 | * |
Gaurav Agrawal | 8e8770a | 2016-02-27 03:57:50 +0530 | [diff] [blame] | 230 | * @return the reference |
Vinod Kumar S | 2ff139c | 2016-02-16 01:37:16 +0530 | [diff] [blame] | 231 | */ |
Bharat saraswal | 594bc6d | 2016-02-22 22:15:21 +0530 | [diff] [blame] | 232 | @Override |
Vinod Kumar S | 2ff139c | 2016-02-16 01:37:16 +0530 | [diff] [blame] | 233 | public String getReference() { |
| 234 | return reference; |
| 235 | } |
| 236 | |
| 237 | /** |
| 238 | * Set the textual reference. |
| 239 | * |
Gaurav Agrawal | 8e8770a | 2016-02-27 03:57:50 +0530 | [diff] [blame] | 240 | * @param reference the reference to set |
Vinod Kumar S | 2ff139c | 2016-02-16 01:37:16 +0530 | [diff] [blame] | 241 | */ |
Bharat saraswal | 594bc6d | 2016-02-22 22:15:21 +0530 | [diff] [blame] | 242 | @Override |
Vinod Kumar S | 2ff139c | 2016-02-16 01:37:16 +0530 | [diff] [blame] | 243 | public void setReference(String reference) { |
| 244 | this.reference = reference; |
| 245 | } |
| 246 | |
| 247 | /** |
| 248 | * Get the status. |
| 249 | * |
Gaurav Agrawal | 8e8770a | 2016-02-27 03:57:50 +0530 | [diff] [blame] | 250 | * @return the status |
Vinod Kumar S | 2ff139c | 2016-02-16 01:37:16 +0530 | [diff] [blame] | 251 | */ |
Bharat saraswal | 594bc6d | 2016-02-22 22:15:21 +0530 | [diff] [blame] | 252 | @Override |
Vinod Kumar S | 2ff139c | 2016-02-16 01:37:16 +0530 | [diff] [blame] | 253 | public YangStatusType getStatus() { |
| 254 | return status; |
| 255 | } |
| 256 | |
| 257 | /** |
| 258 | * Set the status. |
| 259 | * |
Gaurav Agrawal | 8e8770a | 2016-02-27 03:57:50 +0530 | [diff] [blame] | 260 | * @param status the status to set |
Vinod Kumar S | 2ff139c | 2016-02-16 01:37:16 +0530 | [diff] [blame] | 261 | */ |
Bharat saraswal | 594bc6d | 2016-02-22 22:15:21 +0530 | [diff] [blame] | 262 | @Override |
Vinod Kumar S | 2ff139c | 2016-02-16 01:37:16 +0530 | [diff] [blame] | 263 | public void setStatus(YangStatusType status) { |
| 264 | this.status = status; |
| 265 | } |
| 266 | |
| 267 | /** |
| 268 | * Returns the type of the data. |
| 269 | * |
| 270 | * @return returns CHOICE_DATA |
| 271 | */ |
Bharat saraswal | 594bc6d | 2016-02-22 22:15:21 +0530 | [diff] [blame] | 272 | @Override |
Gaurav Agrawal | 8e8770a | 2016-02-27 03:57:50 +0530 | [diff] [blame] | 273 | public YangConstructType getYangConstructType() { |
| 274 | return YangConstructType.CHOICE_DATA; |
Vinod Kumar S | 2ff139c | 2016-02-16 01:37:16 +0530 | [diff] [blame] | 275 | } |
| 276 | |
| 277 | /** |
| 278 | * Validate the data on entering the corresponding parse tree node. |
| 279 | * |
Gaurav Agrawal | 8e8770a | 2016-02-27 03:57:50 +0530 | [diff] [blame] | 280 | * @throws DataModelException a violation of data model rules |
Vinod Kumar S | 2ff139c | 2016-02-16 01:37:16 +0530 | [diff] [blame] | 281 | */ |
Bharat saraswal | 594bc6d | 2016-02-22 22:15:21 +0530 | [diff] [blame] | 282 | @Override |
Vinod Kumar S | 2ff139c | 2016-02-16 01:37:16 +0530 | [diff] [blame] | 283 | public void validateDataOnEntry() throws DataModelException { |
| 284 | // TODO auto-generated method stub, to be implemented by parser |
| 285 | } |
| 286 | |
| 287 | /** |
| 288 | * Validate the data on exiting the corresponding parse tree node. |
| 289 | * |
Gaurav Agrawal | 8e8770a | 2016-02-27 03:57:50 +0530 | [diff] [blame] | 290 | * @throws DataModelException a violation of data model rules |
Vinod Kumar S | 2ff139c | 2016-02-16 01:37:16 +0530 | [diff] [blame] | 291 | */ |
Bharat saraswal | 594bc6d | 2016-02-22 22:15:21 +0530 | [diff] [blame] | 292 | @Override |
Vinod Kumar S | 2ff139c | 2016-02-16 01:37:16 +0530 | [diff] [blame] | 293 | public void validateDataOnExit() throws DataModelException { |
| 294 | // TODO auto-generated method stub, to be implemented by parser |
| 295 | } |
| 296 | |
Vinod Kumar S | 2ff139c | 2016-02-16 01:37:16 +0530 | [diff] [blame] | 297 | @Override |
| 298 | public String getPackage() { |
| 299 | // TODO Auto-generated method stub |
| 300 | return null; |
| 301 | } |
| 302 | |
Vinod Kumar S | 2ff139c | 2016-02-16 01:37:16 +0530 | [diff] [blame] | 303 | @Override |
| 304 | public void setPackage(String pkg) { |
| 305 | // TODO Auto-generated method stub |
| 306 | |
| 307 | } |
| 308 | |
Bharat saraswal | 594bc6d | 2016-02-22 22:15:21 +0530 | [diff] [blame] | 309 | @Override |
Bharat saraswal | 2f00b4b | 2016-03-04 20:08:09 +0530 | [diff] [blame] | 310 | public void generateJavaCodeEntry(String codeGenDir) { |
Vinod Kumar S | 2ff139c | 2016-02-16 01:37:16 +0530 | [diff] [blame] | 311 | // TODO Auto-generated method stub |
| 312 | |
| 313 | } |
| 314 | |
Bharat saraswal | 594bc6d | 2016-02-22 22:15:21 +0530 | [diff] [blame] | 315 | @Override |
Vinod Kumar S | 2ff139c | 2016-02-16 01:37:16 +0530 | [diff] [blame] | 316 | public void generateJavaCodeExit() { |
| 317 | // TODO Auto-generated method stub |
| 318 | |
| 319 | } |
Bharat saraswal | 594bc6d | 2016-02-22 22:15:21 +0530 | [diff] [blame] | 320 | |
| 321 | @Override |
| 322 | public CachedFileHandle getFileHandle() { |
| 323 | // TODO Auto-generated method stub |
| 324 | return null; |
| 325 | } |
| 326 | |
| 327 | @Override |
| 328 | public void setFileHandle(CachedFileHandle fileHandle) { |
| 329 | // TODO Auto-generated method stub |
| 330 | |
| 331 | } |
Gaurav Agrawal | 8e8770a | 2016-02-27 03:57:50 +0530 | [diff] [blame] | 332 | |
| 333 | @Override |
| 334 | public void detectCollidingChild(String identifierName, YangConstructType dataType) throws DataModelException { |
| 335 | |
| 336 | YangNode node = this.getChild(); |
| 337 | while ((node != null)) { |
| 338 | if (node instanceof CollisionDetector) { |
| 339 | ((CollisionDetector) node).detectSelfCollision(identifierName, dataType); |
| 340 | } |
| 341 | node = node.getNextSibling(); |
| 342 | } |
| 343 | } |
| 344 | |
| 345 | @Override |
| 346 | public void detectSelfCollision(String identifierName, YangConstructType dataType) throws DataModelException { |
| 347 | |
| 348 | if (dataType == CHOICE_DATA) { |
| 349 | if (this.getName().equals(identifierName)) { |
| 350 | throw new DataModelException("YANG file error: Identifier collision detected in choice \"" + |
| 351 | this.getName() + "\""); |
| 352 | } |
| 353 | return; |
| 354 | } |
| 355 | |
| 356 | YangNode node = this.getChild(); |
| 357 | while ((node != null)) { |
| 358 | if (node instanceof CollisionDetector) { |
| 359 | ((CollisionDetector) node).detectSelfCollision(identifierName, dataType); |
| 360 | } |
| 361 | node = node.getNextSibling(); |
| 362 | } |
| 363 | } |
Vinod Kumar S | 2ff139c | 2016-02-16 01:37:16 +0530 | [diff] [blame] | 364 | } |