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.stmt.rfc6020;
10 import static org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase.SOURCE_LINKAGE;
11 import static org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils.firstAttributeOf;
13 import com.google.common.base.Optional;
15 import java.util.Collection;
16 import java.util.Date;
18 import java.util.Map.Entry;
19 import org.opendaylight.yangtools.yang.common.SimpleDateFormatUtil;
20 import org.opendaylight.yangtools.yang.model.api.ModuleIdentifier;
21 import org.opendaylight.yangtools.yang.model.api.Rfc6020Mapping;
22 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
23 import org.opendaylight.yangtools.yang.model.api.stmt.ImportStatement;
24 import org.opendaylight.yangtools.yang.model.api.stmt.ModuleStatement;
25 import org.opendaylight.yangtools.yang.model.api.stmt.NamespaceStatement;
26 import org.opendaylight.yangtools.yang.model.api.stmt.PrefixStatement;
27 import org.opendaylight.yangtools.yang.model.api.stmt.RevisionDateStatement;
28 import org.opendaylight.yangtools.yang.parser.builder.impl.ModuleIdentifierImpl;
29 import org.opendaylight.yangtools.yang.parser.spi.ModuleNamespace;
30 import org.opendaylight.yangtools.yang.parser.spi.SubstatementValidator;
31 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
32 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
33 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
34 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceAction;
35 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.Prerequisite;
36 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
37 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
38 import org.opendaylight.yangtools.yang.parser.spi.source.ImpPrefixToModuleIdentifier;
39 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
40 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.ImportEffectiveStatementImpl;
42 public class ImportStatementDefinition
43 extends AbstractStatementSupport<String, ImportStatement, EffectiveStatement<String, ImportStatement>> {
44 private static final SubstatementValidator SUBSTATEMENT_VALIDATOR = SubstatementValidator.builder(Rfc6020Mapping
46 .add(Rfc6020Mapping.PREFIX, 1, 1)
47 .add(Rfc6020Mapping.REVISION_DATE, 0, 1)
50 public ImportStatementDefinition() {
51 super(Rfc6020Mapping.IMPORT);
55 public String parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
60 public ImportStatement createDeclared(
61 final StmtContext<String, ImportStatement, ?> ctx) {
62 return new ImportStatementImpl(ctx);
66 public EffectiveStatement<String, ImportStatement> createEffective(
67 final StmtContext<String, ImportStatement, EffectiveStatement<String, ImportStatement>> ctx) {
68 return new ImportEffectiveStatementImpl(ctx);
72 public void onFullDefinitionDeclared(Mutable<String, ImportStatement,
73 EffectiveStatement<String, ImportStatement>> stmt) throws SourceException {
74 super.onFullDefinitionDeclared(stmt);
75 SUBSTATEMENT_VALIDATOR.validate(stmt);
79 public void onLinkageDeclared(
80 final Mutable<String, ImportStatement, EffectiveStatement<String, ImportStatement>> stmt) {
81 final ModuleIdentifier impIdentifier = getImportedModuleIdentifier(stmt);
82 final ModelActionBuilder importAction = stmt.newInferenceAction(SOURCE_LINKAGE);
83 final Prerequisite<StmtContext<?, ?, ?>> imported = importAction.requiresCtx(stmt, ModuleNamespace.class,
84 impIdentifier, SOURCE_LINKAGE);
85 final Prerequisite<Mutable<?, ?, ?>> linkageTarget = importAction.mutatesCtx(stmt.getRoot(), SOURCE_LINKAGE);
87 importAction.apply(new InferenceAction() {
89 public void apply() throws InferenceException {
90 StmtContext<?, ?, ?> importedModule = null;
91 ModuleIdentifier importedModuleIdentifier = null;
92 if (impIdentifier.getRevision() == SimpleDateFormatUtil.DEFAULT_DATE_IMP) {
93 Entry<ModuleIdentifier, StmtContext<?, ModuleStatement, EffectiveStatement<String, ModuleStatement>>> recentModuleEntry = findRecentModule(
94 impIdentifier, stmt.getAllFromNamespace(ModuleNamespace.class));
95 if (recentModuleEntry != null) {
96 importedModuleIdentifier = recentModuleEntry.getKey();
97 importedModule = recentModuleEntry.getValue();
101 if (importedModule == null || importedModuleIdentifier == null) {
102 importedModule = imported.get();
103 importedModuleIdentifier = impIdentifier;
106 linkageTarget.get().addToNs(ImportedModuleContext.class, importedModuleIdentifier, importedModule);
107 String impPrefix = firstAttributeOf(stmt.declaredSubstatements(), PrefixStatement.class);
108 stmt.addToNs(ImpPrefixToModuleIdentifier.class, impPrefix, importedModuleIdentifier);
110 final URI modNs = firstAttributeOf(importedModule.declaredSubstatements(), NamespaceStatement.class);
111 stmt.addToNs(URIStringToImpPrefix.class, modNs.toString(), impPrefix);
114 private Entry<ModuleIdentifier, StmtContext<?, ModuleStatement, EffectiveStatement<String, ModuleStatement>>> findRecentModule(
115 final ModuleIdentifier impIdentifier,
116 final Map<ModuleIdentifier, StmtContext<?, ModuleStatement, EffectiveStatement<String, ModuleStatement>>> allModules) {
118 ModuleIdentifier recentModuleIdentifier = impIdentifier;
119 Entry<ModuleIdentifier, StmtContext<?, ModuleStatement, EffectiveStatement<String, ModuleStatement>>> recentModuleEntry = null;
121 for (Entry<ModuleIdentifier, StmtContext<?, ModuleStatement, EffectiveStatement<String, ModuleStatement>>> moduleEntry : allModules.entrySet()) {
122 if (moduleEntry.getKey().getName().equals(impIdentifier.getName())
123 && moduleEntry.getKey().getRevision().compareTo(recentModuleIdentifier.getRevision()) > 0) {
124 recentModuleIdentifier = moduleEntry.getKey();
125 recentModuleEntry = moduleEntry;
129 return recentModuleEntry;
133 public void prerequisiteFailed(final Collection<? extends Prerequisite<?>> failed) {
134 if (failed.contains(imported)) {
135 throw new InferenceException(String.format("Imported module [%s] was not found.", impIdentifier),
136 stmt.getStatementSourceReference());
144 private static ModuleIdentifier getImportedModuleIdentifier(final Mutable<String, ImportStatement, ?> stmt) {
145 Date revision = firstAttributeOf(stmt.declaredSubstatements(), RevisionDateStatement.class);
146 if (revision == null) {
147 revision = SimpleDateFormatUtil.DEFAULT_DATE_IMP;
150 return new ModuleIdentifierImpl(stmt.getStatementArgument(), Optional.<URI> absent(),
151 Optional.<Date> of(revision));