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
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
|
/*-
* ============LICENSE_START=======================================================
* ONAP - CCSDK
* ================================================================================
* Copyright (C) 2018 Huawei Technologies Co., Ltd. All rights reserved.
* ================================================================================
* 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.
* ============LICENSE_END=========================================================
*/
package org.onap.ccsdk.sli.plugins.yangserializers.pnserializer;
import com.google.common.collect.ArrayListMultimap;
import com.google.common.collect.Multimap;
import org.onap.ccsdk.sli.core.sli.SvcLogicException;
/**
* Abstraction of properties node data tree. This intermediate representation
* will enable data format serializers to be agnostic of DG context memory
* nuances and thereby will enable faster development of new data format
* serializers.
*/
public abstract class PropertiesNode {
private String name;
private Namespace namespace;
private String uri;
private PropertiesNode parent;
private Object appInfo;
private NodeType nodeType;
private boolean nonAppend;
private Multimap<Object, PropertiesNode> augmentations = ArrayListMultimap.create();
/**
* Creates an instance of properties node.
*
* @param name name of node
* @param namespace namespace of node, null indicates parent namespace
* @param uri URI of this node, if null its calculated based on parent and
* current value of name and namespace
* @param parent parent's node
* @param appInfo application related information
* @param nodeType node type
*/
protected PropertiesNode(String name, Namespace namespace, String uri,
PropertiesNode parent, Object appInfo, NodeType nodeType) {
this.name = name;
this.namespace = namespace;
this.uri = uri;
this.parent = parent;
this.appInfo = appInfo;
this.nodeType = nodeType;
}
/**
* Sets name.
*
* @param name name of the node
*/
public void name(String name) {
this.name = name;
}
/**
* Sets namespace.
*
* @param namespace namespace of the node
*/
public void namespace(Namespace namespace) {
this.namespace = namespace;
}
/**
* Sets uri.
*
* @param uri uri of the node
*/
public void uri(String uri) {
this.uri = uri;
}
/**
* Sets parent node.
*
* @param parent parent node
*/
public void parent(PropertiesNode parent) {
this.parent = parent;
}
/**
* Sets application info.
*
* @param appInfo application info
*/
public void appInfo(Object appInfo) {
this.appInfo = appInfo;
}
/**
* Sets to true if module name is required in forming a request; false
* otherwise.
*
* @param isNotReq true if required; false otherwise
*/
public void nonAppend(boolean isNotReq) {
this.nonAppend = isNotReq;
}
/**
* Returns parent.
*
* @return parent node
*/
public PropertiesNode parent() {
return parent;
}
/**
* Returns name.
*
* @return name of the node
*/
public String name() {
return name;
}
/**
* Returns namespace.
*
* @return namespace of the node
*/
public Namespace namespace() {
return namespace;
}
/**
* Returns uri.
*
* @return uri of the node
*/
public String uri() {
return uri;
}
/**
* Returns application info.
*
* @return application info
*/
public Object appInfo() {
return appInfo;
}
/**
* Returns node type.
*
* @return node type
*/
public NodeType nodeType() {
return nodeType;
}
/**
* Returns if module name is required.
*
* @return status of module name if required
*/
public boolean nonAppend() {
return nonAppend;
}
/**
* Returns augmentations.
*
* @return augmentations
*/
public Multimap<Object, PropertiesNode> augmentations() {
return augmentations;
}
/**
* Sets augmentations.
*
* @param augmentations augmentations of the node
*/
public void augmentations(Multimap<Object, PropertiesNode> augmentations) {
this.augmentations = augmentations;
}
/**
* Adds a child to a current node.
*
* @param name name of child
* @param namespace namespace of child, null represents parent namespace
* @param type type of node
* @param appInfo application info
* @return added properties node
*/
public abstract PropertiesNode addChild(String name, Namespace namespace,
NodeType type,
Object appInfo) throws SvcLogicException;
/**
* Adds a child with value to a current node.
*
* @param name name of child
* @param namespace namespace of child, null represents parent namespace
* @param type type of node
* @param value value of node
* @param valueNs value namespace
* @param appInfo application info
* @throws SvcLogicException if failed to add child
* @return added properties node
*/
public abstract PropertiesNode addChild(String name, Namespace namespace,
NodeType type, String value,
Namespace valueNs,
Object appInfo) throws SvcLogicException;
/**
* Adds a child at a given index to a current node. To be used in case of
* leaf holder child's which is multi instance node.
*
* @param index index at which node is to be added
* @param name name of child
* @param namespace namespace of child, null represents parent namespace
* @param type type of node
* @param appInfo application info
* @throws SvcLogicException if failed to add child
* @return added properties node
*/
public abstract PropertiesNode addChild(String index, String name,
Namespace namespace,
NodeType type,
Object appInfo) throws SvcLogicException;
/**
* Adds a child at a given index to a current node. To be used in case of
* leaf holder child's which is multi instance node.
*
* @param index index at which node is to be added
* @param name name of child
* @param namespace namespace of child, null represents parent namespace
* @param type type of node
* @param value value of node
* @param valueNs value namespace
* @param appInfo application info
* @throws SvcLogicException if failed to add child
* @return added properties node
*/
public abstract PropertiesNode addChild(String index, String name,
Namespace namespace, NodeType type,
String value, Namespace valueNs,
Object appInfo) throws SvcLogicException;
/**
* Returns root node.
*
* @return root node
*/
public PropertiesNode endNode() {
PropertiesNode node = this;
while (node.parent() != null){
node = node.parent();
}
return node;
}
}
|
