model/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/EffectiveAugmentationSchema.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. 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.yangtools.yang.model.util;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.collect.ImmutableMap;
  13 import com.google.common.collect.ImmutableSet;
  14 import java.util.Collection;
  15 import java.util.HashMap;
  16 import java.util.HashSet;
  17 import java.util.Map;
  18 import java.util.Optional;
  19 import java.util.Set;
  20 import org.opendaylight.yangtools.yang.common.QName;
  21 import org.opendaylight.yangtools.yang.model.api.ActionDefinition;
  22 import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
  23 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  24 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  25 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
  26 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
  27 import org.opendaylight.yangtools.yang.model.api.Status;
  28 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  29 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
  30 import org.opendaylight.yangtools.yang.model.api.UsesNode;
  31 import org.opendaylight.yangtools.yang.model.api.stmt.AugmentEffectiveStatement;
  32 import org.opendaylight.yangtools.yang.xpath.api.YangXPathExpression.QualifiedBound;
  33
  34 /**
  35  * Proxy for AugmentationSchema. Child node schemas are replaced with actual schemas from parent. This is needed to
  36  * correctly interpret constructs like this:
  37  * <pre>
  38  *   <code>
  39  *     container foo;
  40  *
  41  *     augment /foo {
  42  *       container bar;
  43  *     }
  44  *
  45  *     augment /foo/bar {
  46  *       container baz;
  47  *     }
  48  *   </code>
  49  * </pre>
  50  * The {@link AugmentationSchemaNode} returned for {@code augment /foo} contains bare {@code container bar}, e.g. it
  51  * does not show {@code augment /foo/bar} as an available augmentation -- this is only visible in {@code foo}'s schema
  52  * nodes.
  53  *
  54  * <p>
  55  * Note this class only handles {@link DataSchemaNode}s, not all {@code schema tree} statements, as it strictly should.
  56  */
  57 // FIXME: YANGTOOLS-1403: this functionality should be integrated into EffectiveAugmentStatement/AugmentationSchemaNode
  58 public final class EffectiveAugmentationSchema implements AugmentationSchemaNode {
  59     private final AugmentationSchemaNode delegate;
  60     private final ImmutableSet<DataSchemaNode> realChildSchemas;
  61     private final ImmutableMap<QName, DataSchemaNode> mappedChildSchemas;
  62
  63     public EffectiveAugmentationSchema(final AugmentationSchemaNode augmentSchema,
  64             final Collection<? extends DataSchemaNode> realChildSchemas) {
  65         delegate = requireNonNull(augmentSchema);
  66         this.realChildSchemas = ImmutableSet.copyOf(realChildSchemas);
  67
  68         final Map<QName, DataSchemaNode> m = new HashMap<>(realChildSchemas.size());
  69         for (DataSchemaNode realChildSchema : realChildSchemas) {
  70             m.put(realChildSchema.getQName(), realChildSchema);
  71         }
  72
  73         mappedChildSchemas = ImmutableMap.copyOf(m);
  74     }
  75
  76     /**
  77      * Returns an AugmentationSchemaNode as effective in a parent node.
  78      *
  79      * @param schema Augmentation schema
  80      * @param parent Parent schema
  81      * @return Adjusted Augmentation schema
  82      * @throws NullPointerException if any of the arguments is null
  83      */
  84     // FIXME: 8.0.0: integrate this method into the constructor
  85     public static AugmentationSchemaNode create(final AugmentationSchemaNode schema, final DataNodeContainer parent) {
  86         final Set<DataSchemaNode> children = new HashSet<>();
  87         for (DataSchemaNode augNode : schema.getChildNodes()) {
  88             // parent may have the corresponding child removed via 'deviate unsupported', i.e. the child is effectively
  89             // not present at the target site
  90             final DataSchemaNode child = parent.dataChildByName(augNode.getQName());
  91             if (child != null) {
  92                 children.add(child);
  93             }
  94         }
  95         return new EffectiveAugmentationSchema(schema, children);
  96     }
  97
  98     @Override
  99     public Optional<? extends QualifiedBound> getWhenCondition() {
 100         return delegate.getWhenCondition();
 101     }
 102
 103     @Override
 104     public Optional<String> getDescription() {
 105         return delegate.getDescription();
 106     }
 107
 108     @Override
 109     public Optional<String> getReference() {
 110         return delegate.getReference();
 111     }
 112
 113     @Override
 114     public Status getStatus() {
 115         return delegate.getStatus();
 116     }
 117
 118     @Override
 119     public Collection<? extends UnknownSchemaNode> getUnknownSchemaNodes() {
 120         return delegate.getUnknownSchemaNodes();
 121     }
 122
 123     @Override
 124     public Collection<? extends TypeDefinition<?>> getTypeDefinitions() {
 125         return delegate.getTypeDefinitions();
 126     }
 127
 128     @Override
 129     public Collection<? extends DataSchemaNode> getChildNodes() {
 130         return realChildSchemas;
 131     }
 132
 133     @Override
 134     public Collection<? extends GroupingDefinition> getGroupings() {
 135         return delegate.getGroupings();
 136     }
 137
 138     @Override
 139     public DataSchemaNode dataChildByName(final QName name) {
 140         return mappedChildSchemas.get(requireNonNull(name));
 141     }
 142
 143     @Override
 144     public Collection<? extends UsesNode> getUses() {
 145         return delegate.getUses();
 146     }
 147
 148     @Override
 149     public Optional<AugmentationSchemaNode> getOriginalDefinition() {
 150         return delegate.getOriginalDefinition();
 151     }
 152
 153     @Override
 154     public Collection<? extends ActionDefinition> getActions() {
 155         return delegate.getActions();
 156     }
 157
 158     @Override
 159     public Optional<ActionDefinition> findAction(final QName qname) {
 160         return delegate.findAction(qname);
 161     }
 162
 163     @Override
 164     public Collection<? extends NotificationDefinition> getNotifications() {
 165         return delegate.getNotifications();
 166     }
 167
 168     @Override
 169     public Optional<NotificationDefinition> findNotification(final QName qname) {
 170         return delegate.findNotification(qname);
 171     }
 172
 173     @Override
 174     public AugmentEffectiveStatement asEffectiveStatement() {
 175         return delegate.asEffectiveStatement();
 176     }
 177 }