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.ImportEffectiveStatement;
51 import org.opendaylight.yangtools.yang.model.api.stmt.ModuleEffectiveStatement;
52 import org.opendaylight.yangtools.yang.model.api.stmt.OrganizationEffectiveStatement;
53 import org.opendaylight.yangtools.yang.model.api.stmt.PrefixEffectiveStatement;
54 import org.opendaylight.yangtools.yang.model.api.stmt.PrefixStatement;
55 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaTreeAwareEffectiveStatement;
56 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaTreeEffectiveStatement;
57 import org.opendaylight.yangtools.yang.model.api.stmt.TypedefEffectiveStatement;
58 import org.opendaylight.yangtools.yang.model.api.stmt.YangVersionEffectiveStatement;
59 import org.opendaylight.yangtools.yang.model.api.stmt.compat.NotificationNodeContainerCompat;
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;
66 public abstract class AbstractEffectiveModule<D extends DeclaredStatement<String>> extends
67 AbstractSchemaEffectiveDocumentedNode<String, D> implements Module,
68 NotificationNodeContainerCompat<String, D> {
69 private final String name;
70 private final String prefix;
71 private final YangVersion yangVersion;
72 private final String organization;
73 private final String contact;
74 private final ImmutableSet<ModuleImport> imports;
75 private final ImmutableSet<FeatureDefinition> features;
76 private final @NonNull ImmutableSet<NotificationDefinition> notifications;
77 private final ImmutableSet<AugmentationSchemaNode> augmentations;
78 private final ImmutableSet<RpcDefinition> rpcs;
79 private final ImmutableSet<Deviation> deviations;
80 private final ImmutableList<ExtensionDefinition> extensionNodes;
81 private final ImmutableSet<IdentitySchemaNode> identities;
82 private final ImmutableSet<GroupingDefinition> groupings;
83 private final ImmutableSet<UsesNode> uses;
84 private final ImmutableSet<TypeDefinition<?>> typeDefinitions;
85 private final ImmutableSet<DataSchemaNode> publicChildNodes;
86 private final SemVer semanticVersion;
87 private final ImmutableMap<QName, SchemaTreeEffectiveStatement<?>> schemaTreeNamespace;
89 protected AbstractEffectiveModule(
90 final @NonNull StmtContext<String, D, ? extends EffectiveStatement<String, ?>> ctx,
91 final @NonNull String prefix) {
94 // This check is rather weird, but comes from our desire to lower memory footprint while providing both
95 // EffectiveStatements and SchemaNode interfaces -- which do not overlap completely where child lookups are
96 // concerned. This ensures that we have SchemaTree index available for use with child lookups.
97 final Map<QName, SchemaTreeEffectiveStatement<?>> schemaTree =
98 createSchemaTreeNamespace(ctx.getStatementSourceReference(), effectiveSubstatements());
99 schemaTreeNamespace = ImmutableMap.copyOf(schemaTree);
101 // Data tree check, not currently used
102 createDataTreeNamespace(ctx.getStatementSourceReference(), schemaTree.values(), schemaTreeNamespace);
104 this.name = argument();
105 this.prefix = requireNonNull(prefix);
106 this.yangVersion = findFirstEffectiveSubstatementArgument(YangVersionEffectiveStatement.class)
107 .orElse(YangVersion.VERSION_1);
108 this.semanticVersion = findFirstEffectiveSubstatementArgument(OpenConfigVersionEffectiveStatement.class)
110 this.organization = findFirstEffectiveSubstatementArgument(OrganizationEffectiveStatement.class)
112 this.contact = findFirstEffectiveSubstatementArgument(ContactEffectiveStatement.class)
115 final Set<AugmentationSchemaNode> augmentationsInit = new LinkedHashSet<>();
116 final Set<ModuleImport> importsInit = new LinkedHashSet<>();
117 final Set<NotificationDefinition> notificationsInit = new LinkedHashSet<>();
118 final Set<RpcDefinition> rpcsInit = new LinkedHashSet<>();
119 final Set<Deviation> deviationsInit = new LinkedHashSet<>();
120 final Set<IdentitySchemaNode> identitiesInit = new LinkedHashSet<>();
121 final Set<FeatureDefinition> featuresInit = new LinkedHashSet<>();
122 final List<ExtensionDefinition> extensionNodesInit = new ArrayList<>();
124 final Set<GroupingDefinition> mutableGroupings = new LinkedHashSet<>();
125 final Set<UsesNode> mutableUses = new LinkedHashSet<>();
126 final Set<TypeDefinition<?>> mutableTypeDefinitions = new LinkedHashSet<>();
127 final Set<DataSchemaNode> mutablePublicChildNodes = new LinkedHashSet<>();
129 for (final EffectiveStatement<?, ?> effectiveStatement : effectiveSubstatements()) {
130 if (effectiveStatement instanceof AugmentationSchemaNode) {
131 augmentationsInit.add((AugmentationSchemaNode) effectiveStatement);
133 if (effectiveStatement instanceof ModuleImport) {
134 importsInit.add((ModuleImport) effectiveStatement);
136 if (effectiveStatement instanceof NotificationDefinition) {
137 notificationsInit.add((NotificationDefinition) effectiveStatement);
139 if (effectiveStatement instanceof RpcDefinition) {
140 rpcsInit.add((RpcDefinition) effectiveStatement);
142 if (effectiveStatement instanceof Deviation) {
143 deviationsInit.add((Deviation) effectiveStatement);
145 if (effectiveStatement instanceof IdentitySchemaNode) {
146 identitiesInit.add((IdentitySchemaNode) effectiveStatement);
148 if (effectiveStatement instanceof FeatureDefinition) {
149 featuresInit.add((FeatureDefinition) effectiveStatement);
151 if (effectiveStatement instanceof ExtensionDefinition) {
152 extensionNodesInit.add((ExtensionDefinition) effectiveStatement);
154 if (effectiveStatement instanceof DataSchemaNode) {
155 mutablePublicChildNodes.add((DataSchemaNode) effectiveStatement);
157 if (effectiveStatement instanceof UsesNode && !mutableUses.add((UsesNode) effectiveStatement)) {
158 throw EffectiveStmtUtils.createNameCollisionSourceException(ctx, effectiveStatement);
160 if (effectiveStatement instanceof TypedefEffectiveStatement) {
161 final TypeDefinition<?> type = ((TypedefEffectiveStatement) effectiveStatement).getTypeDefinition();
162 if (!mutableTypeDefinitions.add(type)) {
163 throw EffectiveStmtUtils.createNameCollisionSourceException(ctx, effectiveStatement);
166 if (effectiveStatement instanceof GroupingDefinition
167 && !mutableGroupings.add((GroupingDefinition) effectiveStatement)) {
168 throw EffectiveStmtUtils.createNameCollisionSourceException(ctx, effectiveStatement);
172 this.augmentations = ImmutableSet.copyOf(augmentationsInit);
173 this.imports = ImmutableSet.copyOf(importsInit);
174 this.notifications = ImmutableSet.copyOf(notificationsInit);
175 this.rpcs = ImmutableSet.copyOf(rpcsInit);
176 this.deviations = ImmutableSet.copyOf(deviationsInit);
177 this.identities = ImmutableSet.copyOf(identitiesInit);
178 this.features = ImmutableSet.copyOf(featuresInit);
179 this.extensionNodes = ImmutableList.copyOf(extensionNodesInit);
181 this.groupings = ImmutableSet.copyOf(mutableGroupings);
182 this.publicChildNodes = ImmutableSet.copyOf(mutablePublicChildNodes);
183 this.typeDefinitions = ImmutableSet.copyOf(mutableTypeDefinitions);
184 this.uses = ImmutableSet.copyOf(mutableUses);
188 public URI getNamespace() {
189 return getQNameModule().getNamespace();
193 public String getName() {
198 public Optional<Revision> getRevision() {
199 return getQNameModule().getRevision();
203 public String getPrefix() {
208 public YangVersion getYangVersion() {
213 public Optional<String> getOrganization() {
214 return Optional.ofNullable(organization);
218 public Optional<String> getContact() {
219 return Optional.ofNullable(contact);
223 public Collection<? extends ModuleImport> getImports() {
228 public Collection<? extends FeatureDefinition> getFeatures() {
233 public Collection<? extends NotificationDefinition> getNotifications() {
234 return notifications;
238 public Collection<? extends AugmentationSchemaNode> getAugmentations() {
239 return augmentations;
243 public Collection<? extends RpcDefinition> getRpcs() {
248 public Collection<? extends Deviation> getDeviations() {
253 public Collection<? extends ExtensionDefinition> getExtensionSchemaNodes() {
254 return extensionNodes;
258 public Collection<? extends IdentitySchemaNode> getIdentities() {
263 public final Collection<? extends TypeDefinition<?>> getTypeDefinitions() {
264 return typeDefinitions;
268 public final Collection<? extends DataSchemaNode> getChildNodes() {
269 return publicChildNodes;
273 public final Collection<? extends GroupingDefinition> getGroupings() {
278 @SuppressWarnings("checkstyle:hiddenField")
279 public final Optional<DataSchemaNode> findDataChildByName(final QName name) {
280 final SchemaTreeEffectiveStatement<?> child = schemaTreeNamespace.get(requireNonNull(name));
281 return child instanceof DataSchemaNode ? Optional.of((DataSchemaNode) child) : Optional.empty();
285 public Collection<? extends UsesNode> getUses() {
290 public Optional<SemVer> getSemanticVersion() {
291 return Optional.ofNullable(semanticVersion);
295 @SuppressWarnings("unchecked")
296 protected <K, V, N extends IdentifierNamespace<K, V>> Optional<? extends Map<K, V>> getNamespaceContents(
297 final Class<N> namespace) {
298 if (SchemaTreeAwareEffectiveStatement.Namespace.class.equals(namespace)) {
299 return Optional.of((Map<K, V>) schemaTreeNamespace);
301 return super.getNamespaceContents(namespace);
305 public String toString() {
306 return MoreObjects.toStringHelper(this).omitNullValues()
308 .add("namespace", getNamespace())
309 .add("revision", getRevision().orElse(null))
310 .add("prefix", prefix)
311 .add("yangVersion", yangVersion)
315 protected static final @NonNull String findPrefix(final @NonNull StmtContext<?, ?, ?> ctx,
316 final String type, final String name) {
317 return SourceException.throwIfNull(
318 StmtContextUtils.firstAttributeOf(ctx.declaredSubstatements(), PrefixStatement.class),
319 ctx.getStatementSourceReference(), "Unable to resolve prefix for %s %s.", type, name);
322 // Alright. this is quite ugly
323 protected final void appendPrefixes(final StmtContext<?, ?, ?> ctx,
324 final Builder<String, ModuleEffectiveStatement> builder) {
325 streamEffectiveSubstatements(ImportEffectiveStatement.class)
326 .map(imp -> imp.findFirstEffectiveSubstatementArgument(PrefixEffectiveStatement.class).get())
328 final StmtContext<?, ?, ?> importedCtx =
329 verifyNotNull(ctx.getFromNamespace(ImportPrefixToModuleCtx.class, pfx),
330 "Failed to resolve prefix %s", pfx);
331 builder.put(pfx, (ModuleEffectiveStatement) importedCtx.buildEffective());