yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/tree/StructuralContainerModificationStrategy.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.data.impl.schema.tree;
   9
  10 import com.google.common.base.Optional;
  11 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  12 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  13 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  14 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  15 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodeContainer;
  16 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataValidationFailedException;
  17 import org.opendaylight.yangtools.yang.data.api.schema.tree.ModificationType;
  18 import org.opendaylight.yangtools.yang.data.api.schema.tree.TreeType;
  19 import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.TreeNode;
  20 import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.TreeNodeFactory;
  21 import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.Version;
  22 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  23 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  24
  25 /**
  26  * Structural containers are special in that they appear when implied by child nodes and disappear whenever they are
  27  * empty. We could implement this as a subclass of {@link SchemaAwareApplyOperation}, but the automatic semantic
  28  * is quite different from all the other strategies. We create a {@link ContainerModificationStrategy} to tap into that
  29  * logic, but wrap it so we only call out into it. We do not use {@link PresenceContainerModificationStrategy} because
  30  * it enforces presence of mandatory leaves, which is not something we want here, as structural containers are not
  31  * root anchors for that validation.
  32  */
  33 final class StructuralContainerModificationStrategy extends ModificationApplyOperation {
  34     /**
  35      * Fake TreeNode version used in
  36      * {@link #checkApplicable(YangInstanceIdentifier, NodeModification, Optional, Version)}.
  37      * It is okay to use a global constant, as the delegate will ignore it anyway. For
  38      * {@link #apply(ModifiedNode, Optional, Version)} we will use the appropriate version as provided to us.
  39      */
  40     private static final Version FAKE_VERSION = Version.initial();
  41     private final ContainerModificationStrategy delegate;
  42
  43     StructuralContainerModificationStrategy(final ContainerSchemaNode schemaNode, final TreeType treeType) {
  44         this.delegate = new ContainerModificationStrategy(schemaNode, treeType);
  45     }
  46
  47     private Optional<TreeNode> fakeMeta(final Version version) {
  48         final ContainerNode container = ImmutableNodes.containerNode(delegate.getSchema().getQName());
  49         return Optional.of(TreeNodeFactory.createTreeNode(container, version));
  50     }
  51
  52     @Override
  53     Optional<TreeNode> apply(final ModifiedNode modification, final Optional<TreeNode> storeMeta, final Version version) {
  54         final Optional<TreeNode> ret;
  55         if (modification.getOperation() == LogicalOperation.TOUCH && !storeMeta.isPresent()) {
  56             // Container is not present, let's take care of the 'magically appear' part of our job
  57             ret = delegate.apply(modification, fakeMeta(version), version);
  58
  59             // Fake container got removed: that is a no-op
  60             if (!ret.isPresent()) {
  61                 modification.resolveModificationType(ModificationType.UNMODIFIED);
  62                 return ret;
  63             }
  64
  65             // If the delegate indicated SUBTREE_MODIFIED, account for the fake and report APPEARED
  66             if (modification.getModificationType() == ModificationType.SUBTREE_MODIFIED) {
  67                 modification.resolveModificationType(ModificationType.APPEARED);
  68             }
  69         } else {
  70             // Container is present, run normal apply operation
  71             ret = delegate.apply(modification, storeMeta, version);
  72
  73             // Container was explicitly deleted, no magic required
  74             if (!ret.isPresent()) {
  75                 return ret;
  76             }
  77         }
  78
  79         /*
  80          * At this point ret is guaranteed to be present. We need to take care of the 'magically disappear' part of
  81          * our job. Check if there are any child nodes left. If there are none, remove this container and turn the
  82          * modification into a DISAPPEARED.
  83          */
  84         if (((NormalizedNodeContainer<?, ?, ?>) ret.get().getData()).getValue().isEmpty()) {
  85             modification.resolveModificationType(ModificationType.DISAPPEARED);
  86             return Optional.absent();
  87         }
  88
  89         return ret;
  90     }
  91
  92     @Override
  93     void checkApplicable(final YangInstanceIdentifier path, final NodeModification modification,
  94             final Optional<TreeNode> current, final Version version) throws DataValidationFailedException {
  95         if (modification.getOperation() == LogicalOperation.TOUCH && !current.isPresent()) {
  96             // Structural containers are created as needed, so we pretend this container is here
  97             delegate.checkApplicable(path, modification, fakeMeta(FAKE_VERSION), version);
  98         } else {
  99             delegate.checkApplicable(path, modification, current, version);
 100         }
 101     }
 102
 103     @Override
 104     void verifyStructure(final NormalizedNode<?, ?> modification, final boolean verifyChildren) throws IllegalArgumentException {
 105         delegate.verifyStructure(modification, verifyChildren);
 106     }
 107
 108     @Override
 109     void recursivelyVerifyStructure(NormalizedNode<?, ?> value) {
 110         delegate.recursivelyVerifyStructure(value);
 111     }
 112
 113     @Override
 114     ChildTrackingPolicy getChildPolicy() {
 115         return delegate.getChildPolicy();
 116     }
 117
 118     @Override
 119     void mergeIntoModifiedNode(ModifiedNode modification, NormalizedNode<?, ?> value, Version version) {
 120         delegate.mergeIntoModifiedNode(modification, value, version);
 121     }
 122
 123     @Override
 124     public Optional<ModificationApplyOperation> getChild(final PathArgument child) {
 125         return delegate.getChild(child);
 126     }
 127 }