opendaylight/md-sal/sal-rest-docgen/src/main/java/org/opendaylight/controller/sal/rest/doc/util/RestDocgenUtil.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.rest.doc.util;
   9
  10 import java.net.URI;
  11 import java.util.Date;
  12 import java.util.HashMap;
  13 import java.util.Iterator;
  14 import java.util.Map;
  15 import org.opendaylight.yangtools.yang.common.QName;
  16 import org.opendaylight.yangtools.yang.model.api.Module;
  17 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  18 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  19
  20 public class RestDocgenUtil {
  21
  22     private RestDocgenUtil() {
  23     }
  24
  25     private static Map<URI, Map<Date, Module>> namespaceAndRevisionToModule = new HashMap<URI, Map<Date, Module>>();
  26
  27     /**
  28      * Resolve path argument name for {@code node}.
  29      *
  30      * The name can contain also prefix which consists of module name followed by colon. The module prefix is presented
  31      * if namespace of {@code node} and its parent is different. In other cases only name of {@code node} is returned.
  32      *
  33      * @return name of {@code node}
  34      */
  35     public static String resolvePathArgumentsName(final SchemaNode node, final SchemaContext schemaContext) {
  36         Iterable<QName> schemaPath = node.getPath().getPathTowardsRoot();
  37         Iterator<QName> it = schemaPath.iterator();
  38         QName nodeQName = it.next();
  39
  40         QName parentQName = null;
  41         if (it.hasNext()) {
  42             parentQName = it.next();
  43         }
  44         if (isEqualNamespaceAndRevision(parentQName, nodeQName)) {
  45             return node.getQName().getLocalName();
  46         } else {
  47             return resolveFullNameFromNode(node, schemaContext);
  48         }
  49     }
  50
  51     private synchronized static String resolveFullNameFromNode(final SchemaNode node, final SchemaContext schemaContext) {
  52         final URI namespace = node.getQName().getNamespace();
  53         final Date revision = node.getQName().getRevision();
  54
  55         Map<Date, Module> revisionToModule = namespaceAndRevisionToModule.get(namespace);
  56         if (revisionToModule == null) {
  57             revisionToModule = new HashMap<>();
  58             namespaceAndRevisionToModule.put(namespace, revisionToModule);
  59         }
  60         Module module = revisionToModule.get(revision);
  61         if (module == null) {
  62             module = schemaContext.findModuleByNamespaceAndRevision(namespace, revision);
  63             revisionToModule.put(revision, module);
  64         }
  65         if (module != null) {
  66             return module.getName() + ":" + node.getQName().getLocalName();
  67         }
  68         return node.getQName().getLocalName();
  69     }
  70
  71     public static String resolveNodesName(final SchemaNode node, final Module module, final SchemaContext schemaContext) {
  72         if (node.getQName().getNamespace().equals(module.getQNameModule().getNamespace())
  73                 && node.getQName().getRevision().equals(module.getQNameModule().getRevision())) {
  74             return node.getQName().getLocalName();
  75         } else {
  76             return resolveFullNameFromNode(node, schemaContext);
  77         }
  78     }
  79
  80     private static boolean isEqualNamespaceAndRevision(QName parentQName, QName nodeQName) {
  81         if (parentQName == null) {
  82             if (nodeQName == null) {
  83                 return true;
  84             }
  85             return false;
  86         }
  87         return parentQName.getNamespace().equals(nodeQName.getNamespace())
  88                 && parentQName.getRevision().equals(nodeQName.getRevision());
  89     }
  90 }