Merge "Refactor LegacyTransactionConntextImpl"
[controller.git] / opendaylight / md-sal / sal-common-impl / src / main / java / org / opendaylight / controller / md / sal / common / impl / util / compat / DataNormalizationOperation.java
1 /*
2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
3  *
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
7  */
8 package org.opendaylight.controller.md.sal.common.impl.util.compat;
9
10 import static com.google.common.base.Preconditions.checkArgument;
11 import static com.google.common.base.Preconditions.checkNotNull;
12
13 import java.util.Collections;
14 import java.util.HashSet;
15 import java.util.List;
16 import java.util.Map;
17 import java.util.Map.Entry;
18 import java.util.Set;
19 import java.util.concurrent.ConcurrentHashMap;
20
21 import javax.xml.transform.dom.DOMSource;
22 import org.opendaylight.yangtools.concepts.Identifiable;
23 import org.opendaylight.yangtools.yang.common.QName;
24 import org.opendaylight.yangtools.yang.data.api.CompositeNode;
25 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
26 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
27 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
28 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
29 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
30 import org.opendaylight.yangtools.yang.data.api.Node;
31 import org.opendaylight.yangtools.yang.data.api.SimpleNode;
32 import org.opendaylight.yangtools.yang.data.api.schema.AnyXmlNode;
33 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
34 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
35 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
36 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
37 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeAttrBuilder;
38 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeAttrBuilder;
39 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeContainerBuilder;
40 import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
41 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
42 import org.opendaylight.yangtools.yang.model.api.AugmentationTarget;
43 import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
44 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
45 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
46 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
47 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
48 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
49 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
50 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
51 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
52
53 import com.google.common.base.Optional;
54 import com.google.common.collect.FluentIterable;
55 import com.google.common.collect.ImmutableMap;
56 import com.google.common.collect.ImmutableSet;
57
58 /**
59  * @deprecated This class provides compatibility between {@link CompositeNode} and {@link NormalizedNode}.
60  *             Users of this class should use {@link NormalizedNode}s directly.
61  */
62 @Deprecated
63 public abstract class DataNormalizationOperation<T extends PathArgument> implements Identifiable<T> {
64
65     private final T identifier;
66     private final Optional<DataSchemaNode> dataSchemaNode;
67
68     @Override
69     public T getIdentifier() {
70         return identifier;
71     };
72
73     protected DataNormalizationOperation(final T identifier, final SchemaNode schema) {
74         super();
75         this.identifier = identifier;
76         if(schema instanceof DataSchemaNode) {
77             this.dataSchemaNode = Optional.of((DataSchemaNode) schema);
78         } else {
79             this.dataSchemaNode = Optional.absent();
80         }
81     }
82
83     public boolean isMixin() {
84         return false;
85     }
86
87
88     public boolean isKeyedEntry() {
89         return false;
90     }
91
92     protected Set<QName> getQNameIdentifiers() {
93         return Collections.singleton(identifier.getNodeType());
94     }
95
96     public abstract DataNormalizationOperation<?> getChild(final PathArgument child) throws DataNormalizationException;
97
98     public abstract DataNormalizationOperation<?> getChild(QName child) throws DataNormalizationException;
99
100     public abstract NormalizedNode<?, ?> normalize(Node<?> legacyData);
101
102     public abstract boolean isLeaf();
103
104     public Optional<DataSchemaNode> getDataSchemaNode() {
105         // FIXME
106         return dataSchemaNode;
107     }
108
109     private static abstract class SimpleTypeNormalization<T extends PathArgument> extends DataNormalizationOperation<T> {
110
111         protected SimpleTypeNormalization(final T identifier, final DataSchemaNode potential) {
112             super(identifier,potential);
113         }
114
115         @Override
116         public NormalizedNode<?, ?> normalize(final Node<?> legacyData) {
117             checkArgument(legacyData != null);
118             checkArgument(legacyData instanceof SimpleNode<?>);
119             return normalizeImpl((SimpleNode<?>) legacyData);
120         }
121
122         protected abstract NormalizedNode<?, ?> normalizeImpl(SimpleNode<?> node);
123
124         @Override
125         public DataNormalizationOperation<?> getChild(final PathArgument child) {
126             return null;
127         }
128
129         @Override
130         public DataNormalizationOperation<?> getChild(final QName child) {
131             return null;
132         }
133
134         @Override
135         public NormalizedNode<?, ?> createDefault(final PathArgument currentArg) {
136             return null;
137         }
138
139         @Override
140         public boolean isLeaf() {
141             return true;
142         }
143
144     }
145
146     private static final class LeafNormalization extends SimpleTypeNormalization<NodeIdentifier> {
147
148         protected LeafNormalization(final LeafSchemaNode potential) {
149             super(new NodeIdentifier(potential.getQName()),potential);
150         }
151
152         @Override
153         protected NormalizedNode<?, ?> normalizeImpl(final SimpleNode<?> node) {
154             return ImmutableNodes.leafNode(node.getNodeType(), node.getValue());
155         }
156
157     }
158
159     private static final class LeafListEntryNormalization extends SimpleTypeNormalization<NodeWithValue> {
160
161         public LeafListEntryNormalization(final LeafListSchemaNode potential) {
162             super(new NodeWithValue(potential.getQName(), null),potential);
163         }
164
165         @Override
166         protected NormalizedNode<?, ?> normalizeImpl(final SimpleNode<?> node) {
167             NodeWithValue nodeId = new NodeWithValue(node.getNodeType(), node.getValue());
168             return Builders.leafSetEntryBuilder().withNodeIdentifier(nodeId).withValue(node.getValue()).build();
169         }
170
171
172         @Override
173         public boolean isKeyedEntry() {
174             return true;
175         }
176     }
177
178     private static abstract class CompositeNodeNormalizationOperation<T extends PathArgument> extends
179     DataNormalizationOperation<T> {
180
181         protected CompositeNodeNormalizationOperation(final T identifier, final DataSchemaNode schema) {
182             super(identifier,schema);
183         }
184
185         @SuppressWarnings({ "rawtypes", "unchecked" })
186         @Override
187         public final NormalizedNode<?, ?> normalize(final Node<?> legacyData) {
188             checkArgument(legacyData != null);
189             if (!isMixin() && getIdentifier().getNodeType() != null) {
190                 checkArgument(getIdentifier().getNodeType().equals(legacyData.getNodeType()),
191                         "Node QName must be %s was %s", getIdentifier().getNodeType(), legacyData.getNodeType());
192             }
193             checkArgument(legacyData instanceof CompositeNode, "Node %s should be composite", legacyData);
194             CompositeNode compositeNode = (CompositeNode) legacyData;
195             NormalizedNodeContainerBuilder builder = createBuilder(compositeNode);
196
197             Set<DataNormalizationOperation<?>> usedMixins = new HashSet<>();
198             for (Node<?> childLegacy : compositeNode.getValue()) {
199                 final DataNormalizationOperation childOp;
200
201                 try {
202                     childOp = getChild(childLegacy.getNodeType());
203                 } catch (DataNormalizationException e) {
204                     throw new IllegalArgumentException(String.format("Failed to normalize data %s", compositeNode.getValue()), e);
205                 }
206
207                 // We skip unknown nodes if this node is mixin since
208                 // it's nodes and parent nodes are interleaved
209                 if (childOp == null && isMixin()) {
210                     continue;
211                 }
212
213                 checkArgument(childOp != null, "Node %s is not allowed inside %s", childLegacy.getNodeType(),
214                         getIdentifier());
215                 if (childOp.isMixin()) {
216                     if (usedMixins.contains(childOp)) {
217                         // We already run / processed that mixin, so to avoid
218                         // duplicity we are skipping next nodes.
219                         continue;
220                     }
221                     builder.addChild(childOp.normalize(compositeNode));
222                     usedMixins.add(childOp);
223                 } else {
224                     builder.addChild(childOp.normalize(childLegacy));
225                 }
226             }
227             return builder.build();
228         }
229
230         @Override
231         public boolean isLeaf() {
232             return false;
233         }
234
235         @SuppressWarnings("rawtypes")
236         protected abstract NormalizedNodeContainerBuilder createBuilder(final CompositeNode compositeNode);
237
238     }
239
240     private static abstract class DataContainerNormalizationOperation<T extends PathArgument> extends
241     CompositeNodeNormalizationOperation<T> {
242
243         private final DataNodeContainer schema;
244         private final Map<QName, DataNormalizationOperation<?>> byQName;
245         private final Map<PathArgument, DataNormalizationOperation<?>> byArg;
246
247         protected DataContainerNormalizationOperation(final T identifier, final DataNodeContainer schema, final DataSchemaNode node) {
248             super(identifier,node);
249             this.schema = schema;
250             this.byArg = new ConcurrentHashMap<>();
251             this.byQName = new ConcurrentHashMap<>();
252         }
253
254         @Override
255         public DataNormalizationOperation<?> getChild(final PathArgument child) throws DataNormalizationException {
256             DataNormalizationOperation<?> potential = byArg.get(child);
257             if (potential != null) {
258                 return potential;
259             }
260             potential = fromLocalSchema(child);
261             return register(potential);
262         }
263
264         private DataNormalizationOperation<?> fromLocalSchema(final PathArgument child) throws DataNormalizationException {
265             if (child instanceof AugmentationIdentifier) {
266                 return fromSchemaAndQNameChecked(schema, ((AugmentationIdentifier) child).getPossibleChildNames()
267                         .iterator().next());
268             }
269             return fromSchemaAndQNameChecked(schema, child.getNodeType());
270         }
271
272         @Override
273         public DataNormalizationOperation<?> getChild(final QName child) throws DataNormalizationException {
274             DataNormalizationOperation<?> potential = byQName.get(child);
275             if (potential != null) {
276                 return potential;
277             }
278             potential = fromLocalSchemaAndQName(schema, child);
279             return register(potential);
280         }
281
282         protected DataNormalizationOperation<?> fromLocalSchemaAndQName(final DataNodeContainer schema2, final QName child) throws DataNormalizationException {
283             return fromSchemaAndQNameChecked(schema2, child);
284         }
285
286         private DataNormalizationOperation<?> register(final DataNormalizationOperation<?> potential) {
287             if (potential != null) {
288                 byArg.put(potential.getIdentifier(), potential);
289                 for (QName qName : potential.getQNameIdentifiers()) {
290                     byQName.put(qName, potential);
291                 }
292             }
293             return potential;
294         }
295
296     }
297
298     private static final class ListItemNormalization extends
299     DataContainerNormalizationOperation<NodeIdentifierWithPredicates> {
300
301         private final List<QName> keyDefinition;
302
303         protected ListItemNormalization(final NodeIdentifierWithPredicates identifier, final ListSchemaNode schema) {
304             super(identifier, schema,schema);
305             keyDefinition = schema.getKeyDefinition();
306         }
307
308         @Override
309         protected NormalizedNodeContainerBuilder<?, ?, ?, ?> createBuilder(final CompositeNode compositeNode) {
310             ImmutableMap.Builder<QName, Object> keys = ImmutableMap.builder();
311             for (QName key : keyDefinition) {
312
313                 SimpleNode<?> valueNode = checkNotNull(compositeNode.getFirstSimpleByName(key),
314                         "List node %s MUST contain leaf %s with value.", getIdentifier().getNodeType(), key);
315                 keys.put(key, valueNode.getValue());
316             }
317
318             return Builders.mapEntryBuilder().withNodeIdentifier(
319                     new NodeIdentifierWithPredicates(getIdentifier().getNodeType(), keys.build()));
320         }
321
322         @Override
323         public NormalizedNode<?, ?> createDefault(final PathArgument currentArg) {
324             DataContainerNodeAttrBuilder<NodeIdentifierWithPredicates, MapEntryNode> builder = Builders
325                     .mapEntryBuilder().withNodeIdentifier((NodeIdentifierWithPredicates) currentArg);
326             for (Entry<QName, Object> keyValue : ((NodeIdentifierWithPredicates) currentArg).getKeyValues().entrySet()) {
327                 builder.addChild(Builders.leafBuilder()
328                         //
329                         .withNodeIdentifier(new NodeIdentifier(keyValue.getKey())).withValue(keyValue.getValue())
330                         .build());
331             }
332             return builder.build();
333         }
334
335
336         @Override
337         public boolean isKeyedEntry() {
338             return true;
339         }
340     }
341
342     private static final class UnkeyedListItemNormalization extends DataContainerNormalizationOperation<NodeIdentifier> {
343
344         protected UnkeyedListItemNormalization(final ListSchemaNode schema) {
345             super(new NodeIdentifier(schema.getQName()), schema,schema);
346         }
347
348         @Override
349         protected NormalizedNodeContainerBuilder<?, ?, ?, ?> createBuilder(final CompositeNode compositeNode) {
350             return Builders.unkeyedListEntryBuilder().withNodeIdentifier(getIdentifier());
351         }
352
353         @Override
354         public NormalizedNode<?, ?> createDefault(final PathArgument currentArg) {
355             return Builders.unkeyedListEntryBuilder().withNodeIdentifier((NodeIdentifier) currentArg).build();
356         }
357
358     }
359
360     private static final class ContainerNormalization extends DataContainerNormalizationOperation<NodeIdentifier> {
361
362         protected ContainerNormalization(final ContainerSchemaNode schema) {
363             super(new NodeIdentifier(schema.getQName()),schema, schema);
364         }
365
366         @Override
367         protected NormalizedNodeContainerBuilder<?, ?, ?, ?> createBuilder(final CompositeNode compositeNode) {
368             return Builders.containerBuilder().withNodeIdentifier(getIdentifier());
369         }
370
371         @Override
372         public NormalizedNode<?, ?> createDefault(final PathArgument currentArg) {
373             return Builders.containerBuilder().withNodeIdentifier((NodeIdentifier) currentArg).build();
374         }
375
376     }
377
378     private static abstract class MixinNormalizationOp<T extends PathArgument> extends
379     CompositeNodeNormalizationOperation<T> {
380
381         protected MixinNormalizationOp(final T identifier, final DataSchemaNode schema) {
382             super(identifier,schema);
383         }
384
385         @Override
386         public final boolean isMixin() {
387             return true;
388         }
389
390     }
391
392
393     private static final class OrderedLeafListMixinNormalization extends UnorderedLeafListMixinNormalization {
394
395
396         public OrderedLeafListMixinNormalization(final LeafListSchemaNode potential) {
397             super(potential);
398         }
399
400         @Override
401         protected NormalizedNodeContainerBuilder<?, ?, ?, ?> createBuilder(final CompositeNode compositeNode) {
402             return Builders.orderedLeafSetBuilder().withNodeIdentifier(getIdentifier());
403         }
404
405         @Override
406         public NormalizedNode<?, ?> createDefault(final PathArgument currentArg) {
407             return Builders.orderedLeafSetBuilder().withNodeIdentifier(getIdentifier()).build();
408         }
409     }
410
411     private static class UnorderedLeafListMixinNormalization extends MixinNormalizationOp<NodeIdentifier> {
412
413         private final DataNormalizationOperation<?> innerOp;
414
415         public UnorderedLeafListMixinNormalization(final LeafListSchemaNode potential) {
416             super(new NodeIdentifier(potential.getQName()),potential);
417             innerOp = new LeafListEntryNormalization(potential);
418         }
419
420         @Override
421         protected NormalizedNodeContainerBuilder<?, ?, ?, ?> createBuilder(final CompositeNode compositeNode) {
422             return Builders.leafSetBuilder().withNodeIdentifier(getIdentifier());
423         }
424
425         @Override
426         public NormalizedNode<?, ?> createDefault(final PathArgument currentArg) {
427             return Builders.leafSetBuilder().withNodeIdentifier(getIdentifier()).build();
428         }
429
430         @Override
431         public DataNormalizationOperation<?> getChild(final PathArgument child) {
432             if (child instanceof NodeWithValue) {
433                 return innerOp;
434             }
435             return null;
436         }
437
438         @Override
439         public DataNormalizationOperation<?> getChild(final QName child) {
440             if (getIdentifier().getNodeType().equals(child)) {
441                 return innerOp;
442             }
443             return null;
444         }
445     }
446
447     private static final class AugmentationNormalization extends DataContainerNormalizationOperation<AugmentationIdentifier> {
448
449         public AugmentationNormalization(final AugmentationSchema augmentation, final DataNodeContainer schema) {
450             //super();
451             super(augmentationIdentifierFrom(augmentation), augmentationProxy(augmentation,schema),null);
452         }
453
454         @Override
455         public boolean isMixin() {
456             return true;
457         }
458
459
460
461         @Override
462         protected DataNormalizationOperation<?> fromLocalSchemaAndQName(final DataNodeContainer schema, final QName child)
463                 throws DataNormalizationException {
464             Optional<DataSchemaNode> potential = findChildSchemaNode(schema, child);
465             if (!potential.isPresent()) {
466                 return null;
467             }
468
469             DataSchemaNode result = potential.get();
470             // We try to look up if this node was added by augmentation
471             if ((schema instanceof DataSchemaNode) && result.isAugmenting()) {
472                 return fromAugmentation(schema, (AugmentationTarget) schema, result);
473             }
474             return fromDataSchemaNode(result);
475         }
476
477         @Override
478         protected Set<QName> getQNameIdentifiers() {
479             return getIdentifier().getPossibleChildNames();
480         }
481
482         @SuppressWarnings("rawtypes")
483         @Override
484         protected NormalizedNodeContainerBuilder createBuilder(final CompositeNode compositeNode) {
485             return Builders.augmentationBuilder().withNodeIdentifier(getIdentifier());
486         }
487
488         @Override
489         public NormalizedNode<?, ?> createDefault(final PathArgument currentArg) {
490             return Builders.augmentationBuilder().withNodeIdentifier(getIdentifier()).build();
491         }
492
493     }
494
495     private static class UnorderedMapMixinNormalization extends MixinNormalizationOp<NodeIdentifier> {
496
497         private final ListItemNormalization innerNode;
498
499         public UnorderedMapMixinNormalization(final ListSchemaNode list) {
500             super(new NodeIdentifier(list.getQName()),list);
501             this.innerNode = new ListItemNormalization(new NodeIdentifierWithPredicates(list.getQName(),
502                     Collections.<QName, Object> emptyMap()), list);
503         }
504
505         @SuppressWarnings("rawtypes")
506         @Override
507         protected NormalizedNodeContainerBuilder createBuilder(final CompositeNode compositeNode) {
508             return Builders.mapBuilder().withNodeIdentifier(getIdentifier());
509         }
510
511         @Override
512         public NormalizedNode<?, ?> createDefault(final PathArgument currentArg) {
513             return Builders.mapBuilder().withNodeIdentifier(getIdentifier()).build();
514         }
515
516         @Override
517         public DataNormalizationOperation<?> getChild(final PathArgument child) {
518             if (child.getNodeType().equals(getIdentifier().getNodeType())) {
519                 return innerNode;
520             }
521             return null;
522         }
523
524         @Override
525         public DataNormalizationOperation<?> getChild(final QName child) {
526             if (getIdentifier().getNodeType().equals(child)) {
527                 return innerNode;
528             }
529             return null;
530         }
531
532     }
533
534
535     private static class UnkeyedListMixinNormalization extends MixinNormalizationOp<NodeIdentifier> {
536
537         private final UnkeyedListItemNormalization innerNode;
538
539         public UnkeyedListMixinNormalization(final ListSchemaNode list) {
540             super(new NodeIdentifier(list.getQName()),list);
541             this.innerNode = new UnkeyedListItemNormalization(list);
542         }
543
544         @SuppressWarnings("rawtypes")
545         @Override
546         protected NormalizedNodeContainerBuilder createBuilder(final CompositeNode compositeNode) {
547             return Builders.unkeyedListBuilder().withNodeIdentifier(getIdentifier());
548         }
549
550         @Override
551         public NormalizedNode<?, ?> createDefault(final PathArgument currentArg) {
552             return Builders.unkeyedListBuilder().withNodeIdentifier(getIdentifier()).build();
553         }
554
555         @Override
556         public DataNormalizationOperation<?> getChild(final PathArgument child) {
557             if (child.getNodeType().equals(getIdentifier().getNodeType())) {
558                 return innerNode;
559             }
560             return null;
561         }
562
563         @Override
564         public DataNormalizationOperation<?> getChild(final QName child) {
565             if (getIdentifier().getNodeType().equals(child)) {
566                 return innerNode;
567             }
568             return null;
569         }
570
571     }
572
573     private static final class OrderedMapMixinNormalization extends UnorderedMapMixinNormalization {
574
575         public OrderedMapMixinNormalization(final ListSchemaNode list) {
576             super(list);
577         }
578
579         @SuppressWarnings("rawtypes")
580         @Override
581         protected NormalizedNodeContainerBuilder createBuilder(final CompositeNode compositeNode) {
582             return Builders.orderedMapBuilder().withNodeIdentifier(getIdentifier());
583         }
584
585         @Override
586         public NormalizedNode<?, ?> createDefault(final PathArgument currentArg) {
587             return Builders.orderedMapBuilder().withNodeIdentifier(getIdentifier()).build();
588         }
589
590     }
591
592     private static class ChoiceNodeNormalization extends MixinNormalizationOp<NodeIdentifier> {
593
594         private final ImmutableMap<QName, DataNormalizationOperation<?>> byQName;
595         private final ImmutableMap<PathArgument, DataNormalizationOperation<?>> byArg;
596
597         protected ChoiceNodeNormalization(final org.opendaylight.yangtools.yang.model.api.ChoiceNode schema) {
598             super(new NodeIdentifier(schema.getQName()),schema);
599             ImmutableMap.Builder<QName, DataNormalizationOperation<?>> byQNameBuilder = ImmutableMap.builder();
600             ImmutableMap.Builder<PathArgument, DataNormalizationOperation<?>> byArgBuilder = ImmutableMap.builder();
601
602             for (ChoiceCaseNode caze : schema.getCases()) {
603                 for (DataSchemaNode cazeChild : caze.getChildNodes()) {
604                     DataNormalizationOperation<?> childOp = fromDataSchemaNode(cazeChild);
605                     byArgBuilder.put(childOp.getIdentifier(), childOp);
606                     for (QName qname : childOp.getQNameIdentifiers()) {
607                         byQNameBuilder.put(qname, childOp);
608                     }
609                 }
610             }
611             byQName = byQNameBuilder.build();
612             byArg = byArgBuilder.build();
613         }
614
615         @Override
616         public DataNormalizationOperation<?> getChild(final PathArgument child) {
617             return byArg.get(child);
618         }
619
620         @Override
621         public DataNormalizationOperation<?> getChild(final QName child) {
622             return byQName.get(child);
623         }
624
625         @Override
626         protected NormalizedNodeContainerBuilder<?, ?, ?, ?> createBuilder(final CompositeNode compositeNode) {
627             return Builders.choiceBuilder().withNodeIdentifier(getIdentifier());
628         }
629
630         @Override
631         public NormalizedNode<?, ?> createDefault(final PathArgument currentArg) {
632             return Builders.choiceBuilder().withNodeIdentifier(getIdentifier()).build();
633         }
634     }
635
636     private static class AnyXmlNormalization extends DataNormalizationOperation<NodeIdentifier> {
637
638         protected AnyXmlNormalization( final AnyXmlSchemaNode schema) {
639             super( new NodeIdentifier(schema.getQName()), schema);
640         }
641
642         @Override
643         public DataNormalizationOperation<?> getChild( final PathArgument child ) throws DataNormalizationException {
644             return null;
645         }
646
647         @Override
648         public DataNormalizationOperation<?> getChild( final QName child ) throws DataNormalizationException {
649             return null;
650         }
651
652         @Override
653         public NormalizedNode<?, ?> normalize( final Node<?> legacyData ) {
654             NormalizedNodeAttrBuilder<NodeIdentifier, DOMSource, AnyXmlNode> builder =
655                     Builders.anyXmlBuilder().withNodeIdentifier(
656                             new NodeIdentifier( legacyData.getNodeType() ) );
657             // Will be removed
658 //            builder.withValue(legacyData);
659             return builder.build();
660         }
661
662         @Override
663         public boolean isLeaf() {
664             return false;
665         }
666
667         @Override
668         public NormalizedNode<?, ?> createDefault( final PathArgument currentArg ) {
669             return null;
670         }
671     }
672
673     private static final Optional<DataSchemaNode> findChildSchemaNode(final DataNodeContainer parent,final QName child) {
674         DataSchemaNode potential = parent.getDataChildByName(child);
675         if (potential == null) {
676             Iterable<org.opendaylight.yangtools.yang.model.api.ChoiceNode> choices = FluentIterable.from(
677                     parent.getChildNodes()).filter(org.opendaylight.yangtools.yang.model.api.ChoiceNode.class);
678             potential = findChoice(choices, child);
679         }
680         return Optional.fromNullable(potential);
681     }
682
683     private static DataNormalizationOperation<?> fromSchemaAndQNameChecked(final DataNodeContainer schema,
684             final QName child) throws DataNormalizationException {
685
686         Optional<DataSchemaNode> potential = findChildSchemaNode(schema, child);
687         if (!potential.isPresent()) {
688             throw new DataNormalizationException(String.format("Supplied QName %s is not valid according to schema %s, potential children nodes: %s", child, schema,schema.getChildNodes()));
689         }
690
691         DataSchemaNode result = potential.get();
692         // We try to look up if this node was added by augmentation
693         if ((schema instanceof DataSchemaNode) && result.isAugmenting()) {
694             return fromAugmentation(schema, (AugmentationTarget) schema, result);
695         }
696         return fromDataSchemaNode(result);
697     }
698
699     private static org.opendaylight.yangtools.yang.model.api.ChoiceNode findChoice(
700             final Iterable<org.opendaylight.yangtools.yang.model.api.ChoiceNode> choices, final QName child) {
701         org.opendaylight.yangtools.yang.model.api.ChoiceNode foundChoice = null;
702         choiceLoop: for (org.opendaylight.yangtools.yang.model.api.ChoiceNode choice : choices) {
703             for (ChoiceCaseNode caze : choice.getCases()) {
704                 if (findChildSchemaNode(caze, child).isPresent()) {
705                     foundChoice = choice;
706                     break choiceLoop;
707                 }
708             }
709         }
710         return foundChoice;
711     }
712
713     public static AugmentationIdentifier augmentationIdentifierFrom(final AugmentationSchema augmentation) {
714         ImmutableSet.Builder<QName> potentialChildren = ImmutableSet.builder();
715         for (DataSchemaNode child : augmentation.getChildNodes()) {
716             potentialChildren.add(child.getQName());
717         }
718         return new AugmentationIdentifier(potentialChildren.build());
719     }
720
721     private static DataNodeContainer augmentationProxy(final AugmentationSchema augmentation, final DataNodeContainer schema) {
722         Set<DataSchemaNode> children = new HashSet<>();
723         for (DataSchemaNode augNode : augmentation.getChildNodes()) {
724             children.add(schema.getDataChildByName(augNode.getQName()));
725         }
726         return new DataSchemaContainerProxy(children);
727     }
728
729     /**
730      * Returns a DataNormalizationOperation for provided child node
731      *
732      * If supplied child is added by Augmentation this operation returns
733      * a DataNormalizationOperation for augmentation,
734      * otherwise returns a DataNormalizationOperation for child as
735      * call for {@link #fromDataSchemaNode(DataSchemaNode)}.
736      *
737      *
738      * @param parent
739      * @param parentAug
740      * @param child
741      * @return
742      */
743     private static DataNormalizationOperation<?> fromAugmentation(final DataNodeContainer parent,
744             final AugmentationTarget parentAug, final DataSchemaNode child) {
745         AugmentationSchema augmentation = null;
746         for (AugmentationSchema aug : parentAug.getAvailableAugmentations()) {
747             DataSchemaNode potential = aug.getDataChildByName(child.getQName());
748             if (potential != null) {
749                 augmentation = aug;
750                 break;
751             }
752
753         }
754         if (augmentation != null) {
755             return new AugmentationNormalization(augmentation, parent);
756         } else {
757             return fromDataSchemaNode(child);
758         }
759     }
760
761     public static DataNormalizationOperation<?> fromDataSchemaNode(final DataSchemaNode potential) {
762         if (potential instanceof ContainerSchemaNode) {
763             return new ContainerNormalization((ContainerSchemaNode) potential);
764         } else if (potential instanceof ListSchemaNode) {
765
766             return fromListSchemaNode((ListSchemaNode) potential);
767         } else if (potential instanceof LeafSchemaNode) {
768             return new LeafNormalization((LeafSchemaNode) potential);
769         } else if (potential instanceof org.opendaylight.yangtools.yang.model.api.ChoiceNode) {
770             return new ChoiceNodeNormalization((org.opendaylight.yangtools.yang.model.api.ChoiceNode) potential);
771         } else if (potential instanceof LeafListSchemaNode) {
772             return fromLeafListSchemaNode((LeafListSchemaNode) potential);
773         } else if (potential instanceof AnyXmlSchemaNode) {
774             return new AnyXmlNormalization( (AnyXmlSchemaNode) potential);
775         }
776         return null;
777     }
778
779     private static DataNormalizationOperation<?> fromListSchemaNode(final ListSchemaNode potential) {
780         List<QName> keyDefinition = potential.getKeyDefinition();
781         if(keyDefinition == null || keyDefinition.isEmpty()) {
782             return new UnkeyedListMixinNormalization(potential);
783         }
784         if(potential.isUserOrdered()) {
785             return new OrderedMapMixinNormalization(potential);
786         }
787         return new UnorderedMapMixinNormalization(potential);
788     }
789
790     private static DataNormalizationOperation<?> fromLeafListSchemaNode(final LeafListSchemaNode potential) {
791         if(potential.isUserOrdered()) {
792             return new OrderedLeafListMixinNormalization(potential);
793         }
794         return new UnorderedLeafListMixinNormalization(potential);
795     }
796
797
798     public static DataNormalizationOperation<?> from(final SchemaContext ctx) {
799         return new ContainerNormalization(ctx);
800     }
801
802     public abstract NormalizedNode<?, ?> createDefault(PathArgument currentArg);
803 }