binding/mdsal-binding-dom-adapter/src/main/java/org/opendaylight/mdsal/binding/dom/adapter/query/QueryBuilderState.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.binding.dom.adapter.query;
   9
  10 import static com.google.common.base.Preconditions.checkState;
  11 import static com.google.common.base.Verify.verify;
  12 import static java.util.Objects.requireNonNull;
  13
  14 import java.util.ArrayList;
  15 import java.util.List;
  16 import org.eclipse.jdt.annotation.NonNull;
  17 import org.opendaylight.mdsal.binding.api.query.MatchBuilderPath.LeafReference;
  18 import org.opendaylight.mdsal.binding.api.query.QueryExpression;
  19 import org.opendaylight.mdsal.binding.dom.adapter.query.LambdaDecoder.LambdaTarget;
  20 import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTree;
  21 import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTreeNode;
  22 import org.opendaylight.mdsal.binding.dom.codec.api.CommonDataObjectCodecTreeNode;
  23 import org.opendaylight.mdsal.dom.api.query.DOMQuery;
  24 import org.opendaylight.mdsal.dom.api.query.DOMQueryPredicate;
  25 import org.opendaylight.yangtools.concepts.Immutable;
  26 import org.opendaylight.yangtools.yang.binding.DataObject;
  27 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  28 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  29 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  30 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  31 import org.opendaylight.yangtools.yang.model.api.DocumentedNode.WithStatus;
  32
  33 final class QueryBuilderState {
  34     static final class BoundMethod implements Immutable {
  35         final @NonNull YangInstanceIdentifier parentPath;
  36         final @NonNull BindingCodecTreeNode methodCodec;
  37
  38         BoundMethod(final YangInstanceIdentifier parentPath, final BindingCodecTreeNode methodCodec) {
  39             this.parentPath = requireNonNull(parentPath);
  40             this.methodCodec = requireNonNull(methodCodec);
  41         }
  42     }
  43
  44     private final List<DOMQueryPredicate> predicates = new ArrayList<>();
  45     private final DefaultQueryFactory factory;
  46     private final YangInstanceIdentifier root;
  47     private final BindingCodecTree codec;
  48
  49     private YangInstanceIdentifier absoluteSelect;
  50     private YangInstanceIdentifier relativeSelect;
  51
  52     QueryBuilderState(final DefaultQueryFactory factory, final InstanceIdentifier<?> root) {
  53         codec = factory.codec();
  54         this.factory = factory;
  55         this.root = fromBinding(root);
  56     }
  57
  58     void setSelectPath(final @NonNull InstanceIdentifier<?> selectPath) {
  59         checkState(root != null, "Root path has not been set yet");
  60         checkState(relativeSelect == null, "Select path has already been set to %s", relativeSelect);
  61
  62         absoluteSelect = fromBinding(selectPath);
  63         relativeSelect = absoluteSelect.relativeTo(root)
  64                 .orElseThrow(() -> new IllegalStateException(root + " is not an ancestor of " + absoluteSelect));
  65     }
  66
  67     @NonNull BoundMethod bindMethod(final @NonNull InstanceIdentifier<?> bindingPath,
  68             final @NonNull LeafReference<?, ?> ref) {
  69         // Verify bindingPath, which will give us something to fish in
  70         final CommonDataObjectCodecTreeNode<?> targetCodec = codec.getSubtreeCodec(bindingPath);
  71         checkState(targetCodec != null, "Failed to find codec for %s", bindingPath);
  72
  73         final WithStatus targetSchema = targetCodec.getSchema();
  74         verify(targetSchema instanceof DataNodeContainer, "Unexpected target schema %s", targetSchema);
  75
  76         final LambdaTarget targetLeaf = LambdaDecoder.resolveLambda(ref);
  77         verify(targetLeaf.targetClass.equals(bindingPath.getTargetType().getName()), "Mismatched target %s and path %s",
  78             targetLeaf, bindingPath);
  79         final NodeIdentifier childId = factory.findChild((DataNodeContainer) targetSchema, targetLeaf.targetMethod);
  80         final YangInstanceIdentifier absTarget = fromBinding(bindingPath);
  81         final YangInstanceIdentifier relTarget = absTarget.relativeTo(absoluteSelect)
  82                 .orElseThrow(() -> new IllegalStateException(absoluteSelect + " is not an ancestor of " + absTarget));
  83
  84         return new BoundMethod(relTarget, targetCodec.yangPathArgumentChild(childId));
  85     }
  86
  87     void addPredicate(final DOMQueryPredicate predicate) {
  88         predicates.add(requireNonNull(predicate));
  89     }
  90
  91     <T extends DataObject> @NonNull QueryExpression<T> buildQuery() {
  92         return new DefaultQuery<>(codec, new DOMQuery(root, relativeSelect, predicates));
  93     }
  94
  95     private @NonNull YangInstanceIdentifier fromBinding(final InstanceIdentifier<?> bindingId) {
  96         return codec.getInstanceIdentifierCodec().fromBinding(bindingId);
  97     }
  98 }