yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/impl/GroupingSort.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.yang.parser.impl;
   9
  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;
  16 import java.util.Map;
  17 import java.util.Set;
  18 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  19 import org.opendaylight.yangtools.yang.parser.builder.api.AugmentationSchemaBuilder;
  20 import org.opendaylight.yangtools.yang.parser.builder.api.DataNodeContainerBuilder;
  21 import org.opendaylight.yangtools.yang.parser.builder.api.DataSchemaNodeBuilder;
  22 import org.opendaylight.yangtools.yang.parser.builder.api.GroupingBuilder;
  23 import org.opendaylight.yangtools.yang.parser.builder.api.UsesNodeBuilder;
  24 import org.opendaylight.yangtools.yang.parser.builder.impl.ChoiceBuilder;
  25 import org.opendaylight.yangtools.yang.parser.builder.impl.ChoiceCaseBuilder;
  26 import org.opendaylight.yangtools.yang.parser.util.NodeWrappedType;
  27 import org.opendaylight.yangtools.yang.parser.util.TopologicalSort;
  28 import org.opendaylight.yangtools.yang.parser.util.TopologicalSort.Node;
  29
  30 /**
  31  * @deprecated Pre-Beryllium implementation, scheduled for removal.
  32  */
  33 @Deprecated
  34 public final class GroupingSort {
  35     private GroupingSort() {
  36         throw new UnsupportedOperationException("Utility class should not be instantiated");
  37     }
  38
  39     /**
  40      * Sorts set <code>groupingDefinitions</code> according to the mutual
  41      * dependencies.<br>
  42      *
  43      * Elements of <code>groupingDefinitions</code> are firstly transformed to
  44      * {@link org.opendaylight.yangtools.yang.parser.util.TopologicalSort.Node
  45      * Node} interfaces and then are sorted by
  46      * {@link org.opendaylight.yangtools.yang.parser.util.TopologicalSort#sort(Set)
  47      * sort()} method of <code>TopologicalSort</code>.<br>
  48      * <br>
  49      *
  50      *
  51      * <i>Definition of dependency relation:<br>
  52      * The first <code>GroupingDefinition</code> object (in this context)
  53      * depends on second <code>GroupingDefinition</code> object if the first one
  54      * contains in its set of <code>UsesNode</code> (obtained through
  55      * {@link org.opendaylight.yangtools.yang.model.api.DataNodeContainer#getUses()
  56      * getUses} method) reference to the second one.</i>
  57      *
  58      * @param groupingDefinitions
  59      *            set of grouping definition which should be sorted according to
  60      *            mutual dependencies
  61      * @return list of grouping definitions which are sorted by mutual
  62      *         dependencies
  63      * @throws IllegalArgumentException
  64      *             if <code>groupingDefinitions</code>
  65      *
  66      */
  67     public static List<GroupingBuilder> sort(final Collection<GroupingBuilder> groupingDefinitions) {
  68         if (groupingDefinitions == null) {
  69             throw new IllegalArgumentException("Set of Type Definitions " + "cannot be NULL!");
  70         }
  71
  72         final List<GroupingBuilder> resultGroupingDefinitions = new ArrayList<>();
  73         final Set<Node> unsorted = groupingDefinitionsToNodes(groupingDefinitions);
  74         final List<Node> sortedNodes = TopologicalSort.sort(unsorted);
  75         for (Node node : sortedNodes) {
  76             NodeWrappedType nodeWrappedType = (NodeWrappedType) node;
  77             resultGroupingDefinitions.add((GroupingBuilder) (nodeWrappedType.getWrappedType()));
  78         }
  79         return resultGroupingDefinitions;
  80
  81     }
  82
  83     /**
  84      * Wraps every grouping definition to node type and adds to every node
  85      * information about dependencies.
  86      *
  87      * The map with mapping from schema path (represents grouping definition) to
  88      * node is created. For every created node (next <i>nodeFrom</i>) is for its
  89      * wrapped grouping definition passed the set of its <i>uses nodes</i>
  90      * through. For every uses node is found its wrapping node (next as
  91      * <i>nodeTo</i>). This dependency relationship between nodeFrom and all
  92      * found nodesTo is modeled with creating of one edge from nodeFrom to
  93      * nodeTo.
  94      *
  95      *
  96      * @param groupingDefinitions
  97      *            set of goruping definition which will be wrapped to nodes
  98      *
  99      * @return set of nodes where every one contains wrapped grouping definition
 100      */
 101     private static Set<Node> groupingDefinitionsToNodes(final Collection<GroupingBuilder> groupingDefinitions) {
 102         final Map<SchemaPath, Node> nodeMap = Maps.newHashMap();
 103         final Set<Node> resultNodes = Sets.newHashSet();
 104
 105         for (final GroupingBuilder groupingDefinition : groupingDefinitions) {
 106             final Node node = new NodeWrappedType(groupingDefinition);
 107             nodeMap.put(groupingDefinition.getPath(), node);
 108             resultNodes.add(node);
 109         }
 110
 111         for (final Node node : resultNodes) {
 112             final NodeWrappedType nodeWrappedType = (NodeWrappedType) node;
 113             final GroupingBuilder groupingDefinition = (GroupingBuilder) nodeWrappedType.getWrappedType();
 114
 115             Set<UsesNodeBuilder> usesNodes = getAllUsesNodes(groupingDefinition);
 116             for (UsesNodeBuilder usesNode : usesNodes) {
 117                 SchemaPath schemaPath = usesNode.getGroupingBuilder().getPath();
 118                 Node nodeTo = nodeMap.get(schemaPath);
 119                 if (nodeTo == null) {
 120                     throw new IllegalArgumentException("target grouping not found for uses " + usesNode);
 121                 }
 122                 nodeWrappedType.addEdge(nodeTo);
 123             }
 124         }
 125
 126         return resultNodes;
 127     }
 128
 129     /**
 130      * Returns the set of the uses nodes which are get from uses in
 131      * <code>container</code>, from uses in groupings inside
 132      * <code>container</code> and from uses inside child nodes of the
 133      * <code>container</code>.
 134      *
 135      * @param container
 136      *            data node container which can contain some uses of grouping
 137      * @return set of uses nodes which were find in <code>container</code>.
 138      */
 139     public static Set<UsesNodeBuilder> getAllUsesNodes(final DataNodeContainerBuilder container) {
 140         Set<UsesNodeBuilder> ret = new HashSet<>();
 141         List<UsesNodeBuilder> usesNodes = container.getUsesNodeBuilders();
 142         ret.addAll(usesNodes);
 143
 144         for (UsesNodeBuilder usesNode : usesNodes) {
 145             for (AugmentationSchemaBuilder augment : usesNode.getAugmentations()) {
 146                 ret.addAll(getAllUsesNodes(augment));
 147             }
 148         }
 149         Set<GroupingBuilder> groupings = container.getGroupingBuilders();
 150         for (GroupingBuilder groupingDefinition : groupings) {
 151             ret.addAll(getAllUsesNodes(groupingDefinition));
 152         }
 153         List<DataSchemaNodeBuilder> childNodes = container.getChildNodeBuilders();
 154         for (DataSchemaNodeBuilder childNode : childNodes) {
 155             if (childNode instanceof DataNodeContainerBuilder) {
 156                 ret.addAll(getAllUsesNodes((DataNodeContainerBuilder) childNode));
 157             } else if (childNode instanceof ChoiceBuilder) {
 158                 Set<ChoiceCaseBuilder> cases = ((ChoiceBuilder) childNode).getCases();
 159                 for (ChoiceCaseBuilder choiceCaseNode : cases) {
 160                     ret.addAll(getAllUsesNodes(choiceCaseNode));
 161                 }
 162             }
 163         }
 164         return ret;
 165     }
 166
 167 }