yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/rfc6020/IncludeStatementImpl.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.stmt.rfc6020;
   9
  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;
  12
  13 import java.util.Collection;
  14 import java.util.Date;
  15 import java.util.Optional;
  16 import javax.annotation.Nonnull;
  17 import org.opendaylight.yangtools.yang.common.SimpleDateFormatUtil;
  18 import org.opendaylight.yangtools.yang.model.api.ModuleIdentifier;
  19 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  20 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  21 import org.opendaylight.yangtools.yang.model.api.stmt.DescriptionStatement;
  22 import org.opendaylight.yangtools.yang.model.api.stmt.IncludeStatement;
  23 import org.opendaylight.yangtools.yang.model.api.stmt.ReferenceStatement;
  24 import org.opendaylight.yangtools.yang.model.api.stmt.RevisionDateStatement;
  25 import org.opendaylight.yangtools.yang.model.util.ModuleIdentifierImpl;
  26 import org.opendaylight.yangtools.yang.parser.spi.SubmoduleNamespace;
  27 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractDeclaredStatement;
  28 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
  29 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
  30 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
  31 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceAction;
  32 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceContext;
  33 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.Prerequisite;
  34 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  35 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  36 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
  37 import org.opendaylight.yangtools.yang.parser.spi.source.IncludedModuleContext;
  38 import org.opendaylight.yangtools.yang.parser.spi.source.IncludedSubmoduleNameToIdentifier;
  39 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.IncludeEffectiveStatementImpl;
  40
  41 public class IncludeStatementImpl extends AbstractDeclaredStatement<String> implements IncludeStatement {
  42     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR = SubstatementValidator.builder(
  43         YangStmtMapping.INCLUDE).addOptional(YangStmtMapping.REVISION_DATE).build();
  44
  45     protected IncludeStatementImpl(final StmtContext<String, IncludeStatement, ?> context) {
  46         super(context);
  47     }
  48
  49     public static class Definition extends
  50             AbstractStatementSupport<String, IncludeStatement, EffectiveStatement<String, IncludeStatement>> {
  51
  52         public Definition() {
  53             super(YangStmtMapping.INCLUDE);
  54         }
  55
  56         @Override
  57         public String parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
  58             return value;
  59         }
  60
  61         @Override
  62         public IncludeStatement createDeclared(final StmtContext<String, IncludeStatement, ?> ctx) {
  63             return new IncludeStatementImpl(ctx);
  64         }
  65
  66         @Override
  67         public EffectiveStatement<String, IncludeStatement> createEffective(
  68                 final StmtContext<String, IncludeStatement, EffectiveStatement<String, IncludeStatement>> ctx) {
  69             return new IncludeEffectiveStatementImpl(ctx);
  70         }
  71
  72         @Override
  73         public void onPreLinkageDeclared(
  74                 final Mutable<String, IncludeStatement, EffectiveStatement<String, IncludeStatement>> stmt) {
  75             stmt.addRequiredModule(getIncludeSubmoduleIdentifier(stmt));
  76         }
  77
  78         @Override
  79         public void onLinkageDeclared(
  80                 final Mutable<String, IncludeStatement, EffectiveStatement<String, IncludeStatement>> stmt) {
  81             final ModuleIdentifier includeSubmoduleIdentifier = getIncludeSubmoduleIdentifier(stmt);
  82
  83             final ModelActionBuilder includeAction = stmt.newInferenceAction(SOURCE_LINKAGE);
  84             final Prerequisite<StmtContext<?, ?, ?>> requiresCtxPrerequisite = includeAction.requiresCtx(stmt,
  85                     SubmoduleNamespace.class, includeSubmoduleIdentifier, SOURCE_LINKAGE);
  86
  87             includeAction.apply(new InferenceAction() {
  88                 @Override
  89                 public void apply(final InferenceContext ctx) {
  90                     final StmtContext<?, ?, ?> includedSubModuleContext = requiresCtxPrerequisite.resolve(ctx);
  91
  92                     stmt.addToNs(IncludedModuleContext.class, includeSubmoduleIdentifier,
  93                             includedSubModuleContext);
  94                     stmt.addToNs(IncludedSubmoduleNameToIdentifier.class,
  95                             stmt.getStatementArgument(), includeSubmoduleIdentifier);
  96                 }
  97
  98                 @Override
  99                 public void prerequisiteFailed(final Collection<? extends Prerequisite<?>> failed) {
 100                     InferenceException.throwIf(failed.contains(requiresCtxPrerequisite),
 101                         stmt.getStatementSourceReference(),
 102                         "Included submodule '%s' was not found: ", stmt.getStatementArgument());
 103                 }
 104             });
 105         }
 106
 107         private static ModuleIdentifier getIncludeSubmoduleIdentifier(
 108                 final StmtContext<String, IncludeStatement, ?> stmt) {
 109             final String subModuleName = stmt.getStatementArgument();
 110
 111             Date revisionDate = firstAttributeOf(stmt.declaredSubstatements(), RevisionDateStatement.class);
 112             if (revisionDate == null) {
 113                 revisionDate = SimpleDateFormatUtil.DEFAULT_DATE_IMP;
 114             }
 115
 116             return ModuleIdentifierImpl.create(subModuleName, Optional.empty(), Optional.of(revisionDate));
 117         }
 118
 119         @Override
 120         protected SubstatementValidator getSubstatementValidator() {
 121             return SUBSTATEMENT_VALIDATOR;
 122         }
 123     }
 124
 125     @Nonnull
 126     @Override
 127     public String getModule() {
 128         return argument();
 129     }
 130
 131     @Override
 132     public RevisionDateStatement getRevisionDate() {
 133         return firstDeclared(RevisionDateStatement.class);
 134     }
 135
 136     @Override
 137     public DescriptionStatement getDescription() {
 138         return firstDeclared(DescriptionStatement.class);
 139     }
 140
 141     @Override
 142     public ReferenceStatement getReference() {
 143         return firstDeclared(ReferenceStatement.class);
 144     }
 145
 146 }