Populate data/ hierarchy
[yangtools.git] / data / yang-data-impl / src / main / java / org / opendaylight / yangtools / yang / data / impl / schema / tree / ChoiceModificationStrategy.java
diff --git a/data/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/tree/ChoiceModificationStrategy.java b/data/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/tree/ChoiceModificationStrategy.java
new file mode 100644 (file)
index 0000000..c2f128d
--- /dev/null
@@ -0,0 +1,164 @@
+/*
+ * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.opendaylight.yangtools.yang.data.impl.schema.tree;
+
+import com.google.common.base.Preconditions;
+import com.google.common.base.Predicates;
+import com.google.common.base.Verify;
+import com.google.common.collect.Collections2;
+import com.google.common.collect.ImmutableList;
+import com.google.common.collect.ImmutableMap;
+import com.google.common.collect.ImmutableMap.Builder;
+import java.util.Collection;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.Map.Entry;
+import java.util.Optional;
+import org.eclipse.jdt.annotation.NonNull;
+import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
+import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
+import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
+import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
+import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
+import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
+import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodes;
+import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeConfiguration;
+import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
+import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableChoiceNodeBuilder;
+import org.opendaylight.yangtools.yang.data.impl.schema.tree.AbstractNodeContainerModificationStrategy.Visible;
+import org.opendaylight.yangtools.yang.data.spi.tree.TreeNode;
+import org.opendaylight.yangtools.yang.data.spi.tree.Version;
+import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.CaseSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
+
+final class ChoiceModificationStrategy extends Visible<ChoiceSchemaNode> {
+    private static final NormalizedNodeContainerSupport<NodeIdentifier, ChoiceNode> SUPPORT =
+            new NormalizedNodeContainerSupport<>(ChoiceNode.class, ImmutableChoiceNodeBuilder::create,
+                    ImmutableChoiceNodeBuilder::create);
+
+    private final ImmutableMap<PathArgument, ModificationApplyOperation> childNodes;
+    // FIXME: enforce leaves not coming from two case statements at the same time
+    private final ImmutableMap<CaseEnforcer, Collection<CaseEnforcer>> exclusions;
+    private final ImmutableMap<PathArgument, CaseEnforcer> caseEnforcers;
+    private final @NonNull ChoiceNode emptyNode;
+
+    ChoiceModificationStrategy(final ChoiceSchemaNode schema, final DataTreeConfiguration treeConfig) {
+        super(SUPPORT, treeConfig, schema);
+
+        final Builder<PathArgument, ModificationApplyOperation> childBuilder = ImmutableMap.builder();
+        final Builder<PathArgument, CaseEnforcer> enforcerBuilder = ImmutableMap.builder();
+        for (final CaseSchemaNode caze : schema.getCases()) {
+            final CaseEnforcer enforcer = CaseEnforcer.forTree(caze, treeConfig);
+            if (enforcer != null) {
+                for (final Entry<NodeIdentifier, DataSchemaNode> entry : enforcer.getChildEntries()) {
+                    final ModificationApplyOperation childOper;
+                    try {
+                        childOper = SchemaAwareApplyOperation.from(entry.getValue(), treeConfig);
+                    } catch (ExcludedDataSchemaNodeException e) {
+                        // This should never happen as enforcer performs filtering
+                        throw new IllegalStateException("Enforcer references out-of-tree child " + entry, e);
+                    }
+
+                    childBuilder.put(entry.getKey(), childOper);
+                    enforcerBuilder.put(entry.getKey(), enforcer);
+                }
+                for (final Entry<AugmentationIdentifier, AugmentationSchemaNode> e
+                        : enforcer.getAugmentationEntries()) {
+                    childBuilder.put(e.getKey(), new AugmentationModificationStrategy(e.getValue(), caze, treeConfig));
+                    enforcerBuilder.put(e.getKey(), enforcer);
+                }
+            }
+        }
+        childNodes = childBuilder.build();
+        caseEnforcers = enforcerBuilder.build();
+
+        final Map<CaseEnforcer, Collection<CaseEnforcer>> exclusionsBuilder = new HashMap<>();
+        for (final CaseEnforcer e : caseEnforcers.values()) {
+            exclusionsBuilder.put(e, ImmutableList.copyOf(
+                Collections2.filter(caseEnforcers.values(), Predicates.not(Predicates.equalTo(e)))));
+        }
+        exclusions = ImmutableMap.copyOf(exclusionsBuilder);
+        emptyNode = ImmutableNodes.choiceNode(schema.getQName());
+    }
+
+    @Override
+    Optional<? extends TreeNode> apply(final ModifiedNode modification, final Optional<? extends TreeNode> storeMeta,
+            final Version version) {
+        return AutomaticLifecycleMixin.apply(super::apply, this::applyWrite, emptyNode, modification, storeMeta,
+            version);
+    }
+
+    @Override
+    TreeNode defaultTreeNode() {
+        return defaultTreeNode(emptyNode);
+    }
+
+    @Override
+    public ModificationApplyOperation childByArg(final PathArgument arg) {
+        return childNodes.get(arg);
+    }
+
+    @Override
+    void optionalVerifyValueChildren(final NormalizedNode writtenValue) {
+        enforceCases(writtenValue);
+    }
+
+    private void enforceCases(final TreeNode tree) {
+        enforceCases(tree.getData());
+    }
+
+    private void enforceCases(final NormalizedNode normalizedNode) {
+        Verify.verify(normalizedNode instanceof ChoiceNode);
+        final Collection<DataContainerChild> children = ((ChoiceNode) normalizedNode).body();
+        if (!children.isEmpty()) {
+            final DataContainerChild firstChild = children.iterator().next();
+            final CaseEnforcer enforcer = Verify.verifyNotNull(caseEnforcers.get(firstChild.getIdentifier()),
+                "Case enforcer cannot be null. Most probably, child node %s of choice node %s does not belong "
+                + "in current tree type.", firstChild.getIdentifier(), normalizedNode.getIdentifier());
+
+            // Make sure no leaves from other cases are present
+            for (final CaseEnforcer other : exclusions.get(enforcer)) {
+                for (final PathArgument id : other.getAllChildIdentifiers()) {
+                    final Optional<NormalizedNode> maybeChild = NormalizedNodes.getDirectChild(normalizedNode,
+                        id);
+                    Preconditions.checkArgument(!maybeChild.isPresent(),
+                        "Child %s (from case %s) implies non-presence of child %s (from case %s), which is %s",
+                        firstChild.getIdentifier(), enforcer, id, other, maybeChild.orElse(null));
+                }
+            }
+
+            // Make sure all mandatory children are present
+            enforcer.enforceOnTreeNode(normalizedNode);
+        }
+    }
+
+    @Override
+    protected TreeNode applyMerge(final ModifiedNode modification, final TreeNode currentMeta, final Version version) {
+        final TreeNode ret = super.applyMerge(modification, currentMeta, version);
+        enforceCases(ret);
+        return ret;
+    }
+
+    @Override
+    protected TreeNode applyWrite(final ModifiedNode modification, final NormalizedNode newValue,
+            final Optional<? extends TreeNode> currentMeta, final Version version) {
+        final TreeNode ret = super.applyWrite(modification, newValue, currentMeta, version);
+        enforceCases(ret);
+        return ret;
+    }
+
+    @Override
+    protected TreeNode applyTouch(final ModifiedNode modification, final TreeNode currentMeta, final Version version) {
+        final TreeNode ret = super.applyTouch(modification, currentMeta, version);
+        enforceCases(ret);
+        return ret;
+    }
+}
+