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