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