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