parser/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.collect.Collections2;
  15 import com.google.common.collect.ImmutableList;
  16 import com.google.common.collect.ImmutableMap.Builder;
  17 import com.google.common.collect.ImmutableSet;
  18 import java.util.Collection;
  19 import java.util.LinkedHashSet;
  20 import java.util.Optional;
  21 import java.util.Set;
  22 import org.eclipse.jdt.annotation.NonNull;
  23 import org.opendaylight.yangtools.concepts.SemVer;
  24 import org.opendaylight.yangtools.openconfig.model.api.OpenConfigVersionEffectiveStatement;
  25 import org.opendaylight.yangtools.yang.common.QName;
  26 import org.opendaylight.yangtools.yang.common.UnresolvedQName.Unqualified;
  27 import org.opendaylight.yangtools.yang.common.YangVersion;
  28 import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
  29 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  30 import org.opendaylight.yangtools.yang.model.api.Deviation;
  31 import org.opendaylight.yangtools.yang.model.api.ExtensionDefinition;
  32 import org.opendaylight.yangtools.yang.model.api.FeatureDefinition;
  33 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
  34 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
  35 import org.opendaylight.yangtools.yang.model.api.ModuleImport;
  36 import org.opendaylight.yangtools.yang.model.api.ModuleLike;
  37 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
  38 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  39 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  40 import org.opendaylight.yangtools.yang.model.api.UsesNode;
  41 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  42 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  43 import org.opendaylight.yangtools.yang.model.api.stmt.ContactEffectiveStatement;
  44 import org.opendaylight.yangtools.yang.model.api.stmt.DataTreeAwareEffectiveStatement;
  45 import org.opendaylight.yangtools.yang.model.api.stmt.ImportEffectiveStatement;
  46 import org.opendaylight.yangtools.yang.model.api.stmt.ModuleEffectiveStatement;
  47 import org.opendaylight.yangtools.yang.model.api.stmt.OrganizationEffectiveStatement;
  48 import org.opendaylight.yangtools.yang.model.api.stmt.PrefixEffectiveStatement;
  49 import org.opendaylight.yangtools.yang.model.api.stmt.TypedefEffectiveStatement;
  50 import org.opendaylight.yangtools.yang.model.api.stmt.YangVersionEffectiveStatement;
  51 import org.opendaylight.yangtools.yang.model.api.stmt.compat.NotificationNodeContainerCompat;
  52 import org.opendaylight.yangtools.yang.model.spi.meta.AbstractDeclaredEffectiveStatement.DefaultWithDataTree.WithTypedefNamespace;
  53 import org.opendaylight.yangtools.yang.model.spi.meta.EffectiveStatementMixins.DocumentedNodeMixin;
  54 import org.opendaylight.yangtools.yang.parser.spi.meta.CommonStmtCtx;
  55 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  56 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  57 import org.opendaylight.yangtools.yang.parser.spi.source.ImportPrefixToModuleCtx;
  58 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  59
  60 @Beta
  61 public abstract class AbstractEffectiveModule<D extends DeclaredStatement<Unqualified>,
  62         E extends DataTreeAwareEffectiveStatement<Unqualified, D>>
  63         extends WithTypedefNamespace<Unqualified, D>
  64         implements ModuleLike, DocumentedNodeMixin<Unqualified, D>, NotificationNodeContainerCompat<Unqualified, D, E> {
  65     private final String prefix;
  66     private final ImmutableSet<GroupingDefinition> groupings;
  67     private final ImmutableSet<UsesNode> uses;
  68     private final ImmutableSet<TypeDefinition<?>> typeDefinitions;
  69
  70     protected AbstractEffectiveModule(final Current<Unqualified, D> stmt,
  71             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements, final String prefix) {
  72         super(stmt.declared(), substatements);
  73
  74         this.prefix = requireNonNull(prefix);
  75
  76         final Set<GroupingDefinition> mutableGroupings = new LinkedHashSet<>();
  77         final Set<UsesNode> mutableUses = new LinkedHashSet<>();
  78         final Set<TypeDefinition<?>> mutableTypeDefinitions = new LinkedHashSet<>();
  79
  80         for (final EffectiveStatement<?, ?> effectiveStatement : effectiveSubstatements()) {
  81             if (effectiveStatement instanceof UsesNode && !mutableUses.add((UsesNode) effectiveStatement)) {
  82                 throw EffectiveStmtUtils.createNameCollisionSourceException(stmt, effectiveStatement);
  83             }
  84             if (effectiveStatement instanceof TypedefEffectiveStatement) {
  85                 final TypeDefinition<?> type = ((TypedefEffectiveStatement) effectiveStatement).getTypeDefinition();
  86                 if (!mutableTypeDefinitions.add(type)) {
  87                     throw EffectiveStmtUtils.createNameCollisionSourceException(stmt, effectiveStatement);
  88                 }
  89             }
  90             if (effectiveStatement instanceof GroupingDefinition
  91                     && !mutableGroupings.add((GroupingDefinition) effectiveStatement)) {
  92                 throw EffectiveStmtUtils.createNameCollisionSourceException(stmt, effectiveStatement);
  93             }
  94         }
  95
  96         this.groupings = ImmutableSet.copyOf(mutableGroupings);
  97         this.typeDefinitions = ImmutableSet.copyOf(mutableTypeDefinitions);
  98         this.uses = ImmutableSet.copyOf(mutableUses);
  99     }
 100
 101     @Override
 102     public Unqualified argument() {
 103         return getDeclared().argument();
 104     }
 105
 106     @Override
 107     public String getName() {
 108         return argument().getLocalName();
 109     }
 110
 111     @Override
 112     public String getPrefix() {
 113         return prefix;
 114     }
 115
 116     @Override
 117     public YangVersion getYangVersion() {
 118         return findFirstEffectiveSubstatementArgument(YangVersionEffectiveStatement.class)
 119                 .orElse(YangVersion.VERSION_1);
 120     }
 121
 122     @Override
 123     public Optional<String> getOrganization() {
 124         return findFirstEffectiveSubstatementArgument(OrganizationEffectiveStatement.class);
 125     }
 126
 127     @Override
 128     public Optional<String> getContact() {
 129         return findFirstEffectiveSubstatementArgument(ContactEffectiveStatement.class);
 130     }
 131
 132     @Override
 133     public Collection<? extends @NonNull ModuleImport> getImports() {
 134         return filterSubstatements(ModuleImport.class);
 135     }
 136
 137     @Override
 138     public Collection<? extends @NonNull FeatureDefinition> getFeatures() {
 139         return filterSubstatements(FeatureDefinition.class);
 140     }
 141
 142     @Override
 143     public Collection<? extends @NonNull NotificationDefinition> getNotifications() {
 144         return filterSubstatements(NotificationDefinition.class);
 145     }
 146
 147     @Override
 148     public Collection<? extends @NonNull AugmentationSchemaNode> getAugmentations() {
 149         return filterSubstatements(AugmentationSchemaNode.class);
 150     }
 151
 152     @Override
 153     public Collection<? extends @NonNull RpcDefinition> getRpcs() {
 154         return filterSubstatements(RpcDefinition.class);
 155     }
 156
 157     @Override
 158     public Collection<? extends @NonNull Deviation> getDeviations() {
 159         return filterSubstatements(Deviation.class);
 160     }
 161
 162     @Override
 163     public Collection<? extends @NonNull ExtensionDefinition> getExtensionSchemaNodes() {
 164         return filterSubstatements(ExtensionDefinition.class);
 165     }
 166
 167     @Override
 168     public Collection<? extends @NonNull IdentitySchemaNode> getIdentities() {
 169         return filterSubstatements(IdentitySchemaNode.class);
 170     }
 171
 172     @Override
 173     public final Collection<? extends TypeDefinition<?>> getTypeDefinitions() {
 174         return typeDefinitions;
 175     }
 176
 177     @Override
 178     public final Collection<? extends DataSchemaNode> getChildNodes() {
 179         return filterSubstatements(DataSchemaNode.class);
 180     }
 181
 182     @Override
 183     public final Collection<? extends GroupingDefinition> getGroupings() {
 184         return groupings;
 185     }
 186
 187     @Override
 188     @SuppressWarnings("checkstyle:hiddenField")
 189     public final DataSchemaNode dataChildByName(final QName name) {
 190         return dataSchemaNode(name);
 191     }
 192
 193     @Override
 194     public Collection<? extends UsesNode> getUses() {
 195         return uses;
 196     }
 197
 198     @Override
 199     public Optional<SemVer> getSemanticVersion() {
 200         return findFirstEffectiveSubstatementArgument(OpenConfigVersionEffectiveStatement.class);
 201     }
 202
 203     protected static final @NonNull String findPrefix(final CommonStmtCtx stmt,
 204             final Collection<? extends EffectiveStatement<?, ?>> substatements, final String type, final String name) {
 205         return substatements.stream()
 206             .filter(PrefixEffectiveStatement.class::isInstance)
 207             .map(prefix -> ((PrefixEffectiveStatement) prefix).argument())
 208             .findAny()
 209             .orElseThrow(() -> new SourceException(stmt, "Unable to resolve prefix for %s %s.", type, name));
 210     }
 211
 212     // Alright. this is quite ugly
 213     protected final void appendPrefixes(final Current<?, ?> stmt,
 214             final Builder<String, ModuleEffectiveStatement> builder) {
 215         streamEffectiveSubstatements(ImportEffectiveStatement.class)
 216             .map(imp -> imp.findFirstEffectiveSubstatementArgument(PrefixEffectiveStatement.class).get())
 217             .forEach(pfx -> {
 218                 final StmtContext<?, ?, ?> importedCtx =
 219                         verifyNotNull(stmt.getFromNamespace(ImportPrefixToModuleCtx.class, pfx),
 220                             "Failed to resolve prefix %s", pfx);
 221                 builder.put(pfx, (ModuleEffectiveStatement) importedCtx.buildEffective());
 222             });
 223     }
 224
 225     @SuppressWarnings("unchecked")
 226     private <T> @NonNull Collection<? extends T> filterSubstatements(final Class<T> type) {
 227         return (Collection<? extends T>) Collections2.filter(effectiveSubstatements(), type::isInstance);
 228     }
 229 }