yang/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/AbstractEffectiveModule.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.annotations.Beta;
  13 import com.google.common.base.MoreObjects;
  14 import com.google.common.collect.ImmutableList;
  15 import com.google.common.collect.ImmutableMap;
  16 import com.google.common.collect.ImmutableSet;
  17 import java.net.URI;
  18 import java.util.ArrayList;
  19 import java.util.HashSet;
  20 import java.util.LinkedHashMap;
  21 import java.util.LinkedHashSet;
  22 import java.util.List;
  23 import java.util.Map;
  24 import java.util.Optional;
  25 import java.util.Set;
  26 import org.eclipse.jdt.annotation.NonNull;
  27 import org.opendaylight.yangtools.concepts.SemVer;
  28 import org.opendaylight.yangtools.openconfig.model.api.OpenConfigVersionEffectiveStatement;
  29 import org.opendaylight.yangtools.yang.common.QName;
  30 import org.opendaylight.yangtools.yang.common.Revision;
  31 import org.opendaylight.yangtools.yang.common.YangVersion;
  32 import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
  33 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  34 import org.opendaylight.yangtools.yang.model.api.Deviation;
  35 import org.opendaylight.yangtools.yang.model.api.ExtensionDefinition;
  36 import org.opendaylight.yangtools.yang.model.api.FeatureDefinition;
  37 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
  38 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
  39 import org.opendaylight.yangtools.yang.model.api.Module;
  40 import org.opendaylight.yangtools.yang.model.api.ModuleImport;
  41 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
  42 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  43 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  44 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
  45 import org.opendaylight.yangtools.yang.model.api.UsesNode;
  46 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  47 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  48 import org.opendaylight.yangtools.yang.model.api.stmt.ContactEffectiveStatement;
  49 import org.opendaylight.yangtools.yang.model.api.stmt.OrganizationEffectiveStatement;
  50 import org.opendaylight.yangtools.yang.model.api.stmt.PrefixStatement;
  51 import org.opendaylight.yangtools.yang.model.api.stmt.TypedefEffectiveStatement;
  52 import org.opendaylight.yangtools.yang.model.api.stmt.YangVersionEffectiveStatement;
  53 import org.opendaylight.yangtools.yang.model.api.stmt.compat.NotificationNodeContainerCompat;
  54 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  55 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
  56 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  57
  58 @Beta
  59 public abstract class AbstractEffectiveModule<D extends DeclaredStatement<String>> extends
  60         AbstractSchemaEffectiveDocumentedNode<String, D> implements Module,
  61         NotificationNodeContainerCompat<String, D> {
  62     private final String name;
  63     private final String prefix;
  64     private final YangVersion yangVersion;
  65     private final String organization;
  66     private final String contact;
  67     private final ImmutableSet<ModuleImport> imports;
  68     private final ImmutableSet<FeatureDefinition> features;
  69     private final @NonNull ImmutableSet<NotificationDefinition> notifications;
  70     private final ImmutableSet<AugmentationSchemaNode> augmentations;
  71     private final ImmutableSet<RpcDefinition> rpcs;
  72     private final ImmutableSet<Deviation> deviations;
  73     private final ImmutableList<ExtensionDefinition> extensionNodes;
  74     private final ImmutableSet<IdentitySchemaNode> identities;
  75     private final @NonNull ImmutableList<UnknownSchemaNode> unknownNodes;
  76     private final ImmutableMap<QName, DataSchemaNode> childNodes;
  77     private final ImmutableSet<GroupingDefinition> groupings;
  78     private final ImmutableSet<UsesNode> uses;
  79     private final ImmutableSet<TypeDefinition<?>> typeDefinitions;
  80     private final ImmutableSet<DataSchemaNode> publicChildNodes;
  81     private final SemVer semanticVersion;
  82
  83     protected AbstractEffectiveModule(
  84             final @NonNull StmtContext<String, D, ? extends EffectiveStatement<String, ?>> ctx,
  85             final @NonNull String prefix) {
  86         super(ctx);
  87
  88         this.name = argument();
  89         this.prefix = requireNonNull(prefix);
  90         this.yangVersion = findFirstEffectiveSubstatementArgument(YangVersionEffectiveStatement.class)
  91                 .orElse(YangVersion.VERSION_1);
  92         this.semanticVersion = findFirstEffectiveSubstatementArgument(OpenConfigVersionEffectiveStatement.class)
  93                 .orElse(null);
  94         this.organization = findFirstEffectiveSubstatementArgument(OrganizationEffectiveStatement.class)
  95                 .orElse(null);
  96         this.contact = findFirstEffectiveSubstatementArgument(ContactEffectiveStatement.class)
  97                 .orElse(null);
  98
  99         final List<UnknownSchemaNode> unknownNodesInit = new ArrayList<>();
 100         final Set<AugmentationSchemaNode> augmentationsInit = new LinkedHashSet<>();
 101         final Set<ModuleImport> importsInit = new HashSet<>();
 102         final Set<NotificationDefinition> notificationsInit = new HashSet<>();
 103         final Set<RpcDefinition> rpcsInit = new HashSet<>();
 104         final Set<Deviation> deviationsInit = new HashSet<>();
 105         final Set<IdentitySchemaNode> identitiesInit = new HashSet<>();
 106         final Set<FeatureDefinition> featuresInit = new HashSet<>();
 107         final List<ExtensionDefinition> extensionNodesInit = new ArrayList<>();
 108
 109         final Map<QName, DataSchemaNode> mutableChildNodes = new LinkedHashMap<>();
 110         final Set<GroupingDefinition> mutableGroupings = new HashSet<>();
 111         final Set<UsesNode> mutableUses = new HashSet<>();
 112         final Set<TypeDefinition<?>> mutableTypeDefinitions = new LinkedHashSet<>();
 113         final Set<DataSchemaNode> mutablePublicChildNodes = new LinkedHashSet<>();
 114
 115         for (final EffectiveStatement<?, ?> effectiveStatement : effectiveSubstatements()) {
 116             if (effectiveStatement instanceof UnknownSchemaNode) {
 117                 unknownNodesInit.add((UnknownSchemaNode) effectiveStatement);
 118             }
 119             if (effectiveStatement instanceof AugmentationSchemaNode) {
 120                 augmentationsInit.add((AugmentationSchemaNode) effectiveStatement);
 121             }
 122             if (effectiveStatement instanceof ModuleImport) {
 123                 importsInit.add((ModuleImport) effectiveStatement);
 124             }
 125             if (effectiveStatement instanceof NotificationDefinition) {
 126                 notificationsInit.add((NotificationDefinition) effectiveStatement);
 127             }
 128             if (effectiveStatement instanceof RpcDefinition) {
 129                 rpcsInit.add((RpcDefinition) effectiveStatement);
 130             }
 131             if (effectiveStatement instanceof Deviation) {
 132                 deviationsInit.add((Deviation) effectiveStatement);
 133             }
 134             if (effectiveStatement instanceof IdentitySchemaNode) {
 135                 identitiesInit.add((IdentitySchemaNode) effectiveStatement);
 136             }
 137             if (effectiveStatement instanceof FeatureDefinition) {
 138                 featuresInit.add((FeatureDefinition) effectiveStatement);
 139             }
 140             if (effectiveStatement instanceof ExtensionDefinition) {
 141                 extensionNodesInit.add((ExtensionDefinition) effectiveStatement);
 142             }
 143             if (effectiveStatement instanceof DataSchemaNode) {
 144                 final DataSchemaNode dataSchemaNode = (DataSchemaNode) effectiveStatement;
 145                 if (!mutableChildNodes.containsKey(dataSchemaNode.getQName())) {
 146                     mutableChildNodes.put(dataSchemaNode.getQName(), dataSchemaNode);
 147                     mutablePublicChildNodes.add(dataSchemaNode);
 148                 } else {
 149                     throw EffectiveStmtUtils.createNameCollisionSourceException(ctx, effectiveStatement);
 150                 }
 151             }
 152             if (effectiveStatement instanceof UsesNode && !mutableUses.add((UsesNode) effectiveStatement)) {
 153                 throw EffectiveStmtUtils.createNameCollisionSourceException(ctx, effectiveStatement);
 154             }
 155             if (effectiveStatement instanceof TypedefEffectiveStatement) {
 156                 final TypeDefinition<?> type = ((TypedefEffectiveStatement) effectiveStatement).getTypeDefinition();
 157                 if (!mutableTypeDefinitions.add(type)) {
 158                     throw EffectiveStmtUtils.createNameCollisionSourceException(ctx, effectiveStatement);
 159                 }
 160             }
 161             if (effectiveStatement instanceof GroupingDefinition
 162                     && !mutableGroupings.add((GroupingDefinition) effectiveStatement)) {
 163                 throw EffectiveStmtUtils.createNameCollisionSourceException(ctx, effectiveStatement);
 164             }
 165         }
 166
 167         this.unknownNodes = ImmutableList.copyOf(unknownNodesInit);
 168         this.augmentations = ImmutableSet.copyOf(augmentationsInit);
 169         this.imports = ImmutableSet.copyOf(importsInit);
 170         this.notifications = ImmutableSet.copyOf(notificationsInit);
 171         this.rpcs = ImmutableSet.copyOf(rpcsInit);
 172         this.deviations = ImmutableSet.copyOf(deviationsInit);
 173         this.identities = ImmutableSet.copyOf(identitiesInit);
 174         this.features = ImmutableSet.copyOf(featuresInit);
 175         this.extensionNodes = ImmutableList.copyOf(extensionNodesInit);
 176
 177         this.childNodes = ImmutableMap.copyOf(mutableChildNodes);
 178         this.groupings = ImmutableSet.copyOf(mutableGroupings);
 179         this.publicChildNodes = ImmutableSet.copyOf(mutablePublicChildNodes);
 180         this.typeDefinitions = ImmutableSet.copyOf(mutableTypeDefinitions);
 181         this.uses = ImmutableSet.copyOf(mutableUses);
 182
 183     }
 184
 185     @Override
 186     public URI getNamespace() {
 187         return getQNameModule().getNamespace();
 188     }
 189
 190     @Override
 191     public String getName() {
 192         return name;
 193     }
 194
 195     @Override
 196     public Optional<Revision> getRevision() {
 197         return getQNameModule().getRevision();
 198     }
 199
 200     @Override
 201     public String getPrefix() {
 202         return prefix;
 203     }
 204
 205     @Override
 206     public YangVersion getYangVersion() {
 207         return yangVersion;
 208     }
 209
 210     @Override
 211     public Optional<String> getOrganization() {
 212         return Optional.ofNullable(organization);
 213     }
 214
 215     @Override
 216     public Optional<String> getContact() {
 217         return Optional.ofNullable(contact);
 218     }
 219
 220     @Override
 221     public Set<ModuleImport> getImports() {
 222         return imports;
 223     }
 224
 225     @Override
 226     public Set<FeatureDefinition> getFeatures() {
 227         return features;
 228     }
 229
 230     @Override
 231     public Set<NotificationDefinition> getNotifications() {
 232         return notifications;
 233     }
 234
 235     @Override
 236     public Set<AugmentationSchemaNode> getAugmentations() {
 237         return augmentations;
 238     }
 239
 240     @Override
 241     public Set<RpcDefinition> getRpcs() {
 242         return rpcs;
 243     }
 244
 245     @Override
 246     public Set<Deviation> getDeviations() {
 247         return deviations;
 248     }
 249
 250     @Override
 251     public List<ExtensionDefinition> getExtensionSchemaNodes() {
 252         return extensionNodes;
 253     }
 254
 255     @Override
 256     public Set<IdentitySchemaNode> getIdentities() {
 257         return identities;
 258     }
 259
 260     @Override
 261     public List<UnknownSchemaNode> getUnknownSchemaNodes() {
 262         return unknownNodes;
 263     }
 264
 265     @Override
 266     public final Set<TypeDefinition<?>> getTypeDefinitions() {
 267         return typeDefinitions;
 268     }
 269
 270     @Override
 271     public final Set<DataSchemaNode> getChildNodes() {
 272         return publicChildNodes;
 273     }
 274
 275     @Override
 276     public final Set<GroupingDefinition> getGroupings() {
 277         return groupings;
 278     }
 279
 280     @Override
 281     @SuppressWarnings("checkstyle:hiddenField")
 282     public final Optional<DataSchemaNode> findDataChildByName(final QName name) {
 283         // Child nodes are keyed by their container name, so we can do a direct lookup
 284         return Optional.ofNullable(childNodes.get(requireNonNull(name)));
 285     }
 286
 287     @Override
 288     public Set<UsesNode> getUses() {
 289         return uses;
 290     }
 291
 292     @Override
 293     public Optional<SemVer> getSemanticVersion() {
 294         return Optional.ofNullable(semanticVersion);
 295     }
 296
 297     @Override
 298     public String toString() {
 299         return MoreObjects.toStringHelper(this).omitNullValues()
 300                 .add("name", name)
 301                 .add("namespace", getNamespace())
 302                 .add("revision", getRevision().orElse(null))
 303                 .add("prefix", prefix)
 304                 .add("yangVersion", yangVersion)
 305                 .toString();
 306     }
 307
 308     protected static final @NonNull String findPrefix(final @NonNull StmtContext<?, ?, ?> ctx,
 309             final String type, final String name) {
 310         return SourceException.throwIfNull(
 311             StmtContextUtils.firstAttributeOf(ctx.declaredSubstatements(), PrefixStatement.class),
 312             ctx.getStatementSourceReference(), "Unable to resolve prefix for %s %s.", type, name);
 313     }
 314 }