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 com.google.common.base.Optional;
  11 import com.google.common.base.Preconditions;
  12 import com.google.common.collect.ImmutableCollection.Builder;
  13 import com.google.common.collect.ImmutableList;
  14 import java.util.Collection;
  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.NormalizedNodes;
  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.ConstraintDefinition;
  23 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  24 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  25 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  26 import org.slf4j.Logger;
  27 import org.slf4j.LoggerFactory;
  28
  29 // TODO: would making this Serializable be useful (for Functions and similar?)
  30 abstract class MandatoryLeafEnforcer implements Immutable {
  31     private static final class NoOp extends MandatoryLeafEnforcer {
  32         @Override
  33         protected void enforceOnTreeNode(final TreeNode tree) {
  34             // Intentional no-op
  35         }
  36
  37         @Override
  38         protected void enforceOnTreeNode(final NormalizedNode<?, ?> normalizedNode) {
  39             // Intentional no-op
  40         }
  41     };
  42     private static final class Strict extends MandatoryLeafEnforcer {
  43         private final Collection<YangInstanceIdentifier> mandatoryNodes;
  44
  45         private Strict(final Collection<YangInstanceIdentifier> mandatoryNodes) {
  46             this.mandatoryNodes = Preconditions.checkNotNull(mandatoryNodes);
  47         }
  48
  49         @Override
  50         protected void enforceOnTreeNode(final TreeNode tree) {
  51             enforceOnTreeNode(tree.getData());
  52         }
  53
  54         @Override
  55         protected void enforceOnTreeNode(final NormalizedNode<?, ?> data) {
  56             for (YangInstanceIdentifier id : mandatoryNodes) {
  57                 final Optional<NormalizedNode<?, ?>> descandant = NormalizedNodes.findNode(data, id);
  58                 Preconditions.checkArgument(descandant.isPresent(), "Node %s is missing mandatory descendant %s",
  59                         data.getIdentifier(), id);
  60             }
  61         }
  62     };
  63
  64     private static final Logger LOG = LoggerFactory.getLogger(MandatoryLeafEnforcer.class);
  65     private static final MandatoryLeafEnforcer NOOP_ENFORCER = new NoOp();
  66
  67     protected abstract void enforceOnTreeNode(final TreeNode tree);
  68
  69     protected abstract void enforceOnTreeNode(final NormalizedNode<?, ?> normalizedNode);
  70
  71     private static void findMandatoryNodes(final Builder<YangInstanceIdentifier> builder,
  72             final YangInstanceIdentifier id, final DataNodeContainer schema, final TreeType type) {
  73         for (DataSchemaNode child : schema.getChildNodes()) {
  74             if (SchemaAwareApplyOperation.belongsToTree(type, child)) {
  75                 if (child instanceof ContainerSchemaNode) {
  76                     final ContainerSchemaNode container = (ContainerSchemaNode) child;
  77                     if (!container.isPresenceContainer()) {
  78                         findMandatoryNodes(builder, id.node(NodeIdentifier.create(child.getQName())), container, type);
  79                     }
  80                 } else {
  81                     final ConstraintDefinition constraints = child.getConstraints();
  82                     final Integer minElements = constraints.getMinElements();
  83                     if (constraints.isMandatory() || (minElements != null && minElements > 0)) {
  84                         final YangInstanceIdentifier childId = id.node(NodeIdentifier.create(child.getQName()));
  85                         LOG.debug("Adding mandatory child {}", childId);
  86                         builder.add(childId.toOptimized());
  87                     }
  88                 }
  89             }
  90         }
  91     }
  92
  93     static MandatoryLeafEnforcer forContainer(final DataNodeContainer schema, final TreeType type) {
  94         switch (type) {
  95         case CONFIGURATION:
  96             final Builder<YangInstanceIdentifier> builder = ImmutableList.builder();
  97             findMandatoryNodes(builder, YangInstanceIdentifier.EMPTY, schema, type);
  98             final Collection<YangInstanceIdentifier> mandatoryNodes = builder.build();
  99             return mandatoryNodes.isEmpty() ? NOOP_ENFORCER : new Strict(mandatoryNodes);
 100         case OPERATIONAL:
 101             return NOOP_ENFORCER;
 102         default:
 103             throw new UnsupportedOperationException(String.format("Not supported tree type %s", type));
 104         }
 105     }
 106 }