yang/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/AbstractEffectiveDocumentedDataNodeContainer.java

   1 /*
   2  * Copyright (c) 2015 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.rfc7950.stmt;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.collect.ImmutableMap;
  13 import com.google.common.collect.ImmutableSet;
  14 import java.util.HashSet;
  15 import java.util.LinkedHashMap;
  16 import java.util.LinkedHashSet;
  17 import java.util.Map;
  18 import java.util.Optional;
  19 import java.util.Set;
  20 import org.opendaylight.yangtools.yang.common.QName;
  21 import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
  22 import org.opendaylight.yangtools.yang.model.api.CaseSchemaNode;
  23 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
  24 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  25 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  26 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
  27 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  28 import org.opendaylight.yangtools.yang.model.api.UsesNode;
  29 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  30 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  31 import org.opendaylight.yangtools.yang.model.api.stmt.TypedefEffectiveStatement;
  32 import org.opendaylight.yangtools.yang.parser.rfc7950.reactor.YangValidationBundles;
  33 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.choice.ImplicitCaseSchemaNode;
  34 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  35 import org.opendaylight.yangtools.yang.parser.spi.source.AugmentToChoiceNamespace;
  36
  37 public abstract class AbstractEffectiveDocumentedDataNodeContainer<A, D extends DeclaredStatement<A>>
  38         extends AbstractSchemaEffectiveDocumentedNode<A, D> implements DataNodeContainer {
  39
  40     private final Map<QName, DataSchemaNode> childNodes;
  41     private final Set<GroupingDefinition> groupings;
  42     private final Set<UsesNode> uses;
  43     private final Set<TypeDefinition<?>> typeDefinitions;
  44     private final Set<DataSchemaNode> publicChildNodes;
  45
  46     protected AbstractEffectiveDocumentedDataNodeContainer(final StmtContext<A, D, ?> ctx) {
  47         super(ctx);
  48
  49         Map<QName, DataSchemaNode> mutableChildNodes = new LinkedHashMap<>();
  50         Set<GroupingDefinition> mutableGroupings = new HashSet<>();
  51         Set<UsesNode> mutableUses = new HashSet<>();
  52         Set<TypeDefinition<?>> mutableTypeDefinitions = new LinkedHashSet<>();
  53         Set<DataSchemaNode> mutablePublicChildNodes = new LinkedHashSet<>();
  54
  55         for (EffectiveStatement<?, ?> stmt : effectiveSubstatements()) {
  56             if (stmt instanceof DataSchemaNode) {
  57                 final DataSchemaNode dataSchemaNode = (DataSchemaNode) stmt;
  58                 if (mutableChildNodes.containsKey(dataSchemaNode.getQName())) {
  59                     throw EffectiveStmtUtils.createNameCollisionSourceException(ctx, stmt);
  60                 }
  61
  62                 //  Add case short hand when augmenting choice with short hand
  63                 if (this instanceof AugmentationSchemaNode
  64                         && !(stmt instanceof CaseSchemaNode || stmt instanceof ChoiceSchemaNode)
  65                         && YangValidationBundles.SUPPORTED_CASE_SHORTHANDS.contains(stmt.statementDefinition())
  66                         && Boolean.TRUE.equals(ctx.getFromNamespace(AugmentToChoiceNamespace.class, ctx))) {
  67                     final ImplicitCaseSchemaNode caseShorthand = new ImplicitCaseSchemaNode(dataSchemaNode);
  68                     mutableChildNodes.put(caseShorthand.getQName(), caseShorthand);
  69                     mutablePublicChildNodes.add(caseShorthand);
  70                 } else {
  71                     mutableChildNodes.put(dataSchemaNode.getQName(), dataSchemaNode);
  72                     mutablePublicChildNodes.add(dataSchemaNode);
  73                 }
  74             }
  75             if (stmt instanceof UsesNode) {
  76                 UsesNode usesNode = (UsesNode) stmt;
  77                 if (!mutableUses.contains(usesNode)) {
  78                     mutableUses.add(usesNode);
  79                 } else {
  80                     throw EffectiveStmtUtils.createNameCollisionSourceException(ctx, stmt);
  81                 }
  82             }
  83             if (stmt instanceof TypedefEffectiveStatement) {
  84                 TypedefEffectiveStatement typeDef = (TypedefEffectiveStatement) stmt;
  85                 TypeDefinition<?> type = typeDef.getTypeDefinition();
  86                 if (!mutableTypeDefinitions.contains(type)) {
  87                     mutableTypeDefinitions.add(type);
  88                 } else {
  89                     throw EffectiveStmtUtils.createNameCollisionSourceException(ctx, stmt);
  90                 }
  91             }
  92             if (stmt instanceof GroupingDefinition) {
  93                 GroupingDefinition grp = (GroupingDefinition) stmt;
  94                 if (!mutableGroupings.contains(grp)) {
  95                     mutableGroupings.add(grp);
  96                 } else {
  97                     throw EffectiveStmtUtils.createNameCollisionSourceException(ctx, stmt);
  98                 }
  99             }
 100         }
 101
 102         this.childNodes = ImmutableMap.copyOf(mutableChildNodes);
 103         this.groupings = ImmutableSet.copyOf(mutableGroupings);
 104         this.publicChildNodes = ImmutableSet.copyOf(mutablePublicChildNodes);
 105         this.typeDefinitions = ImmutableSet.copyOf(mutableTypeDefinitions);
 106         this.uses = ImmutableSet.copyOf(mutableUses);
 107     }
 108
 109     @Override
 110     public final Set<TypeDefinition<?>> getTypeDefinitions() {
 111         return typeDefinitions;
 112     }
 113
 114     @Override
 115     public final Set<DataSchemaNode> getChildNodes() {
 116         return publicChildNodes;
 117     }
 118
 119     @Override
 120     public final Set<GroupingDefinition> getGroupings() {
 121         return groupings;
 122     }
 123
 124     @Override
 125     public final Optional<DataSchemaNode> findDataChildByName(final QName name) {
 126         // Child nodes are keyed by their container name, so we can do a direct lookup
 127         return Optional.ofNullable(childNodes.get(requireNonNull(name)));
 128     }
 129
 130     @Override
 131     public Set<UsesNode> getUses() {
 132         return uses;
 133     }
 134 }