opendaylight/md-sal/sal-dom-broker/src/main/java/org/opendaylight/controller/sal/dom/broker/util/YangSchemaUtils.java

   1 /*
   2  * Copyright (c) 2014 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.controller.sal.dom.broker.util;
   9
  10
  11 import java.util.Iterator;
  12 import java.util.List;
  13 import java.util.Set;
  14
  15 import org.opendaylight.yangtools.yang.common.QName;
  16 import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier;
  17 import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier.PathArgument;
  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.ChoiceNode;
  21 import org.opendaylight.yangtools.yang.model.api.ConstraintDefinition;
  22 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  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.LeafListSchemaNode;
  27 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
  28 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  29 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  30 import org.opendaylight.yangtools.yang.model.api.Status;
  31 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  32 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
  33 import org.opendaylight.yangtools.yang.model.api.UsesNode;
  34
  35 import static com.google.common.base.Preconditions.*;
  36
  37 import com.google.common.base.Function;
  38 import com.google.common.collect.FluentIterable;
  39
  40 public class YangSchemaUtils {
  41
  42     private static final Function<PathArgument, QName> QNAME_FROM_PATH_ARGUMENT = new Function<PathArgument, QName>(){
  43
  44         @Override
  45         public QName apply(PathArgument input) {
  46             if(input == null) {
  47                 return null;
  48             }
  49             return input.getNodeType();
  50         }
  51     };
  52
  53     private  YangSchemaUtils() {
  54         throw new UnsupportedOperationException("Utility class.");
  55     }
  56
  57
  58     public static DataSchemaNode getSchemaNode(SchemaContext schema,InstanceIdentifier path) {
  59         checkArgument(schema != null,"YANG Schema must not be null.");
  60         checkArgument(path != null,"Path must not be null.");
  61         return getSchemaNode(schema, FluentIterable.from(path.getPath()).transform(QNAME_FROM_PATH_ARGUMENT));
  62     }
  63
  64     public static DataSchemaNode getSchemaNode(SchemaContext schema,Iterable<QName> path) {
  65         checkArgument(schema != null,"YANG Schema must not be null.");
  66         checkArgument(path != null,"Path must not be null.");
  67         if(!path.iterator().hasNext()){
  68             return toRootDataNode(schema);
  69         }
  70
  71         QName firstNode = path.iterator().next();
  72         DataNodeContainer previous = schema.findModuleByNamespaceAndRevision(firstNode.getNamespace(),
  73                 firstNode.getRevision());
  74         Iterator<QName> iterator = path.iterator();
  75
  76         while (iterator.hasNext()) {
  77             checkArgument(previous!= null, "Supplied path does not resolve into valid schema node.");
  78             QName arg = iterator.next();
  79             DataSchemaNode currentNode = previous.getDataChildByName(arg);
  80             if (currentNode == null && previous instanceof DataNodeContainer) {
  81                 currentNode = searchInChoices(previous, arg);
  82             }
  83             if (currentNode instanceof DataNodeContainer) {
  84                 previous = (DataNodeContainer) currentNode;
  85             } else if (currentNode instanceof LeafSchemaNode || currentNode instanceof LeafListSchemaNode) {
  86                 checkArgument(!iterator.hasNext(), "Path nests inside leaf node, which is not allowed.");
  87                 return currentNode;
  88             }
  89             checkState(currentNode != null, "Current node should not be null for %s",path);
  90         }
  91         checkState(previous instanceof DataSchemaNode, "Schema node for %s should be instance of DataSchemaNode. Found %s",path,previous);
  92         return (DataSchemaNode) previous;
  93     }
  94
  95     private static DataSchemaNode searchInChoices(DataNodeContainer node, QName arg) {
  96         Set<DataSchemaNode> children = node.getChildNodes();
  97         for (DataSchemaNode child : children) {
  98             if (child instanceof ChoiceNode) {
  99                 ChoiceNode choiceNode = (ChoiceNode) child;
 100                 DataSchemaNode potential = searchInCases(choiceNode, arg);
 101                 if (potential != null) {
 102                     return potential;
 103                 }
 104             }
 105         }
 106         return null;
 107     }
 108
 109     private static DataSchemaNode searchInCases(ChoiceNode choiceNode, QName arg) {
 110         Set<ChoiceCaseNode> cases = choiceNode.getCases();
 111         for (ChoiceCaseNode caseNode : cases) {
 112             DataSchemaNode node = caseNode.getDataChildByName(arg);
 113             if (node != null) {
 114                 return node;
 115             }
 116         }
 117         return null;
 118     }
 119
 120     private static ContainerSchemaNode toRootDataNode(SchemaContext schema) {
 121         return new NetconfDataRootNode(schema);
 122     }
 123
 124     private static final class NetconfDataRootNode implements ContainerSchemaNode {
 125
 126         public NetconfDataRootNode(SchemaContext schema) {
 127             // TODO Auto-generated constructor stub
 128         }
 129
 130         @Override
 131         public Set<TypeDefinition<?>> getTypeDefinitions() {
 132             // TODO Auto-generated method stub
 133             return null;
 134         }
 135
 136         @Override
 137         public Set<DataSchemaNode> getChildNodes() {
 138             // TODO Auto-generated method stub
 139             return null;
 140         }
 141
 142         @Override
 143         public Set<GroupingDefinition> getGroupings() {
 144             // TODO Auto-generated method stub
 145             return null;
 146         }
 147
 148         @Override
 149         public DataSchemaNode getDataChildByName(QName name) {
 150             // TODO Auto-generated method stub
 151             return null;
 152         }
 153
 154         @Override
 155         public DataSchemaNode getDataChildByName(String name) {
 156             // TODO Auto-generated method stub
 157             return null;
 158         }
 159
 160         @Override
 161         public Set<UsesNode> getUses() {
 162             // TODO Auto-generated method stub
 163             return null;
 164         }
 165
 166         @Override
 167         public Set<AugmentationSchema> getAvailableAugmentations() {
 168             // TODO Auto-generated method stub
 169             return null;
 170         }
 171
 172         @Override
 173         public boolean isAugmenting() {
 174             // TODO Auto-generated method stub
 175             return false;
 176         }
 177
 178         @Override
 179         public boolean isAddedByUses() {
 180             // TODO Auto-generated method stub
 181             return false;
 182         }
 183
 184         @Override
 185         public boolean isConfiguration() {
 186             // TODO Auto-generated method stub
 187             return false;
 188         }
 189
 190         @Override
 191         public ConstraintDefinition getConstraints() {
 192             // TODO Auto-generated method stub
 193             return null;
 194         }
 195
 196         @Override
 197         public QName getQName() {
 198             // TODO Auto-generated method stub
 199             return null;
 200         }
 201
 202         @Override
 203         public SchemaPath getPath() {
 204             // TODO Auto-generated method stub
 205             return null;
 206         }
 207
 208         @Override
 209         public String getDescription() {
 210             // TODO Auto-generated method stub
 211             return null;
 212         }
 213
 214         @Override
 215         public String getReference() {
 216             // TODO Auto-generated method stub
 217             return null;
 218         }
 219
 220         @Override
 221         public Status getStatus() {
 222             // TODO Auto-generated method stub
 223             return null;
 224         }
 225
 226         @Override
 227         public List<UnknownSchemaNode> getUnknownSchemaNodes() {
 228             // TODO Auto-generated method stub
 229             return null;
 230         }
 231
 232         @Override
 233         public boolean isPresenceContainer() {
 234             // TODO Auto-generated method stub
 235             return false;
 236         }
 237
 238     }
 239
 240 }