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.mdsal.binding.yang.types;
10 import java.util.ArrayList;
11 import java.util.Collection;
12 import java.util.HashMap;
13 import java.util.HashSet;
14 import java.util.List;
17 import org.opendaylight.yangtools.util.TopologicalSort;
18 import org.opendaylight.yangtools.util.TopologicalSort.Node;
19 import org.opendaylight.yangtools.yang.model.api.ActionDefinition;
20 import org.opendaylight.yangtools.yang.model.api.ActionNodeContainer;
21 import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
22 import org.opendaylight.yangtools.yang.model.api.CaseSchemaNode;
23 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
24 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
25 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
26 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
27 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
28 import org.opendaylight.yangtools.yang.model.api.NotificationNodeContainer;
29 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
30 import org.opendaylight.yangtools.yang.model.api.UsesNode;
32 public class GroupingDefinitionDependencySort {
34 * Sorts set {@code groupingDefinitions} according to the mutual dependencies.<br>
35 * Elements of {@code groupingDefinitions} are firstly transformed to {@link Node} interfaces and then are
36 * sorted by {@link TopologicalSort#sort(Set) sort()} method of {@code TopologicalSort}.<br>
38 * <i>Definition of dependency relation:<br>
39 * The first {@code GroupingDefinition} object (in this context) depends on second {@code GroupingDefinition} object
40 * if the first one contains in its set of {@code UsesNode} (obtained through {@link DataNodeContainer#getUses()})
41 * a reference to the second one.
44 * @param groupingDefinitions set of grouping definition which should be sorted according to mutual dependencies
45 * @return list of grouping definitions which are sorted by mutual dependencies
46 * @throws IllegalArgumentException if {@code groupingDefinitions}
49 public List<GroupingDefinition> sort(final Collection<GroupingDefinition> groupingDefinitions) {
50 if (groupingDefinitions == null) {
51 throw new IllegalArgumentException("Set of Type Definitions cannot be NULL!");
54 final List<Node> sortedNodes = TopologicalSort.sort(groupingDefinitionsToNodes(groupingDefinitions));
55 final List<GroupingDefinition> resultGroupingDefinitions = new ArrayList<>(sortedNodes.size());
56 for (Node node : sortedNodes) {
57 NodeWrappedType nodeWrappedType = (NodeWrappedType) node;
58 resultGroupingDefinitions.add((GroupingDefinition) nodeWrappedType.getWrappedType());
60 return resultGroupingDefinitions;
64 * Wraps every grouping definition to node type and adds to every node information about dependencies. The map
65 * with mapping from schema path (represents grouping definition) to node is created. For every created node
66 * (next <i>nodeFrom</i>) is for its wrapped grouping definition passed the set of its <i>uses nodes</i> through.
67 * For every uses node is found its wrapping node (next as <i>nodeTo</i>). This dependency relationship between
68 * nodeFrom and all found nodesTo is modeled with creating of one edge from nodeFrom to nodeTo.
70 * @param groupingDefinitions set of grouping definition which will be wrapped to nodes
71 * @return set of nodes where every one contains wrapped grouping definition
73 private Set<Node> groupingDefinitionsToNodes(final Collection<GroupingDefinition> groupingDefinitions) {
74 final Map<SchemaPath, Node> nodeMap = new HashMap<>();
75 final Set<Node> resultNodes = new HashSet<>();
77 for (final GroupingDefinition groupingDefinition : groupingDefinitions) {
78 final Node node = new NodeWrappedType(groupingDefinition);
79 nodeMap.put(groupingDefinition.getPath(), node);
80 resultNodes.add(node);
83 for (final Node node : resultNodes) {
84 final NodeWrappedType nodeWrappedType = (NodeWrappedType) node;
85 final GroupingDefinition groupingDefinition = (GroupingDefinition) nodeWrappedType.getWrappedType();
87 Set<UsesNode> usesNodes = getAllUsesNodes(groupingDefinition);
89 for (UsesNode usesNode : usesNodes) {
90 SchemaPath schemaPath = usesNode.getGroupingPath();
91 if (schemaPath != null) {
92 Node nodeTo = nodeMap.get(schemaPath);
94 nodeWrappedType.addEdge(nodeTo);
104 * Returns the set of the uses nodes which are get from uses in <code>container</code>, from uses in groupings
105 * inside <code>container</code> and from uses inside child nodes of the <code>container</code>.
107 * @param container data node container which can contain some uses of grouping
108 * @return set of uses nodes which were find in <code>container</code>.
110 private Set<UsesNode> getAllUsesNodes(final DataNodeContainer container) {
111 Set<UsesNode> ret = new HashSet<>();
112 Set<UsesNode> usesNodes = container.getUses();
113 ret.addAll(usesNodes);
115 for (UsesNode usesNode : usesNodes) {
116 for (AugmentationSchemaNode augment : usesNode.getAugmentations()) {
117 ret.addAll(getAllUsesNodes(augment));
120 for (GroupingDefinition groupingDefinition : container.getGroupings()) {
121 ret.addAll(getAllUsesNodes(groupingDefinition));
123 for (DataSchemaNode childNode : container.getChildNodes()) {
124 if (childNode instanceof DataNodeContainer) {
125 ret.addAll(getAllUsesNodes((DataNodeContainer) childNode));
126 } else if (childNode instanceof ChoiceSchemaNode) {
127 for (CaseSchemaNode choiceCaseNode : ((ChoiceSchemaNode) childNode).getCases().values()) {
128 ret.addAll(getAllUsesNodes(choiceCaseNode));
132 if (container instanceof ActionNodeContainer) {
133 for (ActionDefinition action : ((ActionNodeContainer) container).getActions()) {
134 ret.addAll(getAllUsesNodes(action.getInput()));
135 ret.addAll(getAllUsesNodes(action.getOutput()));
138 if (container instanceof NotificationNodeContainer) {
139 for (NotificationDefinition notification : ((NotificationNodeContainer) container).getNotifications()) {
140 ret.addAll(getAllUsesNodes(notification));