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