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 com.google.common.base.Verify.verifyNotNull;
  11 import static java.util.Objects.requireNonNull;
  12
  13 import com.google.common.annotations.Beta;
  14 import com.google.common.base.MoreObjects;
  15 import com.google.common.collect.ImmutableList;
  16 import com.google.common.collect.ImmutableMap;
  17 import com.google.common.collect.ImmutableMap.Builder;
  18 import com.google.common.collect.ImmutableSet;
  19 import java.util.ArrayList;
  20 import java.util.Collection;
  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.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.meta.IdentifierNamespace;
  47 import org.opendaylight.yangtools.yang.model.api.stmt.ContactEffectiveStatement;
  48 import org.opendaylight.yangtools.yang.model.api.stmt.DataTreeAwareEffectiveStatement;
  49 import org.opendaylight.yangtools.yang.model.api.stmt.ImportEffectiveStatement;
  50 import org.opendaylight.yangtools.yang.model.api.stmt.ModuleEffectiveStatement;
  51 import org.opendaylight.yangtools.yang.model.api.stmt.OrganizationEffectiveStatement;
  52 import org.opendaylight.yangtools.yang.model.api.stmt.PrefixEffectiveStatement;
  53 import org.opendaylight.yangtools.yang.model.api.stmt.PrefixStatement;
  54 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaTreeAwareEffectiveStatement;
  55 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaTreeEffectiveStatement;
  56 import org.opendaylight.yangtools.yang.model.api.stmt.TypedefEffectiveStatement;
  57 import org.opendaylight.yangtools.yang.model.api.stmt.YangVersionEffectiveStatement;
  58 import org.opendaylight.yangtools.yang.model.api.stmt.compat.NotificationNodeContainerCompat;
  59 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  60 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
  61 import org.opendaylight.yangtools.yang.parser.spi.source.ImportPrefixToModuleCtx;
  62 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  63
  64 @Beta
  65 public abstract class AbstractEffectiveModule<D extends DeclaredStatement<String>,
  66         E extends DataTreeAwareEffectiveStatement<String, D>>
  67         extends AbstractEffectiveDocumentedNodeWithStatus<String, D>
  68         implements Module, NotificationNodeContainerCompat<String, D, E> {
  69     private final String prefix;
  70     private final ImmutableSet<ModuleImport> imports;
  71     private final ImmutableSet<FeatureDefinition> features;
  72     private final @NonNull ImmutableSet<NotificationDefinition> notifications;
  73     private final ImmutableSet<AugmentationSchemaNode> augmentations;
  74     private final ImmutableSet<RpcDefinition> rpcs;
  75     private final ImmutableSet<Deviation> deviations;
  76     private final ImmutableList<ExtensionDefinition> extensionNodes;
  77     private final ImmutableSet<IdentitySchemaNode> identities;
  78     private final ImmutableSet<GroupingDefinition> groupings;
  79     private final ImmutableSet<UsesNode> uses;
  80     private final ImmutableSet<TypeDefinition<?>> typeDefinitions;
  81     private final ImmutableSet<DataSchemaNode> publicChildNodes;
  82     private final ImmutableMap<QName, SchemaTreeEffectiveStatement<?>> schemaTreeNamespace;
  83
  84     protected AbstractEffectiveModule(
  85             final @NonNull StmtContext<String, D, ? extends EffectiveStatement<String, ?>> ctx,
  86             final @NonNull String prefix) {
  87         super(ctx);
  88
  89         // This check is rather weird, but comes from our desire to lower memory footprint while providing both
  90         // EffectiveStatements and SchemaNode interfaces -- which do not overlap completely where child lookups are
  91         // concerned. This ensures that we have SchemaTree index available for use with child lookups.
  92         final Map<QName, SchemaTreeEffectiveStatement<?>> schemaTree =
  93                 createSchemaTreeNamespace(ctx.getStatementSourceReference(), effectiveSubstatements());
  94         schemaTreeNamespace = ImmutableMap.copyOf(schemaTree);
  95
  96         // Data tree check, not currently used
  97         createDataTreeNamespace(ctx.getStatementSourceReference(), schemaTree.values(), schemaTreeNamespace);
  98
  99         this.prefix = requireNonNull(prefix);
 100
 101         final Set<AugmentationSchemaNode> augmentationsInit = new LinkedHashSet<>();
 102         final Set<ModuleImport> importsInit = new LinkedHashSet<>();
 103         final Set<NotificationDefinition> notificationsInit = new LinkedHashSet<>();
 104         final Set<RpcDefinition> rpcsInit = new LinkedHashSet<>();
 105         final Set<Deviation> deviationsInit = new LinkedHashSet<>();
 106         final Set<IdentitySchemaNode> identitiesInit = new LinkedHashSet<>();
 107         final Set<FeatureDefinition> featuresInit = new LinkedHashSet<>();
 108         final List<ExtensionDefinition> extensionNodesInit = new ArrayList<>();
 109
 110         final Set<GroupingDefinition> mutableGroupings = new LinkedHashSet<>();
 111         final Set<UsesNode> mutableUses = new LinkedHashSet<>();
 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 AugmentationSchemaNode) {
 117                 augmentationsInit.add((AugmentationSchemaNode) effectiveStatement);
 118             }
 119             if (effectiveStatement instanceof ModuleImport) {
 120                 importsInit.add((ModuleImport) effectiveStatement);
 121             }
 122             if (effectiveStatement instanceof NotificationDefinition) {
 123                 notificationsInit.add((NotificationDefinition) effectiveStatement);
 124             }
 125             if (effectiveStatement instanceof RpcDefinition) {
 126                 rpcsInit.add((RpcDefinition) effectiveStatement);
 127             }
 128             if (effectiveStatement instanceof Deviation) {
 129                 deviationsInit.add((Deviation) effectiveStatement);
 130             }
 131             if (effectiveStatement instanceof IdentitySchemaNode) {
 132                 identitiesInit.add((IdentitySchemaNode) effectiveStatement);
 133             }
 134             if (effectiveStatement instanceof FeatureDefinition) {
 135                 featuresInit.add((FeatureDefinition) effectiveStatement);
 136             }
 137             if (effectiveStatement instanceof ExtensionDefinition) {
 138                 extensionNodesInit.add((ExtensionDefinition) effectiveStatement);
 139             }
 140             if (effectiveStatement instanceof DataSchemaNode) {
 141                 mutablePublicChildNodes.add((DataSchemaNode) effectiveStatement);
 142             }
 143             if (effectiveStatement instanceof UsesNode && !mutableUses.add((UsesNode) effectiveStatement)) {
 144                 throw EffectiveStmtUtils.createNameCollisionSourceException(ctx, effectiveStatement);
 145             }
 146             if (effectiveStatement instanceof TypedefEffectiveStatement) {
 147                 final TypeDefinition<?> type = ((TypedefEffectiveStatement) effectiveStatement).getTypeDefinition();
 148                 if (!mutableTypeDefinitions.add(type)) {
 149                     throw EffectiveStmtUtils.createNameCollisionSourceException(ctx, effectiveStatement);
 150                 }
 151             }
 152             if (effectiveStatement instanceof GroupingDefinition
 153                     && !mutableGroupings.add((GroupingDefinition) effectiveStatement)) {
 154                 throw EffectiveStmtUtils.createNameCollisionSourceException(ctx, effectiveStatement);
 155             }
 156         }
 157
 158         this.augmentations = ImmutableSet.copyOf(augmentationsInit);
 159         this.imports = ImmutableSet.copyOf(importsInit);
 160         this.notifications = ImmutableSet.copyOf(notificationsInit);
 161         this.rpcs = ImmutableSet.copyOf(rpcsInit);
 162         this.deviations = ImmutableSet.copyOf(deviationsInit);
 163         this.identities = ImmutableSet.copyOf(identitiesInit);
 164         this.features = ImmutableSet.copyOf(featuresInit);
 165         this.extensionNodes = ImmutableList.copyOf(extensionNodesInit);
 166
 167         this.groupings = ImmutableSet.copyOf(mutableGroupings);
 168         this.publicChildNodes = ImmutableSet.copyOf(mutablePublicChildNodes);
 169         this.typeDefinitions = ImmutableSet.copyOf(mutableTypeDefinitions);
 170         this.uses = ImmutableSet.copyOf(mutableUses);
 171     }
 172
 173     @Override
 174     public String getName() {
 175         return argument();
 176     }
 177
 178     @Override
 179     public String getPrefix() {
 180         return prefix;
 181     }
 182
 183     @Override
 184     public YangVersion getYangVersion() {
 185         return findFirstEffectiveSubstatementArgument(YangVersionEffectiveStatement.class)
 186                 .orElse(YangVersion.VERSION_1);
 187     }
 188
 189     @Override
 190     public Optional<String> getOrganization() {
 191         return findFirstEffectiveSubstatementArgument(OrganizationEffectiveStatement.class);
 192     }
 193
 194     @Override
 195     public Optional<String> getContact() {
 196         return findFirstEffectiveSubstatementArgument(ContactEffectiveStatement.class);
 197     }
 198
 199     @Override
 200     public Collection<? extends ModuleImport> getImports() {
 201         return imports;
 202     }
 203
 204     @Override
 205     public Collection<? extends FeatureDefinition> getFeatures() {
 206         return features;
 207     }
 208
 209     @Override
 210     public Collection<? extends NotificationDefinition> getNotifications() {
 211         return notifications;
 212     }
 213
 214     @Override
 215     public Collection<? extends AugmentationSchemaNode> getAugmentations() {
 216         return augmentations;
 217     }
 218
 219     @Override
 220     public Collection<? extends RpcDefinition> getRpcs() {
 221         return rpcs;
 222     }
 223
 224     @Override
 225     public Collection<? extends Deviation> getDeviations() {
 226         return deviations;
 227     }
 228
 229     @Override
 230     public Collection<? extends ExtensionDefinition> getExtensionSchemaNodes() {
 231         return extensionNodes;
 232     }
 233
 234     @Override
 235     public Collection<? extends IdentitySchemaNode> getIdentities() {
 236         return identities;
 237     }
 238
 239     @Override
 240     public final Collection<? extends TypeDefinition<?>> getTypeDefinitions() {
 241         return typeDefinitions;
 242     }
 243
 244     @Override
 245     public final Collection<? extends DataSchemaNode> getChildNodes() {
 246         return publicChildNodes;
 247     }
 248
 249     @Override
 250     public final Collection<? extends GroupingDefinition> getGroupings() {
 251         return groupings;
 252     }
 253
 254     @Override
 255     @SuppressWarnings("checkstyle:hiddenField")
 256     public final Optional<DataSchemaNode> findDataChildByName(final QName name) {
 257         final SchemaTreeEffectiveStatement<?> child = schemaTreeNamespace.get(requireNonNull(name));
 258         return child instanceof DataSchemaNode ? Optional.of((DataSchemaNode) child) : Optional.empty();
 259     }
 260
 261     @Override
 262     public Collection<? extends UsesNode> getUses() {
 263         return uses;
 264     }
 265
 266     @Override
 267     public Optional<SemVer> getSemanticVersion() {
 268         return findFirstEffectiveSubstatementArgument(OpenConfigVersionEffectiveStatement.class);
 269     }
 270
 271     @Override
 272     @SuppressWarnings("unchecked")
 273     protected <K, V, N extends IdentifierNamespace<K, V>> Optional<? extends Map<K, V>> getNamespaceContents(
 274             final Class<N> namespace) {
 275         if (SchemaTreeAwareEffectiveStatement.Namespace.class.equals(namespace)) {
 276             return Optional.of((Map<K, V>) schemaTreeNamespace);
 277         }
 278         return super.getNamespaceContents(namespace);
 279     }
 280
 281     @Override
 282     public String toString() {
 283         return MoreObjects.toStringHelper(this).omitNullValues()
 284                 .add("name", getName())
 285                 .add("namespace", getNamespace())
 286                 .add("revision", getRevision().orElse(null))
 287                 .add("prefix", prefix)
 288                 .add("yangVersion", getYangVersion())
 289                 .toString();
 290     }
 291
 292     protected static final @NonNull String findPrefix(final @NonNull StmtContext<?, ?, ?> ctx,
 293             final String type, final String name) {
 294         return SourceException.throwIfNull(
 295             StmtContextUtils.firstAttributeOf(ctx.declaredSubstatements(), PrefixStatement.class),
 296             ctx.getStatementSourceReference(), "Unable to resolve prefix for %s %s.", type, name);
 297     }
 298
 299     // Alright. this is quite ugly
 300     protected final void appendPrefixes(final StmtContext<?, ?, ?> ctx,
 301             final Builder<String, ModuleEffectiveStatement> builder) {
 302         streamEffectiveSubstatements(ImportEffectiveStatement.class)
 303             .map(imp -> imp.findFirstEffectiveSubstatementArgument(PrefixEffectiveStatement.class).get())
 304             .forEach(pfx -> {
 305                 final StmtContext<?, ?, ?> importedCtx =
 306                         verifyNotNull(ctx.getFromNamespace(ImportPrefixToModuleCtx.class, pfx),
 307                             "Failed to resolve prefix %s", pfx);
 308                 builder.put(pfx, (ModuleEffectiveStatement) importedCtx.buildEffective());
 309             });
 310     }
 311 }