X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=yang%2Fyang-data-impl%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fyangtools%2Fyang%2Fdata%2Fimpl%2Fschema%2Ftree%2FModifiedNode.java;h=be0ed682adf111f79b9148bdfdb4953fc5045dcc;hb=f3a3253eb4a5033515898723fcee5a9819135729;hp=5e9c0eb268f933ad7b7eccee3cd8b62c0a6ab3ba;hpb=7ca95bff0f46eb67301634210176ec3f59fd0f4e;p=yangtools.git

diff --git a/yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/tree/ModifiedNode.java b/yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/tree/ModifiedNode.java
index 5e9c0eb268..be0ed682ad 100644
--- a/yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/tree/ModifiedNode.java
+++ b/yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/tree/ModifiedNode.java
@@ -10,74 +10,66 @@ package org.opendaylight.yangtools.yang.data.impl.schema.tree;
 import com.google.common.base.Optional;
 import com.google.common.base.Preconditions;
 import com.google.common.base.Predicate;
-import java.util.HashMap;
-import java.util.Iterator;
-import java.util.LinkedHashMap;
+import java.util.Collection;
 import java.util.Map;
 import javax.annotation.Nonnull;
 import javax.annotation.concurrent.NotThreadSafe;
-import org.opendaylight.yangtools.concepts.Identifiable;
 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
+import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodeContainer;
 import org.opendaylight.yangtools.yang.data.api.schema.tree.ModificationType;
 import org.opendaylight.yangtools.yang.data.api.schema.tree.StoreTreeNode;
 import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.TreeNode;
+import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.TreeNodeFactory;
+import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.Version;
 
 /**
  * Node Modification Node and Tree
  *
- * Tree which structurally resembles data tree and captures client modifications
- * to the data store tree.
+ * Tree which structurally resembles data tree and captures client modifications to the data store tree. This tree is
+ * lazily created and populated via {@link #modifyChild(PathArgument)} and {@link TreeNode} which represents original
+ * state as tracked by {@link #getOriginal()}.
  *
- * This tree is lazily created and populated via {@link #modifyChild(PathArgument)}
- * and {@link StoreMetadataNode} which represents original state {@link #getOriginal()}.
+ * The contract is that the state information exposed here preserves the temporal ordering of whatever modifications
+ * were executed. A child's effects pertain to data node as modified by its ancestors. This means that in order to
+ * reconstruct the effective data node presentation, it is sufficient to perform a depth-first pre-order traversal of
+ * the tree.
  */
 @NotThreadSafe
 final class ModifiedNode extends NodeModification implements StoreTreeNode<ModifiedNode> {
-
-    public static final Predicate<ModifiedNode> IS_TERMINAL_PREDICATE = new Predicate<ModifiedNode>() {
+    static final Predicate<ModifiedNode> IS_TERMINAL_PREDICATE = new Predicate<ModifiedNode>() {
         @Override
-        public boolean apply(final @Nonnull ModifiedNode input) {
+        public boolean apply(@Nonnull final ModifiedNode input) {
             Preconditions.checkNotNull(input);
-            switch (input.getType()) {
+            switch (input.getOperation()) {
             case DELETE:
             case MERGE:
             case WRITE:
                 return true;
-            case SUBTREE_MODIFIED:
-            case UNMODIFIED:
+            case TOUCH:
+            case NONE:
                 return false;
             }
 
-            throw new IllegalArgumentException(String.format("Unhandled modification type %s", input.getType()));
+            throw new IllegalArgumentException(String.format("Unhandled modification type %s", input.getOperation()));
         }
     };
 
     private final Map<PathArgument, ModifiedNode> children;
     private final Optional<TreeNode> original;
     private final PathArgument identifier;
-    private ModificationType modificationType = ModificationType.UNMODIFIED;
+    private LogicalOperation operation = LogicalOperation.NONE;
     private Optional<TreeNode> snapshotCache;
     private NormalizedNode<?, ?> value;
+    private ModificationType modType;
+
+    // Alternative history introduced in WRITE nodes. Instantiated when we touch any child underneath such a node.
+    private TreeNode writtenOriginal;
 
-    private ModifiedNode(final PathArgument identifier, final Optional<TreeNode> original, final boolean isOrdered) {
+    private ModifiedNode(final PathArgument identifier, final Optional<TreeNode> original, final ChildTrackingPolicy childPolicy) {
         this.identifier = identifier;
         this.original = original;
-
-        if (isOrdered) {
-            children = new LinkedHashMap<>();
-        } else {
-            children = new HashMap<>();
-        }
-    }
-
-    /**
-     *
-     *
-     * @return
-     */
-    public NormalizedNode<?, ?> getWrittenValue() {
-        return value;
+        this.children = childPolicy.createMap();
     }
 
     @Override
@@ -85,24 +77,26 @@ final class ModifiedNode extends NodeModification implements StoreTreeNode<Modif
         return identifier;
     }
 
-    /**
-     *
-     * Returns original store metadata
-     * @return original store metadata
-     */
+    @Override
+    LogicalOperation getOperation() {
+        return operation;
+    }
+
     @Override
     Optional<TreeNode> getOriginal() {
         return original;
     }
 
     /**
-     * Returns modification type
+     * Return the value which was written to this node. The returned object is only valid for
+     * {@link LogicalOperation#MERGE} and {@link LogicalOperation#WRITE}.
+     * operations. It should only be consulted when this modification is going to end up being
+     * {@link ModificationType#WRITE}.
      *
-     * @return modification type
+     * @return Currently-written value
      */
-    @Override
-    ModificationType getType() {
-        return modificationType;
+    NormalizedNode<?, ?> getWrittenValue() {
+        return value;
     }
 
     /**
@@ -118,68 +112,121 @@ final class ModifiedNode extends NodeModification implements StoreTreeNode<Modif
         return Optional.<ModifiedNode> fromNullable(children.get(child));
     }
 
+    private Optional<TreeNode> metadataFromSnapshot(@Nonnull final PathArgument child) {
+        return original.isPresent() ? original.get().getChild(child) : Optional.<TreeNode>absent();
+    }
+
+    private Optional<TreeNode> metadataFromData(@Nonnull final PathArgument child, final Version modVersion) {
+        if (writtenOriginal == null) {
+            // Lazy instantiation, as we do not want do this for all writes. We are using the modification's version
+            // here, as that version is what the SchemaAwareApplyOperation will see when dealing with the resulting
+            // modifications.
+            writtenOriginal = TreeNodeFactory.createTreeNode(value, modVersion);
+        }
+
+        return writtenOriginal.getChild(child);
+    }
+
     /**
+     * Determine the base tree node we are going to apply the operation to. This is not entirely trivial because
+     * both DELETE and WRITE operations unconditionally detach their descendants from the original snapshot, so we need
+     * to take the current node's operation into account.
      *
-     * Returns child modification if child was modified, creates {@link org.opendaylight.controller.md.sal.dom.store.impl.tree.data.ModifiedNode}
+     * @param child Child we are looking to modify
+     * @param modVersion Version allocated by the calling {@link InMemoryDataTreeModification}
+     * @return Before-image tree node as observed by that child.
+     */
+    private Optional<TreeNode> findOriginalMetadata(@Nonnull final PathArgument child, final Version modVersion) {
+        switch (operation) {
+        case DELETE:
+            // DELETE implies non-presence
+            return Optional.absent();
+        case NONE:
+        case TOUCH:
+        case MERGE:
+            return metadataFromSnapshot(child);
+        case WRITE:
+            // WRITE implies presence based on written data
+            return metadataFromData(child, modVersion);
+        }
+
+        throw new IllegalStateException("Unhandled node operation " + operation);
+    }
+
+    /**
+     *
+     * Returns child modification if child was modified, creates {@link ModifiedNode}
      * for child otherwise.
      *
      * If this node's {@link ModificationType} is {@link ModificationType#UNMODIFIED}
      * changes modification type to {@link ModificationType#SUBTREE_MODIFIED}
      *
-     * @param child
-     * @return {@link org.opendaylight.controller.md.sal.dom.store.impl.tree.data.ModifiedNode} for specified child, with {@link #getOriginal()}
+     * @param child child identifier, may not be null
+     * @param childPolicy child tracking policy for the node we are looking for
+     * @param modVersion Version allocated by the calling {@link InMemoryDataTreeModification}
+     * @return {@link ModifiedNode} for specified child, with {@link #getOriginal()}
      *         containing child metadata if child was present in original data.
      */
-    public ModifiedNode modifyChild(final PathArgument child, final boolean isOrdered) {
+    ModifiedNode modifyChild(@Nonnull final PathArgument child, @Nonnull final ChildTrackingPolicy childPolicy,
+            @Nonnull final Version modVersion) {
         clearSnapshot();
-        if (modificationType == ModificationType.UNMODIFIED) {
-            updateModificationType(ModificationType.SUBTREE_MODIFIED);
+        if (operation == LogicalOperation.NONE) {
+            updateOperationType(LogicalOperation.TOUCH);
         }
         final ModifiedNode potential = children.get(child);
         if (potential != null) {
             return potential;
         }
 
-        final Optional<TreeNode> currentMetadata;
-        if (original.isPresent()) {
-            final TreeNode orig = original.get();
-            currentMetadata = orig.getChild(child);
-        } else {
-            currentMetadata = Optional.absent();
+        final Optional<TreeNode> currentMetadata = findOriginalMetadata(child, modVersion);
+
+
+        final ModifiedNode newlyCreated = new ModifiedNode(child, currentMetadata, childPolicy);
+        if (operation == LogicalOperation.MERGE && value != null) {
+            /*
+             * We are attempting to modify a previously-unmodified part of a MERGE node. If the
+             * value contains this component, we need to materialize it as a MERGE modification.
+             */
+            @SuppressWarnings({ "rawtypes", "unchecked" })
+            final Optional<NormalizedNode<?, ?>> childData = ((NormalizedNodeContainer)value).getChild(child);
+            if (childData.isPresent()) {
+                newlyCreated.updateValue(LogicalOperation.MERGE, childData.get());
+            }
         }
 
-        ModifiedNode newlyCreated = new ModifiedNode(child, currentMetadata, isOrdered);
         children.put(child, newlyCreated);
         return newlyCreated;
     }
 
     /**
-     *
      * Returns all recorded direct child modification
      *
      * @return all recorded direct child modifications
      */
     @Override
-    Iterable<ModifiedNode> getChildren() {
+    Collection<ModifiedNode> getChildren() {
         return children.values();
     }
 
     /**
-     *
      * Records a delete for associated node.
-     *
      */
-    public void delete() {
-        final ModificationType newType;
+    void delete() {
+        final LogicalOperation newType;
 
-        switch (modificationType) {
+        switch (operation) {
         case DELETE:
-        case UNMODIFIED:
+        case NONE:
             // We need to record this delete.
-            newType = ModificationType.DELETE;
+            newType = LogicalOperation.DELETE;
             break;
         case MERGE:
-        case SUBTREE_MODIFIED:
+                // In case of merge - delete needs to be recored and must not to be changed into
+                // NONE, because lazy expansion of parent MERGE node would reintroduce it
+                // again.
+                newType = LogicalOperation.DELETE;
+                break;
+        case TOUCH:
         case WRITE:
             /*
              * We are canceling a previous modification. This is a bit tricky,
@@ -189,60 +236,55 @@ final class ModifiedNode extends NodeModification implements StoreTreeNode<Modif
              * As documented in BUG-2470, a delete of data introduced in this
              * transaction needs to be turned into a no-op.
              */
-            newType = original.isPresent() ? ModificationType.DELETE : ModificationType.UNMODIFIED;
+            newType = original.isPresent() ? LogicalOperation.DELETE : LogicalOperation.NONE;
             break;
         default:
-            throw new IllegalStateException("Unhandled deletion of node with " + modificationType);
+            throw new IllegalStateException("Unhandled deletion of node with " + operation);
         }
 
         clearSnapshot();
         children.clear();
         this.value = null;
-        updateModificationType(newType);
+        updateOperationType(newType);
     }
 
     /**
-     *
      * Records a write for associated node.
      *
      * @param value
      */
-    public void write(final NormalizedNode<?, ?> value) {
-        clearSnapshot();
-        updateModificationType(ModificationType.WRITE);
+    void write(final NormalizedNode<?, ?> value) {
+        updateValue(LogicalOperation.WRITE, value);
         children.clear();
-        this.value = value;
-    }
-
-    public void merge(final NormalizedNode<?, ?> data) {
-        clearSnapshot();
-        updateModificationType(ModificationType.MERGE);
-        // FIXME: Probably merge with previous value.
-        this.value = data;
     }
 
     /**
-     * Seal the modification node and prune any children which has not been
-     * modified.
+     * Seal the modification node and prune any children which has not been modified.
+     *
+     * @param schema
      */
-    void seal() {
+    void seal(final ModificationApplyOperation schema, final Version version) {
         clearSnapshot();
-
-        // Walk all child nodes and remove any children which have not
-        // been modified.
-        final Iterator<ModifiedNode> it = children.values().iterator();
-        while (it.hasNext()) {
-            final ModifiedNode child = it.next();
-            child.seal();
-
-            if (child.modificationType == ModificationType.UNMODIFIED) {
-                it.remove();
-            }
-        }
-
-        // A SUBTREE_MODIFIED node without any children is a no-op
-        if (modificationType == ModificationType.SUBTREE_MODIFIED && children.isEmpty()) {
-            updateModificationType(ModificationType.UNMODIFIED);
+        writtenOriginal = null;
+
+        switch (operation) {
+            case TOUCH:
+                // A TOUCH node without any children is a no-op
+                if (children.isEmpty()) {
+                    updateOperationType(LogicalOperation.NONE);
+                }
+                break;
+            case WRITE:
+                // A WRITE can collapse all of its children
+                if (!children.isEmpty()) {
+                    value = schema.apply(this, getOriginal(), version).get().getData();
+                    children.clear();
+                }
+
+                schema.verifyStructure(value, true);
+                break;
+            default:
+                break;
         }
     }
 
@@ -259,31 +301,49 @@ final class ModifiedNode extends NodeModification implements StoreTreeNode<Modif
         return snapshot;
     }
 
-    private void updateModificationType(final ModificationType type) {
-        modificationType = type;
+    void updateOperationType(final LogicalOperation type) {
+        operation = type;
+        modType = null;
+
+        // Make sure we do not reuse previously-instantiated data-derived metadata
+        writtenOriginal = null;
         clearSnapshot();
     }
 
     @Override
     public String toString() {
         return "NodeModification [identifier=" + identifier + ", modificationType="
-                + modificationType + ", childModification=" + children + "]";
+                + operation + ", childModification=" + children + "]";
+    }
+
+    void resolveModificationType(@Nonnull final ModificationType type) {
+        modType = type;
+    }
+
+    /**
+     * Update this node's value and operation type without disturbing any of its child modifications.
+     *
+     * @param type New operation type
+     * @param value New node value
+     */
+    void updateValue(final LogicalOperation type, final NormalizedNode<?, ?> value) {
+        this.value = Preconditions.checkNotNull(value);
+        updateOperationType(type);
     }
 
     /**
-     * Create a node which will reflect the state of this node, except it will behave as newly-written
-     * value. This is useful only for merge validation.
+     * Return the physical modification done to data. May return null if the
+     * operation has not been applied to the underlying tree. This is different
+     * from the logical operation in that it can actually be a no-op if the
+     * operation has no side-effects (like an empty merge on a container).
      *
-     * @param value Value associated with the node
-     * @return An isolated node. This node should never reach a datatree.
+     * @return Modification type.
      */
-    ModifiedNode asNewlyWritten(final NormalizedNode<?, ?> value) {
-        final ModifiedNode ret = new ModifiedNode(getIdentifier(), Optional.<TreeNode>absent(), false);
-        ret.write(value);
-        return ret;
+    ModificationType getModificationType() {
+        return modType;
     }
 
-    public static ModifiedNode createUnmodified(final TreeNode metadataTree, final boolean isOrdered) {
-        return new ModifiedNode(metadataTree.getIdentifier(), Optional.of(metadataTree), isOrdered);
+    public static ModifiedNode createUnmodified(final TreeNode metadataTree, final ChildTrackingPolicy childPolicy) {
+        return new ModifiedNode(metadataTree.getIdentifier(), Optional.of(metadataTree), childPolicy);
     }
 }