2 * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.mdsal.binding.dom.adapter;
10 import java.util.Optional;
11 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
12 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
13 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
14 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
15 import org.opendaylight.yangtools.yang.data.api.schema.AnyXmlNode;
16 import org.opendaylight.yangtools.yang.data.api.schema.AugmentationNode;
17 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
18 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
19 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
20 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
21 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetNode;
22 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
23 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
24 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
25 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidateNode;
28 * Defines structural mapping of Normalized Node to Binding data
29 * addressable by Instance Identifier.
32 * Not all binding data are addressable by instance identifier
33 * and there are some differences.
36 * See {@link #NOT_ADDRESSABLE},{@link #INVISIBLE_CONTAINER},{@link #VISIBLE_CONTAINER}
39 enum BindingStructuralType {
42 * DOM Item is not addressable in Binding Instance Identifier,
43 * data is not lost, but are available only via parent object.
46 * Such types of data are leaf-lists, leafs, list without keys
52 * Data container is addressable in NormalizedNode format,
53 * but in Binding it is not represented in Instance Identifier.
56 * This are choice / case nodes.
59 * This data is still accessible using parent object and their
60 * children are addressable.
65 * Data container is addressable in NormalizedNode format,
66 * but in Binding it is not represented in Instance Identifier.
69 * This are list nodes.
72 * This data is still accessible using parent object and their
73 * children are addressable.
78 * Data container is addressable in Binding Instance Identifier format
79 * and also YangInstanceIdentifier format.
84 * Mapping algorithm was unable to detect type or was not updated after introduction
85 * of new NormalizedNode type.
89 static BindingStructuralType from(final DataTreeCandidateNode domChildNode) {
90 Optional<NormalizedNode<?, ?>> dataBased = domChildNode.getDataAfter();
91 if (!dataBased.isPresent()) {
92 dataBased = domChildNode.getDataBefore();
94 if (dataBased.isPresent()) {
95 return from(dataBased.get());
97 return from(domChildNode.getIdentifier());
100 private static BindingStructuralType from(final PathArgument identifier) {
101 if (identifier instanceof NodeIdentifierWithPredicates || identifier instanceof AugmentationIdentifier) {
102 return VISIBLE_CONTAINER;
104 if (identifier instanceof NodeWithValue) {
105 return NOT_ADDRESSABLE;
110 static BindingStructuralType from(final NormalizedNode<?, ?> data) {
111 if (isNotAddressable(data)) {
112 return NOT_ADDRESSABLE;
114 if (data instanceof MapNode) {
115 return INVISIBLE_LIST;
117 if (data instanceof ChoiceNode) {
118 return INVISIBLE_CONTAINER;
120 if (isVisibleContainer(data)) {
121 return VISIBLE_CONTAINER;
126 private static boolean isVisibleContainer(final NormalizedNode<?, ?> data) {
127 return data instanceof MapEntryNode || data instanceof ContainerNode || data instanceof AugmentationNode;
130 private static boolean isNotAddressable(final NormalizedNode<?, ?> normalizedNode) {
131 return normalizedNode instanceof LeafNode
132 || normalizedNode instanceof AnyXmlNode
133 || normalizedNode instanceof LeafSetNode
134 || normalizedNode instanceof LeafSetEntryNode;