yang/rfc8040-parser-support/src/main/java/org/opendaylight/yangtools/rfc8040/parser/YangDataStatementSupport.java

   1 /*
   2  * Copyright (c) 2017 Pantheon Technologies, s.r.o. 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.rfc8040.parser;
   9
  10 import static com.google.common.base.Verify.verifyNotNull;
  11
  12 import com.google.common.annotations.Beta;
  13 import com.google.common.collect.ImmutableList;
  14 import org.eclipse.jdt.annotation.NonNull;
  15 import org.opendaylight.yangtools.rfc8040.model.api.YangDataEffectiveStatement;
  16 import org.opendaylight.yangtools.rfc8040.model.api.YangDataStatement;
  17 import org.opendaylight.yangtools.rfc8040.model.api.YangDataStatements;
  18 import org.opendaylight.yangtools.yang.common.Empty;
  19 import org.opendaylight.yangtools.yang.common.QName;
  20 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  21 import org.opendaylight.yangtools.yang.model.api.meta.DeclarationReference;
  22 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  23 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  24 import org.opendaylight.yangtools.yang.model.api.stmt.DataTreeEffectiveStatement;
  25 import org.opendaylight.yangtools.yang.parser.api.YangParserConfiguration;
  26 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStringStatementSupport;
  27 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  28 import org.opendaylight.yangtools.yang.parser.spi.meta.InvalidSubstatementException;
  29 import org.opendaylight.yangtools.yang.parser.spi.meta.MissingSubstatementException;
  30 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  31 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  32 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
  33 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
  34 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  35
  36 @Beta
  37 public final class YangDataStatementSupport
  38         extends AbstractStringStatementSupport<YangDataStatement, YangDataEffectiveStatement> {
  39     private final SubstatementValidator declaredValidator;
  40
  41     public YangDataStatementSupport(final YangParserConfiguration config) {
  42         super(YangDataStatements.YANG_DATA, StatementPolicy.reject(), config);
  43         declaredValidator = SubstatementValidator.builder(YangDataStatements.YANG_DATA)
  44                 .addMandatory(YangStmtMapping.CONTAINER)
  45                 .addOptional(YangStmtMapping.USES)
  46                 .build();
  47     }
  48
  49     @Override
  50     public void onStatementAdded(final Mutable<String, YangDataStatement, YangDataEffectiveStatement> ctx) {
  51         // as per https://tools.ietf.org/html/rfc8040#section-8,
  52         // yang-data is ignored unless it appears as a top-level statement
  53         if (ctx.coerceParentContext().getParentContext() != null) {
  54             ctx.setIsSupportedToBuildEffective(false);
  55         }
  56     }
  57
  58     @Override
  59     public void onFullDefinitionDeclared(final Mutable<String, YangDataStatement, YangDataEffectiveStatement> ctx) {
  60         // Parse and populate our argument to be picked up when we build the effecitve statement
  61         final String argument = SourceException.throwIfNull(ctx.argument(), ctx, "yang-data requires an argument");
  62         final QName qname = StmtContextUtils.parseIdentifier(ctx, argument);
  63         ctx.addToNs(YangDataArgumentNamespace.class, Empty.getInstance(), qname);
  64     }
  65
  66     @Override
  67     public boolean isIgnoringIfFeatures() {
  68         return true;
  69     }
  70
  71     @Override
  72     public boolean isIgnoringConfig() {
  73         return true;
  74     }
  75
  76     @Override
  77     protected SubstatementValidator getSubstatementValidator() {
  78         return declaredValidator;
  79     }
  80
  81     @Override
  82     protected YangDataStatement createDeclared(@NonNull final StmtContext<String, YangDataStatement, ?> ctx,
  83             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
  84         return new YangDataStatementImpl(ctx.getRawArgument(), substatements);
  85     }
  86
  87     @Override
  88     protected YangDataStatement attachDeclarationReference(final YangDataStatement stmt,
  89             final DeclarationReference reference) {
  90         return new RefYangDataStatement(stmt, reference);
  91     }
  92
  93     @Override
  94     protected YangDataEffectiveStatement createEffective(final Current<String, YangDataStatement> stmt,
  95             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
  96         // So now we need to deal with effective validation. The requirement is that:
  97         //        It MUST contain data definition statements
  98         //        that result in exactly one container data node definition.
  99         final long dataDefs = substatements.stream().filter(DataTreeEffectiveStatement.class::isInstance).count();
 100         if (dataDefs == 0) {
 101             throw new MissingSubstatementException("yang-data requires exactly one container", stmt.sourceReference());
 102         }
 103         if (dataDefs > 1) {
 104             throw new InvalidSubstatementException(stmt,
 105                 "yang-data requires exactly one data definition node, found %s", dataDefs);
 106         }
 107
 108         return new YangDataEffectiveStatementImpl(stmt, substatements,
 109             verifyNotNull(stmt.namespaceItem(YangDataArgumentNamespace.class, Empty.getInstance())));
 110     }
 111 }