dom/mdsal-dom-spi/src/main/java/org/opendaylight/mdsal/dom/spi/query/DOMQueryEvaluator.java

   1 /*
   2  * Copyright (c) 2020 PANTHEON.tech, s.r.o. 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.dom.spi.query;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11
  12 import java.util.AbstractMap.SimpleImmutableEntry;
  13 import java.util.ArrayDeque;
  14 import java.util.ArrayList;
  15 import java.util.Deque;
  16 import java.util.List;
  17 import java.util.Map.Entry;
  18 import java.util.Optional;
  19 import org.eclipse.jdt.annotation.NonNullByDefault;
  20 import org.opendaylight.mdsal.dom.api.query.DOMQuery;
  21 import org.opendaylight.mdsal.dom.api.query.DOMQueryPredicate;
  22 import org.opendaylight.mdsal.dom.api.query.DOMQueryResult;
  23 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  24 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  25 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  26 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  27 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  28 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  29 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodes;
  30
  31 @NonNullByDefault
  32 public final class DOMQueryEvaluator {
  33     private DOMQueryEvaluator() {
  34
  35     }
  36
  37     /**
  38      * Evaluate {@link DOMQuery} on its data element. The element is expected to correspond to
  39      * {@link DOMQuery#getRoot()}.
  40      *
  41      * @param query Query to execute
  42      * @param queryRoot Query root object
  43      * @return Result of evaluation
  44      * @throws NullPointerException if any argument is null
  45      */
  46     public static DOMQueryResult evaluateOn(final DOMQuery query, final NormalizedNode<?, ?> queryRoot) {
  47         final YangInstanceIdentifier path = query.getSelect();
  48         return path.isEmpty() ? evalSingle(queryRoot, query)
  49             : evalPath(new ArrayDeque<>(path.getPathArguments()), queryRoot, query);
  50     }
  51
  52     /**
  53      * Evaluate {@link DOMQuery} on a conceptual root. The element is expected to correspond to the conceptual data tree
  54      * root. This method will first find the {@link DOMQuery#getRoot()} and then defer to
  55      * {@link #evaluateOn(DOMQuery, NormalizedNode)}.
  56      *
  57      * @param query Query to execute
  58      * @param root Conceptual root object
  59      * @return Result of evaluation
  60      * @throws NullPointerException if any argument is null
  61      */
  62     public static DOMQueryResult evaluateOnRoot(final DOMQuery query, final NormalizedNode<?, ?> root) {
  63         NormalizedNode<?, ?> evalRoot = root;
  64         for (PathArgument arg : query.getRoot().getPathArguments()) {
  65             final Optional<NormalizedNode<?, ?>> next = NormalizedNodes.findNode(root, arg);
  66             if (next.isEmpty()) {
  67                 return EagerDOMQueryResult.of();
  68             }
  69             evalRoot = next.orElseThrow();
  70         }
  71         return evaluateOn(query, evalRoot);
  72     }
  73
  74     private static DOMQueryResult evalPath(final ArrayDeque<PathArgument> remaining, final NormalizedNode<?, ?> data,
  75             final DOMQuery query) {
  76         // FIXME: this is eager evaluation, we should be doing lazy traversal
  77         final List<Entry<YangInstanceIdentifier, NormalizedNode<?, ?>>> result = new ArrayList<>();
  78         evalPath(result, new ArrayDeque<>(query.getRoot().getPathArguments()), remaining, data, query);
  79         return EagerDOMQueryResult.of(result);
  80     }
  81
  82     private static void evalPath(final List<Entry<YangInstanceIdentifier, NormalizedNode<?,?>>> result,
  83             final Deque<PathArgument> path, final ArrayDeque<PathArgument> remaining,
  84             final NormalizedNode<?, ?> data, final DOMQuery query) {
  85         final PathArgument next = remaining.poll();
  86         if (next == null) {
  87             if (matches(data, query)) {
  88                 result.add(new SimpleImmutableEntry<>(YangInstanceIdentifier.create(path), data));
  89             }
  90             return;
  91         }
  92
  93         if (data instanceof MapNode && next instanceof NodeIdentifier) {
  94             checkArgument(data.getIdentifier().equals(next), "Unexpected step %s", next);
  95             for (MapEntryNode child : ((MapNode) data).getValue()) {
  96                 evalChild(result, path, remaining, query, child);
  97             }
  98         } else {
  99             NormalizedNodes.getDirectChild(data, next).ifPresent(
 100                 child -> evalChild(result, path, remaining, query, child));
 101         }
 102         remaining.push(next);
 103     }
 104
 105     private static void evalChild(final List<Entry<YangInstanceIdentifier, NormalizedNode<?,?>>> result,
 106             final Deque<PathArgument> path, final ArrayDeque<PathArgument> remaining, final DOMQuery query,
 107             final NormalizedNode<?, ?> child) {
 108         path.addLast(child.getIdentifier());
 109         evalPath(result, path, remaining, child, query);
 110         path.removeLast();
 111     }
 112
 113     private static DOMQueryResult evalSingle(final NormalizedNode<?, ?> data, final DOMQuery query) {
 114         return matches(data, query) ? EagerDOMQueryResult.of()
 115                 : EagerDOMQueryResult.of(new SimpleImmutableEntry<>(query.getRoot(), data));
 116     }
 117
 118     private static boolean matches(final NormalizedNode<?, ?> data, final DOMQuery query) {
 119         for (DOMQueryPredicate pred : query.getPredicates()) {
 120             // Okay, now we need to deal with predicates, but do it in a smart fashion, so we do not end up iterating
 121             // all over the place. Typically we will be matching just a leaf.
 122             final YangInstanceIdentifier path = pred.getPath();
 123             final Optional<NormalizedNode<?, ?>> node;
 124             if (path.coerceParent().isEmpty()) {
 125                 node = NormalizedNodes.getDirectChild(data, path.getLastPathArgument());
 126             } else {
 127                 node = NormalizedNodes.findNode(data, path);
 128             }
 129
 130             if (!pred.test(node.orElse(null))) {
 131                 return false;
 132             }
 133         }
 134         return true;
 135     }
 136 }