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.ArrayList;
11 import java.util.Collection;
12 import java.util.HashSet;
13 import java.util.List;
17 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
18 import org.opendaylight.yangtools.yang.parser.builder.api.AugmentationSchemaBuilder;
19 import org.opendaylight.yangtools.yang.parser.builder.api.DataNodeContainerBuilder;
20 import org.opendaylight.yangtools.yang.parser.builder.api.DataSchemaNodeBuilder;
21 import org.opendaylight.yangtools.yang.parser.builder.api.GroupingBuilder;
22 import org.opendaylight.yangtools.yang.parser.builder.api.UsesNodeBuilder;
23 import org.opendaylight.yangtools.yang.parser.builder.impl.ChoiceBuilder;
24 import org.opendaylight.yangtools.yang.parser.builder.impl.ChoiceCaseBuilder;
25 import org.opendaylight.yangtools.yang.parser.util.TopologicalSort.Node;
27 import com.google.common.collect.Maps;
28 import com.google.common.collect.Sets;
30 public class GroupingSort {
33 * Sorts set <code>groupingDefinitions</code> according to the mutual
36 * Elements of <code>groupingDefinitions</code> are firstly transformed to
37 * {@link org.opendaylight.yangtools.yang.parser.util.TopologicalSort.Node
38 * Node} interfaces and then are sorted by
39 * {@link org.opendaylight.yangtools.yang.parser.util.TopologicalSort#sort(Set)
40 * sort()} method of <code>TopologicalSort</code>.<br />
44 * <i>Definition of dependency relation:<br />
45 * The first <code>GroupingDefinition</code> object (in this context)
46 * depends on second <code>GroupingDefinition</code> object if the first one
47 * contains in its set of <code>UsesNode</code> (obtained through
48 * {@link org.opendaylight.yangtools.yang.model.api.DataNodeContainer#getUses()
49 * getUses} method) reference to the second one.</i>
51 * @param groupingDefinitions
52 * set of grouping definition which should be sorted according to
54 * @return list of grouping definitiond which are sorted by mutual
56 * @throws IllegalArgumentException
57 * if <code>groupingDefinitions</code>
60 public static List<GroupingBuilder> sort(final Collection<GroupingBuilder> groupingDefinitions) {
61 if (groupingDefinitions == null) {
62 throw new IllegalArgumentException("Set of Type Definitions " + "cannot be NULL!");
65 final List<GroupingBuilder> resultGroupingDefinitions = new ArrayList<GroupingBuilder>();
66 final Set<Node> unsorted = groupingDefinitionsToNodes(groupingDefinitions);
67 final List<Node> sortedNodes = TopologicalSort.sort(unsorted);
68 for (Node node : sortedNodes) {
69 NodeWrappedType nodeWrappedType = (NodeWrappedType) node;
70 resultGroupingDefinitions.add((GroupingBuilder) (nodeWrappedType.getWrappedType()));
72 return resultGroupingDefinitions;
77 * Wraps every grouping definition to node type and adds to every node
78 * information about dependencies.
80 * The map with mapping from schema path (represents grouping definition) to
81 * node is created. For every created node (next <i>nodeFrom</i>) is for its
82 * wrapped grouping definition passed the set of its <i>uses nodes</i>
83 * through. For every uses node is found its wrapping node (next as
84 * <i>nodeTo</i>). This dependency relationship between nodeFrom and all
85 * found nodesTo is modeled with creating of one edge from nodeFrom to
89 * @param groupingDefinitions
90 * set of goruping definition which will be wrapped to nodes
92 * @return set of nodes where every one contains wrapped grouping definition
94 private static Set<Node> groupingDefinitionsToNodes(final Collection<GroupingBuilder> groupingDefinitions) {
95 final Map<SchemaPath, Node> nodeMap = Maps.newHashMap();
96 final Set<Node> resultNodes = Sets.newHashSet();
98 for (final GroupingBuilder groupingDefinition : groupingDefinitions) {
99 final Node node = new NodeWrappedType(groupingDefinition);
100 nodeMap.put(groupingDefinition.getPath(), node);
101 resultNodes.add(node);
104 for (final Node node : resultNodes) {
105 final NodeWrappedType nodeWrappedType = (NodeWrappedType) node;
106 final GroupingBuilder groupingDefinition = (GroupingBuilder) nodeWrappedType.getWrappedType();
108 if (groupingDefinition.getQName().getLocalName().equals("rp-object")) {
109 System.out.println();
112 Set<UsesNodeBuilder> usesNodes = getAllUsesNodes(groupingDefinition);
113 for (UsesNodeBuilder usesNode : usesNodes) {
114 SchemaPath schemaPath = usesNode.getGroupingBuilder().getPath();
115 Node nodeTo = nodeMap.get(schemaPath);
116 if (nodeTo == null) {
117 throw new IllegalArgumentException("target grouping not found for uses " + usesNode);
119 nodeWrappedType.addEdge(nodeTo);
127 * Returns the set of the uses nodes which are get from uses in
128 * <code>container</code>, from uses in groupings inside
129 * <code>container</code> and from uses inside child nodes of the
130 * <code>container</code>.
133 * data node container which can contain some uses of grouping
134 * @return set of uses nodes which were find in <code>container</code>.
136 public static Set<UsesNodeBuilder> getAllUsesNodes(DataNodeContainerBuilder container) {
137 Set<UsesNodeBuilder> ret = new HashSet<>();
138 Set<UsesNodeBuilder> usesNodes = container.getUsesNodes();
139 ret.addAll(usesNodes);
141 for (UsesNodeBuilder usesNode : usesNodes) {
142 for (AugmentationSchemaBuilder augment : usesNode.getAugmentations()) {
143 ret.addAll(getAllUsesNodes(augment));
146 Set<GroupingBuilder> groupings = container.getGroupingBuilders();
147 for (GroupingBuilder groupingDefinition : groupings) {
148 ret.addAll(getAllUsesNodes(groupingDefinition));
150 Set<DataSchemaNodeBuilder> childNodes = container.getChildNodeBuilders();
151 for (DataSchemaNodeBuilder childNode : childNodes) {
152 if (childNode instanceof DataNodeContainerBuilder) {
153 ret.addAll(getAllUsesNodes((DataNodeContainerBuilder) childNode));
154 } else if (childNode instanceof ChoiceBuilder) {
155 Set<ChoiceCaseBuilder> cases = ((ChoiceBuilder) childNode).getCases();
156 for (ChoiceCaseBuilder choiceCaseNode : cases) {
157 ret.addAll(getAllUsesNodes(choiceCaseNode));