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 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.NodeWrappedType;
26 import org.opendaylight.yangtools.yang.parser.util.TopologicalSort;
27 import org.opendaylight.yangtools.yang.parser.util.TopologicalSort.Node;
29 import com.google.common.collect.Maps;
30 import com.google.common.collect.Sets;
32 public final class GroupingSort {
33 private GroupingSort() {
34 throw new UnsupportedOperationException("Utility class should not be instantiated");
38 * Sorts set <code>groupingDefinitions</code> according to the mutual
41 * Elements of <code>groupingDefinitions</code> are firstly transformed to
42 * {@link org.opendaylight.yangtools.yang.parser.util.TopologicalSort.Node
43 * Node} interfaces and then are sorted by
44 * {@link org.opendaylight.yangtools.yang.parser.util.TopologicalSort#sort(Set)
45 * sort()} method of <code>TopologicalSort</code>.<br />
49 * <i>Definition of dependency relation:<br />
50 * The first <code>GroupingDefinition</code> object (in this context)
51 * depends on second <code>GroupingDefinition</code> object if the first one
52 * contains in its set of <code>UsesNode</code> (obtained through
53 * {@link org.opendaylight.yangtools.yang.model.api.DataNodeContainer#getUses()
54 * getUses} method) reference to the second one.</i>
56 * @param groupingDefinitions
57 * set of grouping definition which should be sorted according to
59 * @return list of grouping definitions which are sorted by mutual
61 * @throws IllegalArgumentException
62 * if <code>groupingDefinitions</code>
65 public static List<GroupingBuilder> sort(final Collection<GroupingBuilder> groupingDefinitions) {
66 if (groupingDefinitions == null) {
67 throw new IllegalArgumentException("Set of Type Definitions " + "cannot be NULL!");
70 final List<GroupingBuilder> resultGroupingDefinitions = new ArrayList<GroupingBuilder>();
71 final Set<Node> unsorted = groupingDefinitionsToNodes(groupingDefinitions);
72 final List<Node> sortedNodes = TopologicalSort.sort(unsorted);
73 for (Node node : sortedNodes) {
74 NodeWrappedType nodeWrappedType = (NodeWrappedType) node;
75 resultGroupingDefinitions.add((GroupingBuilder) (nodeWrappedType.getWrappedType()));
77 return resultGroupingDefinitions;
82 * Wraps every grouping definition to node type and adds to every node
83 * information about dependencies.
85 * The map with mapping from schema path (represents grouping definition) to
86 * node is created. For every created node (next <i>nodeFrom</i>) is for its
87 * wrapped grouping definition passed the set of its <i>uses nodes</i>
88 * through. For every uses node is found its wrapping node (next as
89 * <i>nodeTo</i>). This dependency relationship between nodeFrom and all
90 * found nodesTo is modeled with creating of one edge from nodeFrom to
94 * @param groupingDefinitions
95 * set of goruping definition which will be wrapped to nodes
97 * @return set of nodes where every one contains wrapped grouping definition
99 private static Set<Node> groupingDefinitionsToNodes(final Collection<GroupingBuilder> groupingDefinitions) {
100 final Map<SchemaPath, Node> nodeMap = Maps.newHashMap();
101 final Set<Node> resultNodes = Sets.newHashSet();
103 for (final GroupingBuilder groupingDefinition : groupingDefinitions) {
104 final Node node = new NodeWrappedType(groupingDefinition);
105 nodeMap.put(groupingDefinition.getPath(), node);
106 resultNodes.add(node);
109 for (final Node node : resultNodes) {
110 final NodeWrappedType nodeWrappedType = (NodeWrappedType) node;
111 final GroupingBuilder groupingDefinition = (GroupingBuilder) nodeWrappedType.getWrappedType();
113 Set<UsesNodeBuilder> usesNodes = getAllUsesNodes(groupingDefinition);
114 for (UsesNodeBuilder usesNode : usesNodes) {
115 SchemaPath schemaPath = usesNode.getGroupingBuilder().getPath();
116 Node nodeTo = nodeMap.get(schemaPath);
117 if (nodeTo == null) {
118 throw new IllegalArgumentException("target grouping not found for uses " + usesNode);
120 nodeWrappedType.addEdge(nodeTo);
128 * Returns the set of the uses nodes which are get from uses in
129 * <code>container</code>, from uses in groupings inside
130 * <code>container</code> and from uses inside child nodes of the
131 * <code>container</code>.
134 * data node container which can contain some uses of grouping
135 * @return set of uses nodes which were find in <code>container</code>.
137 public static Set<UsesNodeBuilder> getAllUsesNodes(final DataNodeContainerBuilder container) {
138 Set<UsesNodeBuilder> ret = new HashSet<>();
139 Set<UsesNodeBuilder> usesNodes = container.getUsesNodeBuilders();
140 ret.addAll(usesNodes);
142 for (UsesNodeBuilder usesNode : usesNodes) {
143 for (AugmentationSchemaBuilder augment : usesNode.getAugmentations()) {
144 ret.addAll(getAllUsesNodes(augment));
147 Set<GroupingBuilder> groupings = container.getGroupingBuilders();
148 for (GroupingBuilder groupingDefinition : groupings) {
149 ret.addAll(getAllUsesNodes(groupingDefinition));
151 Set<DataSchemaNodeBuilder> childNodes = container.getChildNodeBuilders();
152 for (DataSchemaNodeBuilder childNode : childNodes) {
153 if (childNode instanceof DataNodeContainerBuilder) {
154 ret.addAll(getAllUsesNodes((DataNodeContainerBuilder) childNode));
155 } else if (childNode instanceof ChoiceBuilder) {
156 Set<ChoiceCaseBuilder> cases = ((ChoiceBuilder) childNode).getCases();
157 for (ChoiceCaseBuilder choiceCaseNode : cases) {
158 ret.addAll(getAllUsesNodes(choiceCaseNode));