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 com.google.common.collect.ImmutableList;
  13 import java.util.AbstractMap.SimpleImmutableEntry;
  14 import java.util.ArrayDeque;
  15 import java.util.ArrayList;
  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.yangtools.yang.data.api.YangInstanceIdentifier;
  23 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  24 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  25 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  26 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  27 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  28 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodes;
  29
  30 @NonNullByDefault
  31 public final class DOMQueryEvaluator {
  32     private DOMQueryEvaluator() {
  33
  34     }
  35
  36     public static List<? extends Entry<YangInstanceIdentifier, NormalizedNode<?, ?>>> evaluate(final DOMQuery query,
  37             final NormalizedNode<?, ?> root) {
  38         final YangInstanceIdentifier path = query.getSelect();
  39         return path.isEmpty() ? evalSingle(root, query)
  40                 : evalPath(new ArrayDeque<>(path.getPathArguments()), root, query);
  41     }
  42
  43     private static List<? extends Entry<YangInstanceIdentifier, NormalizedNode<?, ?>>> evalPath(
  44             final ArrayDeque<PathArgument> remaining, final NormalizedNode<?,?> data, final DOMQuery query) {
  45         NormalizedNode<?, ?> evalRoot = data;
  46         for (PathArgument arg : query.getRoot().getPathArguments()) {
  47             final Optional<NormalizedNode<?, ?>> next = NormalizedNodes.findNode(data, arg);
  48             if (next.isEmpty()) {
  49                 return ImmutableList.of();
  50             }
  51             evalRoot = next.orElseThrow();
  52         }
  53
  54         final List<Entry<YangInstanceIdentifier, NormalizedNode<?, ?>>> result = new ArrayList<>();
  55         evalPath(result, query.getRoot(), remaining, evalRoot, query);
  56         return result;
  57     }
  58
  59     private static void evalPath(final List<Entry<YangInstanceIdentifier, NormalizedNode<?,?>>> result,
  60             final YangInstanceIdentifier path, final ArrayDeque<PathArgument> remaining,
  61             final NormalizedNode<?, ?> data, final DOMQuery query) {
  62         final PathArgument next = remaining.poll();
  63         if (next == null) {
  64             if (matches(data, query)) {
  65                 result.add(new SimpleImmutableEntry<>(path, data));
  66             }
  67             return;
  68         }
  69
  70         if (data instanceof MapNode && next instanceof NodeIdentifier) {
  71             checkArgument(data.getIdentifier().equals(next), "Unexpected step %s", next);
  72             for (MapEntryNode child : ((MapNode) data).getValue()) {
  73                 evalPath(result, path.node(child.getIdentifier()), remaining, child, query);
  74             }
  75         } else {
  76             NormalizedNodes.getDirectChild(data, next).ifPresent(
  77                 child -> evalPath(result, path.node(next), remaining, child, query));
  78         }
  79         remaining.push(next);
  80     }
  81
  82     private static List<? extends Entry<YangInstanceIdentifier, NormalizedNode<?, ?>>> evalSingle(
  83             final NormalizedNode<?, ?> data, final DOMQuery query) {
  84         return matches(data, query) ? ImmutableList.of()
  85                 : ImmutableList.of(new SimpleImmutableEntry<>(query.getRoot(), data));
  86     }
  87
  88     private static boolean matches(final NormalizedNode<?, ?> data, final DOMQuery query) {
  89         for (DOMQueryPredicate pred : query.getPredicates()) {
  90             if (!pred.test(NormalizedNodes.findNode(data, pred.getPath()).orElse(null))) {
  91                 return false;
  92             }
  93         }
  94         return true;
  95     }
  96 }