yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/DataNodeIterator.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.model.util;
   9
  10 import java.util.ArrayList;
  11 import java.util.Iterator;
  12 import java.util.List;
  13 import java.util.Set;
  14
  15 import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
  16 import org.opendaylight.yangtools.yang.model.api.ChoiceNode;
  17 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  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.ListSchemaNode;
  22 import org.opendaylight.yangtools.yang.model.api.Module;
  23 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
  24 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  25
  26 public class DataNodeIterator implements Iterator<DataSchemaNode> {
  27
  28     private final DataNodeContainer container;
  29     private final List<ListSchemaNode> allLists;
  30     private final List<ContainerSchemaNode> allContainers;
  31     private final List<ChoiceNode> allChoices;
  32     private final List<DataSchemaNode> allChilds;
  33     private final List<GroupingDefinition> allGroupings;
  34
  35     public DataNodeIterator(final DataNodeContainer container) {
  36         if (container == null) {
  37             throw new IllegalArgumentException("Data Node Container MUST be specified and cannot be NULL!");
  38         }
  39
  40         this.allContainers = new ArrayList<>();
  41         this.allLists = new ArrayList<>();
  42         this.allChilds = new ArrayList<>();
  43         this.allChoices = new ArrayList<>();
  44         this.allGroupings = new ArrayList<>();
  45
  46         this.container = container;
  47         traverse(this.container);
  48     }
  49
  50     public List<ContainerSchemaNode> allContainers() {
  51         return allContainers;
  52     }
  53
  54     public List<ListSchemaNode> allLists() {
  55         return allLists;
  56     }
  57
  58     public List<ChoiceNode> allChoices() {
  59         return allChoices;
  60     }
  61
  62     public List<GroupingDefinition> allGroupings() {
  63         return allGroupings;
  64     }
  65
  66     private void traverse(final DataNodeContainer dataNode) {
  67         if (dataNode == null) {
  68             return;
  69         }
  70
  71         final Set<DataSchemaNode> childNodes = dataNode.getChildNodes();
  72         if (childNodes != null) {
  73             for (DataSchemaNode childNode : childNodes) {
  74                 if (childNode.isAugmenting()) {
  75                     continue;
  76                 }
  77                 allChilds.add(childNode);
  78                 if (childNode instanceof ContainerSchemaNode) {
  79                     final ContainerSchemaNode containerNode = (ContainerSchemaNode) childNode;
  80                     allContainers.add(containerNode);
  81                     traverse(containerNode);
  82                 } else if (childNode instanceof ListSchemaNode) {
  83                     final ListSchemaNode list = (ListSchemaNode) childNode;
  84                     allLists.add(list);
  85                     traverse(list);
  86                 } else if (childNode instanceof ChoiceNode) {
  87                     final ChoiceNode choiceNode = (ChoiceNode) childNode;
  88                     allChoices.add(choiceNode);
  89                     final Set<ChoiceCaseNode> cases = choiceNode.getCases();
  90                     if (cases != null) {
  91                         for (final ChoiceCaseNode caseNode : cases) {
  92                             traverse(caseNode);
  93                         }
  94                     }
  95                 }
  96             }
  97         }
  98
  99         traverseModule(dataNode);
 100         traverseGroupings(dataNode);
 101
 102     }
 103
 104     private void traverseModule(DataNodeContainer dataNode) {
 105         final Module module;
 106         if (dataNode instanceof Module) {
 107             module = (Module) dataNode;
 108         } else {
 109             return;
 110         }
 111         final Set<NotificationDefinition> notifications = module.getNotifications();
 112         for (NotificationDefinition notificationDefinition : notifications) {
 113             traverse(notificationDefinition);
 114         }
 115         final Set<RpcDefinition> rpcs = module.getRpcs();
 116         for (RpcDefinition rpcDefinition : rpcs) {
 117             ContainerSchemaNode input = rpcDefinition.getInput();
 118             if (input != null) {
 119                 traverse(input);
 120             }
 121             ContainerSchemaNode output = rpcDefinition.getInput();
 122             if (input != null) {
 123                 traverse(output);
 124             }
 125         }
 126     }
 127
 128     private void traverseGroupings(DataNodeContainer dataNode) {
 129         final Set<GroupingDefinition> groupings = dataNode.getGroupings();
 130         if (groupings != null) {
 131             for (GroupingDefinition grouping : groupings) {
 132                 allGroupings.add(grouping);
 133                 traverse(grouping);
 134             }
 135         }
 136     }
 137
 138     @Override
 139     public boolean hasNext() {
 140         if (container.getChildNodes() != null) {
 141             final Set<DataSchemaNode> childNodes = container.getChildNodes();
 142
 143             if ((childNodes != null) && !childNodes.isEmpty()) {
 144                 return childNodes.iterator().hasNext();
 145             }
 146         }
 147         return false;
 148     }
 149
 150     @Override
 151     public DataSchemaNode next() {
 152         return allChilds.iterator().next();
 153     }
 154
 155     @Override
 156     public void remove() {
 157         throw new UnsupportedOperationException();
 158     }
 159 }