YANGTOOLS-706: split out rfc8040-model-api
[yangtools.git] / yang / yang-parser-impl / src / main / java / org / opendaylight / yangtools / yang / parser / stmt / rfc6020 / effective / AbstractEffectiveModule.java
index 46409984e62e9f69c6ca849cc2ca657326d6f4fc..6d4b993bfa19b0fe6d4480612b79f6b79a668658 100644 (file)
@@ -7,7 +7,10 @@
  */
 package org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective;
 
-import com.google.common.base.Preconditions;
+import static com.google.common.base.Preconditions.checkState;
+import static java.util.Objects.requireNonNull;
+
+import com.google.common.base.MoreObjects;
 import com.google.common.collect.ImmutableList;
 import com.google.common.collect.ImmutableMap;
 import com.google.common.collect.ImmutableSet;
@@ -15,20 +18,21 @@ import com.google.common.collect.Iterables;
 import java.net.URI;
 import java.util.ArrayList;
 import java.util.Collection;
-import java.util.Date;
 import java.util.HashSet;
 import java.util.LinkedHashMap;
 import java.util.LinkedHashSet;
 import java.util.List;
 import java.util.Map;
+import java.util.Optional;
 import java.util.Set;
+import java.util.stream.Collectors;
 import javax.annotation.Nonnull;
 import org.opendaylight.yangtools.concepts.SemVer;
 import org.opendaylight.yangtools.yang.common.QName;
-import org.opendaylight.yangtools.yang.common.QNameModule;
-import org.opendaylight.yangtools.yang.common.SimpleDateFormatUtil;
+import org.opendaylight.yangtools.yang.common.Revision;
 import org.opendaylight.yangtools.yang.common.YangVersion;
-import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
+import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
 import org.opendaylight.yangtools.yang.model.api.Deviation;
 import org.opendaylight.yangtools.yang.model.api.ExtensionDefinition;
@@ -36,10 +40,10 @@ import org.opendaylight.yangtools.yang.model.api.FeatureDefinition;
 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
 import org.opendaylight.yangtools.yang.model.api.Module;
-import org.opendaylight.yangtools.yang.model.api.ModuleIdentifier;
 import org.opendaylight.yangtools.yang.model.api.ModuleImport;
 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
+import org.opendaylight.yangtools.yang.model.api.SchemaNode;
 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
 import org.opendaylight.yangtools.yang.model.api.UsesNode;
@@ -47,18 +51,16 @@ import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
 import org.opendaylight.yangtools.yang.model.api.stmt.SubmoduleStatement;
-import org.opendaylight.yangtools.yang.parser.spi.SubmoduleNamespace;
 import org.opendaylight.yangtools.yang.parser.spi.meta.MutableStatement;
 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
-import org.opendaylight.yangtools.yang.parser.spi.source.DeclarationInTextSource;
-import org.opendaylight.yangtools.yang.parser.spi.source.IncludedSubmoduleNameToIdentifier;
-import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.Utils;
+import org.opendaylight.yangtools.yang.parser.spi.source.IncludedSubmoduleNameToModuleCtx;
+import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
+import org.opendaylight.yangtools.yang.parser.stmt.openconfig.OpenconfigVersionEffectiveStatement;
 
 abstract class AbstractEffectiveModule<D extends DeclaredStatement<String>> extends
         AbstractEffectiveDocumentedNode<String, D> implements Module, MutableStatement {
     private final String name;
-    private final String sourcePath;
     private final String prefix;
     private final YangVersion yangVersion;
     private final String organization;
@@ -66,7 +68,7 @@ abstract class AbstractEffectiveModule<D extends DeclaredStatement<String>> exte
     private final Set<ModuleImport> imports;
     private final Set<FeatureDefinition> features;
     private final Set<NotificationDefinition> notifications;
-    private final Set<AugmentationSchema> augmentations;
+    private final Set<AugmentationSchemaNode> augmentations;
     private final Set<RpcDefinition> rpcs;
     private final Set<Deviation> deviations;
     private final List<ExtensionDefinition> extensionNodes;
@@ -78,7 +80,9 @@ abstract class AbstractEffectiveModule<D extends DeclaredStatement<String>> exte
     private final Set<TypeDefinition<?>> typeDefinitions;
     private final Set<DataSchemaNode> publicChildNodes;
     private final SemVer semanticVersion;
-    private Set<StmtContext<?, SubmoduleStatement, EffectiveStatement<String, SubmoduleStatement>>> submoduleContextsToBuild;
+
+    private Set<StmtContext<?, SubmoduleStatement, EffectiveStatement<String, SubmoduleStatement>>>
+        submoduleContextsToBuild;
     private Set<Module> submodules;
     private boolean sealed;
 
@@ -87,31 +91,38 @@ abstract class AbstractEffectiveModule<D extends DeclaredStatement<String>> exte
 
         this.name = argument();
 
-        final PrefixEffectiveStatementImpl prefixStmt = firstEffective(PrefixEffectiveStatementImpl.class);
-        this.prefix = (prefixStmt == null) ? null : prefixStmt.argument();
+        EffectiveStatementBase<?, ?> parentOfPrefix = this;
+        if (ctx.getPublicDefinition() == YangStmtMapping.SUBMODULE) {
+            parentOfPrefix = firstEffective(BelongsToEffectiveStatementImpl.class);
+            SourceException.throwIfNull(parentOfPrefix, ctx.getStatementSourceReference(),
+                    "Unable to find belongs-to statement in submodule %s.", ctx.getStatementArgument());
+        }
 
-        final YangVersionEffectiveStatementImpl yangVersionStmt = firstEffective(YangVersionEffectiveStatementImpl.class);
-        this.yangVersion = (yangVersionStmt == null) ? YangVersion.VERSION_1 : yangVersionStmt.argument();
+        final PrefixEffectiveStatementImpl prefixStmt = parentOfPrefix
+                .firstEffective(PrefixEffectiveStatementImpl.class);
+        SourceException.throwIfNull(prefixStmt, ctx.getStatementSourceReference(),
+                "Unable to resolve prefix for module or submodule %s.", ctx.getStatementArgument());
+        this.prefix = prefixStmt.argument();
 
-        final SemanticVersionEffectiveStatementImpl semanticVersionStmt = firstEffective(SemanticVersionEffectiveStatementImpl.class);
-        this.semanticVersion = (semanticVersionStmt == null) ? DEFAULT_SEMANTIC_VERSION : semanticVersionStmt.argument();
+        final YangVersionEffectiveStatementImpl yangVersionStmt =
+                firstEffective(YangVersionEffectiveStatementImpl.class);
+        this.yangVersion = yangVersionStmt == null ? YangVersion.VERSION_1 : yangVersionStmt.argument();
 
-        final OrganizationEffectiveStatementImpl organizationStmt = firstEffective(OrganizationEffectiveStatementImpl.class);
-        this.organization = (organizationStmt == null) ? null : organizationStmt.argument();
+        final OpenconfigVersionEffectiveStatement semanticVersionStmt =
+                firstEffective(OpenconfigVersionEffectiveStatement.class);
+        this.semanticVersion = semanticVersionStmt == null ? null : semanticVersionStmt.argument();
 
-        final ContactEffectiveStatementImpl contactStmt = firstEffective(ContactEffectiveStatementImpl.class);
-        this.contact = (contactStmt == null) ? null : contactStmt.argument();
+        final OrganizationEffectiveStatementImpl organizationStmt =
+                firstEffective(OrganizationEffectiveStatementImpl.class);
+        this.organization = organizationStmt == null ? null : organizationStmt.argument();
 
-        if (ctx.getStatementSourceReference() instanceof DeclarationInTextSource) {
-            this.sourcePath = ((DeclarationInTextSource) ctx.getStatementSourceReference()).getSourceName();
-        } else {
-            this.sourcePath = null;
-        }
+        final ContactEffectiveStatementImpl contactStmt = firstEffective(ContactEffectiveStatementImpl.class);
+        this.contact = contactStmt == null ? null : contactStmt.argument();
 
         // init submodules and substatements of submodules
         final List<EffectiveStatement<?, ?>> substatementsOfSubmodules;
-        final Map<String, ModuleIdentifier> includedSubmodulesMap = ctx
-                .getAllFromCurrentStmtCtxNamespace(IncludedSubmoduleNameToIdentifier.class);
+        final Map<String, StmtContext<?, ?, ?>> includedSubmodulesMap = ctx
+                .getAllFromCurrentStmtCtxNamespace(IncludedSubmoduleNameToModuleCtx.class);
 
         if (includedSubmodulesMap == null || includedSubmodulesMap.isEmpty()) {
             this.submodules = ImmutableSet.of();
@@ -123,17 +134,16 @@ abstract class AbstractEffectiveModule<D extends DeclaredStatement<String>> exte
              * for modules. In case of submodules it does not make sense because
              * of possible circular chains of includes between submodules.
              */
-            final Collection<ModuleIdentifier> includedSubmodules = includedSubmodulesMap.values();
+            final Collection<StmtContext<?, ?, ?>> includedSubmodules = includedSubmodulesMap.values();
             final Set<Module> submodulesInit = new HashSet<>();
             final List<EffectiveStatement<?, ?>> substatementsOfSubmodulesInit = new ArrayList<>();
-            for (final ModuleIdentifier submoduleIdentifier : includedSubmodules) {
-                @SuppressWarnings("unchecked")
-                final Mutable<String, SubmoduleStatement, EffectiveStatement<String, SubmoduleStatement>> submoduleCtx = (Mutable<String, SubmoduleStatement, EffectiveStatement<String, SubmoduleStatement>>) ctx
-                        .getFromNamespace(SubmoduleNamespace.class, submoduleIdentifier);
+            for (final StmtContext<?, ?, ?> submoduleCtx : includedSubmodules) {
                 final SubmoduleEffectiveStatementImpl submodule = (SubmoduleEffectiveStatementImpl) submoduleCtx
                         .buildEffective();
                 submodulesInit.add(submodule);
-                substatementsOfSubmodulesInit.addAll(submodule.effectiveSubstatements());
+                substatementsOfSubmodulesInit.addAll(submodule.effectiveSubstatements().stream()
+                        .filter(sub -> sub instanceof SchemaNode || sub instanceof DataNodeContainer)
+                        .collect(Collectors.toList()));
             }
 
             this.submodules = ImmutableSet.copyOf(submodulesInit);
@@ -145,11 +155,11 @@ abstract class AbstractEffectiveModule<D extends DeclaredStatement<String>> exte
              * collect only submodule contexts here and then build them during
              * sealing of this statement.
              */
-            final Set<StmtContext<?, SubmoduleStatement, EffectiveStatement<String, SubmoduleStatement>>> submoduleContextsInit = new HashSet<>();
-            for (final ModuleIdentifier submoduleIdentifier : includedSubmodulesMap.values()) {
-                final StmtContext<?, SubmoduleStatement, EffectiveStatement<String, SubmoduleStatement>> submoduleCtx = ctx
-                        .getFromNamespace(SubmoduleNamespace.class, submoduleIdentifier);
-                submoduleContextsInit.add(submoduleCtx);
+            final Set<StmtContext<?, SubmoduleStatement, EffectiveStatement<String, SubmoduleStatement>>>
+                submoduleContextsInit = new HashSet<>();
+            for (final StmtContext<?, ?, ?> submoduleCtx : includedSubmodulesMap.values()) {
+                submoduleContextsInit.add(
+                    (StmtContext<?, SubmoduleStatement, EffectiveStatement<String, SubmoduleStatement>>)submoduleCtx);
             }
 
             this.submoduleContextsToBuild = ImmutableSet.copyOf(submoduleContextsInit);
@@ -169,7 +179,7 @@ abstract class AbstractEffectiveModule<D extends DeclaredStatement<String>> exte
         effectiveSubstatements.addAll(substatementsOfSubmodules);
 
         final List<UnknownSchemaNode> unknownNodesInit = new ArrayList<>();
-        final Set<AugmentationSchema> augmentationsInit = new LinkedHashSet<>();
+        final Set<AugmentationSchemaNode> augmentationsInit = new LinkedHashSet<>();
         final Set<ModuleImport> importsInit = new HashSet<>();
         final Set<NotificationDefinition> notificationsInit = new HashSet<>();
         final Set<RpcDefinition> rpcsInit = new HashSet<>();
@@ -188,8 +198,8 @@ abstract class AbstractEffectiveModule<D extends DeclaredStatement<String>> exte
             if (effectiveStatement instanceof UnknownSchemaNode) {
                 unknownNodesInit.add((UnknownSchemaNode) effectiveStatement);
             }
-            if (effectiveStatement instanceof AugmentationSchema) {
-                augmentationsInit.add((AugmentationSchema) effectiveStatement);
+            if (effectiveStatement instanceof AugmentationSchemaNode) {
+                augmentationsInit.add((AugmentationSchemaNode) effectiveStatement);
             }
             if (effectiveStatement instanceof ModuleImport) {
                 importsInit.add((ModuleImport) effectiveStatement);
@@ -250,11 +260,7 @@ abstract class AbstractEffectiveModule<D extends DeclaredStatement<String>> exte
 
         this.unknownNodes = ImmutableList.copyOf(unknownNodesInit);
         this.augmentations = ImmutableSet.copyOf(augmentationsInit);
-        if (ctx.isEnabledSemanticVersioning()) {
-            this.imports = ImmutableSet.copyOf(importsInit);
-        } else {
-            this.imports = ImmutableSet.copyOf(resolveModuleImports(importsInit, ctx));
-        }
+        this.imports = ImmutableSet.copyOf(importsInit);
         this.notifications = ImmutableSet.copyOf(notificationsInit);
         this.rpcs = ImmutableSet.copyOf(rpcsInit);
         this.deviations = ImmutableSet.copyOf(deviationsInit);
@@ -270,32 +276,6 @@ abstract class AbstractEffectiveModule<D extends DeclaredStatement<String>> exte
 
     }
 
-    private static Set<ModuleImport> resolveModuleImports(final Set<ModuleImport> importsInit,
-            final StmtContext<String, ? extends DeclaredStatement<String>, ? extends EffectiveStatement<String, ?>> ctx) {
-        final Set<ModuleImport> resolvedModuleImports = new LinkedHashSet<>();
-        for (final ModuleImport moduleImport : importsInit) {
-            if (moduleImport.getRevision().equals(SimpleDateFormatUtil.DEFAULT_DATE_IMP)) {
-                final QNameModule impModuleQName = Utils.getModuleQNameByPrefix(ctx, moduleImport.getPrefix());
-                final ModuleImport resolvedModuleImport = new ModuleImportImpl(moduleImport.getModuleName(),
-                        impModuleQName.getRevision(), moduleImport.getPrefix());
-                resolvedModuleImports.add(resolvedModuleImport);
-            } else {
-                resolvedModuleImports.add(moduleImport);
-            }
-        }
-        return resolvedModuleImports;
-    }
-
-    @Override
-    public String getModuleSourcePath() {
-        return sourcePath;
-    }
-
-    @Override
-    public String getSource() {
-        return null;
-    }
-
     @Override
     public URI getNamespace() {
         return getQNameModule().getNamespace();
@@ -307,7 +287,7 @@ abstract class AbstractEffectiveModule<D extends DeclaredStatement<String>> exte
     }
 
     @Override
-    public Date getRevision() {
+    public Optional<Revision> getRevision() {
         return getQNameModule().getRevision();
     }
 
@@ -317,18 +297,18 @@ abstract class AbstractEffectiveModule<D extends DeclaredStatement<String>> exte
     }
 
     @Override
-    public String getYangVersion() {
-        return yangVersion.toString();
+    public YangVersion getYangVersion() {
+        return yangVersion;
     }
 
     @Override
-    public String getOrganization() {
-        return organization;
+    public Optional<String> getOrganization() {
+        return Optional.ofNullable(organization);
     }
 
     @Override
-    public String getContact() {
-        return contact;
+    public Optional<String> getContact() {
+        return Optional.ofNullable(contact);
     }
 
     @Override
@@ -338,8 +318,8 @@ abstract class AbstractEffectiveModule<D extends DeclaredStatement<String>> exte
 
     @Override
     public Set<Module> getSubmodules() {
-        Preconditions.checkState(sealed, "Attempt to get base submodules from unsealed submodule effective statement %s",
-                getQNameModule());
+        checkState(sealed, "Attempt to get base submodules from unsealed submodule effective statement %s",
+            getQNameModule());
         return submodules;
     }
 
@@ -354,7 +334,7 @@ abstract class AbstractEffectiveModule<D extends DeclaredStatement<String>> exte
     }
 
     @Override
-    public Set<AugmentationSchema> getAugmentations() {
+    public Set<AugmentationSchemaNode> getAugmentations() {
         return augmentations;
     }
 
@@ -400,10 +380,9 @@ abstract class AbstractEffectiveModule<D extends DeclaredStatement<String>> exte
     }
 
     @Override
-    public final DataSchemaNode getDataChildByName(final QName name) {
-        // Child nodes are keyed by their container name, so we can do a direct
-        // lookup
-        return childNodes.get(name);
+    public final Optional<DataSchemaNode> findDataChildByName(final QName name) {
+        // Child nodes are keyed by their container name, so we can do a direct lookup
+        return Optional.ofNullable(childNodes.get(requireNonNull(name)));
     }
 
     @Override
@@ -412,26 +391,26 @@ abstract class AbstractEffectiveModule<D extends DeclaredStatement<String>> exte
     }
 
     @Override
-    public SemVer getSemanticVersion() {
-        return semanticVersion;
+    public Optional<SemVer> getSemanticVersion() {
+        return Optional.ofNullable(semanticVersion);
     }
 
     @Override
     public String toString() {
-        return this.getClass().getSimpleName() + "[" +
-                "name=" + name +
-                ", namespace=" + getNamespace() +
-                ", revision=" + getQNameModule().getFormattedRevision() +
-                ", prefix=" + prefix +
-                ", yangVersion=" + yangVersion +
-                "]";
+        return MoreObjects.toStringHelper(this).omitNullValues()
+                .add("name", name)
+                .add("namespace", getNamespace())
+                .add("revision", getRevision().orElse(null))
+                .add("prefix", prefix)
+                .add("yangVersion", yangVersion)
+                .toString();
     }
 
     @Override
     public void seal() {
         if (!sealed) {
             submodules = ImmutableSet.copyOf(Iterables.transform(submoduleContextsToBuild,
-                    ctx -> (Module) ctx.buildEffective()));
+                ctx -> (Module) ctx.buildEffective()));
             submoduleContextsToBuild = ImmutableSet.of();
             sealed = true;
         }