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.yangtools.yang.parser.util;
10 import java.util.Comparator;
11 import java.util.Date;
14 import java.util.TreeMap;
16 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
17 import org.opendaylight.yangtools.yang.model.api.Module;
18 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
19 import org.opendaylight.yangtools.yang.parser.builder.api.Builder;
20 import org.opendaylight.yangtools.yang.parser.builder.api.DataNodeContainerBuilder;
21 import org.opendaylight.yangtools.yang.parser.builder.api.DataSchemaNodeBuilder;
22 import org.opendaylight.yangtools.yang.parser.builder.api.GroupingBuilder;
23 import org.opendaylight.yangtools.yang.parser.builder.api.UsesNodeBuilder;
24 import org.opendaylight.yangtools.yang.parser.builder.impl.ChoiceBuilder;
25 import org.opendaylight.yangtools.yang.parser.builder.impl.ModuleBuilder;
26 import org.opendaylight.yangtools.yang.parser.builder.impl.RpcDefinitionBuilder;
28 public final class GroupingUtils {
30 private GroupingUtils() {
34 * Search given modules for grouping by name defined in uses node.
37 * builder of uses statement
42 * @return grouping with given name if found, null otherwise
44 public static GroupingBuilder getTargetGroupingFromModules(final UsesNodeBuilder usesBuilder,
45 final Map<String, TreeMap<Date, ModuleBuilder>> modules, final ModuleBuilder module) {
46 final int line = usesBuilder.getLine();
48 final String groupingString = usesBuilder.getGroupingPathAsString();
49 String groupingPrefix;
52 if (groupingString.contains(":")) {
53 String[] splitted = groupingString.split(":");
54 if (splitted.length != 2 || groupingString.contains("/")) {
55 throw new YangParseException(module.getName(), line, "Invalid name of target grouping");
57 groupingPrefix = splitted[0];
58 groupingName = splitted[1];
60 groupingPrefix = module.getPrefix();
61 groupingName = groupingString;
64 ModuleBuilder dependentModule;
65 if (groupingPrefix.equals(module.getPrefix())) {
66 dependentModule = module;
68 dependentModule = ParserUtils.findModuleFromBuilders(modules, module, groupingPrefix, line);
71 if (dependentModule == null) {
75 GroupingBuilder result;
76 Set<GroupingBuilder> groupings = dependentModule.getGroupingBuilders();
77 result = findGroupingBuilder(groupings, groupingName);
82 Builder parent = usesBuilder.getParent();
84 while (parent != null) {
85 if (parent instanceof DataNodeContainerBuilder) {
86 groupings = ((DataNodeContainerBuilder) parent).getGroupingBuilders();
87 } else if (parent instanceof RpcDefinitionBuilder) {
88 groupings = ((RpcDefinitionBuilder) parent).getGroupings();
90 result = findGroupingBuilder(groupings, groupingName);
92 parent = parent.getParent();
99 throw new YangParseException(module.getName(), line, "Referenced grouping '" + groupingName
106 * Search context for grouping by name defined in uses node.
109 * builder of uses statement
113 * SchemaContext containing already resolved modules
114 * @return grouping with given name if found, null otherwise
116 public static GroupingDefinition getTargetGroupingFromContext(final UsesNodeBuilder usesBuilder,
117 final ModuleBuilder module, final SchemaContext context) {
118 final int line = usesBuilder.getLine();
119 String groupingString = usesBuilder.getGroupingPathAsString();
120 String groupingPrefix;
123 if (groupingString.contains(":")) {
124 String[] splitted = groupingString.split(":");
125 if (splitted.length != 2 || groupingString.contains("/")) {
126 throw new YangParseException(module.getName(), line, "Invalid name of target grouping");
128 groupingPrefix = splitted[0];
129 groupingName = splitted[1];
131 groupingPrefix = module.getPrefix();
132 groupingName = groupingString;
135 Module dependentModule = ParserUtils.findModuleFromContext(context, module, groupingPrefix, line);
136 return findGroupingDefinition(dependentModule.getGroupings(), groupingName);
140 * Find grouping by name.
143 * collection of grouping builders to search
146 * @return grouping with given name if present in collection, null otherwise
148 public static GroupingBuilder findGroupingBuilder(Set<GroupingBuilder> groupings, String name) {
149 for (GroupingBuilder grouping : groupings) {
150 if (grouping.getQName().getLocalName().equals(name)) {
158 * Find grouping by name.
161 * collection of grouping definitions to search
164 * @return grouping with given name if present in collection, null otherwise
166 public static GroupingDefinition findGroupingDefinition(Set<GroupingDefinition> groupings, String name) {
167 for (GroupingDefinition grouping : groupings) {
168 if (grouping.getQName().getLocalName().equals(name)) {
176 * Perform refinement of uses target grouping nodes. Uses process has to be
180 * uses node containing refine statements
182 public static void performRefine(UsesNodeBuilder usesNode) {
183 for (RefineHolder refine : usesNode.getRefines()) {
184 String refineTargetPath = refine.getName();
186 String[] splitted = refineTargetPath.split("/");
187 Builder currentNode = usesNode.getParent();
188 for (String pathElement : splitted) {
189 if (currentNode instanceof DataNodeContainerBuilder) {
190 currentNode = ((DataNodeContainerBuilder) currentNode).getDataChildByName(pathElement);
191 } else if (currentNode instanceof ChoiceBuilder) {
192 currentNode = ((ChoiceBuilder) currentNode).getCaseNodeByName(pathElement);
196 DataSchemaNodeBuilder nodeToRefine = (DataSchemaNodeBuilder) currentNode;
197 if (nodeToRefine == null) {
198 throw new YangParseException(refine.getModuleName(), refine.getLine(), "Refine target node '"
199 + refine.getName() + "' not found");
201 RefineUtils.performRefine(nodeToRefine, refine);
202 usesNode.addRefineNode(nodeToRefine);
206 public static class UsesComparator implements Comparator<UsesNodeBuilder> {
208 public int compare(UsesNodeBuilder o1, UsesNodeBuilder o2) {
209 return getElementPosition(o2) - getElementPosition(o1);
213 private static int getElementPosition(UsesNodeBuilder usesNode) {
215 Builder parent = usesNode.getParent();
216 while (!(parent instanceof ModuleBuilder)) {
217 parent = parent.getParent();