yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/InstanceIdToNodes.java

   1 /*
   2  * Copyright (c) 2015 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;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11 import static com.google.common.base.Preconditions.checkState;
  12
  13 import com.google.common.collect.ImmutableMap;
  14 import com.google.common.collect.Iterables;
  15 import java.util.Iterator;
  16 import java.util.List;
  17 import java.util.Map.Entry;
  18 import java.util.Optional;
  19 import javax.xml.transform.dom.DOMSource;
  20 import org.eclipse.jdt.annotation.NonNull;
  21 import org.opendaylight.yangtools.concepts.Identifiable;
  22 import org.opendaylight.yangtools.yang.common.QName;
  23 import org.opendaylight.yangtools.yang.data.api.ModifyAction;
  24 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  25 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  26 import org.opendaylight.yangtools.yang.data.api.schema.AnyXmlNode;
  27 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  28 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListEntryNode;
  29 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
  30 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.AttributesBuilder;
  31 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.CollectionNodeBuilder;
  32 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeAttrBuilder;
  33 import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
  34 import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
  35 import org.opendaylight.yangtools.yang.model.api.AugmentationTarget;
  36 import org.opendaylight.yangtools.yang.model.api.CaseSchemaNode;
  37 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
  38 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  39 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  40 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  41 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
  42 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
  43 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  44
  45 /**
  46  * Base strategy for converting an instance identifier into a normalized node structure.
  47  * Use provided static methods for generic YangInstanceIdentifier -> NormalizedNode translation in ImmutableNodes.
  48  */
  49 abstract class InstanceIdToNodes<T extends PathArgument> implements Identifiable<T> {
  50     private final T identifier;
  51
  52     InstanceIdToNodes(final T identifier) {
  53         this.identifier = identifier;
  54     }
  55
  56     @Override
  57     public final T getIdentifier() {
  58         return identifier;
  59     }
  60
  61     /**
  62      * Build a strategy for the next path argument.
  63      *
  64      * @param child child identifier
  65      * @return transformation strategy for a specific child
  66      */
  67     abstract InstanceIdToNodes<?> getChild(PathArgument child);
  68
  69     /**
  70      * Convert instance identifier into a NormalizedNode structure.
  71      *
  72      * @param instanceId Instance identifier to transform into NormalizedNodes
  73      * @param deepestChild Optional normalized node to be inserted as the last child
  74      * @param operation Optional modify operation to be set on the last child
  75      * @return NormalizedNode structure corresponding to submitted instance ID
  76      */
  77     abstract @NonNull NormalizedNode<?, ?> create(PathArgument first, Iterator<PathArgument> others,
  78             Optional<NormalizedNode<?, ?>> deepestChild, Optional<Entry<QName, ModifyAction>> operation);
  79
  80     abstract boolean isMixin();
  81
  82     static void addModifyOpIfPresent(final Optional<Entry<QName, ModifyAction>> operation,
  83             final AttributesBuilder<?> builder) {
  84         if (operation.isPresent()) {
  85             final Entry<QName, ModifyAction> entry = operation.get();
  86             builder.withAttributes(ImmutableMap.of(entry.getKey(), entry.getValue().name().toLowerCase()));
  87         }
  88     }
  89
  90     private static final class UnkeyedListMixinNormalization extends InstanceIdToCompositeNodes<NodeIdentifier> {
  91         private final UnkeyedListItemNormalization innerNode;
  92
  93         UnkeyedListMixinNormalization(final ListSchemaNode list) {
  94             super(NodeIdentifier.create(list.getQName()));
  95             this.innerNode = new UnkeyedListItemNormalization(list);
  96         }
  97
  98         @Override
  99         CollectionNodeBuilder<UnkeyedListEntryNode, UnkeyedListNode> createBuilder(final PathArgument compositeNode) {
 100             return Builders.unkeyedListBuilder().withNodeIdentifier(getIdentifier());
 101         }
 102
 103         @Override
 104         InstanceIdToNodes<?> getChild(final PathArgument child) {
 105             return child.getNodeType().equals(getIdentifier().getNodeType()) ? innerNode : null;
 106         }
 107
 108         @Override
 109         boolean isMixin() {
 110             return true;
 111         }
 112     }
 113
 114     private static final class AnyXmlNormalization extends InstanceIdToNodes<NodeIdentifier> {
 115         AnyXmlNormalization(final AnyXmlSchemaNode schema) {
 116             super(NodeIdentifier.create(schema.getQName()));
 117         }
 118
 119         @Override
 120         InstanceIdToNodes<?> getChild(final PathArgument child) {
 121             return null;
 122         }
 123
 124         @Override
 125         NormalizedNode<?, ?> create(final PathArgument first, final Iterator<PathArgument> others,
 126                 final Optional<NormalizedNode<?, ?>> deepestChild,
 127                 final Optional<Entry<QName,ModifyAction>> operation) {
 128             final NormalizedNodeAttrBuilder<NodeIdentifier, DOMSource, AnyXmlNode> builder = Builders.anyXmlBuilder()
 129                     .withNodeIdentifier(getIdentifier());
 130             if (deepestChild.isPresent()) {
 131                 final NormalizedNode<?, ?> child = deepestChild.get();
 132                 checkState(child instanceof AnyXmlNode);
 133                 builder.withValue(((AnyXmlNode) child).getValue());
 134             }
 135
 136             addModifyOpIfPresent(operation, builder);
 137             return builder.build();
 138         }
 139
 140         @Override
 141         boolean isMixin() {
 142             return false;
 143         }
 144     }
 145
 146     private static Optional<DataSchemaNode> findChildSchemaNode(final DataNodeContainer parent, final QName child) {
 147         DataSchemaNode potential = parent.getDataChildByName(child);
 148         if (potential == null) {
 149             potential = findChoice(Iterables.filter(parent.getChildNodes(), ChoiceSchemaNode.class), child);
 150         }
 151         return Optional.ofNullable(potential);
 152     }
 153
 154     static InstanceIdToNodes<?> fromSchemaAndQNameChecked(final DataNodeContainer schema, final QName child) {
 155         final Optional<DataSchemaNode> potential = findChildSchemaNode(schema, child);
 156         checkArgument(potential.isPresent(),
 157                 "Supplied QName %s is not valid according to schema %s, potential children nodes: %s", child, schema,
 158                 schema.getChildNodes());
 159
 160         final DataSchemaNode result = potential.get();
 161         // We try to look up if this node was added by augmentation
 162         if (schema instanceof DataSchemaNode && result.isAugmenting()) {
 163             return fromAugmentation(schema, (AugmentationTarget) schema, result);
 164         }
 165         return fromDataSchemaNode(result);
 166     }
 167
 168     private static ChoiceSchemaNode findChoice(final Iterable<ChoiceSchemaNode> choices, final QName child) {
 169         for (final ChoiceSchemaNode choice : choices) {
 170             for (final CaseSchemaNode caze : choice.getCases().values()) {
 171                 if (findChildSchemaNode(caze, child).isPresent()) {
 172                     return choice;
 173                 }
 174             }
 175         }
 176         return null;
 177     }
 178
 179     /**
 180      * Returns a SchemaPathUtil for provided child node
 181      * <p/>
 182      * If supplied child is added by Augmentation this operation returns
 183      * a SchemaPathUtil for augmentation,
 184      * otherwise returns a SchemaPathUtil for child as
 185      * call for {@link #fromDataSchemaNode(org.opendaylight.yangtools.yang.model.api.DataSchemaNode)}.
 186      */
 187     private static InstanceIdToNodes<?> fromAugmentation(final DataNodeContainer parent,
 188             final AugmentationTarget parentAug, final DataSchemaNode child) {
 189         for (final AugmentationSchemaNode aug : parentAug.getAvailableAugmentations()) {
 190             final DataSchemaNode potential = aug.getDataChildByName(child.getQName());
 191             if (potential != null) {
 192                 return new InstanceIdToCompositeNodes.AugmentationNormalization(aug, parent);
 193             }
 194         }
 195         return fromDataSchemaNode(child);
 196     }
 197
 198     static InstanceIdToNodes<?> fromDataSchemaNode(final DataSchemaNode potential) {
 199         if (potential instanceof ContainerSchemaNode) {
 200             return new InstanceIdToCompositeNodes.ContainerTransformation((ContainerSchemaNode) potential);
 201         } else if (potential instanceof ListSchemaNode) {
 202             return fromListSchemaNode((ListSchemaNode) potential);
 203         } else if (potential instanceof LeafSchemaNode) {
 204             return new InstanceIdToSimpleNodes.LeafNormalization((LeafSchemaNode) potential);
 205         } else if (potential instanceof ChoiceSchemaNode) {
 206             return new InstanceIdToCompositeNodes.ChoiceNodeNormalization((ChoiceSchemaNode) potential);
 207         } else if (potential instanceof LeafListSchemaNode) {
 208             return fromLeafListSchemaNode((LeafListSchemaNode) potential);
 209         } else if (potential instanceof AnyXmlSchemaNode) {
 210             return new AnyXmlNormalization((AnyXmlSchemaNode) potential);
 211         }
 212         return null;
 213     }
 214
 215     private static InstanceIdToNodes<?> fromListSchemaNode(final ListSchemaNode potential) {
 216         final List<QName> keyDefinition = potential.getKeyDefinition();
 217         if (keyDefinition == null || keyDefinition.isEmpty()) {
 218             return new UnkeyedListMixinNormalization(potential);
 219         }
 220         return potential.isUserOrdered() ? new InstanceIdToCompositeNodes.OrderedMapMixinNormalization(potential)
 221                 : new InstanceIdToCompositeNodes.UnorderedMapMixinNormalization(potential);
 222     }
 223
 224     private static InstanceIdToNodes<?> fromLeafListSchemaNode(final LeafListSchemaNode potential) {
 225         return potential.isUserOrdered() ? new InstanceIdToCompositeNodes.OrderedLeafListMixinNormalization(potential)
 226                 : new InstanceIdToCompositeNodes.UnorderedLeafListMixinNormalization(potential);
 227     }
 228 }