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