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