yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/tree/MandatoryLeafEnforcer.java

   1 /*
   2  * Copyright (c) 2014 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.data.impl.schema.tree;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.collect.ImmutableList;
  13 import com.google.common.collect.ImmutableList.Builder;
  14 import java.util.Optional;
  15 import org.opendaylight.yangtools.concepts.Immutable;
  16 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  17 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  18 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  19 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeConfiguration;
  20 import org.opendaylight.yangtools.yang.data.api.schema.tree.TreeType;
  21 import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.TreeNode;
  22 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  23 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  24 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  25 import org.opendaylight.yangtools.yang.model.api.ElementCountConstraintAware;
  26 import org.opendaylight.yangtools.yang.model.api.MandatoryAware;
  27 import org.slf4j.Logger;
  28 import org.slf4j.LoggerFactory;
  29
  30 // TODO: would making this Serializable be useful (for Functions and similar?)
  31 final class MandatoryLeafEnforcer implements Immutable {
  32     private static final Logger LOG = LoggerFactory.getLogger(MandatoryLeafEnforcer.class);
  33
  34     private final ImmutableList<MandatoryDescendant> mandatoryNodes;
  35
  36     private MandatoryLeafEnforcer(final ImmutableList<MandatoryDescendant> mandatoryNodes) {
  37         this.mandatoryNodes = requireNonNull(mandatoryNodes);
  38     }
  39
  40     static Optional<MandatoryLeafEnforcer> forContainer(final DataNodeContainer schema,
  41             final DataTreeConfiguration treeConfig) {
  42         if (!treeConfig.isMandatoryNodesValidationEnabled()) {
  43             return Optional.empty();
  44         }
  45
  46         final Builder<MandatoryDescendant> builder = ImmutableList.builder();
  47         findMandatoryNodes(builder, YangInstanceIdentifier.empty(), schema, treeConfig.getTreeType());
  48         final ImmutableList<MandatoryDescendant> mandatoryNodes = builder.build();
  49         return mandatoryNodes.isEmpty() ? Optional.empty() : Optional.of(new MandatoryLeafEnforcer(mandatoryNodes));
  50     }
  51
  52     void enforceOnData(final NormalizedNode<?, ?> data) {
  53         mandatoryNodes.forEach(node -> node.enforceOnData(data));
  54     }
  55
  56     void enforceOnTreeNode(final TreeNode tree) {
  57         enforceOnData(tree.getData());
  58     }
  59
  60     private static void findMandatoryNodes(final Builder<MandatoryDescendant> builder,
  61         final YangInstanceIdentifier id, final DataNodeContainer schema, final TreeType type) {
  62         for (final DataSchemaNode child : schema.getChildNodes()) {
  63             if (SchemaAwareApplyOperation.belongsToTree(type, child)) {
  64                 if (child instanceof ContainerSchemaNode) {
  65                     final ContainerSchemaNode container = (ContainerSchemaNode) child;
  66                     if (!container.isPresenceContainer()) {
  67                         findMandatoryNodes(builder,
  68                             id.node(NodeIdentifier.create(container.getQName())), container, type);
  69                     }
  70                 } else {
  71                     boolean needEnforce = child instanceof MandatoryAware && ((MandatoryAware) child).isMandatory();
  72                     if (!needEnforce && child instanceof ElementCountConstraintAware) {
  73                         needEnforce = ((ElementCountConstraintAware) child).getElementCountConstraint()
  74                             .map(constraint -> {
  75                                 final Integer min = constraint.getMinElements();
  76                                 return min != null && min > 0;
  77                             })
  78                             .orElse(Boolean.FALSE);
  79                     }
  80                     if (needEnforce) {
  81                         final MandatoryDescendant desc = MandatoryDescendant.create(id, schema, child);
  82                         LOG.debug("Adding mandatory child {}", desc);
  83                         builder.add(desc);
  84                     }
  85                 }
  86             }
  87         }
  88     }
  89 }