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