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