Remove an orElse(null) indirection
[yangtools.git] / yang / yang-model-util / src / main / java / org / opendaylight / yangtools / yang / model / util / SchemaContextUtil.java
index c7e7e2bf896d6613e999b70111ce40c079f31273..ea1a9bf677ff8c0f804180eb2ada9961a6a8df86 100644 (file)
@@ -15,6 +15,7 @@ import com.google.common.annotations.Beta;
 import com.google.common.annotations.VisibleForTesting;
 import com.google.common.base.Splitter;
 import com.google.common.collect.Iterables;
+import com.google.common.collect.Lists;
 import java.util.ArrayDeque;
 import java.util.ArrayList;
 import java.util.Arrays;
@@ -35,7 +36,7 @@ import org.opendaylight.yangtools.yang.common.UnqualifiedQName;
 import org.opendaylight.yangtools.yang.model.api.ActionNodeContainer;
 import org.opendaylight.yangtools.yang.model.api.CaseSchemaNode;
 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
-import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.ContainerLike;
 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
 import org.opendaylight.yangtools.yang.model.api.DerivableSchemaNode;
@@ -43,6 +44,7 @@ import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
 import org.opendaylight.yangtools.yang.model.api.Module;
 import org.opendaylight.yangtools.yang.model.api.ModuleImport;
+import org.opendaylight.yangtools.yang.model.api.ModuleLike;
 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
 import org.opendaylight.yangtools.yang.model.api.NotificationNodeContainer;
 import org.opendaylight.yangtools.yang.model.api.OperationDefinition;
@@ -54,6 +56,7 @@ import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
+import org.opendaylight.yangtools.yang.model.api.Submodule;
 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
 import org.opendaylight.yangtools.yang.model.api.TypedDataSchemaNode;
 import org.opendaylight.yangtools.yang.model.api.type.InstanceIdentifierTypeDefinition;
@@ -77,6 +80,7 @@ public final class SchemaContextUtil {
     private static final Logger LOG = LoggerFactory.getLogger(SchemaContextUtil.class);
     private static final Splitter COLON_SPLITTER = Splitter.on(':');
     private static final Splitter SLASH_SPLITTER = Splitter.on('/').omitEmptyStrings();
+    private static final Pattern GROUPS_PATTERN = Pattern.compile("\\[(.*?)\\]");
 
     private SchemaContextUtil() {
         // Hidden on purpose
@@ -264,7 +268,12 @@ public final class SchemaContextUtil {
             final SchemaNode actualSchemaNode, final PathExpression relativeXPath) {
         checkState(!relativeXPath.isAbsolute(), "Revision Aware XPath MUST be relative i.e. MUST contains ../, "
                 + "for non relative Revision Aware XPath use findDataSchemaNode method");
-        return resolveRelativeXPath(context, module, relativeXPath.getOriginalString(), actualSchemaNode);
+        return resolveRelativeXPath(context, module, removePredicatesFromXpath(relativeXPath.getOriginalString()),
+                actualSchemaNode);
+    }
+
+    private static String removePredicatesFromXpath(final String xpath) {
+        return GROUPS_PATTERN.matcher(xpath).replaceAll("");
     }
 
     /**
@@ -326,7 +335,7 @@ public final class SchemaContextUtil {
      * @return Notification schema or null, if notification is not present in schema context.
      */
     @Beta
-    public static @Nullable ContainerSchemaNode getRpcDataSchema(final @NonNull SchemaContext schema,
+    public static @Nullable ContainerLike getRpcDataSchema(final @NonNull SchemaContext schema,
             final @NonNull SchemaPath path) {
         requireNonNull(schema, "Schema context must not be null.");
         requireNonNull(path, "Schema path must not be null.");
@@ -355,7 +364,7 @@ public final class SchemaContextUtil {
         for (Module module : context.getModules()) {
             ret.add(moduleToIdentifier(module));
 
-            for (Module submodule : module.getSubmodules()) {
+            for (Submodule submodule : module.getSubmodules()) {
                 ret.add(moduleToIdentifier(submodule));
             }
         }
@@ -363,7 +372,7 @@ public final class SchemaContextUtil {
         return ret;
     }
 
-    private static SourceIdentifier moduleToIdentifier(final Module module) {
+    private static SourceIdentifier moduleToIdentifier(final ModuleLike module) {
         return RevisionSourceIdentifier.create(module.getName(), module.getRevision());
     }
 
@@ -441,10 +450,10 @@ public final class SchemaContextUtil {
         }
 
         if (foundNode == null && parent instanceof ActionNodeContainer) {
-            foundNode = ((ActionNodeContainer) parent).getActions().stream()
-                    .filter(act -> current.equals(act.getQName())).findFirst().orElse(null);
-            if (foundNode != null && nextPath.iterator().hasNext()) {
-                foundNode = findNodeIn(foundNode, nextPath);
+            final Optional<? extends SchemaNode> next = ((ActionNodeContainer) parent).getActions().stream()
+                .filter(act -> current.equals(act.getQName())).findFirst();
+            if (next.isPresent() && nextPath.iterator().hasNext()) {
+                foundNode = findNodeIn(next.orElseThrow(), nextPath);
             }
         }
 
@@ -482,7 +491,7 @@ public final class SchemaContextUtil {
         }
 
         if (foundNode == null && parent instanceof ChoiceSchemaNode) {
-            foundNode = ((ChoiceSchemaNode) parent).getCaseNodeByName(current);
+            foundNode = ((ChoiceSchemaNode) parent).findCase(current).orElse(null);
 
             if (foundNode != null && nextPath.iterator().hasNext()) {
                 foundNode = findNodeIn(foundNode, nextPath);
@@ -490,7 +499,7 @@ public final class SchemaContextUtil {
 
             if (foundNode == null) {
                 // fallback that tries to map into one of the child cases
-                for (final CaseSchemaNode caseNode : ((ChoiceSchemaNode) parent).getCases().values()) {
+                for (final CaseSchemaNode caseNode : ((ChoiceSchemaNode) parent).getCases()) {
                     final DataSchemaNode maybeChild = caseNode.getDataChildByName(current);
                     if (maybeChild != null) {
                         foundNode = findNodeIn(maybeChild, nextPath);
@@ -627,8 +636,7 @@ public final class SchemaContextUtil {
             return module;
         }
 
-        final Set<ModuleImport> imports = module.getImports();
-        for (final ModuleImport mi : imports) {
+        for (final ModuleImport mi : module.getImports()) {
             if (prefix.equals(mi.getPrefix())) {
                 return context.findModule(mi.getModuleName(), mi.getRevision()).orElse(null);
             }
@@ -643,8 +651,8 @@ public final class SchemaContextUtil {
      *            Schema Context
      * @param module
      *            Yang Module
-     * @param relativeXPath
-     *            Non conditional Revision Aware Relative XPath
+     * @param pathStr
+     *            xPath of leafref
      * @param actualSchemaNode
      *            actual schema node
      * @return target schema node
@@ -665,15 +673,47 @@ public final class SchemaContextUtil {
         final int colCount = normalizeXPath(steps);
         final List<String> xpaths = colCount == 0 ? steps : steps.subList(colCount, steps.size());
 
-        final Iterable<QName> schemaNodePath = actualSchemaNode.getPath().getPathFromRoot();
-        if (Iterables.size(schemaNodePath) - colCount >= 0) {
-            return Iterables.concat(Iterables.limit(schemaNodePath, Iterables.size(schemaNodePath) - colCount),
-                Iterables.transform(xpaths, input -> stringPathPartToQName(context, module, input)));
+        final List<QName> walkablePath = createWalkablePath(actualSchemaNode.getPath().getPathFromRoot(),
+                context, colCount);
+
+        if (walkablePath.size() - colCount >= 0) {
+            return Iterables.concat(Iterables.limit(walkablePath, walkablePath.size() - colCount),
+                    Iterables.transform(xpaths, input -> stringPathPartToQName(context, module, input)));
         }
-        return Iterables.concat(schemaNodePath,
+        return Iterables.concat(walkablePath,
                 Iterables.transform(xpaths, input -> stringPathPartToQName(context, module, input)));
     }
 
+    /**
+     * Return List of qNames that are walkable using xPath. When getting a path from schema node it will return path
+     * with parents like CaseSchemaNode and ChoiceSchemaNode as well if they are parents of the node. We need to get
+     * rid of these in order to find the node that xPath is pointing to. Also we can not remove any node beyond the
+     * amount of "../" because we will not be able to find the correct schema node from schema context
+     *
+     * @param schemaNodePath list of qNames as a path to the leaf of type leafref
+     * @param context        create schema context
+     * @param colCount       amount of "../" in the xPath expression
+     * @return list of QNames as a path where we should be able to find referenced node
+     */
+    private static List<QName> createWalkablePath(final Iterable<QName> schemaNodePath, final SchemaContext context,
+            final int colCount) {
+        final List<Integer> indexToRemove = new ArrayList<>();
+        List<QName> schemaNodePathRet = Lists.newArrayList(schemaNodePath);
+        for (int j = 0, i = schemaNodePathRet.size() - 1; i >= 0 && j != colCount; i--, j++) {
+            final SchemaNode nodeIn = findTargetNode(context, schemaNodePathRet);
+            if (nodeIn instanceof CaseSchemaNode || nodeIn instanceof ChoiceSchemaNode) {
+                indexToRemove.add(i);
+                j--;
+            }
+            schemaNodePathRet.remove(i);
+        }
+        schemaNodePathRet = Lists.newArrayList(schemaNodePath);
+        for (int i : indexToRemove) {
+            schemaNodePathRet.remove(i);
+        }
+        return schemaNodePathRet;
+    }
+
     private static SchemaNode resolveDerefPath(final SchemaContext context, final Module module,
             final SchemaNode actualSchemaNode, final String xpath) {
         final int paren = xpath.indexOf(')', 6);
@@ -797,7 +837,11 @@ public final class SchemaContextUtil {
     }
 
     private static List<String> doSplitXPath(final String xpath) {
-        return SLASH_SPLITTER.splitToList(xpath);
+        final List<String> ret = new ArrayList<>();
+        for (String str : SLASH_SPLITTER.split(xpath)) {
+            ret.add(str);
+        }
+        return ret;
     }
 
     /**