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.controller.md.sal.binding.impl;
10 import com.google.common.base.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;
29 * Defines structural mapping of Normalized Node to Binding data
30 * addressable by Instance Identifier.
32 * Not all binding data are addressable by instance identifier
33 * and there are some differences.
35 * See {@link #NOT_ADDRESSABLE},{@link #INVISIBLE_CONTAINER},{@link #VISIBLE_CONTAINER}
40 enum BindingStructuralType {
43 * DOM Item is not addressable in Binding Instance Identifier,
44 * 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.
55 * This are choice / case nodes.
57 * This data is still accessible using parent object and their
58 * children are addressable.
63 * Data container is addressable in NormalizedNode format,
64 * but in Binding it is not represented in Instance Identifier.
66 * This are list nodes.
68 * This data is still accessible using parent object and their
69 * children are addressable.
74 * Data container is addressable in Binding Instance Identifier format
75 * and also YangInstanceIdentifier format.
80 * Mapping algorithm was unable to detect type or was not updated after introduction
81 * of new NormalizedNode type.
85 static BindingStructuralType from(final DataTreeCandidateNode domChildNode) {
86 final Optional<NormalizedNode<?, ?>> dataBased = domChildNode.getDataAfter().or(domChildNode.getDataBefore());
87 if(dataBased.isPresent()) {
88 return from(dataBased.get());
90 return from(domChildNode.getIdentifier());
93 private static BindingStructuralType from(final PathArgument identifier) {
94 if(identifier instanceof NodeIdentifierWithPredicates || identifier instanceof AugmentationIdentifier) {
95 return VISIBLE_CONTAINER;
97 if(identifier instanceof NodeWithValue) {
98 return NOT_ADDRESSABLE;
103 static BindingStructuralType from(final NormalizedNode<?, ?> data) {
104 if(isNotAddressable(data)) {
105 return NOT_ADDRESSABLE;
107 if(data instanceof MapNode) {
108 return INVISIBLE_LIST;
110 if(data instanceof ChoiceNode) {
111 return INVISIBLE_CONTAINER;
113 if(isVisibleContainer(data)) {
114 return VISIBLE_CONTAINER;
119 private static boolean isVisibleContainer(final NormalizedNode<?, ?> data) {
120 return data instanceof MapEntryNode || data instanceof ContainerNode || data instanceof AugmentationNode;
123 private static boolean isNotAddressable(final NormalizedNode<?, ?> d) {
124 return d instanceof LeafNode
125 || d instanceof AnyXmlNode
126 || d instanceof LeafSetNode
127 || d instanceof LeafSetEntryNode;