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.impl;
10 import com.google.common.collect.Maps;
11 import com.google.common.collect.Sets;
12 import java.util.ArrayList;
13 import java.util.Collection;
14 import java.util.HashSet;
15 import java.util.List;
18 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
19 import org.opendaylight.yangtools.yang.parser.builder.api.AugmentationSchemaBuilder;
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.ChoiceCaseBuilder;
26 import org.opendaylight.yangtools.yang.parser.util.NodeWrappedType;
27 import org.opendaylight.yangtools.yang.parser.util.TopologicalSort;
28 import org.opendaylight.yangtools.yang.parser.util.TopologicalSort.Node;
30 public final class GroupingSort {
31 private GroupingSort() {
32 throw new UnsupportedOperationException("Utility class should not be instantiated");
36 * Sorts set <code>groupingDefinitions</code> according to the mutual
39 * Elements of <code>groupingDefinitions</code> are firstly transformed to
40 * {@link org.opendaylight.yangtools.yang.parser.util.TopologicalSort.Node
41 * Node} interfaces and then are sorted by
42 * {@link org.opendaylight.yangtools.yang.parser.util.TopologicalSort#sort(Set)
43 * sort()} method of <code>TopologicalSort</code>.<br />
47 * <i>Definition of dependency relation:<br />
48 * The first <code>GroupingDefinition</code> object (in this context)
49 * depends on second <code>GroupingDefinition</code> object if the first one
50 * contains in its set of <code>UsesNode</code> (obtained through
51 * {@link org.opendaylight.yangtools.yang.model.api.DataNodeContainer#getUses()
52 * getUses} method) reference to the second one.</i>
54 * @param groupingDefinitions
55 * set of grouping definition which should be sorted according to
57 * @return list of grouping definitions which are sorted by mutual
59 * @throws IllegalArgumentException
60 * if <code>groupingDefinitions</code>
63 public static List<GroupingBuilder> sort(final Collection<GroupingBuilder> groupingDefinitions) {
64 if (groupingDefinitions == null) {
65 throw new IllegalArgumentException("Set of Type Definitions " + "cannot be NULL!");
68 final List<GroupingBuilder> resultGroupingDefinitions = new ArrayList<>();
69 final Set<Node> unsorted = groupingDefinitionsToNodes(groupingDefinitions);
70 final List<Node> sortedNodes = TopologicalSort.sort(unsorted);
71 for (Node node : sortedNodes) {
72 NodeWrappedType nodeWrappedType = (NodeWrappedType) node;
73 resultGroupingDefinitions.add((GroupingBuilder) (nodeWrappedType.getWrappedType()));
75 return resultGroupingDefinitions;
80 * Wraps every grouping definition to node type and adds to every node
81 * information about dependencies.
83 * The map with mapping from schema path (represents grouping definition) to
84 * node is created. For every created node (next <i>nodeFrom</i>) is for its
85 * wrapped grouping definition passed the set of its <i>uses nodes</i>
86 * through. For every uses node is found its wrapping node (next as
87 * <i>nodeTo</i>). This dependency relationship between nodeFrom and all
88 * found nodesTo is modeled with creating of one edge from nodeFrom to
92 * @param groupingDefinitions
93 * set of goruping definition which will be wrapped to nodes
95 * @return set of nodes where every one contains wrapped grouping definition
97 private static Set<Node> groupingDefinitionsToNodes(final Collection<GroupingBuilder> groupingDefinitions) {
98 final Map<SchemaPath, Node> nodeMap = Maps.newHashMap();
99 final Set<Node> resultNodes = Sets.newHashSet();
101 for (final GroupingBuilder groupingDefinition : groupingDefinitions) {
102 final Node node = new NodeWrappedType(groupingDefinition);
103 nodeMap.put(groupingDefinition.getPath(), node);
104 resultNodes.add(node);
107 for (final Node node : resultNodes) {
108 final NodeWrappedType nodeWrappedType = (NodeWrappedType) node;
109 final GroupingBuilder groupingDefinition = (GroupingBuilder) nodeWrappedType.getWrappedType();
111 Set<UsesNodeBuilder> usesNodes = getAllUsesNodes(groupingDefinition);
112 for (UsesNodeBuilder usesNode : usesNodes) {
113 SchemaPath schemaPath = usesNode.getGroupingBuilder().getPath();
114 Node nodeTo = nodeMap.get(schemaPath);
115 if (nodeTo == null) {
116 throw new IllegalArgumentException("target grouping not found for uses " + usesNode);
118 nodeWrappedType.addEdge(nodeTo);
126 * Returns the set of the uses nodes which are get from uses in
127 * <code>container</code>, from uses in groupings inside
128 * <code>container</code> and from uses inside child nodes of the
129 * <code>container</code>.
132 * data node container which can contain some uses of grouping
133 * @return set of uses nodes which were find in <code>container</code>.
135 public static Set<UsesNodeBuilder> getAllUsesNodes(final DataNodeContainerBuilder container) {
136 Set<UsesNodeBuilder> ret = new HashSet<>();
137 Set<UsesNodeBuilder> usesNodes = container.getUsesNodeBuilders();
138 ret.addAll(usesNodes);
140 for (UsesNodeBuilder usesNode : usesNodes) {
141 for (AugmentationSchemaBuilder augment : usesNode.getAugmentations()) {
142 ret.addAll(getAllUsesNodes(augment));
145 Set<GroupingBuilder> groupings = container.getGroupingBuilders();
146 for (GroupingBuilder groupingDefinition : groupings) {
147 ret.addAll(getAllUsesNodes(groupingDefinition));
149 Set<DataSchemaNodeBuilder> childNodes = container.getChildNodeBuilders();
150 for (DataSchemaNodeBuilder childNode : childNodes) {
151 if (childNode instanceof DataNodeContainerBuilder) {
152 ret.addAll(getAllUsesNodes((DataNodeContainerBuilder) childNode));
153 } else if (childNode instanceof ChoiceBuilder) {
154 Set<ChoiceCaseBuilder> cases = ((ChoiceBuilder) childNode).getCases();
155 for (ChoiceCaseBuilder choiceCaseNode : cases) {
156 ret.addAll(getAllUsesNodes(choiceCaseNode));