yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/rfc6020/UsesStatementImpl.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 java.util.Collection;
  11 import org.opendaylight.yangtools.yang.common.QName;
  12 import org.opendaylight.yangtools.yang.model.api.Rfc6020Mapping;
  13 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  14 import org.opendaylight.yangtools.yang.model.api.stmt.AugmentStatement;
  15 import org.opendaylight.yangtools.yang.model.api.stmt.DescriptionStatement;
  16 import org.opendaylight.yangtools.yang.model.api.stmt.IfFeatureStatement;
  17 import org.opendaylight.yangtools.yang.model.api.stmt.ReferenceStatement;
  18 import org.opendaylight.yangtools.yang.model.api.stmt.RefineStatement;
  19 import org.opendaylight.yangtools.yang.model.api.stmt.StatusStatement;
  20 import org.opendaylight.yangtools.yang.model.api.stmt.UsesStatement;
  21 import org.opendaylight.yangtools.yang.model.api.stmt.WhenStatement;
  22 import org.opendaylight.yangtools.yang.parser.spi.GroupingNamespace;
  23 import org.opendaylight.yangtools.yang.parser.spi.SubstatementValidator;
  24 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractDeclaredStatement;
  25 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
  26 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
  27 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
  28 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceAction;
  29 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.Prerequisite;
  30 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
  31 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  32 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
  33 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  34 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase;
  35 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.UsesEffectiveStatementImpl;
  36 import org.slf4j.Logger;
  37 import org.slf4j.LoggerFactory;
  38
  39
  40 public class UsesStatementImpl extends AbstractDeclaredStatement<QName> implements UsesStatement {
  41     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR = SubstatementValidator.builder(Rfc6020Mapping
  42             .USES)
  43             .addAny(Rfc6020Mapping.AUGMENT)
  44             .addOptional(Rfc6020Mapping.DESCRIPTION)
  45             .addAny(Rfc6020Mapping.IF_FEATURE)
  46             .addAny(Rfc6020Mapping.REFINE)
  47             .addOptional(Rfc6020Mapping.REFERENCE)
  48             .addOptional(Rfc6020Mapping.STATUS)
  49             .addOptional(Rfc6020Mapping.WHEN)
  50             .build();
  51
  52     private static final Logger LOG = LoggerFactory.getLogger(UsesStatementImpl.class);
  53
  54     protected UsesStatementImpl(final StmtContext<QName, UsesStatement, ?> context) {
  55         super(context);
  56     }
  57
  58     public static class Definition extends
  59             AbstractStatementSupport<QName, UsesStatement, EffectiveStatement<QName, UsesStatement>> {
  60
  61         public Definition() {
  62             super(Rfc6020Mapping.USES);
  63         }
  64
  65         @Override
  66         public QName parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
  67             return Utils.qNameFromArgument(ctx, value);
  68         }
  69
  70         @Override
  71         public void onFullDefinitionDeclared(
  72                 final StmtContext.Mutable<QName, UsesStatement, EffectiveStatement<QName, UsesStatement>> usesNode) {
  73             if (!StmtContextUtils.areFeaturesSupported(usesNode)) {
  74                 return;
  75             }
  76
  77             SUBSTATEMENT_VALIDATOR.validate(usesNode);
  78
  79             if (StmtContextUtils.isInExtensionBody(usesNode)) {
  80                 return;
  81             }
  82
  83             ModelActionBuilder usesAction = usesNode.newInferenceAction(ModelProcessingPhase.EFFECTIVE_MODEL);
  84             final QName groupingName = usesNode.getStatementArgument();
  85
  86             final Prerequisite<StmtContext<?, ?, ?>> sourceGroupingPre = usesAction.requiresCtx(usesNode,
  87                     GroupingNamespace.class, groupingName, ModelProcessingPhase.EFFECTIVE_MODEL);
  88             final Prerequisite<? extends StmtContext.Mutable<?, ?, ?>> targetNodePre = usesAction.mutatesEffectiveCtx(
  89                     usesNode.getParentContext());
  90
  91             usesAction.apply(new InferenceAction() {
  92
  93                 @Override
  94                 public void apply() {
  95                     StatementContextBase<?, ?, ?> targetNodeStmtCtx = (StatementContextBase<?, ?, ?>) targetNodePre.get();
  96                     StatementContextBase<?, ?, ?> sourceGrpStmtCtx = (StatementContextBase<?, ?, ?>) sourceGroupingPre.get();
  97
  98                     try {
  99                         GroupingUtils.copyFromSourceToTarget(sourceGrpStmtCtx, targetNodeStmtCtx, usesNode);
 100                         GroupingUtils.resolveUsesNode(usesNode, targetNodeStmtCtx);
 101                     } catch (SourceException e) {
 102                         LOG.warn(e.getMessage(), e);
 103                         throw e;
 104                     }
 105                 }
 106
 107                 @Override
 108                 public void prerequisiteFailed(final Collection<? extends Prerequisite<?>> failed) {
 109                     InferenceException.throwIf(failed.contains(sourceGroupingPre),
 110                             usesNode.getStatementSourceReference(), "Grouping '%s' was not resolved.", groupingName);
 111                     throw new InferenceException("Unknown error occurred.", usesNode.getStatementSourceReference());
 112                 }
 113             });
 114         }
 115
 116         @Override
 117         public UsesStatement createDeclared(final StmtContext<QName, UsesStatement, ?> ctx) {
 118             return new UsesStatementImpl(ctx);
 119         }
 120
 121         @Override
 122         public EffectiveStatement<QName, UsesStatement> createEffective(
 123                 final StmtContext<QName, UsesStatement, EffectiveStatement<QName, UsesStatement>> ctx) {
 124             return new UsesEffectiveStatementImpl(ctx);
 125         }
 126
 127     }
 128
 129     @Override
 130     public QName getName() {
 131         return argument();
 132     }
 133
 134     @Override
 135     public WhenStatement getWhenStatement() {
 136         return firstDeclared(WhenStatement.class);
 137     }
 138
 139     @Override
 140     public Collection<? extends IfFeatureStatement> getIfFeatures() {
 141         return allDeclared(IfFeatureStatement.class);
 142     }
 143
 144     @Override
 145     public StatusStatement getStatus() {
 146         return firstDeclared(StatusStatement.class);
 147     }
 148
 149     @Override
 150     public DescriptionStatement getDescription() {
 151         return firstDeclared(DescriptionStatement.class);
 152     }
 153
 154     @Override
 155     public ReferenceStatement getReference() {
 156         return firstDeclared(ReferenceStatement.class);
 157     }
 158
 159     @Override
 160     public Collection<? extends AugmentStatement> getAugments() {
 161         return allDeclared(AugmentStatement.class);
 162     }
 163
 164     @Override
 165     public Collection<? extends RefineStatement> getRefines() {
 166         return allDeclared(RefineStatement.class);
 167     }
 168 }