2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.yangtools.yang.data.impl.schema.tree;
10 import static com.google.common.base.Preconditions.checkArgument;
12 import com.google.common.base.Preconditions;
13 import com.google.common.base.Predicates;
14 import com.google.common.base.Verify;
15 import com.google.common.collect.Collections2;
16 import com.google.common.collect.ImmutableList;
17 import com.google.common.collect.ImmutableMap;
18 import com.google.common.collect.ImmutableMap.Builder;
19 import java.util.Collection;
20 import java.util.HashMap;
22 import java.util.Map.Entry;
23 import java.util.Optional;
24 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
25 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
26 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
27 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
28 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
29 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
30 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodes;
31 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeConfiguration;
32 import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.TreeNode;
33 import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.Version;
34 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
35 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableChoiceNodeBuilder;
36 import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
37 import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
38 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
39 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
41 final class ChoiceModificationStrategy extends AbstractNodeContainerModificationStrategy {
42 private final Map<PathArgument, ModificationApplyOperation> childNodes;
43 // FIXME: enforce leaves not coming from two case statements at the same time
44 private final Map<CaseEnforcer, Collection<CaseEnforcer>> exclusions;
45 private final Map<PathArgument, CaseEnforcer> caseEnforcers;
47 ChoiceModificationStrategy(final ChoiceSchemaNode schemaNode, final DataTreeConfiguration treeConfig) {
48 super(ChoiceNode.class, treeConfig);
50 final Builder<PathArgument, ModificationApplyOperation> childBuilder = ImmutableMap.builder();
51 final Builder<PathArgument, CaseEnforcer> enforcerBuilder = ImmutableMap.builder();
52 for (final ChoiceCaseNode caze : schemaNode.getCases().values()) {
53 final CaseEnforcer enforcer = CaseEnforcer.forTree(caze, treeConfig);
54 if (enforcer != null) {
55 for (final Entry<NodeIdentifier, DataSchemaNode> e : enforcer.getChildEntries()) {
56 childBuilder.put(e.getKey(), SchemaAwareApplyOperation.from(e.getValue(), treeConfig));
57 enforcerBuilder.put(e.getKey(), enforcer);
59 for (final Entry<AugmentationIdentifier, AugmentationSchemaNode> e
60 : enforcer.getAugmentationEntries()) {
61 childBuilder.put(e.getKey(), new AugmentationModificationStrategy(e.getValue(), caze, treeConfig));
62 enforcerBuilder.put(e.getKey(), enforcer);
66 childNodes = childBuilder.build();
67 caseEnforcers = enforcerBuilder.build();
69 final Map<CaseEnforcer, Collection<CaseEnforcer>> exclusionsBuilder = new HashMap<>();
70 for (final CaseEnforcer e : caseEnforcers.values()) {
71 exclusionsBuilder.put(e, ImmutableList.copyOf(
72 Collections2.filter(caseEnforcers.values(), Predicates.not(Predicates.equalTo(e)))));
74 exclusions = ImmutableMap.copyOf(exclusionsBuilder);
78 public Optional<ModificationApplyOperation> getChild(final PathArgument child) {
79 return Optional.ofNullable(childNodes.get(child));
83 @SuppressWarnings("rawtypes")
84 protected DataContainerNodeBuilder createBuilder(final NormalizedNode<?, ?> original) {
85 checkArgument(original instanceof ChoiceNode);
86 return ImmutableChoiceNodeBuilder.create((ChoiceNode) original);
90 void verifyStructure(final NormalizedNode<?, ?> writtenValue, final boolean verifyChildren) {
91 if (verifyChildrenStructure() && verifyChildren) {
92 enforceCases(writtenValue);
94 super.verifyStructure(writtenValue, verifyChildren);
97 private void enforceCases(final TreeNode tree) {
98 enforceCases(tree.getData());
101 private void enforceCases(final NormalizedNode<?, ?> normalizedNode) {
102 Verify.verify(normalizedNode instanceof ChoiceNode);
103 final Collection<DataContainerChild<?, ?>> children = ((ChoiceNode) normalizedNode).getValue();
104 if (!children.isEmpty()) {
105 final DataContainerChild<?, ?> firstChild = children.iterator().next();
106 final CaseEnforcer enforcer = Verify.verifyNotNull(caseEnforcers.get(firstChild.getIdentifier()),
107 "Case enforcer cannot be null. Most probably, child node %s of choice node %s does not belong "
108 + "in current tree type.", firstChild.getIdentifier(), normalizedNode.getIdentifier());
110 // Make sure no leaves from other cases are present
111 for (final CaseEnforcer other : exclusions.get(enforcer)) {
112 for (final PathArgument id : other.getAllChildIdentifiers()) {
113 final Optional<NormalizedNode<?, ?>> maybeChild = NormalizedNodes.getDirectChild(normalizedNode,
115 Preconditions.checkArgument(!maybeChild.isPresent(),
116 "Child %s (from case %s) implies non-presence of child %s (from case %s), which is %s",
117 firstChild.getIdentifier(), enforcer, id, other, maybeChild.orElse(null));
121 // Make sure all mandatory children are present
122 enforcer.enforceOnTreeNode(normalizedNode);
127 protected TreeNode applyMerge(final ModifiedNode modification, final TreeNode currentMeta, final Version version) {
128 final TreeNode ret = super.applyMerge(modification, currentMeta, version);
134 protected TreeNode applyWrite(final ModifiedNode modification, final Optional<TreeNode> currentMeta,
135 final Version version) {
136 final TreeNode ret = super.applyWrite(modification, currentMeta, version);
142 protected TreeNode applyTouch(final ModifiedNode modification, final TreeNode currentMeta, final Version version) {
143 final TreeNode ret = super.applyTouch(modification, currentMeta, version);
149 protected NormalizedNode<?, ?> createEmptyValue(final NormalizedNode<?, ?> original) {
150 checkArgument(original instanceof ChoiceNode);
151 return ImmutableChoiceNodeBuilder.create().withNodeIdentifier(((ChoiceNode) original).getIdentifier()).build();