2 * Copyright (c) 2014 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.controller.md.sal.common.impl.util.compat;
10 import com.google.common.base.Optional;
11 import com.google.common.collect.FluentIterable;
12 import com.google.common.collect.ImmutableMap;
13 import com.google.common.collect.ImmutableSet;
14 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
15 import java.util.Collections;
16 import java.util.HashSet;
17 import java.util.List;
19 import java.util.Map.Entry;
21 import java.util.concurrent.ConcurrentHashMap;
22 import org.opendaylight.yangtools.concepts.Identifiable;
23 import org.opendaylight.yangtools.yang.common.QName;
24 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
25 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
26 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
27 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
28 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
29 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
30 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
31 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
32 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
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 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
45 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
46 import org.opendaylight.yangtools.yang.model.util.EffectiveAugmentationSchema;
49 public abstract class DataNormalizationOperation<T extends PathArgument> implements Identifiable<T> {
51 private final T identifier;
52 private final Optional<DataSchemaNode> dataSchemaNode;
55 public T getIdentifier() {
59 protected DataNormalizationOperation(final T identifier, final SchemaNode schema) {
60 this.identifier = identifier;
61 if (schema instanceof DataSchemaNode) {
62 this.dataSchemaNode = Optional.of((DataSchemaNode) schema);
64 this.dataSchemaNode = Optional.absent();
68 public boolean isMixin() {
73 public boolean isKeyedEntry() {
77 protected Set<QName> getQNameIdentifiers() {
78 return Collections.singleton(identifier.getNodeType());
81 public abstract DataNormalizationOperation<?> getChild(PathArgument child) throws DataNormalizationException;
83 public abstract DataNormalizationOperation<?> getChild(QName child) throws DataNormalizationException;
85 public abstract boolean isLeaf();
87 public Optional<DataSchemaNode> getDataSchemaNode() {
89 return dataSchemaNode;
92 private abstract static class SimpleTypeNormalization<T extends PathArgument>
93 extends DataNormalizationOperation<T> {
94 SimpleTypeNormalization(final T identifier, final DataSchemaNode potential) {
95 super(identifier,potential);
99 public DataNormalizationOperation<?> getChild(final PathArgument child) {
104 public DataNormalizationOperation<?> getChild(final QName child) {
109 public NormalizedNode<?, ?> createDefault(final PathArgument currentArg) {
114 public boolean isLeaf() {
119 private static final class LeafNormalization extends SimpleTypeNormalization<NodeIdentifier> {
120 LeafNormalization(final LeafSchemaNode potential) {
121 super(new NodeIdentifier(potential.getQName()),potential);
125 private static final class LeafListEntryNormalization extends SimpleTypeNormalization<NodeWithValue> {
126 LeafListEntryNormalization(final LeafListSchemaNode potential) {
127 super(new NodeWithValue(potential.getQName(), null),potential);
131 public boolean isKeyedEntry() {
136 private abstract static class CompositeNodeNormalizationOperation<T extends PathArgument>
137 extends DataNormalizationOperation<T> {
138 CompositeNodeNormalizationOperation(final T identifier, final DataSchemaNode schema) {
139 super(identifier,schema);
143 public boolean isLeaf() {
148 private abstract static class DataContainerNormalizationOperation<T extends PathArgument>
149 extends CompositeNodeNormalizationOperation<T> {
150 private final DataNodeContainer schema;
151 private final Map<QName, DataNormalizationOperation<?>> byQName;
152 private final Map<PathArgument, DataNormalizationOperation<?>> byArg;
154 DataContainerNormalizationOperation(final T identifier, final DataNodeContainer schema,
155 final DataSchemaNode node) {
156 super(identifier,node);
157 this.schema = schema;
158 this.byArg = new ConcurrentHashMap<>();
159 this.byQName = new ConcurrentHashMap<>();
163 public DataNormalizationOperation<?> getChild(final PathArgument child) throws DataNormalizationException {
164 DataNormalizationOperation<?> potential = byArg.get(child);
165 if (potential != null) {
168 potential = fromLocalSchema(child);
169 return register(potential);
173 public DataNormalizationOperation<?> getChild(final QName child) throws DataNormalizationException {
174 DataNormalizationOperation<?> potential = byQName.get(child);
175 if (potential != null) {
178 potential = fromLocalSchemaAndQName(schema, child);
179 return register(potential);
182 private DataNormalizationOperation<?> fromLocalSchema(final PathArgument child)
183 throws DataNormalizationException {
184 if (child instanceof AugmentationIdentifier) {
185 return fromSchemaAndQNameChecked(schema, ((AugmentationIdentifier) child).getPossibleChildNames()
188 return fromSchemaAndQNameChecked(schema, child.getNodeType());
191 protected DataNormalizationOperation<?> fromLocalSchemaAndQName(final DataNodeContainer schema2,
192 final QName child) throws DataNormalizationException {
193 return fromSchemaAndQNameChecked(schema2, child);
196 private DataNormalizationOperation<?> register(final DataNormalizationOperation<?> potential) {
197 if (potential != null) {
198 byArg.put(potential.getIdentifier(), potential);
199 for (final QName qname : potential.getQNameIdentifiers()) {
200 byQName.put(qname, potential);
207 private static final class ListItemNormalization extends
208 DataContainerNormalizationOperation<NodeIdentifierWithPredicates> {
209 ListItemNormalization(final NodeIdentifierWithPredicates identifier, final ListSchemaNode schema) {
210 super(identifier, schema, schema);
214 @SuppressFBWarnings("BC_UNCONFIRMED_CAST")
215 public NormalizedNode<?, ?> createDefault(final PathArgument currentArg) {
216 final DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> builder = Builders
217 .mapEntryBuilder().withNodeIdentifier((NodeIdentifierWithPredicates) currentArg);
218 for (final Entry<QName, Object> keyValue : ((NodeIdentifierWithPredicates) currentArg).entrySet()) {
219 builder.addChild(Builders.leafBuilder()
221 .withNodeIdentifier(new NodeIdentifier(keyValue.getKey())).withValue(keyValue.getValue())
224 return builder.build();
228 public boolean isKeyedEntry() {
233 private static final class UnkeyedListItemNormalization
234 extends DataContainerNormalizationOperation<NodeIdentifier> {
235 UnkeyedListItemNormalization(final ListSchemaNode schema) {
236 super(new NodeIdentifier(schema.getQName()), schema,schema);
240 @SuppressFBWarnings("BC_UNCONFIRMED_CAST")
241 public NormalizedNode<?, ?> createDefault(final PathArgument currentArg) {
242 return Builders.unkeyedListEntryBuilder().withNodeIdentifier((NodeIdentifier) currentArg).build();
246 private static final class ContainerNormalization extends DataContainerNormalizationOperation<NodeIdentifier> {
247 ContainerNormalization(final ContainerSchemaNode schema) {
248 super(new NodeIdentifier(schema.getQName()),schema, schema);
252 @SuppressFBWarnings("BC_UNCONFIRMED_CAST")
253 public NormalizedNode<?, ?> createDefault(final PathArgument currentArg) {
254 return Builders.containerBuilder().withNodeIdentifier((NodeIdentifier) currentArg).build();
258 private abstract static class MixinNormalizationOp<T extends PathArgument>
259 extends CompositeNodeNormalizationOperation<T> {
261 MixinNormalizationOp(final T identifier, final DataSchemaNode schema) {
262 super(identifier,schema);
266 public final boolean isMixin() {
271 private static final class OrderedLeafListMixinNormalization extends UnorderedLeafListMixinNormalization {
272 OrderedLeafListMixinNormalization(final LeafListSchemaNode potential) {
277 public NormalizedNode<?, ?> createDefault(final PathArgument currentArg) {
278 return Builders.orderedLeafSetBuilder().withNodeIdentifier(getIdentifier()).build();
282 private static class UnorderedLeafListMixinNormalization extends MixinNormalizationOp<NodeIdentifier> {
284 private final DataNormalizationOperation<?> innerOp;
286 UnorderedLeafListMixinNormalization(final LeafListSchemaNode potential) {
287 super(new NodeIdentifier(potential.getQName()),potential);
288 innerOp = new LeafListEntryNormalization(potential);
292 public NormalizedNode<?, ?> createDefault(final PathArgument currentArg) {
293 return Builders.leafSetBuilder().withNodeIdentifier(getIdentifier()).build();
297 public DataNormalizationOperation<?> getChild(final PathArgument child) {
298 if (child instanceof NodeWithValue) {
305 public DataNormalizationOperation<?> getChild(final QName child) {
306 if (getIdentifier().getNodeType().equals(child)) {
313 private static final class AugmentationNormalization
314 extends DataContainerNormalizationOperation<AugmentationIdentifier> {
316 AugmentationNormalization(final AugmentationSchemaNode augmentation, final DataNodeContainer schema) {
317 super(augmentationIdentifierFrom(augmentation), augmentationProxy(augmentation,schema),null);
321 public boolean isMixin() {
326 protected DataNormalizationOperation<?> fromLocalSchemaAndQName(final DataNodeContainer schema,
328 final Optional<DataSchemaNode> potential = findChildSchemaNode(schema, child);
329 if (!potential.isPresent()) {
333 final DataSchemaNode result = potential.get();
334 // We try to look up if this node was added by augmentation
335 if (schema instanceof DataSchemaNode && result.isAugmenting()) {
336 return fromAugmentation(schema, (AugmentationTarget) schema, result);
338 return fromDataSchemaNode(result);
342 protected Set<QName> getQNameIdentifiers() {
343 return getIdentifier().getPossibleChildNames();
347 public NormalizedNode<?, ?> createDefault(final PathArgument currentArg) {
348 return Builders.augmentationBuilder().withNodeIdentifier(getIdentifier()).build();
353 private static class UnorderedMapMixinNormalization extends MixinNormalizationOp<NodeIdentifier> {
354 private final ListItemNormalization innerNode;
356 UnorderedMapMixinNormalization(final ListSchemaNode list) {
357 super(new NodeIdentifier(list.getQName()),list);
358 this.innerNode = new ListItemNormalization(NodeIdentifierWithPredicates.of(list.getQName(),
359 Collections.<QName, Object>emptyMap()), list);
363 public NormalizedNode<?, ?> createDefault(final PathArgument currentArg) {
364 return Builders.mapBuilder().withNodeIdentifier(getIdentifier()).build();
368 public DataNormalizationOperation<?> getChild(final PathArgument child) {
369 if (child.getNodeType().equals(getIdentifier().getNodeType())) {
376 public DataNormalizationOperation<?> getChild(final QName child) {
377 if (getIdentifier().getNodeType().equals(child)) {
384 private static class UnkeyedListMixinNormalization extends MixinNormalizationOp<NodeIdentifier> {
385 private final UnkeyedListItemNormalization innerNode;
387 UnkeyedListMixinNormalization(final ListSchemaNode list) {
388 super(new NodeIdentifier(list.getQName()),list);
389 this.innerNode = new UnkeyedListItemNormalization(list);
393 public NormalizedNode<?, ?> createDefault(final PathArgument currentArg) {
394 return Builders.unkeyedListBuilder().withNodeIdentifier(getIdentifier()).build();
398 public DataNormalizationOperation<?> getChild(final PathArgument child) {
399 if (child.getNodeType().equals(getIdentifier().getNodeType())) {
406 public DataNormalizationOperation<?> getChild(final QName child) {
407 if (getIdentifier().getNodeType().equals(child)) {
414 private static final class OrderedMapMixinNormalization extends UnorderedMapMixinNormalization {
415 OrderedMapMixinNormalization(final ListSchemaNode list) {
420 public NormalizedNode<?, ?> createDefault(final PathArgument currentArg) {
421 return Builders.orderedMapBuilder().withNodeIdentifier(getIdentifier()).build();
425 private static class ChoiceNodeNormalization extends MixinNormalizationOp<NodeIdentifier> {
426 private final ImmutableMap<QName, DataNormalizationOperation<?>> byQName;
427 private final ImmutableMap<PathArgument, DataNormalizationOperation<?>> byArg;
429 ChoiceNodeNormalization(final ChoiceSchemaNode schema) {
430 super(new NodeIdentifier(schema.getQName()),schema);
431 final ImmutableMap.Builder<QName, DataNormalizationOperation<?>> byQNameBuilder = ImmutableMap.builder();
432 final ImmutableMap.Builder<PathArgument, DataNormalizationOperation<?>> byArgBuilder =
433 ImmutableMap.builder();
435 for (final CaseSchemaNode caze : schema.getCases().values()) {
436 for (final DataSchemaNode cazeChild : caze.getChildNodes()) {
437 final DataNormalizationOperation<?> childOp = fromDataSchemaNode(cazeChild);
438 byArgBuilder.put(childOp.getIdentifier(), childOp);
439 for (final QName qname : childOp.getQNameIdentifiers()) {
440 byQNameBuilder.put(qname, childOp);
444 byQName = byQNameBuilder.build();
445 byArg = byArgBuilder.build();
449 public DataNormalizationOperation<?> getChild(final PathArgument child) {
450 return byArg.get(child);
454 public DataNormalizationOperation<?> getChild(final QName child) {
455 return byQName.get(child);
459 public NormalizedNode<?, ?> createDefault(final PathArgument currentArg) {
460 return Builders.choiceBuilder().withNodeIdentifier(getIdentifier()).build();
464 private static class AnyXmlNormalization extends DataNormalizationOperation<NodeIdentifier> {
465 AnyXmlNormalization(final AnyXmlSchemaNode schema) {
466 super(new NodeIdentifier(schema.getQName()), schema);
470 public DataNormalizationOperation<?> getChild(final PathArgument child) {
475 public DataNormalizationOperation<?> getChild(final QName child) {
480 public boolean isLeaf() {
485 public NormalizedNode<?, ?> createDefault(final PathArgument currentArg) {
490 private static Optional<DataSchemaNode> findChildSchemaNode(final DataNodeContainer parent,
492 DataSchemaNode potential = parent.getDataChildByName(child);
493 if (potential == null) {
494 final Iterable<ChoiceSchemaNode> choices = FluentIterable.from(parent.getChildNodes())
495 .filter(ChoiceSchemaNode.class);
496 potential = findChoice(choices, child);
498 return Optional.fromNullable(potential);
501 private static DataNormalizationOperation<?> fromSchemaAndQNameChecked(final DataNodeContainer schema,
502 final QName child) throws DataNormalizationException {
504 final Optional<DataSchemaNode> potential = findChildSchemaNode(schema, child);
505 if (!potential.isPresent()) {
506 throw new DataNormalizationException(String.format(
507 "Supplied QName %s is not valid according to schema %s, potential children nodes: %s", child,
508 schema,schema.getChildNodes()));
511 final DataSchemaNode result = potential.get();
512 // We try to look up if this node was added by augmentation
513 if (schema instanceof DataSchemaNode && result.isAugmenting()) {
514 return fromAugmentation(schema, (AugmentationTarget) schema, result);
516 return fromDataSchemaNode(result);
519 private static ChoiceSchemaNode findChoice(final Iterable<ChoiceSchemaNode> choices, final QName child) {
520 ChoiceSchemaNode foundChoice = null;
521 choiceLoop: for (final ChoiceSchemaNode choice : choices) {
522 for (final CaseSchemaNode caze : choice.getCases().values()) {
523 if (findChildSchemaNode(caze, child).isPresent()) {
524 foundChoice = choice;
532 public static AugmentationIdentifier augmentationIdentifierFrom(final AugmentationSchemaNode augmentation) {
533 final ImmutableSet.Builder<QName> potentialChildren = ImmutableSet.builder();
534 for (final DataSchemaNode child : augmentation.getChildNodes()) {
535 potentialChildren.add(child.getQName());
537 return new AugmentationIdentifier(potentialChildren.build());
540 private static DataNodeContainer augmentationProxy(final AugmentationSchemaNode augmentation,
541 final DataNodeContainer schema) {
542 final Set<DataSchemaNode> children = new HashSet<>();
543 for (final DataSchemaNode augNode : augmentation.getChildNodes()) {
544 children.add(schema.getDataChildByName(augNode.getQName()));
546 return new EffectiveAugmentationSchema(augmentation, children);
550 * Returns a DataNormalizationOperation for provided child node.
553 * If supplied child is added by Augmentation this operation returns
554 * a DataNormalizationOperation for augmentation,
555 * otherwise returns a DataNormalizationOperation for child as
556 * call for {@link #fromDataSchemaNode(DataSchemaNode)}.
558 private static DataNormalizationOperation<?> fromAugmentation(final DataNodeContainer parent,
559 final AugmentationTarget parentAug, final DataSchemaNode child) {
560 AugmentationSchemaNode augmentation = null;
561 for (final AugmentationSchemaNode aug : parentAug.getAvailableAugmentations()) {
562 final DataSchemaNode potential = aug.getDataChildByName(child.getQName());
563 if (potential != null) {
569 if (augmentation != null) {
570 return new AugmentationNormalization(augmentation, parent);
572 return fromDataSchemaNode(child);
576 public static DataNormalizationOperation<?> fromDataSchemaNode(final DataSchemaNode potential) {
577 if (potential instanceof ContainerSchemaNode) {
578 return new ContainerNormalization((ContainerSchemaNode) potential);
579 } else if (potential instanceof ListSchemaNode) {
581 return fromListSchemaNode((ListSchemaNode) potential);
582 } else if (potential instanceof LeafSchemaNode) {
583 return new LeafNormalization((LeafSchemaNode) potential);
584 } else if (potential instanceof ChoiceSchemaNode) {
585 return new ChoiceNodeNormalization((ChoiceSchemaNode) potential);
586 } else if (potential instanceof LeafListSchemaNode) {
587 return fromLeafListSchemaNode((LeafListSchemaNode) potential);
588 } else if (potential instanceof AnyXmlSchemaNode) {
589 return new AnyXmlNormalization((AnyXmlSchemaNode) potential);
594 private static DataNormalizationOperation<?> fromListSchemaNode(final ListSchemaNode potential) {
595 final List<QName> keyDefinition = potential.getKeyDefinition();
596 if (keyDefinition == null || keyDefinition.isEmpty()) {
597 return new UnkeyedListMixinNormalization(potential);
599 if (potential.isUserOrdered()) {
600 return new OrderedMapMixinNormalization(potential);
602 return new UnorderedMapMixinNormalization(potential);
605 private static DataNormalizationOperation<?> fromLeafListSchemaNode(final LeafListSchemaNode potential) {
606 if (potential.isUserOrdered()) {
607 return new OrderedLeafListMixinNormalization(potential);
609 return new UnorderedLeafListMixinNormalization(potential);
613 public static DataNormalizationOperation<?> from(final SchemaContext ctx) {
614 return new ContainerNormalization(ctx);
617 public abstract NormalizedNode<?, ?> createDefault(PathArgument currentArg);