2 * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.yangtools.yang.data.impl.schema;
10 import static com.google.common.base.Preconditions.checkArgument;
11 import static com.google.common.base.Preconditions.checkState;
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.opendaylight.yangtools.concepts.Identifiable;
21 import org.opendaylight.yangtools.yang.common.QName;
22 import org.opendaylight.yangtools.yang.data.api.ModifyAction;
23 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
24 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
25 import org.opendaylight.yangtools.yang.data.api.schema.AnyXmlNode;
26 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
27 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListEntryNode;
28 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
29 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.AttributesBuilder;
30 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.CollectionNodeBuilder;
31 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeAttrBuilder;
32 import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
33 import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
34 import org.opendaylight.yangtools.yang.model.api.AugmentationTarget;
35 import org.opendaylight.yangtools.yang.model.api.CaseSchemaNode;
36 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
37 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
38 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
39 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
40 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
41 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
42 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
45 * Base strategy for converting an instance identifier into a normalized node structure.
46 * Use provided static methods for generic YangInstanceIdentifier -> NormalizedNode translation in ImmutableNodes.
48 abstract class InstanceIdToNodes<T extends PathArgument> implements Identifiable<T> {
49 private final T identifier;
51 InstanceIdToNodes(final T identifier) {
52 this.identifier = identifier;
56 public final T getIdentifier() {
61 * Build a strategy for the next path argument.
63 * @param child child identifier
64 * @return transformation strategy for a specific child
66 abstract InstanceIdToNodes<?> getChild(PathArgument child);
69 * Convert instance identifier into a NormalizedNode structure.
71 * @param instanceId Instance identifier to transform into NormalizedNodes
72 * @param deepestChild Optional normalized node to be inserted as the last child
73 * @param operation Optional modify operation to be set on the last child
74 * @return NormalizedNode structure corresponding to submitted instance ID
76 abstract NormalizedNode<?, ?> create(PathArgument first, Iterator<PathArgument> others,
77 Optional<NormalizedNode<?, ?>> deepestChild, Optional<Entry<QName, ModifyAction>> operation);
79 abstract boolean isMixin();
81 static void addModifyOpIfPresent(final Optional<Entry<QName, ModifyAction>> operation,
82 final AttributesBuilder<?> builder) {
83 if (operation.isPresent()) {
84 final Entry<QName, ModifyAction> entry = operation.get();
85 builder.withAttributes(ImmutableMap.of(entry.getKey(), entry.getValue().name().toLowerCase()));
89 private static final class UnkeyedListMixinNormalization extends InstanceIdToCompositeNodes<NodeIdentifier> {
90 private final UnkeyedListItemNormalization innerNode;
92 UnkeyedListMixinNormalization(final ListSchemaNode list) {
93 super(NodeIdentifier.create(list.getQName()));
94 this.innerNode = new UnkeyedListItemNormalization(list);
98 CollectionNodeBuilder<UnkeyedListEntryNode, UnkeyedListNode> createBuilder(final PathArgument compositeNode) {
99 return Builders.unkeyedListBuilder().withNodeIdentifier(getIdentifier());
103 InstanceIdToNodes<?> getChild(final PathArgument child) {
104 return child.getNodeType().equals(getIdentifier().getNodeType()) ? innerNode : null;
113 private static final class AnyXmlNormalization extends InstanceIdToNodes<NodeIdentifier> {
114 AnyXmlNormalization(final AnyXmlSchemaNode schema) {
115 super(NodeIdentifier.create(schema.getQName()));
119 InstanceIdToNodes<?> getChild(final PathArgument child) {
124 NormalizedNode<?, ?> create(final PathArgument first, final Iterator<PathArgument> others,
125 final Optional<NormalizedNode<?, ?>> deepestChild,
126 final Optional<Entry<QName,ModifyAction>> operation) {
127 final NormalizedNodeAttrBuilder<NodeIdentifier, DOMSource, AnyXmlNode> builder = Builders.anyXmlBuilder()
128 .withNodeIdentifier(getIdentifier());
129 if (deepestChild.isPresent()) {
130 final NormalizedNode<?, ?> child = deepestChild.get();
131 checkState(child instanceof AnyXmlNode);
132 builder.withValue(((AnyXmlNode) child).getValue());
135 addModifyOpIfPresent(operation, builder);
136 return builder.build();
145 private static Optional<DataSchemaNode> findChildSchemaNode(final DataNodeContainer parent, final QName child) {
146 DataSchemaNode potential = parent.getDataChildByName(child);
147 if (potential == null) {
148 potential = findChoice(Iterables.filter(parent.getChildNodes(), ChoiceSchemaNode.class), child);
150 return Optional.ofNullable(potential);
153 static InstanceIdToNodes<?> fromSchemaAndQNameChecked(final DataNodeContainer schema, final QName child) {
154 final Optional<DataSchemaNode> potential = findChildSchemaNode(schema, child);
155 checkArgument(potential.isPresent(),
156 "Supplied QName %s is not valid according to schema %s, potential children nodes: %s", child, schema,
157 schema.getChildNodes());
159 final DataSchemaNode result = potential.get();
160 // We try to look up if this node was added by augmentation
161 if (schema instanceof DataSchemaNode && result.isAugmenting()) {
162 return fromAugmentation(schema, (AugmentationTarget) schema, result);
164 return fromDataSchemaNode(result);
167 private static ChoiceSchemaNode findChoice(final Iterable<ChoiceSchemaNode> choices, final QName child) {
168 for (final ChoiceSchemaNode choice : choices) {
169 for (final CaseSchemaNode caze : choice.getCases().values()) {
170 if (findChildSchemaNode(caze, child).isPresent()) {
179 * Returns a SchemaPathUtil for provided child node
181 * If supplied child is added by Augmentation this operation returns
182 * a SchemaPathUtil for augmentation,
183 * otherwise returns a SchemaPathUtil for child as
184 * call for {@link #fromDataSchemaNode(org.opendaylight.yangtools.yang.model.api.DataSchemaNode)}.
186 private static InstanceIdToNodes<?> fromAugmentation(final DataNodeContainer parent,
187 final AugmentationTarget parentAug, final DataSchemaNode child) {
188 for (final AugmentationSchemaNode aug : parentAug.getAvailableAugmentations()) {
189 final DataSchemaNode potential = aug.getDataChildByName(child.getQName());
190 if (potential != null) {
191 return new InstanceIdToCompositeNodes.AugmentationNormalization(aug, parent);
194 return fromDataSchemaNode(child);
197 static InstanceIdToNodes<?> fromDataSchemaNode(final DataSchemaNode potential) {
198 if (potential instanceof ContainerSchemaNode) {
199 return new InstanceIdToCompositeNodes.ContainerTransformation((ContainerSchemaNode) potential);
200 } else if (potential instanceof ListSchemaNode) {
201 return fromListSchemaNode((ListSchemaNode) potential);
202 } else if (potential instanceof LeafSchemaNode) {
203 return new InstanceIdToSimpleNodes.LeafNormalization((LeafSchemaNode) potential);
204 } else if (potential instanceof ChoiceSchemaNode) {
205 return new InstanceIdToCompositeNodes.ChoiceNodeNormalization((ChoiceSchemaNode) potential);
206 } else if (potential instanceof LeafListSchemaNode) {
207 return fromLeafListSchemaNode((LeafListSchemaNode) potential);
208 } else if (potential instanceof AnyXmlSchemaNode) {
209 return new AnyXmlNormalization((AnyXmlSchemaNode) potential);
214 private static InstanceIdToNodes<?> fromListSchemaNode(final ListSchemaNode potential) {
215 final List<QName> keyDefinition = potential.getKeyDefinition();
216 if (keyDefinition == null || keyDefinition.isEmpty()) {
217 return new UnkeyedListMixinNormalization(potential);
219 return potential.isUserOrdered() ? new InstanceIdToCompositeNodes.OrderedMapMixinNormalization(potential)
220 : new InstanceIdToCompositeNodes.UnorderedMapMixinNormalization(potential);
223 private static InstanceIdToNodes<?> fromLeafListSchemaNode(final LeafListSchemaNode potential) {
224 return potential.isUserOrdered() ? new InstanceIdToCompositeNodes.OrderedLeafListMixinNormalization(potential)
225 : new InstanceIdToCompositeNodes.UnorderedLeafListMixinNormalization(potential);