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