1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
|
/*
* ============LICENSE_START=======================================================
* Copyright (C) 2021 Bell Canada. All rights reserved.
* Modifications Copyright (C) 2021 Pantheon.tech
* Modifications Copyright (C) 2022 Nordix Foundation.
* Modifications Copyright (C) 2022 TechMahindra Ltd.
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* SPDX-License-Identifier: Apache-2.0
* ============LICENSE_END=========================================================
*/
package org.onap.cps.spi.model;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
import java.io.Serializable;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.stream.Collectors;
import lombok.extern.slf4j.Slf4j;
import org.onap.cps.spi.exceptions.DataValidationException;
import org.onap.cps.utils.YangUtils;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
import org.opendaylight.yangtools.yang.data.api.schema.DataContainerNode;
import org.opendaylight.yangtools.yang.data.api.schema.LeafSetNode;
import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
import org.opendaylight.yangtools.yang.data.api.schema.ValueNode;
@Slf4j
public class DataNodeBuilder {
private ContainerNode containerNode;
private String xpath;
private String moduleNamePrefix;
private String parentNodeXpath = "";
private Map<String, Serializable> leaves = Collections.emptyMap();
private Collection<DataNode> childDataNodes = Collections.emptySet();
/**
* To use parent node xpath for creating {@link DataNode}.
*
* @param parentNodeXpath xpath of a parent node
* @return this {@link DataNodeBuilder} object
*/
public DataNodeBuilder withParentNodeXpath(final String parentNodeXpath) {
this.parentNodeXpath = parentNodeXpath;
return this;
}
/**
* To use {@link Collection} of Normalized Nodes for creating {@link DataNode}.
*
* @param containerNode used for creating the Data Node
* @return this {@link DataNodeBuilder} object
*/
public DataNodeBuilder withContainerNode(final ContainerNode containerNode) {
this.containerNode = containerNode;
return this;
}
/**
* To use xpath for creating {@link DataNode}.
*
* @param xpath for the data node
* @return DataNodeBuilder
*/
public DataNodeBuilder withXpath(final String xpath) {
this.xpath = xpath;
return this;
}
/**
* To use module name for prefix for creating {@link DataNode}.
*
* @param moduleNamePrefix module name as prefix
* @return DataNodeBuilder
*/
public DataNodeBuilder withModuleNamePrefix(final String moduleNamePrefix) {
this.moduleNamePrefix = moduleNamePrefix;
return this;
}
/**
* To use attributes for creating {@link DataNode}.
*
* @param leaves for the data node
* @return DataNodeBuilder
*/
public DataNodeBuilder withLeaves(final Map<String, Serializable> leaves) {
this.leaves = leaves;
return this;
}
/**
* To specify child nodes needs to be used while creating {@link DataNode}.
*
* @param childDataNodes to be added to the dataNode
* @return DataNodeBuilder
*/
public DataNodeBuilder withChildDataNodes(final Collection<DataNode> childDataNodes) {
// Added as this is being set from test cases .
// Open for suggestions
this.childDataNodes = childDataNodes;
return this;
}
/**
* To create the {@link DataNode}.
*
* @return {@link DataNode}
*/
public DataNode build() {
if (containerNode != null) {
return buildFromContainerNode();
}
return buildFromAttributes();
}
/**
* To build a {@link Collection} of {@link DataNode} objects.
*
* @return {@link DataNode} {@link Collection}
*/
public Collection<DataNode> buildCollection() {
if (containerNode != null) {
return buildCollectionFromContainerNode();
}
return Collections.emptySet();
}
private DataNode buildFromAttributes() {
final var dataNode = new DataNode();
dataNode.setXpath(xpath);
dataNode.setModuleNamePrefix(moduleNamePrefix);
dataNode.setLeaves(leaves);
dataNode.setChildDataNodes(childDataNodes);
return dataNode;
}
private DataNode buildFromContainerNode() {
final Collection<DataNode> dataNodeCollection = buildCollectionFromContainerNode();
if (!dataNodeCollection.iterator().hasNext()) {
throw new DataValidationException(
"Unsupported xpath: ", "Unsupported xpath as it is referring to one element");
}
return dataNodeCollection.iterator().next();
}
private Collection<DataNode> buildCollectionFromContainerNode() {
final var parentDataNode = new DataNodeBuilder().withXpath(parentNodeXpath).build();
if (containerNode.body() != null) {
for (final NormalizedNode normalizedNode: containerNode.body()) {
addDataNodeFromNormalizedNode(parentDataNode, normalizedNode);
}
}
return parentDataNode.getChildDataNodes();
}
private static void addDataNodeFromNormalizedNode(final DataNode currentDataNode,
final NormalizedNode normalizedNode) {
if (normalizedNode instanceof ChoiceNode) {
addChoiceNode(currentDataNode, (ChoiceNode) normalizedNode);
} else if (normalizedNode instanceof DataContainerNode) {
addYangContainer(currentDataNode, (DataContainerNode) normalizedNode);
} else if (normalizedNode instanceof MapNode) {
addDataNodeForEachListElement(currentDataNode, (MapNode) normalizedNode);
} else if (normalizedNode instanceof ValueNode) {
final ValueNode<NormalizedNode> valuesNode = (ValueNode) normalizedNode;
addYangLeaf(currentDataNode, valuesNode.getIdentifier().getNodeType().getLocalName(),
(Serializable) valuesNode.body());
} else if (normalizedNode instanceof LeafSetNode) {
addYangLeafList(currentDataNode, (LeafSetNode<?>) normalizedNode);
} else {
log.warn("Unsupported NormalizedNode type detected: {}", normalizedNode.getClass());
}
}
private static void addYangContainer(final DataNode currentDataNode, final DataContainerNode dataContainerNode) {
final DataNode dataContainerDataNode =
(dataContainerNode.getIdentifier() instanceof YangInstanceIdentifier.AugmentationIdentifier)
? currentDataNode
: createAndAddChildDataNode(currentDataNode, YangUtils.buildXpath(dataContainerNode.getIdentifier()));
final Collection<DataContainerChild> normalizedChildNodes = dataContainerNode.body();
for (final NormalizedNode normalizedNode : normalizedChildNodes) {
addDataNodeFromNormalizedNode(dataContainerDataNode, normalizedNode);
}
}
private static void addYangLeaf(final DataNode currentDataNode, final String leafName,
final Serializable leafValue) {
final Map<String, Serializable> leaves = new ImmutableMap.Builder<String, Serializable>()
.putAll(currentDataNode.getLeaves())
.put(leafName, leafValue)
.build();
currentDataNode.setLeaves(leaves);
}
private static void addYangLeafList(final DataNode currentDataNode, final LeafSetNode<?> leafSetNode) {
final String leafListName = leafSetNode.getIdentifier().getNodeType().getLocalName();
final List<?> leafListValues = ((Collection<? extends NormalizedNode>) leafSetNode.body())
.stream()
.map(normalizedNode -> (normalizedNode).body())
.collect(Collectors.toUnmodifiableList());
addYangLeaf(currentDataNode, leafListName, (Serializable) leafListValues);
}
private static void addDataNodeForEachListElement(final DataNode currentDataNode, final MapNode mapNode) {
final Collection<MapEntryNode> mapEntryNodes = mapNode.body();
for (final MapEntryNode mapEntryNode : mapEntryNodes) {
addDataNodeFromNormalizedNode(currentDataNode, mapEntryNode);
}
}
private static DataNode createAndAddChildDataNode(final DataNode parentDataNode, final String childXpath) {
final var newChildDataNode = new DataNodeBuilder()
.withXpath(parentDataNode.getXpath() + childXpath)
.build();
final Set<DataNode> allChildDataNodes = new ImmutableSet.Builder<DataNode>()
.addAll(parentDataNode.getChildDataNodes())
.add(newChildDataNode)
.build();
parentDataNode.setChildDataNodes(allChildDataNodes);
return newChildDataNode;
}
private static void addChoiceNode(final DataNode currentDataNode, final ChoiceNode choiceNode) {
final Collection<DataContainerChild> normalizedChildNodes = choiceNode.body();
for (final NormalizedNode normalizedNode : normalizedChildNodes) {
addDataNodeFromNormalizedNode(currentDataNode, normalizedNode);
}
}
}
|
