yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/builder/impl/ImmutableMapEntryNodeBuilder.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;
   9
  10 import java.util.Collection;
  11 import java.util.LinkedHashMap;
  12 import java.util.Map;
  13 import java.util.Map.Entry;
  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.NodeIdentifierWithPredicates;
  17 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  18 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  19 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
  20 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  21 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  22 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeAttrBuilder;
  23 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.valid.DataValidationException;
  24 import org.opendaylight.yangtools.yang.data.impl.schema.nodes.AbstractImmutableDataContainerAttrNode;
  25 import org.slf4j.Logger;
  26 import org.slf4j.LoggerFactory;
  27
  28 public class ImmutableMapEntryNodeBuilder
  29         extends AbstractImmutableDataContainerNodeAttrBuilder<NodeIdentifierWithPredicates, MapEntryNode> {
  30     private static final Logger LOG = LoggerFactory.getLogger(ImmutableMapEntryNodeBuilder.class);
  31     protected final Map<QName, PathArgument> childrenQNamesToPaths;
  32
  33     protected ImmutableMapEntryNodeBuilder() {
  34         super();
  35         this.childrenQNamesToPaths = new LinkedHashMap<>();
  36     }
  37
  38     protected ImmutableMapEntryNodeBuilder(final int sizeHint) {
  39         super(sizeHint);
  40         this.childrenQNamesToPaths = new LinkedHashMap<>(sizeHint);
  41     }
  42
  43     protected ImmutableMapEntryNodeBuilder(final ImmutableMapEntryNode node) {
  44         super(node);
  45         this.childrenQNamesToPaths = new LinkedHashMap<>();
  46         fillQnames(node.getValue(), childrenQNamesToPaths);
  47     }
  48
  49     public static DataContainerNodeAttrBuilder<NodeIdentifierWithPredicates, MapEntryNode> create() {
  50         return new ImmutableMapEntryNodeBuilder();
  51     }
  52
  53     public static DataContainerNodeAttrBuilder<NodeIdentifierWithPredicates, MapEntryNode> create(final int sizeHint) {
  54         return new ImmutableMapEntryNodeBuilder(sizeHint);
  55     }
  56
  57     public static DataContainerNodeAttrBuilder<NodeIdentifierWithPredicates, MapEntryNode> create(
  58             final MapEntryNode node) {
  59         if (!(node instanceof ImmutableMapEntryNode)) {
  60             throw new UnsupportedOperationException(String.format("Cannot initialize from class %s", node.getClass()));
  61         }
  62
  63         return new ImmutableMapEntryNodeBuilder((ImmutableMapEntryNode)node);
  64     }
  65
  66     private static void fillQnames(final Iterable<DataContainerChild<? extends PathArgument, ?>> iterable,
  67             final Map<QName, PathArgument> out) {
  68         for (final DataContainerChild<? extends PathArgument, ?> childId : iterable) {
  69             final PathArgument identifier = childId.getIdentifier();
  70
  71             // Augmentation nodes cannot be keys, and do not have to be present in childrenQNamesToPaths map
  72             if (isAugment(identifier)) {
  73                 continue;
  74             }
  75
  76             out.put(childId.getNodeType(), identifier);
  77         }
  78     }
  79
  80
  81     @Override
  82     public DataContainerNodeAttrBuilder<NodeIdentifierWithPredicates, MapEntryNode> withValue(
  83             final Collection<DataContainerChild<? extends PathArgument, ?>> value) {
  84         fillQnames(value, childrenQNamesToPaths);
  85         return super.withValue(value);
  86     }
  87
  88     private static boolean isAugment(final PathArgument identifier) {
  89         return identifier instanceof AugmentationIdentifier;
  90     }
  91
  92     @Override
  93     public DataContainerNodeAttrBuilder<NodeIdentifierWithPredicates, MapEntryNode> withChild(
  94             final DataContainerChild<?, ?> child) {
  95         // Augmentation nodes cannot be keys, and do not have to be present in childrenQNamesToPaths map
  96         if (!isAugment(child.getIdentifier())) {
  97             childrenQNamesToPaths.put(child.getNodeType(), child.getIdentifier());
  98         }
  99
 100         return super.withChild(child);
 101     }
 102
 103     @Override
 104     public MapEntryNode build() {
 105         for (final Entry<QName, Object> key : getNodeIdentifier().getKeyValues().entrySet()) {
 106             final DataContainerChild<?, ?> childNode = getChild(childrenQNamesToPaths.get(key.getKey()));
 107
 108             // We have enough information to fill-in missing leaf nodes, so let's do that
 109             if (childNode == null) {
 110                 LeafNode<Object> leaf = ImmutableNodes.leafNode(key.getKey(), key.getValue());
 111                 LOG.debug("Adding leaf {} implied by key {}", leaf, key);
 112                 withChild(leaf);
 113             } else {
 114                 DataValidationException.checkListKey(getNodeIdentifier(), key.getKey(), key.getValue(),
 115                     childNode.getValue());
 116             }
 117         }
 118
 119         return new ImmutableMapEntryNode(getNodeIdentifier(), buildValue(), getAttributes());
 120     }
 121
 122     private static final class ImmutableMapEntryNode
 123             extends AbstractImmutableDataContainerAttrNode<NodeIdentifierWithPredicates> implements MapEntryNode {
 124
 125         ImmutableMapEntryNode(final NodeIdentifierWithPredicates nodeIdentifier,
 126                 final Map<PathArgument, DataContainerChild<? extends PathArgument, ?>> children,
 127                 final Map<QName, String> attributes) {
 128             super(children, nodeIdentifier, attributes);
 129         }
 130     }
 131 }