yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/tree/ModifiedNode.java

   1 /*
   2  * Copyright (c) 2014 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 static com.google.common.base.Verify.verifyNotNull;
  11 import static java.util.Objects.requireNonNull;
  12
  13 import com.google.common.base.MoreObjects;
  14 import com.google.common.base.MoreObjects.ToStringHelper;
  15 import java.util.Collection;
  16 import java.util.Map;
  17 import java.util.Optional;
  18 import java.util.function.Predicate;
  19 import org.eclipse.jdt.annotation.NonNull;
  20 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  21 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  22 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodeContainer;
  23 import org.opendaylight.yangtools.yang.data.api.schema.tree.ModificationType;
  24 import org.opendaylight.yangtools.yang.data.api.schema.tree.StoreTreeNode;
  25 import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.TreeNode;
  26 import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.TreeNodeFactory;
  27 import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.Version;
  28
  29 /**
  30  * Node Modification Node and Tree.
  31  *
  32  * <p>
  33  * Tree which structurally resembles data tree and captures client modifications to the data store tree. This tree is
  34  * lazily created and populated via {@link #modifyChild(PathArgument, ModificationApplyOperation, Version)} and
  35  * {@link TreeNode} which represents original state as tracked by {@link #getOriginal()}.
  36  *
  37  * <p>
  38  * The contract is that the state information exposed here preserves the temporal ordering of whatever modifications
  39  * were executed. A child's effects pertain to data node as modified by its ancestors. This means that in order to
  40  * reconstruct the effective data node presentation, it is sufficient to perform a depth-first pre-order traversal of
  41  * the tree.
  42  */
  43 final class ModifiedNode extends NodeModification implements StoreTreeNode<ModifiedNode> {
  44     static final Predicate<ModifiedNode> IS_TERMINAL_PREDICATE = input -> {
  45         requireNonNull(input);
  46         switch (input.getOperation()) {
  47             case DELETE:
  48             case MERGE:
  49             case WRITE:
  50                 return true;
  51             case TOUCH:
  52             case NONE:
  53                 return false;
  54             default:
  55                 throw new IllegalArgumentException("Unhandled modification type " + input.getOperation());
  56         }
  57     };
  58
  59     private final Map<PathArgument, ModifiedNode> children;
  60     private final Optional<? extends TreeNode> original;
  61     private final PathArgument identifier;
  62     private LogicalOperation operation = LogicalOperation.NONE;
  63     private Optional<TreeNode> snapshotCache;
  64     private NormalizedNode<?, ?> value;
  65     private ModificationType modType;
  66
  67     // Alternative history introduced in WRITE nodes. Instantiated when we touch any child underneath such a node.
  68     private TreeNode writtenOriginal;
  69
  70     // Internal cache for TreeNodes created as part of validation
  71     private ModificationApplyOperation validatedOp;
  72     private Optional<? extends TreeNode> validatedCurrent;
  73     private Optional<? extends TreeNode> validatedNode;
  74
  75     private ModifiedNode(final PathArgument identifier, final Optional<? extends TreeNode> original,
  76             final ChildTrackingPolicy childPolicy) {
  77         this.identifier = identifier;
  78         this.original = original;
  79         this.children = childPolicy.createMap();
  80     }
  81
  82     @Override
  83     public PathArgument getIdentifier() {
  84         return identifier;
  85     }
  86
  87     @Override
  88     LogicalOperation getOperation() {
  89         return operation;
  90     }
  91
  92     @Override
  93     Optional<? extends TreeNode> getOriginal() {
  94         return original;
  95     }
  96
  97     /**
  98      * Return the value which was written to this node. The returned object is only valid for
  99      * {@link LogicalOperation#MERGE} and {@link LogicalOperation#WRITE}.
 100      * operations. It should only be consulted when this modification is going to end up being
 101      * {@link ModificationType#WRITE}.
 102      *
 103      * @return Currently-written value
 104      */
 105     @NonNull NormalizedNode<?, ?> getWrittenValue() {
 106         return verifyNotNull(value);
 107     }
 108
 109     /**
 110      * Returns child modification if child was modified.
 111      *
 112      * @return Child modification if direct child or it's subtree was modified.
 113      */
 114     @Override
 115     public Optional<ModifiedNode> getChild(final PathArgument child) {
 116         return Optional.ofNullable(children.get(child));
 117     }
 118
 119     private Optional<? extends TreeNode> metadataFromSnapshot(final @NonNull PathArgument child) {
 120         return original.isPresent() ? original.get().getChild(child) : Optional.empty();
 121     }
 122
 123     private Optional<? extends TreeNode> metadataFromData(final @NonNull PathArgument child, final Version modVersion) {
 124         if (writtenOriginal == null) {
 125             // Lazy instantiation, as we do not want do this for all writes. We are using the modification's version
 126             // here, as that version is what the SchemaAwareApplyOperation will see when dealing with the resulting
 127             // modifications.
 128             writtenOriginal = TreeNodeFactory.createTreeNode(value, modVersion);
 129         }
 130
 131         return writtenOriginal.getChild(child);
 132     }
 133
 134     /**
 135      * Determine the base tree node we are going to apply the operation to. This is not entirely trivial because
 136      * both DELETE and WRITE operations unconditionally detach their descendants from the original snapshot, so we need
 137      * to take the current node's operation into account.
 138      *
 139      * @param child Child we are looking to modify
 140      * @param modVersion Version allocated by the calling {@link InMemoryDataTreeModification}
 141      * @return Before-image tree node as observed by that child.
 142      */
 143     private Optional<? extends TreeNode> findOriginalMetadata(final @NonNull PathArgument child,
 144             final Version modVersion) {
 145         switch (operation) {
 146             case DELETE:
 147                 // DELETE implies non-presence
 148                 return Optional.empty();
 149             case NONE:
 150             case TOUCH:
 151             case MERGE:
 152                 return metadataFromSnapshot(child);
 153             case WRITE:
 154                 // WRITE implies presence based on written data
 155                 return metadataFromData(child, modVersion);
 156             default:
 157                 throw new IllegalStateException("Unhandled node operation " + operation);
 158         }
 159     }
 160
 161     /**
 162      * Returns child modification if child was modified, creates {@link ModifiedNode}
 163      * for child otherwise. If this node's {@link ModificationType} is {@link ModificationType#UNMODIFIED}
 164      * changes modification type to {@link ModificationType#SUBTREE_MODIFIED}.
 165      *
 166      * @param child child identifier, may not be null
 167      * @param childOper Child operation
 168      * @param modVersion Version allocated by the calling {@link InMemoryDataTreeModification}
 169      * @return {@link ModifiedNode} for specified child, with {@link #getOriginal()}
 170      *         containing child metadata if child was present in original data.
 171      */
 172     ModifiedNode modifyChild(final @NonNull PathArgument child, final @NonNull ModificationApplyOperation childOper,
 173             final @NonNull Version modVersion) {
 174         clearSnapshot();
 175         if (operation == LogicalOperation.NONE) {
 176             updateOperationType(LogicalOperation.TOUCH);
 177         }
 178         final ModifiedNode potential = children.get(child);
 179         if (potential != null) {
 180             return potential;
 181         }
 182
 183         final Optional<? extends TreeNode> currentMetadata = findOriginalMetadata(child, modVersion);
 184         final ModifiedNode newlyCreated = new ModifiedNode(child, currentMetadata, childOper.getChildPolicy());
 185         if (operation == LogicalOperation.MERGE && value != null) {
 186             /*
 187              * We are attempting to modify a previously-unmodified part of a MERGE node. If the
 188              * value contains this component, we need to materialize it as a MERGE modification.
 189              */
 190             @SuppressWarnings({ "rawtypes", "unchecked" })
 191             final Optional<NormalizedNode<?, ?>> childData = ((NormalizedNodeContainer)value).getChild(child);
 192             if (childData.isPresent()) {
 193                 childOper.mergeIntoModifiedNode(newlyCreated, childData.get(), modVersion);
 194             }
 195         }
 196
 197         children.put(child, newlyCreated);
 198         return newlyCreated;
 199     }
 200
 201     /**
 202      * Returns all recorded direct child modifications.
 203      *
 204      * @return all recorded direct child modifications
 205      */
 206     @Override
 207     Collection<ModifiedNode> getChildren() {
 208         return children.values();
 209     }
 210
 211     /**
 212      * Records a delete for associated node.
 213      */
 214     void delete() {
 215         final LogicalOperation newType;
 216
 217         switch (operation) {
 218             case DELETE:
 219             case NONE:
 220                 // We need to record this delete.
 221                 newType = LogicalOperation.DELETE;
 222                 break;
 223             case MERGE:
 224                 // In case of merge - delete needs to be recored and must not to be changed into NONE, because lazy
 225                 // expansion of parent MERGE node would reintroduce it again.
 226                 newType = LogicalOperation.DELETE;
 227                 break;
 228             case TOUCH:
 229             case WRITE:
 230                 /*
 231                  * We are canceling a previous modification. This is a bit tricky, as the original write may have just
 232                  * introduced the data, or it may have modified it.
 233                  *
 234                  * As documented in BUG-2470, a delete of data introduced in this transaction needs to be turned into
 235                  * a no-op.
 236                  */
 237                 newType = original.isPresent() ? LogicalOperation.DELETE : LogicalOperation.NONE;
 238                 break;
 239             default:
 240                 throw new IllegalStateException("Unhandled deletion of node with " + operation);
 241         }
 242
 243         clearSnapshot();
 244         children.clear();
 245         this.value = null;
 246         updateOperationType(newType);
 247     }
 248
 249     /**
 250      * Records a write for associated node.
 251      *
 252      * @param newValue new value
 253      */
 254     void write(final NormalizedNode<?, ?> newValue) {
 255         updateValue(LogicalOperation.WRITE, newValue);
 256         children.clear();
 257     }
 258
 259     /**
 260      * Seal the modification node and prune any children which has not been modified.
 261      *
 262      * @param schema associated apply operation
 263      * @param version target version
 264      */
 265     void seal(final ModificationApplyOperation schema, final Version version) {
 266         clearSnapshot();
 267         writtenOriginal = null;
 268
 269         switch (operation) {
 270             case TOUCH:
 271                 // A TOUCH node without any children is a no-op
 272                 if (children.isEmpty()) {
 273                     updateOperationType(LogicalOperation.NONE);
 274                 }
 275                 break;
 276             case WRITE:
 277                 // A WRITE can collapse all of its children
 278                 if (!children.isEmpty()) {
 279                     value = schema.apply(this, getOriginal(), version).map(TreeNode::getData).orElse(null);
 280                     children.clear();
 281                 }
 282
 283                 if (value == null) {
 284                     // The write has ended up being empty, such as a write of an empty list.
 285                     updateOperationType(LogicalOperation.DELETE);
 286                 } else {
 287                     schema.fullVerifyStructure(value);
 288                 }
 289                 break;
 290             default:
 291                 break;
 292         }
 293     }
 294
 295     private void clearSnapshot() {
 296         snapshotCache = null;
 297     }
 298
 299     Optional<TreeNode> getSnapshot() {
 300         return snapshotCache;
 301     }
 302
 303     Optional<TreeNode> setSnapshot(final Optional<TreeNode> snapshot) {
 304         snapshotCache = requireNonNull(snapshot);
 305         return snapshot;
 306     }
 307
 308     void updateOperationType(final LogicalOperation type) {
 309         operation = type;
 310         modType = null;
 311
 312         // Make sure we do not reuse previously-instantiated data-derived metadata
 313         writtenOriginal = null;
 314         clearSnapshot();
 315     }
 316
 317     @Override
 318     public String toString() {
 319         final ToStringHelper helper = MoreObjects.toStringHelper(this).omitNullValues()
 320                 .add("identifier", identifier).add("operation", operation).add("modificationType", modType);
 321         if (!children.isEmpty()) {
 322             helper.add("childModification", children);
 323         }
 324         return helper.toString();
 325     }
 326
 327     void resolveModificationType(final @NonNull ModificationType type) {
 328         modType = type;
 329     }
 330
 331     /**
 332      * Update this node's value and operation type without disturbing any of its child modifications.
 333      *
 334      * @param type New operation type
 335      * @param newValue New node value
 336      */
 337     void updateValue(final LogicalOperation type, final NormalizedNode<?, ?> newValue) {
 338         this.value = requireNonNull(newValue);
 339         updateOperationType(type);
 340     }
 341
 342     /**
 343      * Return the physical modification done to data. May return null if the
 344      * operation has not been applied to the underlying tree. This is different
 345      * from the logical operation in that it can actually be a no-op if the
 346      * operation has no side-effects (like an empty merge on a container).
 347      *
 348      * @return Modification type.
 349      */
 350     ModificationType getModificationType() {
 351         return modType;
 352     }
 353
 354     public static ModifiedNode createUnmodified(final TreeNode metadataTree, final ChildTrackingPolicy childPolicy) {
 355         return new ModifiedNode(metadataTree.getIdentifier(), Optional.of(metadataTree), childPolicy);
 356     }
 357
 358     void setValidatedNode(final ModificationApplyOperation op, final Optional<? extends TreeNode> current,
 359             final Optional<? extends TreeNode> node) {
 360         this.validatedOp = requireNonNull(op);
 361         this.validatedCurrent = requireNonNull(current);
 362         this.validatedNode = requireNonNull(node);
 363     }
 364
 365     Optional<? extends TreeNode> getValidatedNode(final ModificationApplyOperation op,
 366             final Optional<? extends TreeNode> current) {
 367         return op.equals(validatedOp) && current.equals(validatedCurrent) ? validatedNode : null;
 368     }
 369 }