yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/tree/UnkeyedListModificationStrategy.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 com.google.common.base.Optional;
  11 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  12 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  13 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  14 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  15 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListEntryNode;
  16 import org.opendaylight.yangtools.yang.data.api.schema.tree.IncorrectDataStructureException;
  17 import org.opendaylight.yangtools.yang.data.api.schema.tree.TreeType;
  18 import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.MutableTreeNode;
  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.builder.api.NormalizedNodeContainerBuilder;
  23 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableUnkeyedListEntryNodeBuilder;
  24 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  25
  26 final class UnkeyedListModificationStrategy extends SchemaAwareApplyOperation {
  27
  28     private final Optional<ModificationApplyOperation> entryStrategy;
  29
  30     UnkeyedListModificationStrategy(final ListSchemaNode schema, final TreeType treeType) {
  31         entryStrategy = Optional.<ModificationApplyOperation> of(new UnkeyedListItemModificationStrategy(schema, treeType));
  32     }
  33
  34     @Override
  35     protected ChildTrackingPolicy getChildPolicy() {
  36         return ChildTrackingPolicy.ORDERED;
  37     }
  38
  39     @Override
  40     protected TreeNode applyMerge(final ModifiedNode modification, final TreeNode currentMeta, final Version version) {
  41         // A merge operation is promoted into a write
  42         return applyWrite(modification, Optional.of(currentMeta), version);
  43     }
  44
  45     @Override
  46     protected TreeNode applyTouch(final ModifiedNode modification,
  47             final TreeNode currentMeta, final Version version) {
  48         throw new UnsupportedOperationException("UnkeyedList does not support subtree change.");
  49     }
  50
  51     @Override
  52     protected TreeNode applyWrite(final ModifiedNode modification,
  53             final Optional<TreeNode> currentMeta, final Version version) {
  54         final NormalizedNode<?, ?> newValue = modification.getWrittenValue();
  55         final TreeNode newValueMeta = TreeNodeFactory.createTreeNode(newValue, version);
  56
  57         if (modification.getChildren().isEmpty()) {
  58             return newValueMeta;
  59         }
  60
  61         /*
  62          * This is where things get interesting. The user has performed a write and
  63          * then she applied some more modifications to it. So we need to make sense
  64          * of that an apply the operations on top of the written value. We could have
  65          * done it during the write, but this operation is potentially expensive, so
  66          * we have left it out of the fast path.
  67          *
  68          * As it turns out, once we materialize the written data, we can share the
  69          * code path with the subtree change. So let's create an unsealed TreeNode
  70          * and run the common parts on it -- which end with the node being sealed.
  71          */
  72         final MutableTreeNode mutable = newValueMeta.mutable();
  73         mutable.setSubtreeVersion(version);
  74
  75         @SuppressWarnings("rawtypes")
  76         final NormalizedNodeContainerBuilder dataBuilder = ImmutableUnkeyedListEntryNodeBuilder
  77             .create((UnkeyedListEntryNode) newValue);
  78
  79         return mutateChildren(mutable, dataBuilder, version, modification.getChildren());
  80     }
  81
  82     /**
  83      * Applies write/remove diff operation for each modification child in modification subtree.
  84      * Operation also sets the Data tree references for each Tree Node (Index Node) in meta (MutableTreeNode) structure.
  85      *
  86      * @param meta MutableTreeNode (IndexTreeNode)
  87      * @param data DataBuilder
  88      * @param nodeVersion Version of TreeNode
  89      * @param modifications modification operations to apply
  90      * @return Sealed immutable copy of TreeNode structure with all Data Node references set.
  91      */
  92     @SuppressWarnings({ "rawtypes", "unchecked" })
  93     private TreeNode mutateChildren(final MutableTreeNode meta, final NormalizedNodeContainerBuilder data,
  94         final Version nodeVersion, final Iterable<ModifiedNode> modifications) {
  95
  96         for (final ModifiedNode mod : modifications) {
  97             final PathArgument id = mod.getIdentifier();
  98             final Optional<TreeNode> cm = meta.getChild(id);
  99
 100             final Optional<TreeNode> result = resolveChildOperation(id).apply(mod, cm, nodeVersion);
 101             if (result.isPresent()) {
 102                 final TreeNode tn = result.get();
 103                 meta.addChild(tn);
 104                 data.addChild(tn.getData());
 105             } else {
 106                 meta.removeChild(id);
 107                 data.removeChild(id);
 108             }
 109         }
 110
 111         meta.setData(data.build());
 112         return meta.seal();
 113     }
 114
 115     @Override
 116     public Optional<ModificationApplyOperation> getChild(final PathArgument child) {
 117         if (child instanceof NodeIdentifier) {
 118             return entryStrategy;
 119         }
 120         return Optional.absent();
 121     }
 122
 123     @Override
 124     protected void verifyStructure(final NormalizedNode<?, ?> writtenValue, final boolean verifyChildren) {
 125
 126     }
 127
 128     @Override
 129     void recursivelyVerifyStructure(NormalizedNode<?, ?> value) {
 130         // NOOP
 131     }
 132
 133     @Override
 134     protected void checkTouchApplicable(final YangInstanceIdentifier path, final NodeModification modification,
 135             final Optional<TreeNode> current) throws IncorrectDataStructureException {
 136         throw new IncorrectDataStructureException(path, "Subtree modification is not allowed.");
 137     }
 138
 139     @Override
 140     void mergeIntoModifiedNode(final ModifiedNode node, final NormalizedNode<?, ?> value, final Version version) {
 141         // Unkeyed lists are always replaced
 142         node.write(value);
 143     }
 144 }