2 * Copyright (c) 2020 PANTHEON.tech, s.r.o. and others. All rights reserved.
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
8 package org.opendaylight.mdsal.dom.spi.query;
10 import static com.google.common.base.Preconditions.checkArgument;
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;
31 public final class DOMQueryEvaluator {
32 private DOMQueryEvaluator() {
37 * Evaluate {@link DOMQuery} on its data element. The element is expected to correspond to
38 * {@link DOMQuery#getRoot()}.
40 * @param query Query to execute
41 * @param queryRoot Query root object
42 * @return Result of evaluation
43 * @throws NullPointerException if any argument is null
45 public static List<? extends Entry<YangInstanceIdentifier, NormalizedNode<?, ?>>> evaluateOn(final DOMQuery query,
46 final NormalizedNode<?, ?> queryRoot) {
47 final YangInstanceIdentifier path = query.getSelect();
48 return path.isEmpty() ? evalSingle(queryRoot, query)
49 : evalPath(new ArrayDeque<>(path.getPathArguments()), queryRoot, query);
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)}.
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
62 public static List<? extends Entry<YangInstanceIdentifier, NormalizedNode<?, ?>>> evaluateOnRoot(
63 final DOMQuery query, final NormalizedNode<?, ?> root) {
64 NormalizedNode<?, ?> evalRoot = root;
65 for (PathArgument arg : query.getRoot().getPathArguments()) {
66 final Optional<NormalizedNode<?, ?>> next = NormalizedNodes.findNode(root, arg);
68 return ImmutableList.of();
70 evalRoot = next.orElseThrow();
72 return evaluateOn(query, evalRoot);
75 private static List<? extends Entry<YangInstanceIdentifier, NormalizedNode<?, ?>>> evalPath(
76 final ArrayDeque<PathArgument> remaining, final NormalizedNode<?,?> data, final DOMQuery query) {
77 final List<Entry<YangInstanceIdentifier, NormalizedNode<?, ?>>> result = new ArrayList<>();
78 evalPath(result, query.getRoot(), remaining, data, query);
82 private static void evalPath(final List<Entry<YangInstanceIdentifier, NormalizedNode<?,?>>> result,
83 final YangInstanceIdentifier path, final ArrayDeque<PathArgument> remaining,
84 final NormalizedNode<?, ?> data, final DOMQuery query) {
85 final PathArgument next = remaining.poll();
87 if (matches(data, query)) {
88 result.add(new SimpleImmutableEntry<>(path, data));
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 evalPath(result, path.node(child.getIdentifier()), remaining, child, query);
99 NormalizedNodes.getDirectChild(data, next).ifPresent(
100 child -> evalPath(result, path.node(next), remaining, child, query));
102 remaining.push(next);
105 private static List<? extends Entry<YangInstanceIdentifier, NormalizedNode<?, ?>>> evalSingle(
106 final NormalizedNode<?, ?> data, final DOMQuery query) {
107 return matches(data, query) ? ImmutableList.of()
108 : ImmutableList.of(new SimpleImmutableEntry<>(query.getRoot(), data));
111 private static boolean matches(final NormalizedNode<?, ?> data, final DOMQuery query) {
112 for (DOMQueryPredicate pred : query.getPredicates()) {
113 if (!pred.test(NormalizedNodes.findNode(data, pred.getPath()).orElse(null))) {