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 java.util.AbstractMap.SimpleImmutableEntry;
  11 import java.util.Optional;
  12 import org.eclipse.jdt.annotation.NonNullByDefault;
  13 import org.opendaylight.mdsal.dom.api.query.DOMQuery;
  14 import org.opendaylight.mdsal.dom.api.query.DOMQueryResult;
  15 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  16 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  17 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  18 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodes;
  19
  20 @NonNullByDefault
  21 public final class DOMQueryEvaluator {
  22     private DOMQueryEvaluator() {
  23
  24     }
  25
  26     /**
  27      * Evaluate {@link DOMQuery} on its data element. The element is expected to correspond to
  28      * {@link DOMQuery#getRoot()}.
  29      *
  30      * @param query Query to execute
  31      * @param queryRoot Query root object
  32      * @return Result of evaluation
  33      * @throws NullPointerException if any argument is null
  34      */
  35     public static DOMQueryResult evaluateOn(final DOMQuery query, final NormalizedNode<?, ?> queryRoot) {
  36         final YangInstanceIdentifier path = query.getSelect();
  37         return path.isEmpty() ? evalSingle(query, queryRoot) : new LazyDOMQueryResult(query, queryRoot);
  38     }
  39
  40     /**
  41      * Evaluate {@link DOMQuery} on a conceptual root. The element is expected to correspond to the conceptual data tree
  42      * root. This method will first find the {@link DOMQuery#getRoot()} and then defer to
  43      * {@link #evaluateOn(DOMQuery, NormalizedNode)}.
  44      *
  45      * @param query Query to execute
  46      * @param root Conceptual root object
  47      * @return Result of evaluation
  48      * @throws NullPointerException if any argument is null
  49      */
  50     public static DOMQueryResult evaluateOnRoot(final DOMQuery query, final NormalizedNode<?, ?> root) {
  51         NormalizedNode<?, ?> evalRoot = root;
  52         for (PathArgument arg : query.getRoot().getPathArguments()) {
  53             final Optional<NormalizedNode<?, ?>> next = NormalizedNodes.findNode(root, arg);
  54             if (next.isEmpty()) {
  55                 return DOMQueryResult.of();
  56             }
  57             evalRoot = next.orElseThrow();
  58         }
  59         return evaluateOn(query, evalRoot);
  60     }
  61
  62     private static DOMQueryResult evalSingle(final DOMQuery query, final NormalizedNode<?, ?> data) {
  63         return LazyDOMQueryResultIterator.matches(data, query.getPredicates()) ? DOMQueryResult.of()
  64                 : DOMQueryResult.of(new SimpleImmutableEntry<>(query.getRoot(), data));
  65     }
  66 }