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.Collections2;
  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.Collection;
  20 import java.util.LinkedHashSet;
  21 import java.util.Map;
  22 import java.util.Optional;
  23 import java.util.Set;
  24 import org.eclipse.jdt.annotation.NonNull;
  25 import org.opendaylight.yangtools.concepts.SemVer;
  26 import org.opendaylight.yangtools.openconfig.model.api.OpenConfigVersionEffectiveStatement;
  27 import org.opendaylight.yangtools.yang.common.QName;
  28 import org.opendaylight.yangtools.yang.common.YangVersion;
  29 import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
  30 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  31 import org.opendaylight.yangtools.yang.model.api.Deviation;
  32 import org.opendaylight.yangtools.yang.model.api.ExtensionDefinition;
  33 import org.opendaylight.yangtools.yang.model.api.FeatureDefinition;
  34 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
  35 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
  36 import org.opendaylight.yangtools.yang.model.api.Module;
  37 import org.opendaylight.yangtools.yang.model.api.ModuleImport;
  38 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
  39 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  40 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  41 import org.opendaylight.yangtools.yang.model.api.UsesNode;
  42 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  43 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  44 import org.opendaylight.yangtools.yang.model.api.meta.IdentifierNamespace;
  45 import org.opendaylight.yangtools.yang.model.api.stmt.ContactEffectiveStatement;
  46 import org.opendaylight.yangtools.yang.model.api.stmt.DataTreeAwareEffectiveStatement;
  47 import org.opendaylight.yangtools.yang.model.api.stmt.ImportEffectiveStatement;
  48 import org.opendaylight.yangtools.yang.model.api.stmt.ModuleEffectiveStatement;
  49 import org.opendaylight.yangtools.yang.model.api.stmt.OrganizationEffectiveStatement;
  50 import org.opendaylight.yangtools.yang.model.api.stmt.PrefixEffectiveStatement;
  51 import org.opendaylight.yangtools.yang.model.api.stmt.PrefixStatement;
  52 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaTreeAwareEffectiveStatement;
  53 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaTreeEffectiveStatement;
  54 import org.opendaylight.yangtools.yang.model.api.stmt.TypedefEffectiveStatement;
  55 import org.opendaylight.yangtools.yang.model.api.stmt.YangVersionEffectiveStatement;
  56 import org.opendaylight.yangtools.yang.model.api.stmt.compat.NotificationNodeContainerCompat;
  57 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  58 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
  59 import org.opendaylight.yangtools.yang.parser.spi.source.ImportPrefixToModuleCtx;
  60 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  61
  62 @Beta
  63 public abstract class AbstractEffectiveModule<D extends DeclaredStatement<String>,
  64         E extends DataTreeAwareEffectiveStatement<String, D>>
  65         extends AbstractEffectiveDocumentedNodeWithStatus<String, D>
  66         implements Module, NotificationNodeContainerCompat<String, D, E> {
  67     private final String prefix;
  68     private final ImmutableSet<GroupingDefinition> groupings;
  69     private final ImmutableSet<UsesNode> uses;
  70     private final ImmutableSet<TypeDefinition<?>> typeDefinitions;
  71     private final ImmutableMap<QName, SchemaTreeEffectiveStatement<?>> schemaTreeNamespace;
  72
  73     protected AbstractEffectiveModule(
  74             final @NonNull StmtContext<String, D, ? extends EffectiveStatement<String, ?>> ctx,
  75             final @NonNull String prefix) {
  76         super(ctx);
  77
  78         // This check is rather weird, but comes from our desire to lower memory footprint while providing both
  79         // EffectiveStatements and SchemaNode interfaces -- which do not overlap completely where child lookups are
  80         // concerned. This ensures that we have SchemaTree index available for use with child lookups.
  81         final Map<QName, SchemaTreeEffectiveStatement<?>> schemaTree =
  82                 createSchemaTreeNamespace(ctx.getStatementSourceReference(), effectiveSubstatements());
  83         schemaTreeNamespace = ImmutableMap.copyOf(schemaTree);
  84
  85         // Data tree check, not currently used
  86         createDataTreeNamespace(ctx.getStatementSourceReference(), schemaTree.values(), schemaTreeNamespace);
  87
  88         this.prefix = requireNonNull(prefix);
  89
  90         final Set<GroupingDefinition> mutableGroupings = new LinkedHashSet<>();
  91         final Set<UsesNode> mutableUses = new LinkedHashSet<>();
  92         final Set<TypeDefinition<?>> mutableTypeDefinitions = new LinkedHashSet<>();
  93
  94         for (final EffectiveStatement<?, ?> effectiveStatement : effectiveSubstatements()) {
  95             if (effectiveStatement instanceof UsesNode && !mutableUses.add((UsesNode) effectiveStatement)) {
  96                 throw EffectiveStmtUtils.createNameCollisionSourceException(ctx, effectiveStatement);
  97             }
  98             if (effectiveStatement instanceof TypedefEffectiveStatement) {
  99                 final TypeDefinition<?> type = ((TypedefEffectiveStatement) effectiveStatement).getTypeDefinition();
 100                 if (!mutableTypeDefinitions.add(type)) {
 101                     throw EffectiveStmtUtils.createNameCollisionSourceException(ctx, effectiveStatement);
 102                 }
 103             }
 104             if (effectiveStatement instanceof GroupingDefinition
 105                     && !mutableGroupings.add((GroupingDefinition) effectiveStatement)) {
 106                 throw EffectiveStmtUtils.createNameCollisionSourceException(ctx, effectiveStatement);
 107             }
 108         }
 109
 110         this.groupings = ImmutableSet.copyOf(mutableGroupings);
 111         this.typeDefinitions = ImmutableSet.copyOf(mutableTypeDefinitions);
 112         this.uses = ImmutableSet.copyOf(mutableUses);
 113     }
 114
 115     @Override
 116     public String getName() {
 117         return argument();
 118     }
 119
 120     @Override
 121     public String getPrefix() {
 122         return prefix;
 123     }
 124
 125     @Override
 126     public YangVersion getYangVersion() {
 127         return findFirstEffectiveSubstatementArgument(YangVersionEffectiveStatement.class)
 128                 .orElse(YangVersion.VERSION_1);
 129     }
 130
 131     @Override
 132     public Optional<String> getOrganization() {
 133         return findFirstEffectiveSubstatementArgument(OrganizationEffectiveStatement.class);
 134     }
 135
 136     @Override
 137     public Optional<String> getContact() {
 138         return findFirstEffectiveSubstatementArgument(ContactEffectiveStatement.class);
 139     }
 140
 141     @Override
 142     public Collection<? extends ModuleImport> getImports() {
 143         return filterSubstatements(ModuleImport.class);
 144     }
 145
 146     @Override
 147     public Collection<? extends FeatureDefinition> getFeatures() {
 148         return filterSubstatements(FeatureDefinition.class);
 149     }
 150
 151     @Override
 152     public Collection<? extends NotificationDefinition> getNotifications() {
 153         return filterSubstatements(NotificationDefinition.class);
 154     }
 155
 156     @Override
 157     public Collection<? extends AugmentationSchemaNode> getAugmentations() {
 158         return filterSubstatements(AugmentationSchemaNode.class);
 159     }
 160
 161     @Override
 162     public Collection<? extends RpcDefinition> getRpcs() {
 163         return filterSubstatements(RpcDefinition.class);
 164     }
 165
 166     @Override
 167     public Collection<? extends Deviation> getDeviations() {
 168         return filterSubstatements(Deviation.class);
 169     }
 170
 171     @Override
 172     public Collection<? extends ExtensionDefinition> getExtensionSchemaNodes() {
 173         return filterSubstatements(ExtensionDefinition.class);
 174     }
 175
 176     @Override
 177     public Collection<? extends IdentitySchemaNode> getIdentities() {
 178         return filterSubstatements(IdentitySchemaNode.class);
 179     }
 180
 181     @Override
 182     public final Collection<? extends TypeDefinition<?>> getTypeDefinitions() {
 183         return typeDefinitions;
 184     }
 185
 186     @Override
 187     public final Collection<? extends DataSchemaNode> getChildNodes() {
 188         return filterSubstatements(DataSchemaNode.class);
 189     }
 190
 191     @Override
 192     public final Collection<? extends GroupingDefinition> getGroupings() {
 193         return groupings;
 194     }
 195
 196     @Override
 197     @SuppressWarnings("checkstyle:hiddenField")
 198     public final Optional<DataSchemaNode> findDataChildByName(final QName name) {
 199         final SchemaTreeEffectiveStatement<?> child = schemaTreeNamespace.get(requireNonNull(name));
 200         return child instanceof DataSchemaNode ? Optional.of((DataSchemaNode) child) : Optional.empty();
 201     }
 202
 203     @Override
 204     public Collection<? extends UsesNode> getUses() {
 205         return uses;
 206     }
 207
 208     @Override
 209     public Optional<SemVer> getSemanticVersion() {
 210         return findFirstEffectiveSubstatementArgument(OpenConfigVersionEffectiveStatement.class);
 211     }
 212
 213     @Override
 214     @SuppressWarnings("unchecked")
 215     protected <K, V, N extends IdentifierNamespace<K, V>> Optional<? extends Map<K, V>> getNamespaceContents(
 216             final Class<N> namespace) {
 217         if (SchemaTreeAwareEffectiveStatement.Namespace.class.equals(namespace)) {
 218             return Optional.of((Map<K, V>) schemaTreeNamespace);
 219         }
 220         return super.getNamespaceContents(namespace);
 221     }
 222
 223     @Override
 224     public String toString() {
 225         return MoreObjects.toStringHelper(this).omitNullValues()
 226                 .add("name", getName())
 227                 .add("namespace", getNamespace())
 228                 .add("revision", getRevision().orElse(null))
 229                 .add("prefix", prefix)
 230                 .add("yangVersion", getYangVersion())
 231                 .toString();
 232     }
 233
 234     protected static final @NonNull String findPrefix(final @NonNull StmtContext<?, ?, ?> ctx,
 235             final String type, final String name) {
 236         return SourceException.throwIfNull(
 237             StmtContextUtils.firstAttributeOf(ctx.declaredSubstatements(), PrefixStatement.class),
 238             ctx.getStatementSourceReference(), "Unable to resolve prefix for %s %s.", type, name);
 239     }
 240
 241     // Alright. this is quite ugly
 242     protected final void appendPrefixes(final StmtContext<?, ?, ?> ctx,
 243             final Builder<String, ModuleEffectiveStatement> builder) {
 244         streamEffectiveSubstatements(ImportEffectiveStatement.class)
 245             .map(imp -> imp.findFirstEffectiveSubstatementArgument(PrefixEffectiveStatement.class).get())
 246             .forEach(pfx -> {
 247                 final StmtContext<?, ?, ?> importedCtx =
 248                         verifyNotNull(ctx.getFromNamespace(ImportPrefixToModuleCtx.class, pfx),
 249                             "Failed to resolve prefix %s", pfx);
 250                 builder.put(pfx, (ModuleEffectiveStatement) importedCtx.buildEffective());
 251             });
 252     }
 253
 254     @SuppressWarnings("unchecked")
 255     private <T> @NonNull Collection<? extends T> filterSubstatements(final Class<T> type) {
 256         return (Collection<? extends T>) Collections2.filter(effectiveSubstatements(), type::isInstance);
 257     }
 258 }