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.PrefixStatement;
  51 import org.opendaylight.yangtools.yang.model.api.stmt.TypedefEffectiveStatement;
  52 import org.opendaylight.yangtools.yang.model.api.stmt.YangVersionEffectiveStatement;
  53 import org.opendaylight.yangtools.yang.model.api.stmt.compat.NotificationNodeContainerCompat;
  54 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.AbstractDeclaredEffectiveStatement.DefaultWithDataTree.WithSubstatements;
  55 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStatementMixins.DocumentedNodeMixin;
  56 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  57 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
  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 D declared,
  73             final StmtContext<UnqualifiedQName, D, ? extends EffectiveStatement<UnqualifiedQName, ?>> ctx,
  74             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements, final String prefix) {
  75         super(declared, ctx, substatements);
  76
  77         this.prefix = requireNonNull(prefix);
  78
  79         final Set<GroupingDefinition> mutableGroupings = new LinkedHashSet<>();
  80         final Set<UsesNode> mutableUses = new LinkedHashSet<>();
  81         final Set<TypeDefinition<?>> mutableTypeDefinitions = new LinkedHashSet<>();
  82
  83         for (final EffectiveStatement<?, ?> effectiveStatement : effectiveSubstatements()) {
  84             if (effectiveStatement instanceof UsesNode && !mutableUses.add((UsesNode) effectiveStatement)) {
  85                 throw EffectiveStmtUtils.createNameCollisionSourceException(ctx, effectiveStatement);
  86             }
  87             if (effectiveStatement instanceof TypedefEffectiveStatement) {
  88                 final TypeDefinition<?> type = ((TypedefEffectiveStatement) effectiveStatement).getTypeDefinition();
  89                 if (!mutableTypeDefinitions.add(type)) {
  90                     throw EffectiveStmtUtils.createNameCollisionSourceException(ctx, effectiveStatement);
  91                 }
  92             }
  93             if (effectiveStatement instanceof GroupingDefinition
  94                     && !mutableGroupings.add((GroupingDefinition) effectiveStatement)) {
  95                 throw EffectiveStmtUtils.createNameCollisionSourceException(ctx, effectiveStatement);
  96             }
  97         }
  98
  99         this.groupings = ImmutableSet.copyOf(mutableGroupings);
 100         this.typeDefinitions = ImmutableSet.copyOf(mutableTypeDefinitions);
 101         this.uses = ImmutableSet.copyOf(mutableUses);
 102     }
 103
 104     @Override
 105     public UnqualifiedQName argument() {
 106         return getDeclared().argument();
 107     }
 108
 109     @Override
 110     public String getName() {
 111         return argument().getLocalName();
 112     }
 113
 114     @Override
 115     public String getPrefix() {
 116         return prefix;
 117     }
 118
 119     @Override
 120     public YangVersion getYangVersion() {
 121         return findFirstEffectiveSubstatementArgument(YangVersionEffectiveStatement.class)
 122                 .orElse(YangVersion.VERSION_1);
 123     }
 124
 125     @Override
 126     public Optional<String> getOrganization() {
 127         return findFirstEffectiveSubstatementArgument(OrganizationEffectiveStatement.class);
 128     }
 129
 130     @Override
 131     public Optional<String> getContact() {
 132         return findFirstEffectiveSubstatementArgument(ContactEffectiveStatement.class);
 133     }
 134
 135     @Override
 136     public Collection<? extends @NonNull ModuleImport> getImports() {
 137         return filterSubstatements(ModuleImport.class);
 138     }
 139
 140     @Override
 141     public Collection<? extends @NonNull FeatureDefinition> getFeatures() {
 142         return filterSubstatements(FeatureDefinition.class);
 143     }
 144
 145     @Override
 146     public Collection<? extends @NonNull NotificationDefinition> getNotifications() {
 147         return filterSubstatements(NotificationDefinition.class);
 148     }
 149
 150     @Override
 151     public Collection<? extends @NonNull AugmentationSchemaNode> getAugmentations() {
 152         return filterSubstatements(AugmentationSchemaNode.class);
 153     }
 154
 155     @Override
 156     public Collection<? extends @NonNull RpcDefinition> getRpcs() {
 157         return filterSubstatements(RpcDefinition.class);
 158     }
 159
 160     @Override
 161     public Collection<? extends @NonNull Deviation> getDeviations() {
 162         return filterSubstatements(Deviation.class);
 163     }
 164
 165     @Override
 166     public Collection<? extends @NonNull ExtensionDefinition> getExtensionSchemaNodes() {
 167         return filterSubstatements(ExtensionDefinition.class);
 168     }
 169
 170     @Override
 171     public Collection<? extends @NonNull IdentitySchemaNode> getIdentities() {
 172         return filterSubstatements(IdentitySchemaNode.class);
 173     }
 174
 175     @Override
 176     public final Collection<? extends TypeDefinition<?>> getTypeDefinitions() {
 177         return typeDefinitions;
 178     }
 179
 180     @Override
 181     public final Collection<? extends DataSchemaNode> getChildNodes() {
 182         return filterSubstatements(DataSchemaNode.class);
 183     }
 184
 185     @Override
 186     public final Collection<? extends GroupingDefinition> getGroupings() {
 187         return groupings;
 188     }
 189
 190     @Override
 191     @SuppressWarnings("checkstyle:hiddenField")
 192     public final Optional<DataSchemaNode> findDataChildByName(final QName name) {
 193         return findDataSchemaNode(name);
 194     }
 195
 196     @Override
 197     public Collection<? extends UsesNode> getUses() {
 198         return uses;
 199     }
 200
 201     @Override
 202     public Optional<SemVer> getSemanticVersion() {
 203         return findFirstEffectiveSubstatementArgument(OpenConfigVersionEffectiveStatement.class);
 204     }
 205
 206     @Override
 207     public String toString() {
 208         return MoreObjects.toStringHelper(this).omitNullValues()
 209                 .add("name", getName())
 210                 .add("namespace", getNamespace())
 211                 .add("revision", getRevision().orElse(null))
 212                 .add("prefix", prefix)
 213                 .add("yangVersion", getYangVersion())
 214                 .toString();
 215     }
 216
 217     protected static final @NonNull String findPrefix(final @NonNull StmtContext<?, ?, ?> ctx,
 218             final String type, final String name) {
 219         return SourceException.throwIfNull(
 220             StmtContextUtils.firstAttributeOf(ctx.declaredSubstatements(), PrefixStatement.class),
 221             ctx.getStatementSourceReference(), "Unable to resolve prefix for %s %s.", type, name);
 222     }
 223
 224     // Alright. this is quite ugly
 225     protected final void appendPrefixes(final StmtContext<?, ?, ?> ctx,
 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(ctx.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 }