binding/mdsal-binding-api/src/test/java/org/opendaylight/mdsal/binding/api/query/QueryBuilderExamples.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.api.query;
   9
  10 import org.mockito.Mock;
  11 import org.opendaylight.yang.gen.v1.mdsal.query.norev.Foo;
  12 import org.opendaylight.yang.gen.v1.mdsal.query.norev.first.grp.System;
  13 import org.opendaylight.yang.gen.v1.mdsal.query.norev.first.grp.SystemKey;
  14 import org.opendaylight.yang.gen.v1.mdsal.query.norev.second.grp.Alarms;
  15 import org.opendaylight.yang.gen.v1.mdsal.query.norev.third.grp.AffectedUsers;
  16 import org.opendaylight.yang.gen.v1.mdsal426.norev.BooleanCont;
  17 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  18 import org.opendaylight.yangtools.yang.common.Uint64;
  19
  20 @SuppressWarnings("exports")
  21 public class QueryBuilderExamples {
  22     @Mock
  23     private QueryFactory factory;
  24
  25     /*
  26      * Return all of /foo. Equivalent to a read() of the same identifier.
  27      */
  28     public QueryExpression<Foo> selectFoo() {
  29         return factory
  30                 .querySubtree(InstanceIdentifier.create(Foo.class))
  31                 .build();
  32     }
  33
  34     /*
  35      * Read all of /foo/system[name="some"]. Equivalent to a read() of the same identifier.
  36      */
  37     public QueryExpression<System> selectFooSystemSome() {
  38         return factory
  39                 .querySubtree(InstanceIdentifier.create(Foo.class).child(System.class, new SystemKey("some")))
  40                 .build();
  41     }
  42
  43     /*
  44      * Read all entries in /foo/system. Equivalent to a read(/foo).get().nonnullSystem().
  45      */
  46     public QueryExpression<System> selectFooSystem() {
  47         return factory
  48                 .querySubtree(InstanceIdentifier.create(Foo.class))
  49                 .extractChild(System.class)
  50                 .build();
  51     }
  52
  53     /*
  54      * Read all entries in /foo/system, which have 'alias' set to 'some'.
  55      */
  56     public QueryExpression<System> selectFooSystemAliasSome() {
  57         return factory
  58                 .querySubtree(InstanceIdentifier.create(Foo.class))
  59                 .extractChild(System.class)
  60                 .matching()
  61                     .leaf(System::getAlias)
  62                     .valueEquals("some")
  63                 .build();
  64     }
  65
  66     /*
  67      * Read all entries in /foo/system, which have 'alias' containing the string 'needle'.
  68      */
  69     public QueryExpression<System> selectFooSystemAliasWithNeedle() {
  70         return factory
  71                 .querySubtree(InstanceIdentifier.create(Foo.class))
  72                 .extractChild(System.class)
  73                 .matching()
  74                     .leaf(System::getAlias)
  75                     .contains("needle")
  76                 .build();
  77     }
  78
  79     /*
  80      * Read all entries in /foo/system/alarms, which have 'critical' leaf present.
  81      */
  82     public QueryExpression<Alarms> selectFooSystemAlarmsCritical() {
  83         return factory
  84                 .querySubtree(InstanceIdentifier.create(Foo.class))
  85                 .extractChild(System.class)
  86                 .extractChild(Alarms.class)
  87                 .matching()
  88                     .leaf(Alarms::getCritical)
  89                     .nonNull()
  90                 .build();
  91     }
  92
  93     /*
  94      * Read all entries in /foo/system/alarms, which have 'critical' leaf present and have an entry in 'affected-users'
  95      * with 'uid' larger than 10.
  96      *
  97      * Note this is the same expression as selectFooSystemCriticalUid(), but selects Alarms objects.
  98      */
  99     public QueryExpression<Alarms> selectFooSystemAlarmsCriticalUid() {
 100         return factory
 101                 .querySubtree(InstanceIdentifier.create(Foo.class))
 102                 .extractChild(System.class)
 103                 .extractChild(Alarms.class)
 104                 .matching()
 105                     .leaf(Alarms::getCritical)
 106                     .nonNull()
 107                 .and()
 108                     .childObject(AffectedUsers.class)
 109                     .leaf(AffectedUsers::getUid)
 110                     .greaterThan(Uint64.TEN)
 111                 .build();
 112     }
 113
 114
 115     /*
 116      * Read all entries in /foo/system, which have 'critical' leaf present and have an entry in 'affected-users'
 117      * with 'uid' larger than 10.
 118      *
 119      * Note this is the same expression as selectFooSystemAlarmsCriticalUid(), but selects System objects.
 120      */
 121     public QueryExpression<System> selectFooSystemCriticalUid() {
 122         return factory
 123                 .querySubtree(InstanceIdentifier.create(Foo.class))
 124                 .extractChild(System.class)
 125                 .matching()
 126                     .childObject(Alarms.class)
 127                     .leaf(Alarms::getCritical)
 128                     .nonNull()
 129                 .and()
 130                     .childObject(Alarms.class)
 131                     .childObject(AffectedUsers.class)
 132                     .leaf(AffectedUsers::getUid)
 133                     .greaterThan(Uint64.TEN)
 134                 .build();
 135     }
 136
 137     public QueryExpression<BooleanCont> selectBoolean() {
 138         return factory
 139                 .querySubtree(InstanceIdentifier.create(BooleanCont.class))
 140                 .matching()
 141                     .leaf(BooleanCont::getIsFoo)
 142                     .valueEquals(true)
 143                 .build();
 144     }
 145 }