yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/builder/impl/ContainerSchemaNodeBuilder.java

   1 /*
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.yangtools.yang.parser.builder.impl;
   9
  10 import java.net.URI;
  11 import java.util.ArrayList;
  12 import java.util.Collections;
  13 import java.util.Date;
  14 import java.util.HashMap;
  15 import java.util.HashSet;
  16 import java.util.List;
  17 import java.util.Map;
  18 import java.util.Set;
  19 import java.util.TreeSet;
  20
  21 import org.opendaylight.yangtools.yang.common.QName;
  22 import org.opendaylight.yangtools.yang.model.api.*;
  23 import org.opendaylight.yangtools.yang.parser.builder.api.AbstractDataNodeContainerBuilder;
  24 import org.opendaylight.yangtools.yang.parser.builder.api.AugmentationSchemaBuilder;
  25 import org.opendaylight.yangtools.yang.parser.builder.api.AugmentationTargetBuilder;
  26 import org.opendaylight.yangtools.yang.parser.builder.api.DataSchemaNodeBuilder;
  27 import org.opendaylight.yangtools.yang.parser.builder.api.GroupingBuilder;
  28 import org.opendaylight.yangtools.yang.parser.builder.api.TypeDefinitionBuilder;
  29 import org.opendaylight.yangtools.yang.parser.builder.api.UsesNodeBuilder;
  30 import org.opendaylight.yangtools.yang.parser.util.Comparators;
  31 import org.opendaylight.yangtools.yang.parser.util.ParserUtils;
  32 import org.opendaylight.yangtools.yang.parser.util.YangParseException;
  33
  34 public final class ContainerSchemaNodeBuilder extends AbstractDataNodeContainerBuilder implements
  35         AugmentationTargetBuilder, DataSchemaNodeBuilder {
  36     private boolean isBuilt;
  37     private final ContainerSchemaNodeImpl instance;
  38     private YangNode parent;
  39
  40     private final SchemaPath path;
  41     // DataSchemaNode args
  42     private Boolean configuration;
  43     private final ConstraintsBuilder constraints;
  44     // AugmentationTarget args
  45     private final List<AugmentationSchemaBuilder> augmentationBuilders = new ArrayList<>();
  46
  47     public ContainerSchemaNodeBuilder(final String moduleName, final int line, final QName qname, final SchemaPath path) {
  48         super(moduleName, line, qname);
  49         this.path = path;
  50         this.instance = new ContainerSchemaNodeImpl(qname, path);
  51         this.constraints = new ConstraintsBuilder(moduleName, line);
  52     }
  53
  54     // constructor for uses
  55     public ContainerSchemaNodeBuilder(final String moduleName, final int line, final QName qname,
  56             final SchemaPath path, final ContainerSchemaNode base) {
  57         super(moduleName, line, qname);
  58         this.path = path;
  59         instance = new ContainerSchemaNodeImpl(qname, path);
  60         constraints = new ConstraintsBuilder(moduleName, line, base.getConstraints());
  61
  62         instance.description = base.getDescription();
  63         instance.reference = base.getReference();
  64         instance.status = base.getStatus();
  65         instance.augmenting = base.isAugmenting();
  66         instance.addedByUses = base.isAddedByUses();
  67         instance.configuration = base.isConfiguration();
  68         instance.constraints = base.getConstraints();
  69         instance.augmentations.addAll(base.getAvailableAugmentations());
  70
  71         URI ns = qname.getNamespace();
  72         Date rev = qname.getRevision();
  73         String pref = qname.getPrefix();
  74         addedChildNodes.addAll(ParserUtils.wrapChildNodes(moduleName, line, base.getChildNodes(), path, ns, rev, pref));
  75         addedGroupings.addAll(ParserUtils.wrapGroupings(moduleName, line, base.getGroupings(), path, ns, rev, pref));
  76         addedTypedefs.addAll(ParserUtils.wrapTypedefs(moduleName, line, base, path, ns, rev, pref));
  77         addedUnknownNodes.addAll(ParserUtils.wrapUnknownNodes(moduleName, line, base.getUnknownSchemaNodes(), path, ns,
  78                 rev, pref));
  79
  80         instance.uses.addAll(base.getUses());
  81         instance.presence = base.isPresenceContainer();
  82         instance.configuration = base.isConfiguration();
  83         this.configuration = base.isConfiguration();
  84     }
  85
  86     @Override
  87     public ContainerSchemaNode build() {
  88         if (!isBuilt) {
  89
  90             // if this builder represents rpc input or output, it can has
  91             // configuration value set to null
  92             if (configuration == null) {
  93                 configuration = false;
  94             }
  95             instance.setConfiguration(configuration);
  96
  97             // USES
  98             for (UsesNodeBuilder builder : addedUsesNodes) {
  99                 usesNodes.add(builder.build());
 100             }
 101             instance.addUses(usesNodes);
 102
 103             // CHILD NODES
 104             for (DataSchemaNodeBuilder node : addedChildNodes) {
 105                 DataSchemaNode child = node.build();
 106                 childNodes.put(child.getQName(), child);
 107             }
 108             instance.addChildNodes(childNodes);
 109
 110             // GROUPINGS
 111             for (GroupingBuilder builder : addedGroupings) {
 112                 groupings.add(builder.build());
 113             }
 114             instance.addGroupings(groupings);
 115
 116             // TYPEDEFS
 117             for (TypeDefinitionBuilder entry : addedTypedefs) {
 118                 typedefs.add(entry.build());
 119             }
 120             instance.addTypeDefinitions(typedefs);
 121
 122             // AUGMENTATIONS
 123             final List<AugmentationSchema> augmentations = new ArrayList<>();
 124             for (AugmentationSchemaBuilder builder : augmentationBuilders) {
 125                 augmentations.add(builder.build());
 126             }
 127             instance.addAvailableAugmentations(new HashSet<>(augmentations));
 128
 129             // UNKNOWN NODES
 130             for (UnknownSchemaNodeBuilder b : addedUnknownNodes) {
 131                 unknownNodes.add(b.build());
 132             }
 133             Collections.sort(unknownNodes, Comparators.SCHEMA_NODE_COMP);
 134             instance.addUnknownSchemaNodes(unknownNodes);
 135
 136             if (constraints != null) {
 137                 instance.setConstraints(constraints.build());
 138             }
 139
 140             isBuilt = true;
 141         }
 142         return instance;
 143     }
 144
 145     @Override
 146     public Set<TypeDefinitionBuilder> getTypeDefinitionBuilders() {
 147         return addedTypedefs;
 148     }
 149
 150     @Override
 151     public void addTypedef(final TypeDefinitionBuilder type) {
 152         String typeName = type.getQName().getLocalName();
 153         for (TypeDefinitionBuilder addedTypedef : addedTypedefs) {
 154             if (addedTypedef.getQName().getLocalName().equals(typeName)) {
 155                 throw new YangParseException(moduleName, type.getLine(), "Can not add typedef '" + typeName
 156                         + "': typedef with same name already declared at line " + addedTypedef.getLine());
 157             }
 158         }
 159         addedTypedefs.add(type);
 160     }
 161
 162     public List<AugmentationSchemaBuilder> getAugmentationBuilders() {
 163         return augmentationBuilders;
 164     }
 165
 166     @Override
 167     public void addAugmentation(AugmentationSchemaBuilder augment) {
 168         augmentationBuilders.add(augment);
 169     }
 170
 171     @Override
 172     public SchemaPath getPath() {
 173         return instance.path;
 174     }
 175
 176     @Override
 177     public void setPath(SchemaPath path) {
 178         instance.path = path;
 179     }
 180
 181     @Override
 182     public String getDescription() {
 183         return instance.description;
 184     }
 185
 186     @Override
 187     public void setDescription(final String description) {
 188         instance.description = description;
 189     }
 190
 191     @Override
 192     public String getReference() {
 193         return instance.reference;
 194     }
 195
 196     @Override
 197     public void setReference(final String reference) {
 198         instance.reference = reference;
 199     }
 200
 201     @Override
 202     public Status getStatus() {
 203         return instance.status;
 204     }
 205
 206     @Override
 207     public void setStatus(Status status) {
 208         if (status != null) {
 209             instance.status = status;
 210         }
 211     }
 212
 213     @Override
 214     public boolean isAugmenting() {
 215         return instance.augmenting;
 216     }
 217
 218     @Override
 219     public void setAugmenting(boolean augmenting) {
 220         instance.augmenting = augmenting;
 221     }
 222
 223     @Override
 224     public boolean isAddedByUses() {
 225         return instance.addedByUses;
 226     }
 227
 228     @Override
 229     public void setAddedByUses(final boolean addedByUses) {
 230         instance.addedByUses = addedByUses;
 231     }
 232
 233     @Override
 234     public Boolean isConfiguration() {
 235         return instance.configuration;
 236     }
 237
 238     @Override
 239     public void setConfiguration(Boolean configuration) {
 240         instance.configuration = configuration;
 241     }
 242
 243     @Override
 244     public ConstraintsBuilder getConstraints() {
 245         return constraints;
 246     }
 247
 248     public boolean isPresence() {
 249         return instance.presence;
 250     }
 251
 252     public void setPresence(boolean presence) {
 253         instance.presence = presence;
 254     }
 255
 256     @Override
 257     public int hashCode() {
 258         final int prime = 31;
 259         int result = 1;
 260         result = prime * result + ((path == null) ? 0 : path.hashCode());
 261         return result;
 262     }
 263
 264     @Override
 265     public boolean equals(Object obj) {
 266         if (this == obj) {
 267             return true;
 268         }
 269         if (obj == null) {
 270             return false;
 271         }
 272         if (getClass() != obj.getClass()) {
 273             return false;
 274         }
 275         ContainerSchemaNodeBuilder other = (ContainerSchemaNodeBuilder) obj;
 276         if (path == null) {
 277             if (other.path != null) {
 278                 return false;
 279             }
 280         } else if (!path.equals(other.path)) {
 281             return false;
 282         }
 283         if (parent == null) {
 284             if (other.parent != null) {
 285                 return false;
 286             }
 287         } else if (!parent.equals(other.parent)) {
 288             return false;
 289         }
 290         return true;
 291     }
 292
 293     @Override
 294     public String toString() {
 295         return "container " + qname.getLocalName();
 296     }
 297
 298     public final class ContainerSchemaNodeImpl implements ContainerSchemaNode {
 299         private final QName qname;
 300         private SchemaPath path;
 301         private String description;
 302         private String reference;
 303         private Status status = Status.CURRENT;
 304         private boolean augmenting;
 305         private boolean addedByUses;
 306         private boolean configuration;
 307         private ConstraintDefinition constraints;
 308         private final Set<AugmentationSchema> augmentations = new HashSet<>();
 309         private final Map<QName, DataSchemaNode> childNodes = new HashMap<>();
 310         private final Set<GroupingDefinition> groupings = new TreeSet<>(Comparators.SCHEMA_NODE_COMP);
 311         private final Set<TypeDefinition<?>> typeDefinitions = new TreeSet<>(Comparators.SCHEMA_NODE_COMP);
 312         private final Set<UsesNode> uses = new HashSet<>();
 313         private final List<UnknownSchemaNode> unknownNodes = new ArrayList<>();
 314         private boolean presence;
 315
 316         private ContainerSchemaNodeImpl(QName qname, SchemaPath path) {
 317             this.qname = qname;
 318             this.path = path;
 319         }
 320
 321         @Override
 322         public QName getQName() {
 323             return qname;
 324         }
 325
 326         @Override
 327         public SchemaPath getPath() {
 328             return path;
 329         }
 330
 331         @Override
 332         public String getDescription() {
 333             return description;
 334         }
 335
 336         @Override
 337         public String getReference() {
 338             return reference;
 339         }
 340
 341         @Override
 342         public Status getStatus() {
 343             return status;
 344         }
 345
 346         @Override
 347         public boolean isAugmenting() {
 348             return augmenting;
 349         }
 350
 351         @Override
 352         public boolean isAddedByUses() {
 353             return addedByUses;
 354         }
 355
 356         @Override
 357         public boolean isConfiguration() {
 358             return configuration;
 359         }
 360
 361         private void setConfiguration(boolean configuration) {
 362             this.configuration = configuration;
 363         }
 364
 365         @Override
 366         public ConstraintDefinition getConstraints() {
 367             return constraints;
 368         }
 369
 370         private void setConstraints(ConstraintDefinition constraints) {
 371             this.constraints = constraints;
 372         }
 373
 374         @Override
 375         public Set<AugmentationSchema> getAvailableAugmentations() {
 376             return Collections.unmodifiableSet(augmentations);
 377         }
 378
 379         private void addAvailableAugmentations(Set<AugmentationSchema> augmentations) {
 380             if (augmentations != null) {
 381                 this.augmentations.addAll(augmentations);
 382             }
 383         }
 384
 385         @Override
 386         public Set<DataSchemaNode> getChildNodes() {
 387             final Set<DataSchemaNode> result = new TreeSet<>(Comparators.SCHEMA_NODE_COMP);
 388             result.addAll(childNodes.values());
 389             return Collections.unmodifiableSet(result);
 390         }
 391
 392         private void addChildNodes(Map<QName, DataSchemaNode> childNodes) {
 393             if (childNodes != null) {
 394                 this.childNodes.putAll(childNodes);
 395             }
 396         }
 397
 398         @Override
 399         public Set<GroupingDefinition> getGroupings() {
 400             return Collections.unmodifiableSet(groupings);
 401         }
 402
 403         private void addGroupings(Set<GroupingDefinition> groupings) {
 404             if (groupings != null) {
 405                 this.groupings.addAll(groupings);
 406             }
 407         }
 408
 409         @Override
 410         public DataSchemaNode getDataChildByName(QName name) {
 411             return childNodes.get(name);
 412         }
 413
 414         @Override
 415         public DataSchemaNode getDataChildByName(String name) {
 416             DataSchemaNode result = null;
 417             for (Map.Entry<QName, DataSchemaNode> entry : childNodes.entrySet()) {
 418                 if (entry.getKey().getLocalName().equals(name)) {
 419                     result = entry.getValue();
 420                     break;
 421                 }
 422             }
 423             return result;
 424         }
 425
 426         @Override
 427         public Set<UsesNode> getUses() {
 428             return Collections.unmodifiableSet(uses);
 429         }
 430
 431         private void addUses(Set<UsesNode> uses) {
 432             if (uses != null) {
 433                 this.uses.addAll(uses);
 434             }
 435         }
 436
 437         @Override
 438         public boolean isPresenceContainer() {
 439             return presence;
 440         }
 441
 442         @Override
 443         public Set<TypeDefinition<?>> getTypeDefinitions() {
 444             return Collections.unmodifiableSet(typeDefinitions);
 445         }
 446
 447         private void addTypeDefinitions(Set<TypeDefinition<?>> typeDefinitions) {
 448             if (typeDefinitions != null) {
 449                 this.typeDefinitions.addAll(typeDefinitions);
 450             }
 451         }
 452
 453         @Override
 454         public List<UnknownSchemaNode> getUnknownSchemaNodes() {
 455             return Collections.unmodifiableList(unknownNodes);
 456         }
 457
 458         private void addUnknownSchemaNodes(List<UnknownSchemaNode> unknownSchemaNodes) {
 459             if (unknownSchemaNodes != null) {
 460                 this.unknownNodes.addAll(unknownSchemaNodes);
 461             }
 462         }
 463
 464         @Override
 465         public int hashCode() {
 466             final int prime = 31;
 467             int result = 1;
 468             result = prime * result + ((qname == null) ? 0 : qname.hashCode());
 469             result = prime * result + ((path == null) ? 0 : path.hashCode());
 470             return result;
 471         }
 472
 473         @Override
 474         public boolean equals(Object obj) {
 475             if (this == obj) {
 476                 return true;
 477             }
 478             if (obj == null) {
 479                 return false;
 480             }
 481             if (getClass() != obj.getClass()) {
 482                 return false;
 483             }
 484             ContainerSchemaNodeImpl other = (ContainerSchemaNodeImpl) obj;
 485             if (qname == null) {
 486                 if (other.qname != null) {
 487                     return false;
 488                 }
 489             } else if (!qname.equals(other.qname)) {
 490                 return false;
 491             }
 492             if (path == null) {
 493                 if (other.path != null) {
 494                     return false;
 495                 }
 496             } else if (!path.equals(other.path)) {
 497                 return false;
 498             }
 499             return true;
 500         }
 501
 502         @Override
 503         public String toString() {
 504             return "container " + qname.getLocalName();
 505         }
 506     }
 507
 508 }