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;
13 import java.util.ArrayList;
14 import java.util.Collection;
15 import java.util.HashSet;
16 import java.util.List;
20 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
21 import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
22 import org.opendaylight.yangtools.yang.model.api.ChoiceNode;
23 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
24 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
25 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
26 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
27 import org.opendaylight.yangtools.yang.model.api.UsesNode;
28 import org.opendaylight.yangtools.yang.parser.util.TopologicalSort;
29 import org.opendaylight.yangtools.yang.parser.util.TopologicalSort.Node;
31 public class GroupingDefinitionDependencySort {
34 * Sorts set <code>groupingDefinitions</code> according to the mutual
37 * Elements of <code>groupingDefinitions</code> are firstly transformed to
38 * {@link org.opendaylight.yangtools.yang.parser.util.TopologicalSort.Node
39 * Node} interfaces and then are sorted by
40 * {@link org.opendaylight.yangtools.yang.parser.util.TopologicalSort#sort(Set)
41 * sort()} method of <code>TopologicalSort</code>.<br />
45 * <i>Definition of dependency relation:<br />
46 * The first <code>GroupingDefinition</code> object (in this context)
47 * depends on second <code>GroupingDefinition</code> object if the first one
48 * contains in its set of <code>UsesNode</code> (obtained through
49 * {@link org.opendaylight.yangtools.yang.model.api.DataNodeContainer#getUses()
50 * getUses} method) reference to the second one.</i>
52 * @param groupingDefinitions
53 * set of grouping definition which should be sorted according to
55 * @return list of grouping definitiond which are sorted by mutual
57 * @throws IllegalArgumentException
58 * if <code>groupingDefinitions</code>
61 public List<GroupingDefinition> sort(final Collection<GroupingDefinition> groupingDefinitions) {
62 if (groupingDefinitions == null) {
63 throw new IllegalArgumentException("Set of Type Definitions " + "cannot be NULL!");
66 final List<GroupingDefinition> resultGroupingDefinitions = new ArrayList<GroupingDefinition>();
67 final Set<Node> unsorted = groupingDefinitionsToNodes(groupingDefinitions);
68 final List<Node> sortedNodes = TopologicalSort.sort(unsorted);
69 for (Node node : sortedNodes) {
70 NodeWrappedType nodeWrappedType = (NodeWrappedType) node;
71 resultGroupingDefinitions.add((GroupingDefinition) (nodeWrappedType.getWrappedType()));
73 return resultGroupingDefinitions;
78 * Wraps every grouping definition to node type and adds to every node
79 * information about dependencies.
81 * The map with mapping from schema path (represents grouping definition) to
82 * node is created. For every created node (next <i>nodeFrom</i>) is for its
83 * wrapped grouping definition passed the set of its <i>uses nodes</i>
84 * through. For every uses node is found its wrapping node (next as
85 * <i>nodeTo</i>). This dependency relationship between nodeFrom and all
86 * found nodesTo is modeled with creating of one edge from nodeFrom to
90 * @param groupingDefinitions
91 * set of goruping definition which will be wrapped to nodes
93 * @return set of nodes where every one contains wrapped grouping definition
95 private Set<Node> groupingDefinitionsToNodes(final Collection<GroupingDefinition> groupingDefinitions) {
96 final Map<SchemaPath, Node> nodeMap = Maps.newHashMap();
97 final Set<Node> resultNodes = Sets.newHashSet();
99 for (final GroupingDefinition groupingDefinition : groupingDefinitions) {
100 final Node node = new NodeWrappedType(groupingDefinition);
101 nodeMap.put(groupingDefinition.getPath(), node);
102 resultNodes.add(node);
105 for (final Node node : resultNodes) {
106 final NodeWrappedType nodeWrappedType = (NodeWrappedType) node;
107 final GroupingDefinition groupingDefinition = (GroupingDefinition) nodeWrappedType.getWrappedType();
109 Set<UsesNode> usesNodes = getAllUsesNodes(groupingDefinition);
111 for (UsesNode usesNode : usesNodes) {
112 SchemaPath schemaPath = usesNode.getGroupingPath();
113 if (schemaPath != null) {
114 Node nodeTo = nodeMap.get(schemaPath);
115 if (nodeTo != null) {
116 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 private Set<UsesNode> getAllUsesNodes(final DataNodeContainer container) {
136 Set<UsesNode> ret = new HashSet<>();
137 Set<UsesNode> usesNodes = container.getUses();
138 ret.addAll(usesNodes);
140 for (UsesNode usesNode : usesNodes) {
141 for (AugmentationSchema augment : usesNode.getAugmentations()) {
142 ret.addAll(getAllUsesNodes(augment));
145 Set<GroupingDefinition> groupings = container.getGroupings();
146 for (GroupingDefinition groupingDefinition : groupings) {
147 ret.addAll(getAllUsesNodes(groupingDefinition));
149 for (DataSchemaNode childNode : container.getChildNodes()) {
150 if (childNode instanceof DataNodeContainer) {
151 ret.addAll(getAllUsesNodes((DataNodeContainer) childNode));
152 } else if (childNode instanceof ChoiceNode) {
153 Set<ChoiceCaseNode> cases = ((ChoiceNode) childNode).getCases();
154 for (ChoiceCaseNode choiceCaseNode : cases) {
155 ret.addAll(getAllUsesNodes(choiceCaseNode));