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