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 java.util.Collections;
15 import java.util.HashSet;
16 import java.util.List;
18 import java.util.Map.Entry;
20 import java.util.concurrent.ConcurrentHashMap;
21 import org.opendaylight.yangtools.concepts.Identifiable;
22 import org.opendaylight.yangtools.yang.common.QName;
23 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
24 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
25 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
26 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
27 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
28 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
29 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
30 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
31 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeAttrBuilder;
32 import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
33 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
34 import org.opendaylight.yangtools.yang.model.api.AugmentationTarget;
35 import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
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;
43 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
44 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
45 import org.opendaylight.yangtools.yang.model.util.EffectiveAugmentationSchema;
48 public abstract class DataNormalizationOperation<T extends PathArgument> implements Identifiable<T> {
50 private final T identifier;
51 private final Optional<DataSchemaNode> dataSchemaNode;
54 public T getIdentifier() {
58 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(final PathArgument child) throws DataNormalizationException;
83 public abstract DataNormalizationOperation<?> getChild(QName child) throws DataNormalizationException;
86 public abstract boolean isLeaf();
88 public Optional<DataSchemaNode> getDataSchemaNode() {
90 return dataSchemaNode;
93 private static abstract class SimpleTypeNormalization<T extends PathArgument> extends DataNormalizationOperation<T> {
95 protected SimpleTypeNormalization(final T identifier, final DataSchemaNode potential) {
96 super(identifier,potential);
100 public DataNormalizationOperation<?> getChild(final PathArgument child) {
105 public DataNormalizationOperation<?> getChild(final QName child) {
110 public NormalizedNode<?, ?> createDefault(final PathArgument currentArg) {
115 public boolean isLeaf() {
121 private static final class LeafNormalization extends SimpleTypeNormalization<NodeIdentifier> {
123 protected LeafNormalization(final LeafSchemaNode potential) {
124 super(new NodeIdentifier(potential.getQName()),potential);
129 private static final class LeafListEntryNormalization extends SimpleTypeNormalization<NodeWithValue> {
131 public LeafListEntryNormalization(final LeafListSchemaNode potential) {
132 super(new NodeWithValue(potential.getQName(), null),potential);
136 public boolean isKeyedEntry() {
141 private static abstract class CompositeNodeNormalizationOperation<T extends PathArgument> extends
142 DataNormalizationOperation<T> {
144 protected CompositeNodeNormalizationOperation(final T identifier, final DataSchemaNode schema) {
145 super(identifier,schema);
149 public boolean isLeaf() {
156 private static abstract class DataContainerNormalizationOperation<T extends PathArgument> extends
157 CompositeNodeNormalizationOperation<T> {
159 private final DataNodeContainer schema;
160 private final Map<QName, DataNormalizationOperation<?>> byQName;
161 private final Map<PathArgument, DataNormalizationOperation<?>> byArg;
163 protected DataContainerNormalizationOperation(final T identifier, final DataNodeContainer schema, final DataSchemaNode node) {
164 super(identifier,node);
165 this.schema = schema;
166 this.byArg = new ConcurrentHashMap<>();
167 this.byQName = new ConcurrentHashMap<>();
171 public DataNormalizationOperation<?> getChild(final PathArgument child) throws DataNormalizationException {
172 DataNormalizationOperation<?> potential = byArg.get(child);
173 if (potential != null) {
176 potential = fromLocalSchema(child);
177 return register(potential);
180 private DataNormalizationOperation<?> fromLocalSchema(final PathArgument child) throws DataNormalizationException {
181 if (child instanceof AugmentationIdentifier) {
182 return fromSchemaAndQNameChecked(schema, ((AugmentationIdentifier) child).getPossibleChildNames()
185 return fromSchemaAndQNameChecked(schema, child.getNodeType());
189 public DataNormalizationOperation<?> getChild(final QName child) throws DataNormalizationException {
190 DataNormalizationOperation<?> potential = byQName.get(child);
191 if (potential != null) {
194 potential = fromLocalSchemaAndQName(schema, child);
195 return register(potential);
198 protected DataNormalizationOperation<?> fromLocalSchemaAndQName(final DataNodeContainer schema2, final QName child) throws DataNormalizationException {
199 return fromSchemaAndQNameChecked(schema2, child);
202 private DataNormalizationOperation<?> register(final DataNormalizationOperation<?> potential) {
203 if (potential != null) {
204 byArg.put(potential.getIdentifier(), potential);
205 for (final QName qName : potential.getQNameIdentifiers()) {
206 byQName.put(qName, potential);
214 private static final class ListItemNormalization extends
215 DataContainerNormalizationOperation<NodeIdentifierWithPredicates> {
217 private final List<QName> keyDefinition;
219 protected ListItemNormalization(final NodeIdentifierWithPredicates identifier, final ListSchemaNode schema) {
220 super(identifier, schema,schema);
221 keyDefinition = schema.getKeyDefinition();
225 public NormalizedNode<?, ?> createDefault(final PathArgument currentArg) {
226 final DataContainerNodeAttrBuilder<NodeIdentifierWithPredicates, MapEntryNode> builder = Builders
227 .mapEntryBuilder().withNodeIdentifier((NodeIdentifierWithPredicates) currentArg);
228 for (final Entry<QName, Object> keyValue : ((NodeIdentifierWithPredicates) currentArg).getKeyValues().entrySet()) {
229 builder.addChild(Builders.leafBuilder()
231 .withNodeIdentifier(new NodeIdentifier(keyValue.getKey())).withValue(keyValue.getValue())
234 return builder.build();
239 public boolean isKeyedEntry() {
244 private static final class UnkeyedListItemNormalization extends DataContainerNormalizationOperation<NodeIdentifier> {
246 protected UnkeyedListItemNormalization(final ListSchemaNode schema) {
247 super(new NodeIdentifier(schema.getQName()), schema,schema);
251 public NormalizedNode<?, ?> createDefault(final PathArgument currentArg) {
252 return Builders.unkeyedListEntryBuilder().withNodeIdentifier((NodeIdentifier) currentArg).build();
257 private static final class ContainerNormalization extends DataContainerNormalizationOperation<NodeIdentifier> {
259 protected ContainerNormalization(final ContainerSchemaNode schema) {
260 super(new NodeIdentifier(schema.getQName()),schema, schema);
264 public NormalizedNode<?, ?> createDefault(final PathArgument currentArg) {
265 return Builders.containerBuilder().withNodeIdentifier((NodeIdentifier) currentArg).build();
270 private static abstract class MixinNormalizationOp<T extends PathArgument> extends
271 CompositeNodeNormalizationOperation<T> {
273 protected MixinNormalizationOp(final T identifier, final DataSchemaNode schema) {
274 super(identifier,schema);
278 public final boolean isMixin() {
285 private static final class OrderedLeafListMixinNormalization extends UnorderedLeafListMixinNormalization {
288 public OrderedLeafListMixinNormalization(final LeafListSchemaNode potential) {
293 public NormalizedNode<?, ?> createDefault(final PathArgument currentArg) {
294 return Builders.orderedLeafSetBuilder().withNodeIdentifier(getIdentifier()).build();
298 private static class UnorderedLeafListMixinNormalization extends MixinNormalizationOp<NodeIdentifier> {
300 private final DataNormalizationOperation<?> innerOp;
302 public UnorderedLeafListMixinNormalization(final LeafListSchemaNode potential) {
303 super(new NodeIdentifier(potential.getQName()),potential);
304 innerOp = new LeafListEntryNormalization(potential);
307 public NormalizedNode<?, ?> createDefault(final PathArgument currentArg) {
308 return Builders.leafSetBuilder().withNodeIdentifier(getIdentifier()).build();
312 public DataNormalizationOperation<?> getChild(final PathArgument child) {
313 if (child instanceof NodeWithValue) {
320 public DataNormalizationOperation<?> getChild(final QName child) {
321 if (getIdentifier().getNodeType().equals(child)) {
328 private static final class AugmentationNormalization extends DataContainerNormalizationOperation<AugmentationIdentifier> {
330 public AugmentationNormalization(final AugmentationSchema augmentation, final DataNodeContainer schema) {
332 super(augmentationIdentifierFrom(augmentation), augmentationProxy(augmentation,schema),null);
336 public boolean isMixin() {
343 protected DataNormalizationOperation<?> fromLocalSchemaAndQName(final DataNodeContainer schema, final QName child)
344 throws DataNormalizationException {
345 final Optional<DataSchemaNode> potential = findChildSchemaNode(schema, child);
346 if (!potential.isPresent()) {
350 final DataSchemaNode result = potential.get();
351 // We try to look up if this node was added by augmentation
352 if ((schema instanceof DataSchemaNode) && result.isAugmenting()) {
353 return fromAugmentation(schema, (AugmentationTarget) schema, result);
355 return fromDataSchemaNode(result);
359 protected Set<QName> getQNameIdentifiers() {
360 return getIdentifier().getPossibleChildNames();
364 public NormalizedNode<?, ?> createDefault(final PathArgument currentArg) {
365 return Builders.augmentationBuilder().withNodeIdentifier(getIdentifier()).build();
370 private static class UnorderedMapMixinNormalization extends MixinNormalizationOp<NodeIdentifier> {
372 private final ListItemNormalization innerNode;
374 public UnorderedMapMixinNormalization(final ListSchemaNode list) {
375 super(new NodeIdentifier(list.getQName()),list);
376 this.innerNode = new ListItemNormalization(new NodeIdentifierWithPredicates(list.getQName(),
377 Collections.<QName, Object> emptyMap()), list);
381 public NormalizedNode<?, ?> createDefault(final PathArgument currentArg) {
382 return Builders.mapBuilder().withNodeIdentifier(getIdentifier()).build();
386 public DataNormalizationOperation<?> getChild(final PathArgument child) {
387 if (child.getNodeType().equals(getIdentifier().getNodeType())) {
394 public DataNormalizationOperation<?> getChild(final QName child) {
395 if (getIdentifier().getNodeType().equals(child)) {
404 private static class UnkeyedListMixinNormalization extends MixinNormalizationOp<NodeIdentifier> {
406 private final UnkeyedListItemNormalization innerNode;
408 public UnkeyedListMixinNormalization(final ListSchemaNode list) {
409 super(new NodeIdentifier(list.getQName()),list);
410 this.innerNode = new UnkeyedListItemNormalization(list);
414 public NormalizedNode<?, ?> createDefault(final PathArgument currentArg) {
415 return Builders.unkeyedListBuilder().withNodeIdentifier(getIdentifier()).build();
419 public DataNormalizationOperation<?> getChild(final PathArgument child) {
420 if (child.getNodeType().equals(getIdentifier().getNodeType())) {
427 public DataNormalizationOperation<?> getChild(final QName child) {
428 if (getIdentifier().getNodeType().equals(child)) {
436 private static final class OrderedMapMixinNormalization extends UnorderedMapMixinNormalization {
438 public OrderedMapMixinNormalization(final ListSchemaNode list) {
443 public NormalizedNode<?, ?> createDefault(final PathArgument currentArg) {
444 return Builders.orderedMapBuilder().withNodeIdentifier(getIdentifier()).build();
449 private static class ChoiceNodeNormalization extends MixinNormalizationOp<NodeIdentifier> {
451 private final ImmutableMap<QName, DataNormalizationOperation<?>> byQName;
452 private final ImmutableMap<PathArgument, DataNormalizationOperation<?>> byArg;
454 protected ChoiceNodeNormalization(final ChoiceSchemaNode schema) {
455 super(new NodeIdentifier(schema.getQName()),schema);
456 final ImmutableMap.Builder<QName, DataNormalizationOperation<?>> byQNameBuilder = ImmutableMap.builder();
457 final ImmutableMap.Builder<PathArgument, DataNormalizationOperation<?>> byArgBuilder = ImmutableMap.builder();
459 for (final ChoiceCaseNode caze : schema.getCases()) {
460 for (final DataSchemaNode cazeChild : caze.getChildNodes()) {
461 final DataNormalizationOperation<?> childOp = fromDataSchemaNode(cazeChild);
462 byArgBuilder.put(childOp.getIdentifier(), childOp);
463 for (final QName qname : childOp.getQNameIdentifiers()) {
464 byQNameBuilder.put(qname, childOp);
468 byQName = byQNameBuilder.build();
469 byArg = byArgBuilder.build();
473 public DataNormalizationOperation<?> getChild(final PathArgument child) {
474 return byArg.get(child);
478 public DataNormalizationOperation<?> getChild(final QName child) {
479 return byQName.get(child);
483 public NormalizedNode<?, ?> createDefault(final PathArgument currentArg) {
484 return Builders.choiceBuilder().withNodeIdentifier(getIdentifier()).build();
488 private static class AnyXmlNormalization extends DataNormalizationOperation<NodeIdentifier> {
490 protected AnyXmlNormalization( final AnyXmlSchemaNode schema) {
491 super( new NodeIdentifier(schema.getQName()), schema);
495 public DataNormalizationOperation<?> getChild( final PathArgument child ) throws DataNormalizationException {
500 public DataNormalizationOperation<?> getChild( final QName child ) throws DataNormalizationException {
505 public boolean isLeaf() {
510 public NormalizedNode<?, ?> createDefault( final PathArgument currentArg ) {
515 private static final Optional<DataSchemaNode> findChildSchemaNode(final DataNodeContainer parent,final QName child) {
516 DataSchemaNode potential = parent.getDataChildByName(child);
517 if (potential == null) {
518 final Iterable<ChoiceSchemaNode> choices = FluentIterable.from(parent.getChildNodes()).filter(ChoiceSchemaNode.class);
519 potential = findChoice(choices, child);
521 return Optional.fromNullable(potential);
524 private static DataNormalizationOperation<?> fromSchemaAndQNameChecked(final DataNodeContainer schema,
525 final QName child) throws DataNormalizationException {
527 final Optional<DataSchemaNode> potential = findChildSchemaNode(schema, child);
528 if (!potential.isPresent()) {
529 throw new DataNormalizationException(String.format("Supplied QName %s is not valid according to schema %s, potential children nodes: %s", child, schema,schema.getChildNodes()));
532 final DataSchemaNode result = potential.get();
533 // We try to look up if this node was added by augmentation
534 if ((schema instanceof DataSchemaNode) && result.isAugmenting()) {
535 return fromAugmentation(schema, (AugmentationTarget) schema, result);
537 return fromDataSchemaNode(result);
540 private static ChoiceSchemaNode findChoice(final Iterable<ChoiceSchemaNode> choices, final QName child) {
541 ChoiceSchemaNode foundChoice = null;
542 choiceLoop: for (final ChoiceSchemaNode choice : choices) {
543 for (final ChoiceCaseNode caze : choice.getCases()) {
544 if (findChildSchemaNode(caze, child).isPresent()) {
545 foundChoice = choice;
553 public static AugmentationIdentifier augmentationIdentifierFrom(final AugmentationSchema augmentation) {
554 final ImmutableSet.Builder<QName> potentialChildren = ImmutableSet.builder();
555 for (final DataSchemaNode child : augmentation.getChildNodes()) {
556 potentialChildren.add(child.getQName());
558 return new AugmentationIdentifier(potentialChildren.build());
561 private static DataNodeContainer augmentationProxy(final AugmentationSchema augmentation, final DataNodeContainer schema) {
562 final Set<DataSchemaNode> children = new HashSet<>();
563 for (final DataSchemaNode augNode : augmentation.getChildNodes()) {
564 children.add(schema.getDataChildByName(augNode.getQName()));
566 return new EffectiveAugmentationSchema(augmentation, children);
570 * Returns a DataNormalizationOperation for provided child node
572 * If supplied child is added by Augmentation this operation returns
573 * a DataNormalizationOperation for augmentation,
574 * otherwise returns a DataNormalizationOperation for child as
575 * call for {@link #fromDataSchemaNode(DataSchemaNode)}.
583 private static DataNormalizationOperation<?> fromAugmentation(final DataNodeContainer parent,
584 final AugmentationTarget parentAug, final DataSchemaNode child) {
585 AugmentationSchema augmentation = null;
586 for (final AugmentationSchema aug : parentAug.getAvailableAugmentations()) {
587 final DataSchemaNode potential = aug.getDataChildByName(child.getQName());
588 if (potential != null) {
594 if (augmentation != null) {
595 return new AugmentationNormalization(augmentation, parent);
597 return fromDataSchemaNode(child);
601 public static DataNormalizationOperation<?> fromDataSchemaNode(final DataSchemaNode potential) {
602 if (potential instanceof ContainerSchemaNode) {
603 return new ContainerNormalization((ContainerSchemaNode) potential);
604 } else if (potential instanceof ListSchemaNode) {
606 return fromListSchemaNode((ListSchemaNode) potential);
607 } else if (potential instanceof LeafSchemaNode) {
608 return new LeafNormalization((LeafSchemaNode) potential);
609 } else if (potential instanceof ChoiceSchemaNode) {
610 return new ChoiceNodeNormalization((ChoiceSchemaNode) potential);
611 } else if (potential instanceof LeafListSchemaNode) {
612 return fromLeafListSchemaNode((LeafListSchemaNode) potential);
613 } else if (potential instanceof AnyXmlSchemaNode) {
614 return new AnyXmlNormalization( (AnyXmlSchemaNode) potential);
619 private static DataNormalizationOperation<?> fromListSchemaNode(final ListSchemaNode potential) {
620 final List<QName> keyDefinition = potential.getKeyDefinition();
621 if(keyDefinition == null || keyDefinition.isEmpty()) {
622 return new UnkeyedListMixinNormalization(potential);
624 if(potential.isUserOrdered()) {
625 return new OrderedMapMixinNormalization(potential);
627 return new UnorderedMapMixinNormalization(potential);
630 private static DataNormalizationOperation<?> fromLeafListSchemaNode(final LeafListSchemaNode potential) {
631 if(potential.isUserOrdered()) {
632 return new OrderedLeafListMixinNormalization(potential);
634 return new UnorderedLeafListMixinNormalization(potential);
638 public static DataNormalizationOperation<?> from(final SchemaContext ctx) {
639 return new ContainerNormalization(ctx);
642 public abstract NormalizedNode<?, ?> createDefault(PathArgument currentArg);