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);
206 private static DataNormalizationOperation<?> fromSchemaAndQNameChecked(final DataNodeContainer schema,
207 final QName child) throws DataNormalizationException {
209 final Optional<DataSchemaNode> potential = findChildSchemaNode(schema, child);
210 if (!potential.isPresent()) {
211 throw new DataNormalizationException(String.format(
212 "Supplied QName %s is not valid according to schema %s, potential children nodes: %s", child,
213 schema,schema.getChildNodes()));
216 final DataSchemaNode result = potential.get();
217 // We try to look up if this node was added by augmentation
218 if (schema instanceof DataSchemaNode && result.isAugmenting()) {
219 return fromAugmentation(schema, (AugmentationTarget) schema, result);
221 return fromDataSchemaNode(result);
225 private static final class ListItemNormalization extends
226 DataContainerNormalizationOperation<NodeIdentifierWithPredicates> {
227 ListItemNormalization(final NodeIdentifierWithPredicates identifier, final ListSchemaNode schema) {
228 super(identifier, schema, schema);
232 @SuppressFBWarnings("BC_UNCONFIRMED_CAST")
233 public NormalizedNode<?, ?> createDefault(final PathArgument currentArg) {
234 final DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> builder = Builders
235 .mapEntryBuilder().withNodeIdentifier((NodeIdentifierWithPredicates) currentArg);
236 for (final Entry<QName, Object> keyValue : ((NodeIdentifierWithPredicates) currentArg).entrySet()) {
237 builder.addChild(Builders.leafBuilder()
239 .withNodeIdentifier(new NodeIdentifier(keyValue.getKey())).withValue(keyValue.getValue())
242 return builder.build();
246 public boolean isKeyedEntry() {
251 private static final class UnkeyedListItemNormalization
252 extends DataContainerNormalizationOperation<NodeIdentifier> {
253 UnkeyedListItemNormalization(final ListSchemaNode schema) {
254 super(new NodeIdentifier(schema.getQName()), schema,schema);
258 @SuppressFBWarnings("BC_UNCONFIRMED_CAST")
259 public NormalizedNode<?, ?> createDefault(final PathArgument currentArg) {
260 return Builders.unkeyedListEntryBuilder().withNodeIdentifier((NodeIdentifier) currentArg).build();
264 private static final class ContainerNormalization extends DataContainerNormalizationOperation<NodeIdentifier> {
265 ContainerNormalization(final ContainerSchemaNode schema) {
266 super(new NodeIdentifier(schema.getQName()),schema, schema);
270 @SuppressFBWarnings("BC_UNCONFIRMED_CAST")
271 public NormalizedNode<?, ?> createDefault(final PathArgument currentArg) {
272 return Builders.containerBuilder().withNodeIdentifier((NodeIdentifier) currentArg).build();
276 private abstract static class MixinNormalizationOp<T extends PathArgument>
277 extends CompositeNodeNormalizationOperation<T> {
279 MixinNormalizationOp(final T identifier, final DataSchemaNode schema) {
280 super(identifier,schema);
284 public final boolean isMixin() {
289 private static final class OrderedLeafListMixinNormalization extends UnorderedLeafListMixinNormalization {
290 OrderedLeafListMixinNormalization(final LeafListSchemaNode potential) {
295 public NormalizedNode<?, ?> createDefault(final PathArgument currentArg) {
296 return Builders.orderedLeafSetBuilder().withNodeIdentifier(getIdentifier()).build();
300 private static class UnorderedLeafListMixinNormalization extends MixinNormalizationOp<NodeIdentifier> {
302 private final DataNormalizationOperation<?> innerOp;
304 UnorderedLeafListMixinNormalization(final LeafListSchemaNode potential) {
305 super(new NodeIdentifier(potential.getQName()),potential);
306 innerOp = new LeafListEntryNormalization(potential);
310 public NormalizedNode<?, ?> createDefault(final PathArgument currentArg) {
311 return Builders.leafSetBuilder().withNodeIdentifier(getIdentifier()).build();
315 public DataNormalizationOperation<?> getChild(final PathArgument child) {
316 if (child instanceof NodeWithValue) {
323 public DataNormalizationOperation<?> getChild(final QName child) {
324 if (getIdentifier().getNodeType().equals(child)) {
331 private static final class AugmentationNormalization
332 extends DataContainerNormalizationOperation<AugmentationIdentifier> {
334 AugmentationNormalization(final AugmentationSchemaNode augmentation, final DataNodeContainer schema) {
335 super(augmentationIdentifierFrom(augmentation), augmentationProxy(augmentation,schema),null);
338 private static DataNodeContainer augmentationProxy(final AugmentationSchemaNode augmentation,
339 final DataNodeContainer schema) {
340 final Set<DataSchemaNode> children = new HashSet<>();
341 for (final DataSchemaNode augNode : augmentation.getChildNodes()) {
342 children.add(schema.getDataChildByName(augNode.getQName()));
344 return new EffectiveAugmentationSchema(augmentation, children);
348 public boolean isMixin() {
353 protected DataNormalizationOperation<?> fromLocalSchemaAndQName(final DataNodeContainer schema,
355 final Optional<DataSchemaNode> potential = findChildSchemaNode(schema, child);
356 if (!potential.isPresent()) {
360 final DataSchemaNode result = potential.get();
361 // We try to look up if this node was added by augmentation
362 if (schema instanceof DataSchemaNode && result.isAugmenting()) {
363 return fromAugmentation(schema, (AugmentationTarget) schema, result);
365 return fromDataSchemaNode(result);
369 protected Set<QName> getQNameIdentifiers() {
370 return getIdentifier().getPossibleChildNames();
374 public NormalizedNode<?, ?> createDefault(final PathArgument currentArg) {
375 return Builders.augmentationBuilder().withNodeIdentifier(getIdentifier()).build();
379 private static class UnorderedMapMixinNormalization extends MixinNormalizationOp<NodeIdentifier> {
380 private final ListItemNormalization innerNode;
382 UnorderedMapMixinNormalization(final ListSchemaNode list) {
383 super(new NodeIdentifier(list.getQName()),list);
384 this.innerNode = new ListItemNormalization(NodeIdentifierWithPredicates.of(list.getQName(),
385 Collections.<QName, Object>emptyMap()), list);
389 public NormalizedNode<?, ?> createDefault(final PathArgument currentArg) {
390 return Builders.mapBuilder().withNodeIdentifier(getIdentifier()).build();
394 public DataNormalizationOperation<?> getChild(final PathArgument child) {
395 if (child.getNodeType().equals(getIdentifier().getNodeType())) {
402 public DataNormalizationOperation<?> getChild(final QName child) {
403 if (getIdentifier().getNodeType().equals(child)) {
410 private static class UnkeyedListMixinNormalization extends MixinNormalizationOp<NodeIdentifier> {
411 private final UnkeyedListItemNormalization innerNode;
413 UnkeyedListMixinNormalization(final ListSchemaNode list) {
414 super(new NodeIdentifier(list.getQName()),list);
415 this.innerNode = new UnkeyedListItemNormalization(list);
419 public NormalizedNode<?, ?> createDefault(final PathArgument currentArg) {
420 return Builders.unkeyedListBuilder().withNodeIdentifier(getIdentifier()).build();
424 public DataNormalizationOperation<?> getChild(final PathArgument child) {
425 if (child.getNodeType().equals(getIdentifier().getNodeType())) {
432 public DataNormalizationOperation<?> getChild(final QName child) {
433 if (getIdentifier().getNodeType().equals(child)) {
440 private static final class OrderedMapMixinNormalization extends UnorderedMapMixinNormalization {
441 OrderedMapMixinNormalization(final ListSchemaNode list) {
446 public NormalizedNode<?, ?> createDefault(final PathArgument currentArg) {
447 return Builders.orderedMapBuilder().withNodeIdentifier(getIdentifier()).build();
451 private static class ChoiceNodeNormalization extends MixinNormalizationOp<NodeIdentifier> {
452 private final ImmutableMap<QName, DataNormalizationOperation<?>> byQName;
453 private final ImmutableMap<PathArgument, DataNormalizationOperation<?>> byArg;
455 ChoiceNodeNormalization(final ChoiceSchemaNode schema) {
456 super(new NodeIdentifier(schema.getQName()),schema);
457 final ImmutableMap.Builder<QName, DataNormalizationOperation<?>> byQNameBuilder = ImmutableMap.builder();
458 final ImmutableMap.Builder<PathArgument, DataNormalizationOperation<?>> byArgBuilder =
459 ImmutableMap.builder();
461 for (final CaseSchemaNode caze : schema.getCases().values()) {
462 for (final DataSchemaNode cazeChild : caze.getChildNodes()) {
463 final DataNormalizationOperation<?> childOp = fromDataSchemaNode(cazeChild);
464 byArgBuilder.put(childOp.getIdentifier(), childOp);
465 for (final QName qname : childOp.getQNameIdentifiers()) {
466 byQNameBuilder.put(qname, childOp);
470 byQName = byQNameBuilder.build();
471 byArg = byArgBuilder.build();
475 public DataNormalizationOperation<?> getChild(final PathArgument child) {
476 return byArg.get(child);
480 public DataNormalizationOperation<?> getChild(final QName child) {
481 return byQName.get(child);
485 public NormalizedNode<?, ?> createDefault(final PathArgument currentArg) {
486 return Builders.choiceBuilder().withNodeIdentifier(getIdentifier()).build();
490 private static class AnyXmlNormalization extends DataNormalizationOperation<NodeIdentifier> {
491 AnyXmlNormalization(final AnyXmlSchemaNode schema) {
492 super(new NodeIdentifier(schema.getQName()), schema);
496 public DataNormalizationOperation<?> getChild(final PathArgument child) {
501 public DataNormalizationOperation<?> getChild(final QName child) {
506 public boolean isLeaf() {
511 public NormalizedNode<?, ?> createDefault(final PathArgument currentArg) {
516 private static Optional<DataSchemaNode> findChildSchemaNode(final DataNodeContainer parent,
518 DataSchemaNode potential = parent.getDataChildByName(child);
519 if (potential == null) {
520 final Iterable<ChoiceSchemaNode> choices = FluentIterable.from(parent.getChildNodes())
521 .filter(ChoiceSchemaNode.class);
522 potential = findChoice(choices, child);
524 return Optional.fromNullable(potential);
527 private static ChoiceSchemaNode findChoice(final Iterable<ChoiceSchemaNode> choices, final QName child) {
528 ChoiceSchemaNode foundChoice = null;
529 choiceLoop: for (final ChoiceSchemaNode choice : choices) {
530 for (final CaseSchemaNode caze : choice.getCases().values()) {
531 if (findChildSchemaNode(caze, child).isPresent()) {
532 foundChoice = choice;
540 public static AugmentationIdentifier augmentationIdentifierFrom(final AugmentationSchemaNode augmentation) {
541 final ImmutableSet.Builder<QName> potentialChildren = ImmutableSet.builder();
542 for (final DataSchemaNode child : augmentation.getChildNodes()) {
543 potentialChildren.add(child.getQName());
545 return new AugmentationIdentifier(potentialChildren.build());
549 * Returns a DataNormalizationOperation for provided child node.
552 * If supplied child is added by Augmentation this operation returns
553 * a DataNormalizationOperation for augmentation,
554 * otherwise returns a DataNormalizationOperation for child as
555 * call for {@link #fromDataSchemaNode(DataSchemaNode)}.
557 private static DataNormalizationOperation<?> fromAugmentation(final DataNodeContainer parent,
558 final AugmentationTarget parentAug, final DataSchemaNode child) {
559 AugmentationSchemaNode augmentation = null;
560 for (final AugmentationSchemaNode aug : parentAug.getAvailableAugmentations()) {
561 final DataSchemaNode potential = aug.getDataChildByName(child.getQName());
562 if (potential != null) {
568 if (augmentation != null) {
569 return new AugmentationNormalization(augmentation, parent);
571 return fromDataSchemaNode(child);
575 public static DataNormalizationOperation<?> fromDataSchemaNode(final DataSchemaNode potential) {
576 if (potential instanceof ContainerSchemaNode) {
577 return new ContainerNormalization((ContainerSchemaNode) potential);
578 } else if (potential instanceof ListSchemaNode) {
580 return fromListSchemaNode((ListSchemaNode) potential);
581 } else if (potential instanceof LeafSchemaNode) {
582 return new LeafNormalization((LeafSchemaNode) potential);
583 } else if (potential instanceof ChoiceSchemaNode) {
584 return new ChoiceNodeNormalization((ChoiceSchemaNode) potential);
585 } else if (potential instanceof LeafListSchemaNode) {
586 return fromLeafListSchemaNode((LeafListSchemaNode) potential);
587 } else if (potential instanceof AnyXmlSchemaNode) {
588 return new AnyXmlNormalization((AnyXmlSchemaNode) potential);
593 private static DataNormalizationOperation<?> fromListSchemaNode(final ListSchemaNode potential) {
594 final List<QName> keyDefinition = potential.getKeyDefinition();
595 if (keyDefinition == null || keyDefinition.isEmpty()) {
596 return new UnkeyedListMixinNormalization(potential);
598 if (potential.isUserOrdered()) {
599 return new OrderedMapMixinNormalization(potential);
601 return new UnorderedMapMixinNormalization(potential);
604 private static DataNormalizationOperation<?> fromLeafListSchemaNode(final LeafListSchemaNode potential) {
605 if (potential.isUserOrdered()) {
606 return new OrderedLeafListMixinNormalization(potential);
608 return new UnorderedLeafListMixinNormalization(potential);
612 public static DataNormalizationOperation<?> from(final SchemaContext ctx) {
613 return new ContainerNormalization(ctx);
616 public abstract NormalizedNode<?, ?> createDefault(PathArgument currentArg);