yang/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/list/AbstractListStatementSupport.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.yang.parser.rfc7950.stmt.list;
   9
  10 import com.google.common.collect.ImmutableList;
  11 import java.util.ArrayList;
  12 import java.util.HashSet;
  13 import java.util.List;
  14 import java.util.Optional;
  15 import java.util.Set;
  16 import org.opendaylight.yangtools.yang.common.QName;
  17 import org.opendaylight.yangtools.yang.model.api.ElementCountConstraint;
  18 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
  19 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  20 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  21 import org.opendaylight.yangtools.yang.model.api.Status;
  22 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  23 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  24 import org.opendaylight.yangtools.yang.model.api.stmt.KeyEffectiveStatement;
  25 import org.opendaylight.yangtools.yang.model.api.stmt.ListEffectiveStatement;
  26 import org.opendaylight.yangtools.yang.model.api.stmt.ListStatement;
  27 import org.opendaylight.yangtools.yang.model.api.stmt.OrderedByEffectiveStatement;
  28 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier;
  29 import org.opendaylight.yangtools.yang.model.api.stmt.StatusEffectiveStatement;
  30 import org.opendaylight.yangtools.yang.parser.rfc7950.namespace.ChildSchemaNodeNamespace;
  31 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.BaseQNameStatementSupport;
  32 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStatementMixins.EffectiveStatementWithFlags.FlagsBuilder;
  33 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStmtUtils;
  34 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
  35 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  36 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  37 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
  38 import org.opendaylight.yangtools.yang.parser.spi.source.StatementSourceReference;
  39 import org.slf4j.Logger;
  40 import org.slf4j.LoggerFactory;
  41
  42 abstract class AbstractListStatementSupport extends BaseQNameStatementSupport<ListStatement, ListEffectiveStatement> {
  43     private static final Logger LOG = LoggerFactory.getLogger(AbstractListStatementSupport.class);
  44
  45     AbstractListStatementSupport() {
  46         super(YangStmtMapping.LIST);
  47     }
  48
  49     @Override
  50     public final QName parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
  51         return StmtContextUtils.parseIdentifier(ctx, value);
  52     }
  53
  54     @Override
  55     public final void onStatementAdded(final Mutable<QName, ListStatement, ListEffectiveStatement> stmt) {
  56         stmt.coerceParentContext().addToNs(ChildSchemaNodeNamespace.class, stmt.coerceStatementArgument(), stmt);
  57     }
  58
  59     @Override
  60     public final ListStatement createDeclared(final StmtContext<QName, ListStatement, ?> ctx) {
  61         return new ListStatementImpl(ctx);
  62     }
  63
  64     @Override
  65     protected final ListEffectiveStatement createEffective(
  66             final StmtContext<QName, ListStatement, ListEffectiveStatement> ctx,
  67             final ListStatement declared, final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
  68         final StatementSourceReference ref = ctx.getStatementSourceReference();
  69         final SchemaPath path = ctx.getSchemaPath().get();
  70         final ListSchemaNode original = (ListSchemaNode) ctx.getOriginalCtx().map(StmtContext::buildEffective)
  71                 .orElse(null);
  72
  73         final ImmutableList<QName> keyDefinition;
  74         final KeyEffectiveStatement keyStmt = findFirstStatement(substatements, KeyEffectiveStatement.class);
  75         if (keyStmt != null) {
  76             final List<QName> keyDefinitionInit = new ArrayList<>(keyStmt.argument().size());
  77             final Set<QName> possibleLeafQNamesForKey = new HashSet<>();
  78             for (final EffectiveStatement<?, ?> effectiveStatement : substatements) {
  79                 if (effectiveStatement instanceof LeafSchemaNode) {
  80                     possibleLeafQNamesForKey.add(((LeafSchemaNode) effectiveStatement).getQName());
  81                 }
  82             }
  83             for (final SchemaNodeIdentifier key : keyStmt.argument()) {
  84                 final QName keyQName = key.getLastComponent();
  85
  86                 if (!possibleLeafQNamesForKey.contains(keyQName)) {
  87                     throw new InferenceException(ref, "Key '%s' misses node '%s' in list '%s'",
  88                         keyStmt.getDeclared().rawArgument(), keyQName.getLocalName(), ctx.getStatementArgument());
  89                 }
  90                 keyDefinitionInit.add(keyQName);
  91             }
  92
  93             keyDefinition = ImmutableList.copyOf(keyDefinitionInit);
  94         } else {
  95             keyDefinition = ImmutableList.of();
  96         }
  97
  98         final boolean configuration = ctx.isConfiguration();
  99         final int flags = new FlagsBuilder()
 100                 .setHistory(ctx.getCopyHistory())
 101                 .setStatus(findFirstArgument(substatements, StatusEffectiveStatement.class, Status.CURRENT))
 102                 .setConfiguration(configuration)
 103                 .setUserOrdered(findFirstArgument(substatements, OrderedByEffectiveStatement.class, "system")
 104                     .equals("user"))
 105                 .toFlags();
 106         if (configuration && keyDefinition.isEmpty()) {
 107             LOG.info("Configuration list {} does not define any keys in violation of RFC7950 section 7.8.2. While "
 108                     + " this is fine with OpenDaylight, it can cause interoperability issues with other systems "
 109                     + "[at {}]", ctx.getStatementArgument(), ref);
 110         }
 111
 112         final Optional<ElementCountConstraint> elementCountConstraint =
 113                 EffectiveStmtUtils.createElementCountConstraint(substatements);
 114         return original == null && !elementCountConstraint.isPresent()
 115                 ? new EmptyListEffectiveStatement(declared, path, flags, ctx, substatements, keyDefinition)
 116                         : new RegularListEffectiveStatement(declared, path, flags, ctx, substatements, keyDefinition,
 117                             elementCountConstraint.orElse(null), original);
 118     }
 119
 120     @Override
 121     protected final ListEffectiveStatement createEmptyEffective(
 122             final StmtContext<QName, ListStatement, ListEffectiveStatement> ctx, final ListStatement declared) {
 123         return createEffective(ctx, declared, ImmutableList.of());
 124     }
 125 }