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;
  18 import com.google.common.collect.ImmutableMap.Builder;
  19 import com.google.common.collect.ImmutableSet;
  20 import java.util.Collection;
  21 import java.util.LinkedHashSet;
  22 import java.util.Map;
  23 import java.util.Optional;
  24 import java.util.Set;
  25 import org.eclipse.jdt.annotation.NonNull;
  26 import org.opendaylight.yangtools.concepts.SemVer;
  27 import org.opendaylight.yangtools.openconfig.model.api.OpenConfigVersionEffectiveStatement;
  28 import org.opendaylight.yangtools.yang.common.QName;
  29 import org.opendaylight.yangtools.yang.common.YangVersion;
  30 import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
  31 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  32 import org.opendaylight.yangtools.yang.model.api.Deviation;
  33 import org.opendaylight.yangtools.yang.model.api.ExtensionDefinition;
  34 import org.opendaylight.yangtools.yang.model.api.FeatureDefinition;
  35 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
  36 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
  37 import org.opendaylight.yangtools.yang.model.api.ModuleImport;
  38 import org.opendaylight.yangtools.yang.model.api.ModuleLike;
  39 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
  40 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  41 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  42 import org.opendaylight.yangtools.yang.model.api.UsesNode;
  43 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  44 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  45 import org.opendaylight.yangtools.yang.model.api.meta.IdentifierNamespace;
  46 import org.opendaylight.yangtools.yang.model.api.stmt.ContactEffectiveStatement;
  47 import org.opendaylight.yangtools.yang.model.api.stmt.DataTreeAwareEffectiveStatement;
  48 import org.opendaylight.yangtools.yang.model.api.stmt.ImportEffectiveStatement;
  49 import org.opendaylight.yangtools.yang.model.api.stmt.ModuleEffectiveStatement;
  50 import org.opendaylight.yangtools.yang.model.api.stmt.OrganizationEffectiveStatement;
  51 import org.opendaylight.yangtools.yang.model.api.stmt.PrefixEffectiveStatement;
  52 import org.opendaylight.yangtools.yang.model.api.stmt.PrefixStatement;
  53 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaTreeAwareEffectiveStatement;
  54 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaTreeEffectiveStatement;
  55 import org.opendaylight.yangtools.yang.model.api.stmt.TypedefEffectiveStatement;
  56 import org.opendaylight.yangtools.yang.model.api.stmt.YangVersionEffectiveStatement;
  57 import org.opendaylight.yangtools.yang.model.api.stmt.compat.NotificationNodeContainerCompat;
  58 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.AbstractDeclaredEffectiveStatement.DefaultWithDataTree.WithSubstatements;
  59 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStatementMixins.DocumentedNodeMixin;
  60 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  61 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
  62 import org.opendaylight.yangtools.yang.parser.spi.source.ImportPrefixToModuleCtx;
  63 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  64
  65 @Beta
  66 public abstract class AbstractEffectiveModule<D extends DeclaredStatement<String>,
  67         E extends DataTreeAwareEffectiveStatement<String, D>> extends WithSubstatements<String, D, E>
  68         implements ModuleLike, DocumentedNodeMixin<String, D>, NotificationNodeContainerCompat<String, D, E> {
  69     private final String prefix;
  70     private final ImmutableSet<GroupingDefinition> groupings;
  71     private final ImmutableSet<UsesNode> uses;
  72     private final ImmutableSet<TypeDefinition<?>> typeDefinitions;
  73     private final ImmutableMap<QName, SchemaTreeEffectiveStatement<?>> schemaTreeNamespace;
  74
  75     protected AbstractEffectiveModule(final D declared,
  76             final StmtContext<String, D, ? extends EffectiveStatement<String, ?>> ctx,
  77             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements, final String prefix) {
  78         super(declared, ctx, substatements);
  79
  80         // This check is rather weird, but comes from our desire to lower memory footprint while providing both
  81         // EffectiveStatements and SchemaNode interfaces -- which do not overlap completely where child lookups are
  82         // concerned. This ensures that we have SchemaTree index available for use with child lookups.
  83         final Map<QName, SchemaTreeEffectiveStatement<?>> schemaTree =
  84                 createSchemaTreeNamespace(ctx.getStatementSourceReference(), effectiveSubstatements());
  85         schemaTreeNamespace = ImmutableMap.copyOf(schemaTree);
  86
  87         // Data tree check, not currently used
  88         createDataTreeNamespace(ctx.getStatementSourceReference(), schemaTree.values(), schemaTreeNamespace);
  89
  90         this.prefix = requireNonNull(prefix);
  91
  92         final Set<GroupingDefinition> mutableGroupings = new LinkedHashSet<>();
  93         final Set<UsesNode> mutableUses = new LinkedHashSet<>();
  94         final Set<TypeDefinition<?>> mutableTypeDefinitions = new LinkedHashSet<>();
  95
  96         for (final EffectiveStatement<?, ?> effectiveStatement : effectiveSubstatements()) {
  97             if (effectiveStatement instanceof UsesNode && !mutableUses.add((UsesNode) effectiveStatement)) {
  98                 throw EffectiveStmtUtils.createNameCollisionSourceException(ctx, effectiveStatement);
  99             }
 100             if (effectiveStatement instanceof TypedefEffectiveStatement) {
 101                 final TypeDefinition<?> type = ((TypedefEffectiveStatement) effectiveStatement).getTypeDefinition();
 102                 if (!mutableTypeDefinitions.add(type)) {
 103                     throw EffectiveStmtUtils.createNameCollisionSourceException(ctx, effectiveStatement);
 104                 }
 105             }
 106             if (effectiveStatement instanceof GroupingDefinition
 107                     && !mutableGroupings.add((GroupingDefinition) effectiveStatement)) {
 108                 throw EffectiveStmtUtils.createNameCollisionSourceException(ctx, effectiveStatement);
 109             }
 110         }
 111
 112         this.groupings = ImmutableSet.copyOf(mutableGroupings);
 113         this.typeDefinitions = ImmutableSet.copyOf(mutableTypeDefinitions);
 114         this.uses = ImmutableSet.copyOf(mutableUses);
 115     }
 116
 117     @Override
 118     public String argument() {
 119         return getDeclared().argument();
 120     }
 121
 122     @Override
 123     public String getName() {
 124         return argument();
 125     }
 126
 127     @Override
 128     public String getPrefix() {
 129         return prefix;
 130     }
 131
 132     @Override
 133     public YangVersion getYangVersion() {
 134         return findFirstEffectiveSubstatementArgument(YangVersionEffectiveStatement.class)
 135                 .orElse(YangVersion.VERSION_1);
 136     }
 137
 138     @Override
 139     public Optional<String> getOrganization() {
 140         return findFirstEffectiveSubstatementArgument(OrganizationEffectiveStatement.class);
 141     }
 142
 143     @Override
 144     public Optional<String> getContact() {
 145         return findFirstEffectiveSubstatementArgument(ContactEffectiveStatement.class);
 146     }
 147
 148     @Override
 149     public Collection<? extends ModuleImport> getImports() {
 150         return filterSubstatements(ModuleImport.class);
 151     }
 152
 153     @Override
 154     public Collection<? extends FeatureDefinition> getFeatures() {
 155         return filterSubstatements(FeatureDefinition.class);
 156     }
 157
 158     @Override
 159     public Collection<? extends NotificationDefinition> getNotifications() {
 160         return filterSubstatements(NotificationDefinition.class);
 161     }
 162
 163     @Override
 164     public Collection<? extends AugmentationSchemaNode> getAugmentations() {
 165         return filterSubstatements(AugmentationSchemaNode.class);
 166     }
 167
 168     @Override
 169     public Collection<? extends RpcDefinition> getRpcs() {
 170         return filterSubstatements(RpcDefinition.class);
 171     }
 172
 173     @Override
 174     public Collection<? extends Deviation> getDeviations() {
 175         return filterSubstatements(Deviation.class);
 176     }
 177
 178     @Override
 179     public Collection<? extends ExtensionDefinition> getExtensionSchemaNodes() {
 180         return filterSubstatements(ExtensionDefinition.class);
 181     }
 182
 183     @Override
 184     public Collection<? extends IdentitySchemaNode> getIdentities() {
 185         return filterSubstatements(IdentitySchemaNode.class);
 186     }
 187
 188     @Override
 189     public final Collection<? extends TypeDefinition<?>> getTypeDefinitions() {
 190         return typeDefinitions;
 191     }
 192
 193     @Override
 194     public final Collection<? extends DataSchemaNode> getChildNodes() {
 195         return filterSubstatements(DataSchemaNode.class);
 196     }
 197
 198     @Override
 199     public final Collection<? extends GroupingDefinition> getGroupings() {
 200         return groupings;
 201     }
 202
 203     @Override
 204     @SuppressWarnings("checkstyle:hiddenField")
 205     public final Optional<DataSchemaNode> findDataChildByName(final QName name) {
 206         final SchemaTreeEffectiveStatement<?> child = schemaTreeNamespace.get(requireNonNull(name));
 207         return child instanceof DataSchemaNode ? Optional.of((DataSchemaNode) child) : Optional.empty();
 208     }
 209
 210     @Override
 211     public Collection<? extends UsesNode> getUses() {
 212         return uses;
 213     }
 214
 215     @Override
 216     public Optional<SemVer> getSemanticVersion() {
 217         return findFirstEffectiveSubstatementArgument(OpenConfigVersionEffectiveStatement.class);
 218     }
 219
 220     @Override
 221     @SuppressWarnings("unchecked")
 222     protected <K, V, N extends IdentifierNamespace<K, V>> Optional<? extends Map<K, V>> getNamespaceContents(
 223             final Class<N> namespace) {
 224         if (SchemaTreeAwareEffectiveStatement.Namespace.class.equals(namespace)) {
 225             return Optional.of((Map<K, V>) schemaTreeNamespace);
 226         }
 227         return super.getNamespaceContents(namespace);
 228     }
 229
 230     @Override
 231     public String toString() {
 232         return MoreObjects.toStringHelper(this).omitNullValues()
 233                 .add("name", getName())
 234                 .add("namespace", getNamespace())
 235                 .add("revision", getRevision().orElse(null))
 236                 .add("prefix", prefix)
 237                 .add("yangVersion", getYangVersion())
 238                 .toString();
 239     }
 240
 241     protected static final @NonNull String findPrefix(final @NonNull StmtContext<?, ?, ?> ctx,
 242             final String type, final String name) {
 243         return SourceException.throwIfNull(
 244             StmtContextUtils.firstAttributeOf(ctx.declaredSubstatements(), PrefixStatement.class),
 245             ctx.getStatementSourceReference(), "Unable to resolve prefix for %s %s.", type, name);
 246     }
 247
 248     // Alright. this is quite ugly
 249     protected final void appendPrefixes(final StmtContext<?, ?, ?> ctx,
 250             final Builder<String, ModuleEffectiveStatement> builder) {
 251         streamEffectiveSubstatements(ImportEffectiveStatement.class)
 252             .map(imp -> imp.findFirstEffectiveSubstatementArgument(PrefixEffectiveStatement.class).get())
 253             .forEach(pfx -> {
 254                 final StmtContext<?, ?, ?> importedCtx =
 255                         verifyNotNull(ctx.getFromNamespace(ImportPrefixToModuleCtx.class, pfx),
 256                             "Failed to resolve prefix %s", pfx);
 257                 builder.put(pfx, (ModuleEffectiveStatement) importedCtx.buildEffective());
 258             });
 259     }
 260
 261     @SuppressWarnings("unchecked")
 262     private <T> @NonNull Collection<? extends T> filterSubstatements(final Class<T> type) {
 263         return (Collection<? extends T>) Collections2.filter(effectiveSubstatements(), type::isInstance);
 264     }
 265 }