binding/mdsal-binding-generator-impl/src/main/java/org/opendaylight/mdsal/binding/generator/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.mdsal.binding.generator.util;
   9
  10 import static com.google.common.base.Preconditions.checkNotNull;
  11 import static com.google.common.base.Preconditions.checkState;
  12
  13 import com.google.common.base.Preconditions;
  14 import java.net.URI;
  15 import java.util.Iterator;
  16 import java.util.Optional;
  17 import javax.annotation.Nullable;
  18 import org.opendaylight.yangtools.yang.common.QName;
  19 import org.opendaylight.yangtools.yang.common.Revision;
  20 import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
  21 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
  22 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  23 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  24 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
  25 import org.opendaylight.yangtools.yang.model.api.NamespaceRevisionAware;
  26 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  27 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  28 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  29 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
  30
  31 public final class YangSchemaUtils {
  32     public static final String AUGMENT_IDENTIFIER = "augment-identifier";
  33
  34     private YangSchemaUtils() {
  35         throw new UnsupportedOperationException("Helper class. Instantiation is prohibited");
  36     }
  37
  38     public static QName getAugmentationQName(final AugmentationSchemaNode augmentation) {
  39         checkNotNull(augmentation, "Augmentation must not be null.");
  40         final QName identifier = getAugmentationIdentifier(augmentation);
  41         if(identifier != null) {
  42             return identifier;
  43         }
  44         URI namespace = null;
  45         Optional<Revision> revision = null;
  46         if(augmentation instanceof NamespaceRevisionAware) {
  47             namespace = ((NamespaceRevisionAware) augmentation).getNamespace();
  48             revision = ((NamespaceRevisionAware) augmentation).getRevision();
  49         }
  50         if(namespace == null || revision == null) {
  51             for(final DataSchemaNode child : augmentation.getChildNodes()) {
  52                 // Derive QName from child nodes
  53                 if(!child.isAugmenting()) {
  54                     namespace = child.getQName().getNamespace();
  55                     revision = child.getQName().getRevision();
  56                     break;
  57                 }
  58             }
  59         }
  60         checkState(namespace != null, "Augmentation namespace must not be null");
  61         checkState(revision != null, "Augmentation revision must not be null");
  62         // FIXME: Always return a qname with module namespace.
  63         return QName.create(namespace, revision, "foo_augment");
  64     }
  65
  66     public static QName getAugmentationIdentifier(final AugmentationSchemaNode augmentation) {
  67         for(final UnknownSchemaNode extension : augmentation.getUnknownSchemaNodes()) {
  68             if(AUGMENT_IDENTIFIER.equals(extension.getNodeType().getLocalName())) {
  69                 return extension.getQName();
  70             }
  71         }
  72         return null;
  73     }
  74
  75     @Nullable
  76     public static TypeDefinition<?> findTypeDefinition(final SchemaContext context, final SchemaPath path) {
  77         final Iterator<QName> arguments = path.getPathFromRoot().iterator();
  78         Preconditions.checkArgument(arguments.hasNext(), "Type Definition path must contain at least one element.");
  79
  80         QName currentArg = arguments.next();
  81         DataNodeContainer currentNode = context.findModule(currentArg.getModule()).orElse(null);
  82         if(currentNode == null) {
  83             return null;
  84         }
  85         // Last argument is type definition, so we need to cycle until we hit last argument.
  86         while(arguments.hasNext()) {
  87             // Nested private type - we need to find container/grouping to which type belongs.
  88             final DataSchemaNode child = currentNode.getDataChildByName(currentArg);
  89             if(child instanceof DataNodeContainer) {
  90                 currentNode = (DataNodeContainer) child;
  91             } else if (child instanceof ChoiceSchemaNode) {
  92                 final QName caseQName = arguments.next();
  93                 Preconditions.checkArgument(arguments.hasNext(), "Path must not refer case only.");
  94                 currentNode = ((ChoiceSchemaNode) child).getCaseNodeByName(caseQName);
  95             } else {
  96                 // Search in grouping
  97                 for (final GroupingDefinition grouping : currentNode.getGroupings()) {
  98                     if (currentArg.equals(grouping.getQName())) {
  99                         currentNode = grouping;
 100                         break;
 101                     }
 102                 }
 103             }
 104             currentArg = arguments.next();
 105         }
 106
 107         for(final TypeDefinition<?> typedef : currentNode.getTypeDefinitions()) {
 108             if(typedef.getQName().equals(currentArg)) {
 109                 return typedef;
 110             }
 111         }
 112         return null;
 113     }
 114 }