data/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/builder/impl/valid/DataNodeContainerValidator.java

   1 /*
   2  * Copyright (c) 2013 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.builder.impl.valid;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import java.util.HashSet;
  13 import java.util.Set;
  14 import org.opendaylight.yangtools.yang.common.QName;
  15 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
  16 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  17 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  18 import org.opendaylight.yangtools.yang.data.util.DataSchemaContextNode;
  19 import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
  20 import org.opendaylight.yangtools.yang.model.api.AugmentationTarget;
  21 import org.opendaylight.yangtools.yang.model.api.CaseSchemaNode;
  22 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  23
  24 /**
  25  * General validator for container like statements, e.g. container, list-entry, choice, augment
  26  */
  27 public class DataNodeContainerValidator {
  28     private final Set<AugmentationIdentifier> augments = new HashSet<>();
  29     private final DataNodeContainer schema;
  30     private final Set<QName> childNodes;
  31
  32     public DataNodeContainerValidator(final DataNodeContainer schema) {
  33         this.schema = requireNonNull(schema, "Schema was null");
  34         childNodes = getChildNodes(schema);
  35
  36         if (schema instanceof AugmentationTarget target) {
  37             for (var augmentation : target.getAvailableAugmentations()) {
  38                 augments.add(DataSchemaContextNode.augmentationIdentifierFrom(augmentation));
  39             }
  40         }
  41     }
  42
  43     private boolean isKnownChild(final PathArgument child) {
  44         if (child instanceof AugmentationIdentifier) {
  45             return augments.contains(child);
  46         }
  47
  48         return childNodes.contains(child.getNodeType());
  49     }
  50
  51     public void validateChild(final PathArgument child) {
  52         DataValidationException.checkLegalChild(isKnownChild(child), child, schema, childNodes, augments);
  53     }
  54
  55     public DataContainerChild validateChild(final DataContainerChild child) {
  56         validateChild(child.getIdentifier());
  57         return child;
  58     }
  59
  60     /**
  61      * Map all direct child nodes. Skip augments since they have no qname. List cases since cases do not exist in
  62      * NormalizedNode API.
  63      */
  64     private static Set<QName> getChildNodes(final DataNodeContainer nodeContainer) {
  65         Set<QName> allChildNodes = new HashSet<>();
  66
  67         for (var childSchema : nodeContainer.getChildNodes()) {
  68             if (childSchema instanceof CaseSchemaNode caseChildSchema) {
  69                 allChildNodes.addAll(getChildNodes(caseChildSchema));
  70             } else if (!(childSchema instanceof AugmentationSchemaNode)) {
  71                 allChildNodes.add(childSchema.getQName());
  72             }
  73         }
  74
  75         return allChildNodes;
  76     }
  77 }