code-generator/binding-generator-impl/src/main/java/org/opendaylight/yangtools/sal/binding/yang/types/GroupingDefinitionDependencySort.java

   1 /*
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.yangtools.sal.binding.yang.types;
   9
  10 import java.util.ArrayList;
  11 import java.util.HashSet;
  12 import java.util.List;
  13 import java.util.Map;
  14 import java.util.Set;
  15
  16 import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
  17 import org.opendaylight.yangtools.yang.model.api.ChoiceNode;
  18 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  19 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  20 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
  21 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  22 import org.opendaylight.yangtools.yang.model.api.UsesNode;
  23 import org.opendaylight.yangtools.yang.parser.util.TopologicalSort;
  24 import org.opendaylight.yangtools.yang.parser.util.TopologicalSort.Node;
  25 import org.opendaylight.yangtools.yang.parser.util.TopologicalSort.NodeImpl;
  26 import org.slf4j.Logger;
  27 import org.slf4j.LoggerFactory;
  28
  29 import com.google.common.collect.Maps;
  30 import com.google.common.collect.Sets;
  31
  32 //import org.opendaylight.yangtools.yang.model.util.GroupingDefinition;
  33
  34 public class GroupingDefinitionDependencySort {
  35     private static final Logger logger = LoggerFactory.getLogger(GroupingDefinitionDependencySort.class);
  36
  37     public static List<GroupingDefinition> sort(final Set<GroupingDefinition> groupingDefinitions) {
  38         if (groupingDefinitions == null) {
  39             logger.error("Set of grouping definitions cannot be NULL!");
  40             throw new IllegalArgumentException("Set of Type Definitions " + "cannot be NULL!");
  41         }
  42
  43         final List<GroupingDefinition> resultGroupingDefinitions = new ArrayList<GroupingDefinition>();
  44         final Set<Node> unsorted = groupingDefinitionsToGroupingNodes(groupingDefinitions);
  45         final List<Node> sortedNodes = TopologicalSort.sort(unsorted);
  46         for (Node node : sortedNodes) {
  47             resultGroupingDefinitions.add(((GroupingNode) node).getGroupingDefinition());
  48         }
  49         return resultGroupingDefinitions;
  50
  51     }
  52
  53     private static Set<Node> groupingDefinitionsToGroupingNodes(final Set<GroupingDefinition> groupingDefinitions) {
  54         final Map<SchemaPath, Node> nodeMap = Maps.newHashMap();
  55         final Set<Node> resultNodes = Sets.newHashSet();
  56
  57         for (final GroupingDefinition groupingDefinition : groupingDefinitions) {
  58             final Node node = new GroupingNode(groupingDefinition);
  59             nodeMap.put(groupingDefinition.getPath(), node);
  60             resultNodes.add(node);
  61         }
  62
  63         for (final Node node : resultNodes) {
  64             final GroupingNode groupingNode = (GroupingNode) node;
  65             final GroupingDefinition groupingDefinition = groupingNode.getGroupingDefinition();
  66
  67             Set<UsesNode> usesNodes = getAllUsesNodes(groupingDefinition);
  68             for (UsesNode usesNode : usesNodes) {
  69                 SchemaPath schemaPath = usesNode.getGroupingPath();
  70                 if (schemaPath != null) {
  71                     Node nodeTo = nodeMap.get(schemaPath);
  72                     if (nodeTo != null) {
  73                         groupingNode.addEdge(nodeTo);
  74                     }
  75
  76                 }
  77             }
  78         }
  79
  80         return resultNodes;
  81     }
  82
  83     private static Set<UsesNode> getAllUsesNodes(DataNodeContainer container) {
  84         Set<UsesNode> ret = new HashSet<>();
  85         ret.addAll(container.getUses());
  86
  87         Set<GroupingDefinition> groupings = container.getGroupings();
  88         for (GroupingDefinition groupingDefinition : groupings) {
  89             ret.addAll(getAllUsesNodes(groupingDefinition));
  90         }
  91         Set<DataSchemaNode> children = container.getChildNodes();
  92         for (DataSchemaNode dataSchemaNode : children) {
  93             if (dataSchemaNode instanceof DataNodeContainer) {
  94                 ret.addAll(getAllUsesNodes((DataNodeContainer) dataSchemaNode));
  95             } else if (dataSchemaNode instanceof ChoiceNode) {
  96                 Set<ChoiceCaseNode> cases = ((ChoiceNode) dataSchemaNode).getCases();
  97                 for (ChoiceCaseNode choiceCaseNode : cases) {
  98                     ret.addAll(getAllUsesNodes(choiceCaseNode));
  99                 }
 100
 101             }
 102         }
 103
 104         return ret;
 105
 106     }
 107
 108     private static final class GroupingNode extends NodeImpl {
 109         private final GroupingDefinition groupingDefinition;
 110
 111         GroupingNode(GroupingDefinition groupingDefinition) {
 112             this.groupingDefinition = groupingDefinition;
 113         }
 114
 115         GroupingDefinition getGroupingDefinition() {
 116             return groupingDefinition;
 117         }
 118
 119         @Override
 120         public boolean equals(Object o) {
 121             if (this == o) {
 122                 return true;
 123             }
 124             if (!(o instanceof GroupingNode)) {
 125                 return false;
 126             }
 127             GroupingNode groupingNode = (GroupingNode) o;
 128             if (!groupingDefinition.equals(groupingNode.groupingDefinition)) {
 129                 return false;
 130             }
 131             return true;
 132         }
 133
 134         @Override
 135         public int hashCode() {
 136             return groupingDefinition.hashCode();
 137         }
 138
 139         @Override
 140         public String toString() {
 141             return "GroupingNode{" + "groupingType=" + groupingDefinition + '}';
 142         }
 143     }
 144 }