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.sal.binding.yang.types;
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.AugmentationSchema;
19 import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
20 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
21 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
22 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
23 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
24 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
25 import org.opendaylight.yangtools.yang.model.api.UsesNode;
26 import org.opendaylight.yangtools.yang.parser.util.TopologicalSort;
27 import org.opendaylight.yangtools.yang.parser.util.TopologicalSort.Node;
29 public class GroupingDefinitionDependencySort {
32 * Sorts set <code>groupingDefinitions</code> according to the mutual
35 * Elements of <code>groupingDefinitions</code> are firstly transformed to
36 * {@link org.opendaylight.yangtools.yang.parser.util.TopologicalSort.Node
37 * Node} interfaces and then are sorted by
38 * {@link org.opendaylight.yangtools.yang.parser.util.TopologicalSort#sort(Set)
39 * sort()} method of <code>TopologicalSort</code>.<br>
43 * <i>Definition of dependency relation:<br>
44 * The first <code>GroupingDefinition</code> object (in this context)
45 * depends on second <code>GroupingDefinition</code> object if the first one
46 * contains in its set of <code>UsesNode</code> (obtained through
47 * {@link org.opendaylight.yangtools.yang.model.api.DataNodeContainer#getUses()
48 * getUses} method) reference to the second one.</i>
50 * @param groupingDefinitions
51 * set of grouping definition which should be sorted according to
53 * @return list of grouping definitiond which are sorted by mutual
55 * @throws IllegalArgumentException
56 * if <code>groupingDefinitions</code>
59 public List<GroupingDefinition> sort(final Collection<GroupingDefinition> groupingDefinitions) {
60 if (groupingDefinitions == null) {
61 throw new IllegalArgumentException("Set of Type Definitions " + "cannot be NULL!");
64 final List<GroupingDefinition> resultGroupingDefinitions = new ArrayList<GroupingDefinition>();
65 final Set<Node> unsorted = groupingDefinitionsToNodes(groupingDefinitions);
66 final List<Node> sortedNodes = TopologicalSort.sort(unsorted);
67 for (Node node : sortedNodes) {
68 NodeWrappedType nodeWrappedType = (NodeWrappedType) node;
69 resultGroupingDefinitions.add((GroupingDefinition) (nodeWrappedType.getWrappedType()));
71 return resultGroupingDefinitions;
76 * Wraps every grouping definition to node type and adds to every node
77 * information about dependencies.
79 * The map with mapping from schema path (represents grouping definition) to
80 * node is created. For every created node (next <i>nodeFrom</i>) is for its
81 * wrapped grouping definition passed the set of its <i>uses nodes</i>
82 * through. For every uses node is found its wrapping node (next as
83 * <i>nodeTo</i>). This dependency relationship between nodeFrom and all
84 * found nodesTo is modeled with creating of one edge from nodeFrom to
88 * @param groupingDefinitions
89 * set of goruping definition which will be wrapped to nodes
91 * @return set of nodes where every one contains wrapped grouping definition
93 private Set<Node> groupingDefinitionsToNodes(final Collection<GroupingDefinition> groupingDefinitions) {
94 final Map<SchemaPath, Node> nodeMap = Maps.newHashMap();
95 final Set<Node> resultNodes = Sets.newHashSet();
97 for (final GroupingDefinition groupingDefinition : groupingDefinitions) {
98 final Node node = new NodeWrappedType(groupingDefinition);
99 nodeMap.put(groupingDefinition.getPath(), node);
100 resultNodes.add(node);
103 for (final Node node : resultNodes) {
104 final NodeWrappedType nodeWrappedType = (NodeWrappedType) node;
105 final GroupingDefinition groupingDefinition = (GroupingDefinition) nodeWrappedType.getWrappedType();
107 Set<UsesNode> usesNodes = getAllUsesNodes(groupingDefinition);
109 for (UsesNode usesNode : usesNodes) {
110 SchemaPath schemaPath = usesNode.getGroupingPath();
111 if (schemaPath != null) {
112 Node nodeTo = nodeMap.get(schemaPath);
113 if (nodeTo != null) {
114 nodeWrappedType.addEdge(nodeTo);
124 * Returns the set of the uses nodes which are get from uses in
125 * <code>container</code>, from uses in groupings inside
126 * <code>container</code> and from uses inside child nodes of the
127 * <code>container</code>.
130 * data node container which can contain some uses of grouping
131 * @return set of uses nodes which were find in <code>container</code>.
133 private Set<UsesNode> getAllUsesNodes(final DataNodeContainer container) {
134 Set<UsesNode> ret = new HashSet<>();
135 Set<UsesNode> usesNodes = container.getUses();
136 ret.addAll(usesNodes);
138 for (UsesNode usesNode : usesNodes) {
139 for (AugmentationSchema augment : usesNode.getAugmentations()) {
140 ret.addAll(getAllUsesNodes(augment));
143 Set<GroupingDefinition> groupings = container.getGroupings();
144 for (GroupingDefinition groupingDefinition : groupings) {
145 ret.addAll(getAllUsesNodes(groupingDefinition));
147 for (DataSchemaNode childNode : container.getChildNodes()) {
148 if (childNode instanceof DataNodeContainer) {
149 ret.addAll(getAllUsesNodes((DataNodeContainer) childNode));
150 } else if (childNode instanceof ChoiceSchemaNode) {
151 Set<ChoiceCaseNode> cases = ((ChoiceSchemaNode) childNode).getCases();
152 for (ChoiceCaseNode choiceCaseNode : cases) {
153 ret.addAll(getAllUsesNodes(choiceCaseNode));