2 * Copyright (c) 2013 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.yang.parser.util;
10 import static org.opendaylight.controller.yang.parser.util.ParserUtils.*;
12 import java.lang.reflect.Method;
13 import java.util.List;
15 import org.opendaylight.controller.yang.model.api.AnyXmlSchemaNode;
16 import org.opendaylight.controller.yang.model.api.ChoiceNode;
17 import org.opendaylight.controller.yang.model.api.ContainerSchemaNode;
18 import org.opendaylight.controller.yang.model.api.GroupingDefinition;
19 import org.opendaylight.controller.yang.model.api.LeafListSchemaNode;
20 import org.opendaylight.controller.yang.model.api.LeafSchemaNode;
21 import org.opendaylight.controller.yang.model.api.ListSchemaNode;
22 import org.opendaylight.controller.yang.model.api.MustDefinition;
23 import org.opendaylight.controller.yang.model.api.TypeDefinition;
24 import org.opendaylight.controller.yang.model.util.ExtendedType;
25 import org.opendaylight.controller.yang.parser.builder.api.Builder;
26 import org.opendaylight.controller.yang.parser.builder.api.GroupingBuilder;
27 import org.opendaylight.controller.yang.parser.builder.api.SchemaNodeBuilder;
28 import org.opendaylight.controller.yang.parser.builder.api.TypeDefinitionBuilder;
29 import org.opendaylight.controller.yang.parser.builder.api.UsesNodeBuilder;
30 import org.opendaylight.controller.yang.parser.builder.impl.AnyXmlBuilder;
31 import org.opendaylight.controller.yang.parser.builder.impl.ChoiceBuilder;
32 import org.opendaylight.controller.yang.parser.builder.impl.ContainerSchemaNodeBuilder;
33 import org.opendaylight.controller.yang.parser.builder.impl.GroupingBuilderImpl;
34 import org.opendaylight.controller.yang.parser.builder.impl.LeafListSchemaNodeBuilder;
35 import org.opendaylight.controller.yang.parser.builder.impl.LeafSchemaNodeBuilder;
36 import org.opendaylight.controller.yang.parser.builder.impl.ListSchemaNodeBuilder;
37 import org.opendaylight.controller.yang.parser.builder.impl.TypeDefinitionBuilderImpl;
38 import org.opendaylight.controller.yang.parser.builder.impl.UnknownSchemaNodeBuilder;
41 * Utility class with helper methods to perform operations tied to refine
44 public class RefineUtils {
46 private RefineUtils() {
50 * Find original builder of node to refine and return copy of this builder.
52 * We must create and use a copy of builder to preserve original builder
53 * state, because this object will be refined (modified) and later added to
54 * {@link UsesNodeBuilder}.
57 * @param targetGrouping
58 * builder of grouping which should contains node to refine
60 * refine object containing informations about refine
65 public static SchemaNodeBuilder getRefineNodeFromGroupingBuilder(final GroupingBuilder targetGrouping,
66 final RefineHolder refine, final String moduleName) {
67 Builder result = null;
68 final Builder lookedUpBuilder = findRefineTargetBuilder(targetGrouping, refine.getName());
69 if (lookedUpBuilder instanceof LeafSchemaNodeBuilder) {
70 result = new LeafSchemaNodeBuilder((LeafSchemaNodeBuilder) lookedUpBuilder);
71 } else if (lookedUpBuilder instanceof ContainerSchemaNodeBuilder) {
72 result = new ContainerSchemaNodeBuilder((ContainerSchemaNodeBuilder) lookedUpBuilder);
73 } else if (lookedUpBuilder instanceof ListSchemaNodeBuilder) {
74 result = new ListSchemaNodeBuilder((ListSchemaNodeBuilder) lookedUpBuilder);
75 } else if (lookedUpBuilder instanceof LeafListSchemaNodeBuilder) {
76 result = new LeafListSchemaNodeBuilder((LeafListSchemaNodeBuilder) lookedUpBuilder);
77 } else if (lookedUpBuilder instanceof ChoiceBuilder) {
78 result = new ChoiceBuilder((ChoiceBuilder) lookedUpBuilder);
79 } else if (lookedUpBuilder instanceof AnyXmlBuilder) {
80 result = new AnyXmlBuilder((AnyXmlBuilder) lookedUpBuilder);
81 } else if (lookedUpBuilder instanceof GroupingBuilder) {
82 result = new GroupingBuilderImpl((GroupingBuilder) lookedUpBuilder);
83 } else if (lookedUpBuilder instanceof TypeDefinitionBuilder) {
84 result = new TypeDefinitionBuilderImpl((TypeDefinitionBuilder) lookedUpBuilder);
86 throw new YangParseException(moduleName, refine.getLine(), "Target '" + refine.getName()
87 + "' can not be refined");
89 return (SchemaNodeBuilder) result;
93 * Create builder object from refine target node.
96 * grouping which should contains node to refine
98 * refine object containing informations about refine
101 public static SchemaNodeBuilder getRefineNodeFromGroupingDefinition(final GroupingDefinition grouping,
102 final RefineHolder refine) {
103 final String moduleName = refine.getModuleName();
104 final int line = refine.getLine();
105 SchemaNodeBuilder result = null;
106 final Object lookedUpNode = findRefineTargetNode(grouping, refine.getName());
107 if (lookedUpNode instanceof LeafSchemaNode) {
108 result = createLeafBuilder((LeafSchemaNode) lookedUpNode, moduleName, line);
109 } else if (lookedUpNode instanceof ContainerSchemaNode) {
110 result = createContainer((ContainerSchemaNode) lookedUpNode, moduleName, line);
111 } else if (lookedUpNode instanceof ListSchemaNode) {
112 result = createList((ListSchemaNode) lookedUpNode, moduleName, line);
113 } else if (lookedUpNode instanceof LeafListSchemaNode) {
114 result = createLeafList((LeafListSchemaNode) lookedUpNode, moduleName, line);
115 } else if (lookedUpNode instanceof ChoiceNode) {
116 result = createChoice((ChoiceNode) lookedUpNode, moduleName, line);
117 } else if (lookedUpNode instanceof AnyXmlSchemaNode) {
118 result = createAnyXml((AnyXmlSchemaNode) lookedUpNode, moduleName, line);
119 } else if (lookedUpNode instanceof GroupingDefinition) {
120 result = createGrouping((GroupingDefinition) lookedUpNode, moduleName, line);
121 } else if (lookedUpNode instanceof TypeDefinition) {
122 result = createTypedef((ExtendedType) lookedUpNode, moduleName, line);
124 throw new YangParseException(moduleName, line, "Target '" + refine.getName() + "' can not be refined");
129 public static void refineLeaf(LeafSchemaNodeBuilder leaf, RefineHolder refine) {
130 String defaultStr = refine.getDefaultStr();
131 Boolean mandatory = refine.isMandatory();
132 MustDefinition must = refine.getMust();
133 List<UnknownSchemaNodeBuilder> unknownNodes = refine.getUnknownNodeBuilders();
135 if (defaultStr != null && !("".equals(defaultStr))) {
136 leaf.setDefaultStr(defaultStr);
138 if (mandatory != null) {
139 leaf.getConstraints().setMandatory(mandatory);
142 leaf.getConstraints().addMustDefinition(must);
144 if (unknownNodes != null) {
145 for (UnknownSchemaNodeBuilder unknown : unknownNodes) {
146 leaf.addUnknownNodeBuilder(unknown);
151 public static void refineContainer(ContainerSchemaNodeBuilder container, RefineHolder refine, int line) {
152 Boolean presence = refine.isPresence();
153 MustDefinition must = refine.getMust();
154 List<UnknownSchemaNodeBuilder> unknownNodes = refine.getUnknownNodeBuilders();
156 if (presence != null) {
157 container.setPresence(presence);
160 container.getConstraints().addMustDefinition(must);
162 if (unknownNodes != null) {
163 for (UnknownSchemaNodeBuilder unknown : unknownNodes) {
164 container.addUnknownNodeBuilder(unknown);
169 public static void refineList(ListSchemaNodeBuilder list, RefineHolder refine, int line) {
170 MustDefinition must = refine.getMust();
171 Integer min = refine.getMinElements();
172 Integer max = refine.getMaxElements();
173 List<UnknownSchemaNodeBuilder> unknownNodes = refine.getUnknownNodeBuilders();
176 list.getConstraints().addMustDefinition(must);
179 list.getConstraints().setMinElements(min);
182 list.getConstraints().setMaxElements(max);
184 if (unknownNodes != null) {
185 for (UnknownSchemaNodeBuilder unknown : unknownNodes) {
186 list.addUnknownNodeBuilder(unknown);
191 public static void refineLeafList(LeafListSchemaNodeBuilder leafList, RefineHolder refine, int line) {
192 MustDefinition must = refine.getMust();
193 Integer min = refine.getMinElements();
194 Integer max = refine.getMaxElements();
195 List<UnknownSchemaNodeBuilder> unknownNodes = refine.getUnknownNodeBuilders();
198 leafList.getConstraints().addMustDefinition(must);
201 leafList.getConstraints().setMinElements(min);
204 leafList.getConstraints().setMaxElements(max);
206 if (unknownNodes != null) {
207 for (UnknownSchemaNodeBuilder unknown : unknownNodes) {
208 leafList.addUnknownNodeBuilder(unknown);
213 public static void refineChoice(ChoiceBuilder choice, RefineHolder refine, int line) {
214 String defaultStr = refine.getDefaultStr();
215 Boolean mandatory = refine.isMandatory();
216 List<UnknownSchemaNodeBuilder> unknownNodes = refine.getUnknownNodeBuilders();
218 if (defaultStr != null) {
219 choice.setDefaultCase(defaultStr);
221 if (mandatory != null) {
222 choice.getConstraints().setMandatory(mandatory);
224 if (unknownNodes != null) {
225 for (UnknownSchemaNodeBuilder unknown : unknownNodes) {
226 choice.addUnknownNodeBuilder(unknown);
231 public static void refineAnyxml(AnyXmlBuilder anyXml, RefineHolder refine, int line) {
232 Boolean mandatory = refine.isMandatory();
233 MustDefinition must = refine.getMust();
234 List<UnknownSchemaNodeBuilder> unknownNodes = refine.getUnknownNodeBuilders();
236 if (mandatory != null) {
237 anyXml.getConstraints().setMandatory(mandatory);
240 anyXml.getConstraints().addMustDefinition(must);
242 if (unknownNodes != null) {
243 for (UnknownSchemaNodeBuilder unknown : unknownNodes) {
244 anyXml.addUnknownNodeBuilder(unknown);
250 * Check if refine can be performed on given node.
255 * refine object containing information about refine process
257 public static void checkRefine(SchemaNodeBuilder node, RefineHolder refine) {
258 String moduleName = refine.getModuleName();
259 int line = refine.getLine();
260 String name = node.getQName().getLocalName();
262 String defaultStr = refine.getDefaultStr();
263 Boolean mandatory = refine.isMandatory();
264 Boolean presence = refine.isPresence();
265 MustDefinition must = refine.getMust();
266 Integer min = refine.getMinElements();
267 Integer max = refine.getMaxElements();
269 if (node instanceof AnyXmlBuilder) {
270 checkRefineDefault(node, defaultStr, moduleName, line);
271 checkRefinePresence(node, presence, moduleName, line);
272 checkRefineMinMax(name, min, max, moduleName, line);
273 } else if (node instanceof ChoiceBuilder) {
274 checkRefinePresence(node, presence, moduleName, line);
275 checkRefineMust(node, must, moduleName, line);
276 checkRefineMinMax(name, min, max, moduleName, line);
277 } else if (node instanceof ContainerSchemaNodeBuilder) {
278 checkRefineDefault(node, defaultStr, moduleName, line);
279 checkRefineMandatory(node, mandatory, moduleName, line);
280 checkRefineMust(node, must, moduleName, line);
281 checkRefineMinMax(name, min, max, moduleName, line);
282 } else if (node instanceof LeafSchemaNodeBuilder) {
283 checkRefinePresence(node, presence, moduleName, line);
284 checkRefineMinMax(name, min, max, moduleName, line);
285 } else if (node instanceof LeafListSchemaNodeBuilder || node instanceof ListSchemaNodeBuilder) {
286 checkRefineDefault(node, defaultStr, moduleName, line);
287 checkRefinePresence(node, presence, moduleName, line);
288 checkRefineMandatory(node, mandatory, moduleName, line);
289 } else if (node instanceof GroupingBuilder || node instanceof TypeDefinitionBuilder
290 || node instanceof UsesNodeBuilder) {
291 checkRefineDefault(node, defaultStr, moduleName, line);
292 checkRefinePresence(node, presence, moduleName, line);
293 checkRefineMandatory(node, mandatory, moduleName, line);
294 checkRefineMust(node, must, moduleName, line);
295 checkRefineMinMax(name, min, max, moduleName, line);
299 private static void checkRefineDefault(SchemaNodeBuilder node, String defaultStr, String moduleName, int line) {
300 if (defaultStr != null) {
301 throw new YangParseException(moduleName, line, "Can not refine 'default' for '"
302 + node.getQName().getLocalName() + "'.");
306 private static void checkRefineMandatory(SchemaNodeBuilder node, Boolean mandatory, String moduleName, int line) {
307 if (mandatory != null) {
308 throw new YangParseException(moduleName, line, "Can not refine 'mandatory' for '"
309 + node.getQName().getLocalName() + "'.");
313 private static void checkRefinePresence(SchemaNodeBuilder node, Boolean presence, String moduleName, int line) {
314 if (presence != null) {
315 throw new YangParseException(moduleName, line, "Can not refine 'presence' for '"
316 + node.getQName().getLocalName() + "'.");
320 private static void checkRefineMust(SchemaNodeBuilder node, MustDefinition must, String moduleName, int line) {
322 throw new YangParseException(moduleName, line, "Can not refine 'must' for '"
323 + node.getQName().getLocalName() + "'.");
327 private static void checkRefineMinMax(String refineTargetName, Integer min, Integer max, String moduleName, int line) {
328 if (min != null || max != null) {
329 throw new YangParseException(moduleName, line, "Can not refine 'min-elements' or 'max-elements' for '"
330 + refineTargetName + "'.");
335 * Perform refine operation of following parameters:
337 * <li>description</li>
342 * These parameters may be refined for any node.
347 * refine object containing information about refine process
349 public static void refineDefault(final Builder node, final RefineHolder refine) {
350 final String moduleName = refine.getModuleName();
351 final int line = refine.getLine();
352 Class<? extends Builder> cls = node.getClass();
354 String description = refine.getDescription();
355 if (description != null) {
357 Method method = cls.getDeclaredMethod("setDescription", String.class);
358 method.invoke(node, description);
359 } catch (Exception e) {
360 throw new YangParseException(moduleName, line, "Cannot refine description in " + cls.getName(), e);
364 String reference = refine.getReference();
365 if (reference != null) {
367 Method method = cls.getDeclaredMethod("setReference", String.class);
368 method.invoke(node, reference);
369 } catch (Exception e) {
370 throw new YangParseException(moduleName, line, "Cannot refine reference in " + cls.getName(), e);
374 Boolean config = refine.isConfiguration();
375 if (config != null) {
377 Method method = cls.getDeclaredMethod("setConfiguration", Boolean.class);
378 method.invoke(node, config);
379 } catch (Exception e) {
380 throw new YangParseException(moduleName, line, "Cannot refine config in " + cls.getName(), e);
386 * Perform refine operation on given node.
388 * @param nodeToRefine
389 * builder of node to refine
391 * refine object containing information about refine process
393 * current line in yang model
395 public static void performRefine(SchemaNodeBuilder nodeToRefine, RefineHolder refine, int line) {
396 checkRefine(nodeToRefine, refine);
397 refineDefault(nodeToRefine, refine);
398 if (nodeToRefine instanceof LeafSchemaNodeBuilder) {
399 refineLeaf((LeafSchemaNodeBuilder) nodeToRefine, refine);
400 } else if (nodeToRefine instanceof ContainerSchemaNodeBuilder) {
401 refineContainer((ContainerSchemaNodeBuilder) nodeToRefine, refine, line);
402 } else if (nodeToRefine instanceof ListSchemaNodeBuilder) {
403 refineList((ListSchemaNodeBuilder) nodeToRefine, refine, line);
404 } else if (nodeToRefine instanceof LeafListSchemaNodeBuilder) {
405 refineLeafList((LeafListSchemaNodeBuilder) nodeToRefine, refine, line);
406 } else if (nodeToRefine instanceof ChoiceBuilder) {
407 refineChoice((ChoiceBuilder) nodeToRefine, refine, line);
408 } else if (nodeToRefine instanceof AnyXmlBuilder) {
409 refineAnyxml((AnyXmlBuilder) nodeToRefine, refine, line);