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