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.Iterables;
14 import java.util.Iterator;
15 import java.util.List;
16 import java.util.Optional;
17 import javax.xml.transform.dom.DOMSource;
18 import org.eclipse.jdt.annotation.NonNull;
19 import org.opendaylight.yangtools.concepts.AbstractIdentifiable;
20 import org.opendaylight.yangtools.yang.common.QName;
21 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
22 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
23 import org.opendaylight.yangtools.yang.data.api.schema.AnyXmlNode;
24 import org.opendaylight.yangtools.yang.data.api.schema.AnydataNode;
25 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
26 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListEntryNode;
27 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
28 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.CollectionNodeBuilder;
29 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeBuilder;
30 import org.opendaylight.yangtools.yang.model.api.AnyDataSchemaNode;
31 import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
32 import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
33 import org.opendaylight.yangtools.yang.model.api.AugmentationTarget;
34 import org.opendaylight.yangtools.yang.model.api.CaseSchemaNode;
35 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
36 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
37 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
38 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
39 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
40 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
41 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
44 * Base strategy for converting an instance identifier into a normalized node structure.
45 * Use provided static methods for generic YangInstanceIdentifier -> NormalizedNode translation in ImmutableNodes.
47 abstract class InstanceIdToNodes<T extends PathArgument> extends AbstractIdentifiable<T> {
48 InstanceIdToNodes(final T identifier) {
53 * Build a strategy for the next path argument.
55 * @param child child identifier
56 * @return transformation strategy for a specific child
58 abstract InstanceIdToNodes<?> getChild(PathArgument child);
61 * Convert instance identifier into a NormalizedNode structure.
63 * @param instanceId Instance identifier to transform into NormalizedNodes
64 * @param deepestChild Optional normalized node to be inserted as the last child
65 * @param operation Optional modify operation to be set on the last child
66 * @return NormalizedNode structure corresponding to submitted instance ID
68 abstract @NonNull NormalizedNode<?, ?> create(PathArgument first, Iterator<PathArgument> others,
69 Optional<NormalizedNode<?, ?>> deepestChild);
71 abstract boolean isMixin();
73 private static final class UnkeyedListMixinNormalization extends InstanceIdToCompositeNodes<NodeIdentifier> {
74 private final UnkeyedListItemNormalization innerNode;
76 UnkeyedListMixinNormalization(final ListSchemaNode list) {
77 super(NodeIdentifier.create(list.getQName()));
78 this.innerNode = new UnkeyedListItemNormalization(list);
82 CollectionNodeBuilder<UnkeyedListEntryNode, UnkeyedListNode> createBuilder(final PathArgument compositeNode) {
83 return Builders.unkeyedListBuilder().withNodeIdentifier(getIdentifier());
87 InstanceIdToNodes<?> getChild(final PathArgument child) {
88 return child.getNodeType().equals(getIdentifier().getNodeType()) ? innerNode : null;
97 private abstract static class AbstractOpaqueNormalization extends InstanceIdToNodes<NodeIdentifier> {
98 AbstractOpaqueNormalization(final DataSchemaNode schema) {
99 super(NodeIdentifier.create(schema.getQName()));
103 final InstanceIdToNodes<?> getChild(final PathArgument child) {
108 final boolean isMixin() {
113 private static final class AnydataNormalization extends AbstractOpaqueNormalization {
114 AnydataNormalization(final AnyDataSchemaNode schema) {
119 NormalizedNode<?, ?> create(final PathArgument first, final Iterator<PathArgument> others,
120 final Optional<NormalizedNode<?, ?>> deepestChild) {
121 checkState(deepestChild.isPresent(), "Cannot instantiate anydata node without a value");
122 final NormalizedNode<?, ?> child = deepestChild.get();
123 checkState(child instanceof AnydataNode, "Invalid child %s", child);
124 return createAnydata((AnydataNode<?>) child);
127 private <T> AnydataNode<T> createAnydata(final AnydataNode<T> child) {
128 return Builders.anydataBuilder(child.getValueObjectModel()).withValue(child.getValue())
129 .withNodeIdentifier(getIdentifier()).build();
133 private static final class AnyXmlNormalization extends AbstractOpaqueNormalization {
134 AnyXmlNormalization(final AnyXmlSchemaNode schema) {
139 NormalizedNode<?, ?> create(final PathArgument first, final Iterator<PathArgument> others,
140 final Optional<NormalizedNode<?, ?>> deepestChild) {
141 final NormalizedNodeBuilder<NodeIdentifier, DOMSource, AnyXmlNode> builder = Builders.anyXmlBuilder()
142 .withNodeIdentifier(getIdentifier());
143 if (deepestChild.isPresent()) {
144 final NormalizedNode<?, ?> child = deepestChild.get();
145 checkState(child instanceof AnyXmlNode, "Invalid child %s", child);
146 builder.withValue(((AnyXmlNode) child).getValue());
149 return builder.build();
153 private static Optional<DataSchemaNode> findChildSchemaNode(final DataNodeContainer parent, final QName child) {
154 final Optional<DataSchemaNode> potential = parent.findDataChildByName(child);
155 return potential.isPresent() ? potential : Optional.ofNullable(
156 findChoice(Iterables.filter(parent.getChildNodes(), ChoiceSchemaNode.class), child));
159 static InstanceIdToNodes<?> fromSchemaAndQNameChecked(final DataNodeContainer schema, final QName child) {
160 final Optional<DataSchemaNode> potential = findChildSchemaNode(schema, child);
161 checkArgument(potential.isPresent(),
162 "Supplied QName %s is not valid according to schema %s, potential children nodes: %s", child, schema,
163 schema.getChildNodes());
165 final DataSchemaNode result = potential.get();
166 // We try to look up if this node was added by augmentation
167 if (schema instanceof DataSchemaNode && result.isAugmenting()) {
168 return fromAugmentation(schema, (AugmentationTarget) schema, result);
170 return fromDataSchemaNode(result);
173 private static ChoiceSchemaNode findChoice(final Iterable<ChoiceSchemaNode> choices, final QName child) {
174 for (final ChoiceSchemaNode choice : choices) {
175 for (final CaseSchemaNode caze : choice.getCases().values()) {
176 if (findChildSchemaNode(caze, child).isPresent()) {
185 * Returns a SchemaPathUtil for provided child node
187 * If supplied child is added by Augmentation this operation returns
188 * a SchemaPathUtil for augmentation,
189 * otherwise returns a SchemaPathUtil for child as
190 * call for {@link #fromDataSchemaNode(org.opendaylight.yangtools.yang.model.api.DataSchemaNode)}.
192 private static InstanceIdToNodes<?> fromAugmentation(final DataNodeContainer parent,
193 final AugmentationTarget parentAug, final DataSchemaNode child) {
194 for (final AugmentationSchemaNode aug : parentAug.getAvailableAugmentations()) {
195 final Optional<DataSchemaNode> potential = aug.findDataChildByName(child.getQName());
196 if (potential.isPresent()) {
197 return new InstanceIdToCompositeNodes.AugmentationNormalization(aug, parent);
200 return fromDataSchemaNode(child);
203 static InstanceIdToNodes<?> fromDataSchemaNode(final DataSchemaNode potential) {
204 if (potential instanceof ContainerSchemaNode) {
205 return new InstanceIdToCompositeNodes.ContainerTransformation((ContainerSchemaNode) potential);
206 } else if (potential instanceof ListSchemaNode) {
207 return fromListSchemaNode((ListSchemaNode) potential);
208 } else if (potential instanceof LeafSchemaNode) {
209 return new InstanceIdToSimpleNodes.LeafNormalization((LeafSchemaNode) potential);
210 } else if (potential instanceof ChoiceSchemaNode) {
211 return new InstanceIdToCompositeNodes.ChoiceNodeNormalization((ChoiceSchemaNode) potential);
212 } else if (potential instanceof LeafListSchemaNode) {
213 return fromLeafListSchemaNode((LeafListSchemaNode) potential);
214 } else if (potential instanceof AnyDataSchemaNode) {
215 return new AnydataNormalization((AnyDataSchemaNode) potential);
216 } else if (potential instanceof AnyXmlSchemaNode) {
217 return new AnyXmlNormalization((AnyXmlSchemaNode) potential);
222 private static InstanceIdToNodes<?> fromListSchemaNode(final ListSchemaNode potential) {
223 final List<QName> keyDefinition = potential.getKeyDefinition();
224 if (keyDefinition == null || keyDefinition.isEmpty()) {
225 return new UnkeyedListMixinNormalization(potential);
227 return potential.isUserOrdered() ? new InstanceIdToCompositeNodes.OrderedMapMixinNormalization(potential)
228 : new InstanceIdToCompositeNodes.UnorderedMapMixinNormalization(potential);
231 private static InstanceIdToNodes<?> fromLeafListSchemaNode(final LeafListSchemaNode potential) {
232 return potential.isUserOrdered() ? new InstanceIdToCompositeNodes.OrderedLeafListMixinNormalization(potential)
233 : new InstanceIdToCompositeNodes.UnorderedLeafListMixinNormalization(potential);