yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/rfc6020/BelongsToStatementImpl.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.StmtContextUtils.findFirstDeclaredSubstatement;
  11
  12 import java.util.Collection;
  13 import javax.annotation.Nonnull;
  14 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  15 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  16 import org.opendaylight.yangtools.yang.model.api.stmt.BelongsToStatement;
  17 import org.opendaylight.yangtools.yang.model.api.stmt.PrefixStatement;
  18 import org.opendaylight.yangtools.yang.model.repo.api.RevisionSourceIdentifier;
  19 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
  20 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractDeclaredStatement;
  21 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
  22 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
  23 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
  24 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceAction;
  25 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceContext;
  26 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.Prerequisite;
  27 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
  28 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  29 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  30 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
  31 import org.opendaylight.yangtools.yang.parser.spi.source.BelongsToModuleContext;
  32 import org.opendaylight.yangtools.yang.parser.spi.source.BelongsToPrefixToModuleCtx;
  33 import org.opendaylight.yangtools.yang.parser.spi.source.ModuleNamespaceForBelongsTo;
  34 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.BelongsToEffectiveStatementImpl;
  35
  36 public class BelongsToStatementImpl extends AbstractDeclaredStatement<String>
  37         implements BelongsToStatement {
  38     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR =
  39             SubstatementValidator.builder(YangStmtMapping.BELONGS_TO).addMandatory(YangStmtMapping.PREFIX).build();
  40
  41     protected BelongsToStatementImpl(final StmtContext<String, BelongsToStatement, ?> context) {
  42         super(context);
  43     }
  44
  45     public static class Definition
  46             extends
  47             AbstractStatementSupport<String, BelongsToStatement, EffectiveStatement<String, BelongsToStatement>> {
  48
  49         public Definition() {
  50             super(YangStmtMapping.BELONGS_TO);
  51         }
  52
  53         @Override
  54         public String parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
  55             return value;
  56         }
  57
  58         @Override
  59         public BelongsToStatement createDeclared(
  60                 final StmtContext<String, BelongsToStatement, ?> ctx) {
  61             return new BelongsToStatementImpl(ctx);
  62         }
  63
  64         @Override
  65         public EffectiveStatement<String, BelongsToStatement> createEffective(
  66                 final StmtContext<String, BelongsToStatement, EffectiveStatement<String, BelongsToStatement>> ctx) {
  67             return new BelongsToEffectiveStatementImpl(ctx);
  68         }
  69
  70         @Override
  71         public void onPreLinkageDeclared(final StmtContext.Mutable<String, BelongsToStatement,
  72                 EffectiveStatement<String, BelongsToStatement>> belongsToCtx) {
  73             belongsToCtx.addRequiredSource(getSourceIdentifier(belongsToCtx));
  74         }
  75
  76         @Override
  77         public void onLinkageDeclared(final Mutable<String, BelongsToStatement,
  78                 EffectiveStatement<String, BelongsToStatement>> belongsToCtx) {
  79             ModelActionBuilder belongsToAction = belongsToCtx.newInferenceAction(ModelProcessingPhase.SOURCE_LINKAGE);
  80
  81             final SourceIdentifier belongsToSourceIdentifier = getSourceIdentifier(belongsToCtx);
  82             final Prerequisite<StmtContext<?, ?, ?>> belongsToPrereq = belongsToAction.requiresCtx(belongsToCtx,
  83                 ModuleNamespaceForBelongsTo.class, belongsToCtx.getStatementArgument(),
  84                 ModelProcessingPhase.SOURCE_LINKAGE);
  85
  86             belongsToAction.apply(new InferenceAction() {
  87                 @Override
  88                 public void apply(final InferenceContext ctx) {
  89                     StmtContext<?, ?, ?> belongsToModuleCtx = belongsToPrereq.resolve(ctx);
  90
  91                     belongsToCtx.addToNs(BelongsToModuleContext.class, belongsToSourceIdentifier, belongsToModuleCtx);
  92                     belongsToCtx.addToNs(BelongsToPrefixToModuleCtx.class,
  93                         findFirstDeclaredSubstatement(belongsToCtx, PrefixStatement.class).getStatementArgument(),
  94                         belongsToModuleCtx);
  95                 }
  96
  97                 @Override
  98                 public void prerequisiteFailed(final Collection<? extends ModelActionBuilder.Prerequisite<?>> failed) {
  99                     if (failed.contains(belongsToPrereq)) {
 100                         throw new InferenceException(belongsToCtx.getStatementSourceReference(),
 101                             "Module '%s' from belongs-to was not found", belongsToCtx.getStatementArgument());
 102                     }
 103                 }
 104             });
 105         }
 106
 107         private static SourceIdentifier getSourceIdentifier(final StmtContext<String, BelongsToStatement,
 108                 EffectiveStatement<String, BelongsToStatement>> belongsToCtx) {
 109             return RevisionSourceIdentifier.create(belongsToCtx.getStatementArgument());
 110         }
 111
 112         @Override
 113         protected SubstatementValidator getSubstatementValidator() {
 114             return SUBSTATEMENT_VALIDATOR;
 115         }
 116     }
 117
 118     @Nonnull
 119     @Override
 120     public String getModule() {
 121         return argument();
 122     }
 123
 124     @Nonnull
 125     @Override
 126     public PrefixStatement getPrefix() {
 127         return firstDeclared(PrefixStatement.class);
 128     }
 129 }