2 * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.yangtools.yang.parser.stmt.rfc6020;
10 import static org.opendaylight.yangtools.yang.parser.spi.SubstatementValidator.MAX;
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;
42 public class UsesStatementImpl extends AbstractDeclaredStatement<QName> implements UsesStatement {
43 private static final SubstatementValidator SUBSTATEMENT_VALIDATOR = SubstatementValidator.builder(Rfc6020Mapping
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)
54 private static final Logger LOG = LoggerFactory.getLogger(UsesStatementImpl.class);
56 protected UsesStatementImpl(final StmtContext<QName, UsesStatement, ?> context) {
60 public static class Definition extends
61 AbstractStatementSupport<QName, UsesStatement, EffectiveStatement<QName, UsesStatement>> {
64 super(Rfc6020Mapping.USES);
68 public QName parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
69 return Utils.qNameFromArgument(ctx, value);
73 public void onFullDefinitionDeclared(
74 final StmtContext.Mutable<QName, UsesStatement, EffectiveStatement<QName, UsesStatement>> usesNode)
75 throws SourceException {
76 SUBSTATEMENT_VALIDATOR.validate(usesNode);
78 if(StmtContextUtils.isInExtensionBody(usesNode)) {
82 ModelActionBuilder usesAction = usesNode.newInferenceAction(ModelProcessingPhase.EFFECTIVE_MODEL);
83 final QName groupingName = usesNode.getStatementArgument();
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());
90 usesAction.apply(new InferenceAction() {
93 public void apply() throws InferenceException {
94 StatementContextBase<?, ?, ?> targetNodeStmtCtx = (StatementContextBase<?, ?, ?>) targetNodePre.get();
95 StatementContextBase<?, ?, ?> sourceGrpStmtCtx = (StatementContextBase<?, ?, ?>) sourceGroupingPre.get();
98 GroupingUtils.copyFromSourceToTarget(sourceGrpStmtCtx, targetNodeStmtCtx, usesNode);
99 GroupingUtils.resolveUsesNode(usesNode, targetNodeStmtCtx);
100 } catch (SourceException e) {
101 LOG.warn(e.getMessage(), e);
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());
112 throw new InferenceException("Unknown error occurred.", usesNode.getStatementSourceReference());
118 public UsesStatement createDeclared(final StmtContext<QName, UsesStatement, ?> ctx) {
119 return new UsesStatementImpl(ctx);
123 public EffectiveStatement<QName, UsesStatement> createEffective(
124 final StmtContext<QName, UsesStatement, EffectiveStatement<QName, UsesStatement>> ctx) {
125 return new UsesEffectiveStatementImpl(ctx);
131 public QName getName() {
136 public WhenStatement getWhenStatement() {
137 return firstDeclared(WhenStatement.class);
141 public Collection<? extends IfFeatureStatement> getIfFeatures() {
142 return allDeclared(IfFeatureStatement.class);
146 public StatusStatement getStatus() {
147 return firstDeclared(StatusStatement.class);
151 public DescriptionStatement getDescription() {
152 return firstDeclared(DescriptionStatement.class);
156 public ReferenceStatement getReference() {
157 return firstDeclared(ReferenceStatement.class);
161 public Collection<? extends AugmentStatement> getAugments() {
162 return allDeclared(AugmentStatement.class);
166 public Collection<? extends RefineStatement> getRefines() {
167 return allDeclared(RefineStatement.class);