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