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.binding.dom.adapter.query;
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;
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.api.query.QueryStructureException;
20 import org.opendaylight.mdsal.binding.dom.adapter.query.LambdaDecoder.LambdaTarget;
21 import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTree;
22 import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTreeNode;
23 import org.opendaylight.mdsal.binding.dom.codec.api.BindingDataObjectCodecTreeNode;
24 import org.opendaylight.mdsal.binding.dom.codec.spi.BindingSchemaMapping;
25 import org.opendaylight.mdsal.dom.api.query.DOMQuery;
26 import org.opendaylight.mdsal.dom.api.query.DOMQueryPredicate;
27 import org.opendaylight.yangtools.concepts.Immutable;
28 import org.opendaylight.yangtools.yang.binding.DataObject;
29 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
30 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
31 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
32 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
33 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
34 import org.opendaylight.yangtools.yang.model.api.DocumentedNode.WithStatus;
36 final class QueryBuilderState {
37 static final class BoundMethod implements Immutable {
38 final @NonNull YangInstanceIdentifier parentPath;
39 final @NonNull BindingCodecTreeNode methodCodec;
41 BoundMethod(final YangInstanceIdentifier parentPath, final BindingCodecTreeNode methodCodec) {
42 this.parentPath = requireNonNull(parentPath);
43 this.methodCodec = requireNonNull(methodCodec);
47 private final BindingCodecTree codec;
49 private final List<DOMQueryPredicate> predicates = new ArrayList<>();
50 private final YangInstanceIdentifier root;
51 private YangInstanceIdentifier absoluteSelect;
52 private YangInstanceIdentifier relativeSelect;
54 QueryBuilderState(final BindingCodecTree codec, final InstanceIdentifier<?> root) {
55 this.codec = requireNonNull(codec);
56 this.root = fromBinding(root);
59 void setSelectPath(final @NonNull InstanceIdentifier<?> selectPath) {
60 checkState(root != null, "Root path has not been set yet");
61 checkState(relativeSelect == null, "Select path has already been set to %s", relativeSelect);
63 absoluteSelect = fromBinding(selectPath);
64 relativeSelect = absoluteSelect.relativeTo(root)
65 .orElseThrow(() -> new IllegalStateException(root + " is not an ancestor of " + absoluteSelect));
68 @NonNull BoundMethod bindMethod(final @NonNull InstanceIdentifier<?> bindingPath,
69 final @NonNull LeafReference<?, ?> ref) {
70 // Verify bindingPath, which will give us something to fish in
71 final BindingDataObjectCodecTreeNode<?> targetCodec = codec.getSubtreeCodec(bindingPath);
72 checkState(targetCodec != null, "Failed to find codec for %s", bindingPath);
74 final WithStatus targetSchema = targetCodec.getSchema();
75 verify(targetSchema instanceof DataNodeContainer, "Unexpected target schema %s", targetSchema);
77 final LambdaTarget targetLeaf = LambdaDecoder.resolveLambda(ref);
78 verify(targetLeaf.targetClass.equals(bindingPath.getTargetType().getName()), "Mismatched target %s and path %s",
79 targetLeaf, bindingPath);
80 final DataSchemaNode child = findChild((DataNodeContainer) targetSchema, targetLeaf.targetMethod);
81 final YangInstanceIdentifier absTarget = fromBinding(bindingPath);
82 final YangInstanceIdentifier relTarget = absTarget.relativeTo(absoluteSelect)
83 .orElseThrow(() -> new IllegalStateException(absoluteSelect + " is not an ancestor of " + absTarget));
85 return new BoundMethod(relTarget, targetCodec.yangPathArgumentChild(new NodeIdentifier(child.getQName())));
88 void addPredicate(final DOMQueryPredicate predicate) {
89 predicates.add(requireNonNull(predicate));
92 <T extends DataObject> @NonNull QueryExpression<T> buildQuery() {
93 return new DefaultQuery<>(new DOMQuery(root, relativeSelect, predicates));
96 private @NonNull YangInstanceIdentifier fromBinding(final InstanceIdentifier<?> bindingId) {
97 return codec.getInstanceIdentifierCodec().fromBinding(bindingId);
100 private static DataSchemaNode findChild(final DataNodeContainer parent, final String methodName) {
101 for (DataSchemaNode child : parent.getChildNodes()) {
102 if (methodName.equals(BindingSchemaMapping.getGetterMethodName(child))) {
106 throw new QueryStructureException("Failed to find schema matching " + methodName + " in " + parent);