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.AnydataNode;
24 import org.opendaylight.yangtools.yang.data.api.schema.DOMSourceAnyxmlNode;
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, DOMSourceAnyxmlNode> builder =
142 Builders.anyXmlBuilder()
143 .withNodeIdentifier(getIdentifier());
144 if (deepestChild.isPresent()) {
145 final NormalizedNode<?, ?> child = deepestChild.get();
146 checkState(child instanceof DOMSourceAnyxmlNode, "Invalid child %s", child);
147 builder.withValue(((DOMSourceAnyxmlNode) child).getValue());
150 return builder.build();
154 private static Optional<DataSchemaNode> findChildSchemaNode(final DataNodeContainer parent, final QName child) {
155 final Optional<DataSchemaNode> potential = parent.findDataChildByName(child);
156 return potential.isPresent() ? potential : Optional.ofNullable(
157 findChoice(Iterables.filter(parent.getChildNodes(), ChoiceSchemaNode.class), child));
160 static InstanceIdToNodes<?> fromSchemaAndQNameChecked(final DataNodeContainer schema, final QName child) {
161 final Optional<DataSchemaNode> potential = findChildSchemaNode(schema, child);
162 checkArgument(potential.isPresent(),
163 "Supplied QName %s is not valid according to schema %s, potential children nodes: %s", child, schema,
164 schema.getChildNodes());
166 final DataSchemaNode result = potential.get();
167 // We try to look up if this node was added by augmentation
168 if (schema instanceof DataSchemaNode && result.isAugmenting()) {
169 return fromAugmentation(schema, (AugmentationTarget) schema, result);
171 return fromDataSchemaNode(result);
174 private static ChoiceSchemaNode findChoice(final Iterable<ChoiceSchemaNode> choices, final QName child) {
175 for (final ChoiceSchemaNode choice : choices) {
176 for (final CaseSchemaNode caze : choice.getCases().values()) {
177 if (findChildSchemaNode(caze, child).isPresent()) {
186 * Returns a SchemaPathUtil for provided child node
188 * If supplied child is added by Augmentation this operation returns
189 * a SchemaPathUtil for augmentation,
190 * otherwise returns a SchemaPathUtil for child as
191 * call for {@link #fromDataSchemaNode(org.opendaylight.yangtools.yang.model.api.DataSchemaNode)}.
193 private static InstanceIdToNodes<?> fromAugmentation(final DataNodeContainer parent,
194 final AugmentationTarget parentAug, final DataSchemaNode child) {
195 for (final AugmentationSchemaNode aug : parentAug.getAvailableAugmentations()) {
196 final Optional<DataSchemaNode> potential = aug.findDataChildByName(child.getQName());
197 if (potential.isPresent()) {
198 return new InstanceIdToCompositeNodes.AugmentationNormalization(aug, parent);
201 return fromDataSchemaNode(child);
204 static InstanceIdToNodes<?> fromDataSchemaNode(final DataSchemaNode potential) {
205 if (potential instanceof ContainerSchemaNode) {
206 return new InstanceIdToCompositeNodes.ContainerTransformation((ContainerSchemaNode) potential);
207 } else if (potential instanceof ListSchemaNode) {
208 return fromListSchemaNode((ListSchemaNode) potential);
209 } else if (potential instanceof LeafSchemaNode) {
210 return new InstanceIdToSimpleNodes.LeafNormalization((LeafSchemaNode) potential);
211 } else if (potential instanceof ChoiceSchemaNode) {
212 return new InstanceIdToCompositeNodes.ChoiceNodeNormalization((ChoiceSchemaNode) potential);
213 } else if (potential instanceof LeafListSchemaNode) {
214 return fromLeafListSchemaNode((LeafListSchemaNode) potential);
215 } else if (potential instanceof AnydataSchemaNode) {
216 return new AnydataNormalization((AnydataSchemaNode) potential);
217 } else if (potential instanceof AnyxmlSchemaNode) {
218 return new AnyXmlNormalization((AnyxmlSchemaNode) potential);
223 private static InstanceIdToNodes<?> fromListSchemaNode(final ListSchemaNode potential) {
224 final List<QName> keyDefinition = potential.getKeyDefinition();
225 if (keyDefinition == null || keyDefinition.isEmpty()) {
226 return new UnkeyedListMixinNormalization(potential);
228 return potential.isUserOrdered() ? new InstanceIdToCompositeNodes.OrderedMapMixinNormalization(potential)
229 : new InstanceIdToCompositeNodes.UnorderedMapMixinNormalization(potential);
232 private static InstanceIdToNodes<?> fromLeafListSchemaNode(final LeafListSchemaNode potential) {
233 return potential.isUserOrdered() ? new InstanceIdToCompositeNodes.OrderedLeafListMixinNormalization(potential)
234 : new InstanceIdToCompositeNodes.UnorderedLeafListMixinNormalization(potential);