2 * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.yangtools.yang.parser.rfc7950.stmt;
10 import static com.google.common.base.Verify.verifyNotNull;
11 import static java.util.Objects.requireNonNull;
13 import com.google.common.annotations.Beta;
14 import com.google.common.base.MoreObjects;
15 import com.google.common.collect.ImmutableList;
16 import com.google.common.collect.ImmutableMap;
17 import com.google.common.collect.ImmutableMap.Builder;
18 import com.google.common.collect.ImmutableSet;
20 import java.util.ArrayList;
21 import java.util.Collection;
22 import java.util.LinkedHashSet;
23 import java.util.List;
25 import java.util.Optional;
27 import org.eclipse.jdt.annotation.NonNull;
28 import org.opendaylight.yangtools.concepts.SemVer;
29 import org.opendaylight.yangtools.openconfig.model.api.OpenConfigVersionEffectiveStatement;
30 import org.opendaylight.yangtools.yang.common.QName;
31 import org.opendaylight.yangtools.yang.common.Revision;
32 import org.opendaylight.yangtools.yang.common.YangVersion;
33 import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
34 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
35 import org.opendaylight.yangtools.yang.model.api.Deviation;
36 import org.opendaylight.yangtools.yang.model.api.ExtensionDefinition;
37 import org.opendaylight.yangtools.yang.model.api.FeatureDefinition;
38 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
39 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
40 import org.opendaylight.yangtools.yang.model.api.Module;
41 import org.opendaylight.yangtools.yang.model.api.ModuleImport;
42 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
43 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
44 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
45 import org.opendaylight.yangtools.yang.model.api.UsesNode;
46 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
47 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
48 import org.opendaylight.yangtools.yang.model.api.meta.IdentifierNamespace;
49 import org.opendaylight.yangtools.yang.model.api.stmt.ContactEffectiveStatement;
50 import org.opendaylight.yangtools.yang.model.api.stmt.DataTreeAwareEffectiveStatement;
51 import org.opendaylight.yangtools.yang.model.api.stmt.ImportEffectiveStatement;
52 import org.opendaylight.yangtools.yang.model.api.stmt.ModuleEffectiveStatement;
53 import org.opendaylight.yangtools.yang.model.api.stmt.OrganizationEffectiveStatement;
54 import org.opendaylight.yangtools.yang.model.api.stmt.PrefixEffectiveStatement;
55 import org.opendaylight.yangtools.yang.model.api.stmt.PrefixStatement;
56 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaTreeAwareEffectiveStatement;
57 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaTreeEffectiveStatement;
58 import org.opendaylight.yangtools.yang.model.api.stmt.TypedefEffectiveStatement;
59 import org.opendaylight.yangtools.yang.model.api.stmt.YangVersionEffectiveStatement;
60 import org.opendaylight.yangtools.yang.model.api.stmt.compat.NotificationNodeContainerCompat;
61 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
62 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
63 import org.opendaylight.yangtools.yang.parser.spi.source.ImportPrefixToModuleCtx;
64 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
67 public abstract class AbstractEffectiveModule<D extends DeclaredStatement<String>,
68 E extends DataTreeAwareEffectiveStatement<String, D>> extends
69 AbstractSchemaEffectiveDocumentedNode<String, D> implements Module,
70 NotificationNodeContainerCompat<String, D, E> {
71 private final String name;
72 private final String prefix;
73 private final YangVersion yangVersion;
74 private final String organization;
75 private final String contact;
76 private final ImmutableSet<ModuleImport> imports;
77 private final ImmutableSet<FeatureDefinition> features;
78 private final @NonNull ImmutableSet<NotificationDefinition> notifications;
79 private final ImmutableSet<AugmentationSchemaNode> augmentations;
80 private final ImmutableSet<RpcDefinition> rpcs;
81 private final ImmutableSet<Deviation> deviations;
82 private final ImmutableList<ExtensionDefinition> extensionNodes;
83 private final ImmutableSet<IdentitySchemaNode> identities;
84 private final ImmutableSet<GroupingDefinition> groupings;
85 private final ImmutableSet<UsesNode> uses;
86 private final ImmutableSet<TypeDefinition<?>> typeDefinitions;
87 private final ImmutableSet<DataSchemaNode> publicChildNodes;
88 private final SemVer semanticVersion;
89 private final ImmutableMap<QName, SchemaTreeEffectiveStatement<?>> schemaTreeNamespace;
91 protected AbstractEffectiveModule(
92 final @NonNull StmtContext<String, D, ? extends EffectiveStatement<String, ?>> ctx,
93 final @NonNull String prefix) {
96 // This check is rather weird, but comes from our desire to lower memory footprint while providing both
97 // EffectiveStatements and SchemaNode interfaces -- which do not overlap completely where child lookups are
98 // concerned. This ensures that we have SchemaTree index available for use with child lookups.
99 final Map<QName, SchemaTreeEffectiveStatement<?>> schemaTree =
100 createSchemaTreeNamespace(ctx.getStatementSourceReference(), effectiveSubstatements());
101 schemaTreeNamespace = ImmutableMap.copyOf(schemaTree);
103 // Data tree check, not currently used
104 createDataTreeNamespace(ctx.getStatementSourceReference(), schemaTree.values(), schemaTreeNamespace);
106 this.name = argument();
107 this.prefix = requireNonNull(prefix);
108 this.yangVersion = findFirstEffectiveSubstatementArgument(YangVersionEffectiveStatement.class)
109 .orElse(YangVersion.VERSION_1);
110 this.semanticVersion = findFirstEffectiveSubstatementArgument(OpenConfigVersionEffectiveStatement.class)
112 this.organization = findFirstEffectiveSubstatementArgument(OrganizationEffectiveStatement.class)
114 this.contact = findFirstEffectiveSubstatementArgument(ContactEffectiveStatement.class)
117 final Set<AugmentationSchemaNode> augmentationsInit = new LinkedHashSet<>();
118 final Set<ModuleImport> importsInit = new LinkedHashSet<>();
119 final Set<NotificationDefinition> notificationsInit = new LinkedHashSet<>();
120 final Set<RpcDefinition> rpcsInit = new LinkedHashSet<>();
121 final Set<Deviation> deviationsInit = new LinkedHashSet<>();
122 final Set<IdentitySchemaNode> identitiesInit = new LinkedHashSet<>();
123 final Set<FeatureDefinition> featuresInit = new LinkedHashSet<>();
124 final List<ExtensionDefinition> extensionNodesInit = new ArrayList<>();
126 final Set<GroupingDefinition> mutableGroupings = new LinkedHashSet<>();
127 final Set<UsesNode> mutableUses = new LinkedHashSet<>();
128 final Set<TypeDefinition<?>> mutableTypeDefinitions = new LinkedHashSet<>();
129 final Set<DataSchemaNode> mutablePublicChildNodes = new LinkedHashSet<>();
131 for (final EffectiveStatement<?, ?> effectiveStatement : effectiveSubstatements()) {
132 if (effectiveStatement instanceof AugmentationSchemaNode) {
133 augmentationsInit.add((AugmentationSchemaNode) effectiveStatement);
135 if (effectiveStatement instanceof ModuleImport) {
136 importsInit.add((ModuleImport) effectiveStatement);
138 if (effectiveStatement instanceof NotificationDefinition) {
139 notificationsInit.add((NotificationDefinition) effectiveStatement);
141 if (effectiveStatement instanceof RpcDefinition) {
142 rpcsInit.add((RpcDefinition) effectiveStatement);
144 if (effectiveStatement instanceof Deviation) {
145 deviationsInit.add((Deviation) effectiveStatement);
147 if (effectiveStatement instanceof IdentitySchemaNode) {
148 identitiesInit.add((IdentitySchemaNode) effectiveStatement);
150 if (effectiveStatement instanceof FeatureDefinition) {
151 featuresInit.add((FeatureDefinition) effectiveStatement);
153 if (effectiveStatement instanceof ExtensionDefinition) {
154 extensionNodesInit.add((ExtensionDefinition) effectiveStatement);
156 if (effectiveStatement instanceof DataSchemaNode) {
157 mutablePublicChildNodes.add((DataSchemaNode) effectiveStatement);
159 if (effectiveStatement instanceof UsesNode && !mutableUses.add((UsesNode) effectiveStatement)) {
160 throw EffectiveStmtUtils.createNameCollisionSourceException(ctx, effectiveStatement);
162 if (effectiveStatement instanceof TypedefEffectiveStatement) {
163 final TypeDefinition<?> type = ((TypedefEffectiveStatement) effectiveStatement).getTypeDefinition();
164 if (!mutableTypeDefinitions.add(type)) {
165 throw EffectiveStmtUtils.createNameCollisionSourceException(ctx, effectiveStatement);
168 if (effectiveStatement instanceof GroupingDefinition
169 && !mutableGroupings.add((GroupingDefinition) effectiveStatement)) {
170 throw EffectiveStmtUtils.createNameCollisionSourceException(ctx, effectiveStatement);
174 this.augmentations = ImmutableSet.copyOf(augmentationsInit);
175 this.imports = ImmutableSet.copyOf(importsInit);
176 this.notifications = ImmutableSet.copyOf(notificationsInit);
177 this.rpcs = ImmutableSet.copyOf(rpcsInit);
178 this.deviations = ImmutableSet.copyOf(deviationsInit);
179 this.identities = ImmutableSet.copyOf(identitiesInit);
180 this.features = ImmutableSet.copyOf(featuresInit);
181 this.extensionNodes = ImmutableList.copyOf(extensionNodesInit);
183 this.groupings = ImmutableSet.copyOf(mutableGroupings);
184 this.publicChildNodes = ImmutableSet.copyOf(mutablePublicChildNodes);
185 this.typeDefinitions = ImmutableSet.copyOf(mutableTypeDefinitions);
186 this.uses = ImmutableSet.copyOf(mutableUses);
190 public URI getNamespace() {
191 return getQNameModule().getNamespace();
195 public String getName() {
200 public Optional<Revision> getRevision() {
201 return getQNameModule().getRevision();
205 public String getPrefix() {
210 public YangVersion getYangVersion() {
215 public Optional<String> getOrganization() {
216 return Optional.ofNullable(organization);
220 public Optional<String> getContact() {
221 return Optional.ofNullable(contact);
225 public Collection<? extends ModuleImport> getImports() {
230 public Collection<? extends FeatureDefinition> getFeatures() {
235 public Collection<? extends NotificationDefinition> getNotifications() {
236 return notifications;
240 public Collection<? extends AugmentationSchemaNode> getAugmentations() {
241 return augmentations;
245 public Collection<? extends RpcDefinition> getRpcs() {
250 public Collection<? extends Deviation> getDeviations() {
255 public Collection<? extends ExtensionDefinition> getExtensionSchemaNodes() {
256 return extensionNodes;
260 public Collection<? extends IdentitySchemaNode> getIdentities() {
265 public final Collection<? extends TypeDefinition<?>> getTypeDefinitions() {
266 return typeDefinitions;
270 public final Collection<? extends DataSchemaNode> getChildNodes() {
271 return publicChildNodes;
275 public final Collection<? extends GroupingDefinition> getGroupings() {
280 @SuppressWarnings("checkstyle:hiddenField")
281 public final Optional<DataSchemaNode> findDataChildByName(final QName name) {
282 final SchemaTreeEffectiveStatement<?> child = schemaTreeNamespace.get(requireNonNull(name));
283 return child instanceof DataSchemaNode ? Optional.of((DataSchemaNode) child) : Optional.empty();
287 public Collection<? extends UsesNode> getUses() {
292 public Optional<SemVer> getSemanticVersion() {
293 return Optional.ofNullable(semanticVersion);
297 @SuppressWarnings("unchecked")
298 protected <K, V, N extends IdentifierNamespace<K, V>> Optional<? extends Map<K, V>> getNamespaceContents(
299 final Class<N> namespace) {
300 if (SchemaTreeAwareEffectiveStatement.Namespace.class.equals(namespace)) {
301 return Optional.of((Map<K, V>) schemaTreeNamespace);
303 return super.getNamespaceContents(namespace);
307 public String toString() {
308 return MoreObjects.toStringHelper(this).omitNullValues()
310 .add("namespace", getNamespace())
311 .add("revision", getRevision().orElse(null))
312 .add("prefix", prefix)
313 .add("yangVersion", yangVersion)
317 protected static final @NonNull String findPrefix(final @NonNull StmtContext<?, ?, ?> ctx,
318 final String type, final String name) {
319 return SourceException.throwIfNull(
320 StmtContextUtils.firstAttributeOf(ctx.declaredSubstatements(), PrefixStatement.class),
321 ctx.getStatementSourceReference(), "Unable to resolve prefix for %s %s.", type, name);
324 // Alright. this is quite ugly
325 protected final void appendPrefixes(final StmtContext<?, ?, ?> ctx,
326 final Builder<String, ModuleEffectiveStatement> builder) {
327 streamEffectiveSubstatements(ImportEffectiveStatement.class)
328 .map(imp -> imp.findFirstEffectiveSubstatementArgument(PrefixEffectiveStatement.class).get())
330 final StmtContext<?, ?, ?> importedCtx =
331 verifyNotNull(ctx.getFromNamespace(ImportPrefixToModuleCtx.class, pfx),
332 "Failed to resolve prefix %s", pfx);
333 builder.put(pfx, (ModuleEffectiveStatement) importedCtx.buildEffective());