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;
11 import com.google.common.base.Optional;
12 import com.google.common.collect.ImmutableMap;
13 import com.google.common.collect.Iterables;
15 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
16 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetNode;
17 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
18 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
19 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodeContainer;
20 import org.opendaylight.yangtools.yang.data.api.schema.OrderedLeafSetNode;
21 import org.opendaylight.yangtools.yang.data.api.schema.OrderedMapNode;
22 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataValidationFailedException;
23 import org.opendaylight.yangtools.yang.data.api.schema.tree.ModifiedNodeDoesNotExistException;
24 import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.MutableTreeNode;
25 import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.TreeNode;
26 import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.TreeNodeFactory;
27 import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.Version;
28 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
29 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeContainerBuilder;
30 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableChoiceNodeBuilder;
31 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafSetNodeBuilder;
32 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapNodeBuilder;
33 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableOrderedLeafSetNodeBuilder;
34 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableOrderedMapNodeBuilder;
35 import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
36 import org.opendaylight.yangtools.yang.model.api.ChoiceNode;
37 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
38 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
39 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
41 abstract class NormalizedNodeContainerModificationStrategy extends SchemaAwareApplyOperation {
43 private final Class<? extends NormalizedNode<?, ?>> nodeClass;
45 protected NormalizedNodeContainerModificationStrategy(final Class<? extends NormalizedNode<?, ?>> nodeClass) {
46 this.nodeClass = nodeClass;
50 public void verifyStructure(final ModifiedNode modification) throws IllegalArgumentException {
51 for (ModifiedNode childModification : modification.getChildren()) {
52 resolveChildOperation(childModification.getIdentifier()).verifyStructure(childModification);
56 @SuppressWarnings("rawtypes")
58 protected void verifyWrittenStructure(final NormalizedNode<?, ?> writtenValue) {
59 checkArgument(nodeClass.isInstance(writtenValue), "Node %s is not of type %s", writtenValue, nodeClass);
60 checkArgument(writtenValue instanceof NormalizedNodeContainer);
62 NormalizedNodeContainer container = (NormalizedNodeContainer) writtenValue;
63 for (Object child : container.getValue()) {
64 checkArgument(child instanceof NormalizedNode);
67 * FIXME: fail-fast semantics:
69 * We can validate the data structure here, aborting the commit
70 * before it ever progresses to being committed.
76 protected TreeNode applyWrite(final ModifiedNode modification,
77 final Optional<TreeNode> currentMeta, final Version version) {
78 final NormalizedNode<?, ?> newValue = modification.getWrittenValue();
79 final TreeNode newValueMeta = TreeNodeFactory.createTreeNode(newValue, version);
81 if (Iterables.isEmpty(modification.getChildren())) {
86 * This is where things get interesting. The user has performed a write and
87 * then she applied some more modifications to it. So we need to make sense
88 * of that an apply the operations on top of the written value. We could have
89 * done it during the write, but this operation is potentially expensive, so
90 * we have left it out of the fast path.
92 * As it turns out, once we materialize the written data, we can share the
93 * code path with the subtree change. So let's create an unsealed TreeNode
94 * and run the common parts on it -- which end with the node being sealed.
96 * FIXME: this code needs to be moved out from the prepare() path and into
97 * the read() and seal() paths. Merging of writes needs to be charged
98 * to the code which originated this, not to the code which is
99 * attempting to make it visible.
101 final MutableTreeNode mutable = newValueMeta.mutable();
102 mutable.setSubtreeVersion(version);
104 @SuppressWarnings("rawtypes")
105 final NormalizedNodeContainerBuilder dataBuilder = createBuilder(newValue);
107 return mutateChildren(mutable, dataBuilder, version, modification.getChildren());
111 * Applies write/remove diff operation for each modification child in modification subtree.
112 * Operation also sets the Data tree references for each Tree Node (Index Node) in meta (MutableTreeNode) structure.
114 * @param meta MutableTreeNode (IndexTreeNode)
115 * @param data DataBuilder
116 * @param nodeVersion Version of TreeNode
117 * @param modifications modification operations to apply
118 * @return Sealed immutable copy of TreeNode structure with all Data Node references set.
120 @SuppressWarnings({ "rawtypes", "unchecked" })
121 private TreeNode mutateChildren(final MutableTreeNode meta, final NormalizedNodeContainerBuilder data,
122 final Version nodeVersion, final Iterable<ModifiedNode> modifications) {
124 for (ModifiedNode mod : modifications) {
125 final YangInstanceIdentifier.PathArgument id = mod.getIdentifier();
126 final Optional<TreeNode> cm = meta.getChild(id);
128 Optional<TreeNode> result = resolveChildOperation(id).apply(mod, cm, nodeVersion);
129 if (result.isPresent()) {
130 final TreeNode tn = result.get();
132 data.addChild(tn.getData());
134 meta.removeChild(id);
135 data.removeChild(id);
139 meta.setData(data.build());
144 protected TreeNode applyMerge(final ModifiedNode modification, final TreeNode currentMeta,
145 final Version version) {
146 // For Node Containers - merge is same as subtree change - we only replace children.
147 return applySubtreeChange(modification, currentMeta, version);
151 public TreeNode applySubtreeChange(final ModifiedNode modification,
152 final TreeNode currentMeta, final Version version) {
153 final MutableTreeNode newMeta = currentMeta.mutable();
154 newMeta.setSubtreeVersion(version);
157 * The user has issued an empty merge operation. In this case we do not perform
158 * a data tree mutation, do not pass GO, and do not collect useless garbage.
160 final Iterable<ModifiedNode> children = modification.getChildren();
161 if (Iterables.isEmpty(children)) {
162 newMeta.setData(currentMeta.getData());
163 return newMeta.seal();
166 @SuppressWarnings("rawtypes")
167 NormalizedNodeContainerBuilder dataBuilder = createBuilder(currentMeta.getData());
169 return mutateChildren(newMeta, dataBuilder, version, children);
173 protected void checkSubtreeModificationApplicable(final YangInstanceIdentifier path, final NodeModification modification,
174 final Optional<TreeNode> current) throws DataValidationFailedException {
175 if (!modification.getOriginal().isPresent() && !current.isPresent()) {
176 throw new ModifiedNodeDoesNotExistException(path, String.format("Node %s does not exist. Cannot apply modification to its children.", path));
179 SchemaAwareApplyOperation.checkConflicting(path, current.isPresent(), "Node was deleted by other transaction.");
180 checkChildPreconditions(path, modification, current);
183 private void checkChildPreconditions(final YangInstanceIdentifier path, final NodeModification modification, final Optional<TreeNode> current) throws DataValidationFailedException {
184 final TreeNode currentMeta = current.get();
185 for (NodeModification childMod : modification.getChildren()) {
186 final YangInstanceIdentifier.PathArgument childId = childMod.getIdentifier();
187 final Optional<TreeNode> childMeta = currentMeta.getChild(childId);
189 YangInstanceIdentifier childPath = path.node(childId);
190 resolveChildOperation(childId).checkApplicable(childPath, childMod, childMeta);
195 protected void checkMergeApplicable(final YangInstanceIdentifier path, final NodeModification modification,
196 final Optional<TreeNode> current) throws DataValidationFailedException {
197 if(current.isPresent()) {
198 checkChildPreconditions(path, modification,current);
202 @SuppressWarnings("rawtypes")
203 protected abstract NormalizedNodeContainerBuilder createBuilder(NormalizedNode<?, ?> original);
205 public static class ChoiceModificationStrategy extends NormalizedNodeContainerModificationStrategy {
207 private final Map<YangInstanceIdentifier.PathArgument, ModificationApplyOperation> childNodes;
209 public ChoiceModificationStrategy(final ChoiceNode schemaNode) {
210 super(org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode.class);
211 ImmutableMap.Builder<YangInstanceIdentifier.PathArgument, ModificationApplyOperation> child = ImmutableMap.builder();
213 for (ChoiceCaseNode caze : schemaNode.getCases()) {
214 for (DataSchemaNode cazeChild : caze.getChildNodes()) {
215 SchemaAwareApplyOperation childNode = SchemaAwareApplyOperation.from(cazeChild);
216 child.put(new YangInstanceIdentifier.NodeIdentifier(cazeChild.getQName()), childNode);
219 childNodes = child.build();
223 public Optional<ModificationApplyOperation> getChild(final YangInstanceIdentifier.PathArgument child) {
224 return Optional.fromNullable(childNodes.get(child));
228 @SuppressWarnings("rawtypes")
229 protected DataContainerNodeBuilder createBuilder(final NormalizedNode<?, ?> original) {
230 checkArgument(original instanceof org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode);
231 return ImmutableChoiceNodeBuilder.create((org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode) original);
235 public static class OrderedLeafSetModificationStrategy extends NormalizedNodeContainerModificationStrategy {
237 private final Optional<ModificationApplyOperation> entryStrategy;
239 @SuppressWarnings({ "unchecked", "rawtypes" })
240 protected OrderedLeafSetModificationStrategy(final LeafListSchemaNode schema) {
241 super((Class) LeafSetNode.class);
242 entryStrategy = Optional.<ModificationApplyOperation> of(new ValueNodeModificationStrategy.LeafSetEntryModificationStrategy(schema));
246 boolean isOrdered() {
250 @SuppressWarnings("rawtypes")
252 protected NormalizedNodeContainerBuilder createBuilder(final NormalizedNode<?, ?> original) {
253 checkArgument(original instanceof OrderedLeafSetNode<?>);
254 return ImmutableOrderedLeafSetNodeBuilder.create((OrderedLeafSetNode<?>) original);
258 public Optional<ModificationApplyOperation> getChild(final YangInstanceIdentifier.PathArgument identifier) {
259 if (identifier instanceof YangInstanceIdentifier.NodeWithValue) {
260 return entryStrategy;
262 return Optional.absent();
266 public static class OrderedMapModificationStrategy extends NormalizedNodeContainerModificationStrategy {
268 private final Optional<ModificationApplyOperation> entryStrategy;
270 protected OrderedMapModificationStrategy(final ListSchemaNode schema) {
271 super(OrderedMapNode.class);
272 entryStrategy = Optional.<ModificationApplyOperation> of(new DataNodeContainerModificationStrategy.ListEntryModificationStrategy(schema));
276 boolean isOrdered() {
280 @SuppressWarnings("rawtypes")
282 protected NormalizedNodeContainerBuilder createBuilder(final NormalizedNode<?, ?> original) {
283 checkArgument(original instanceof OrderedMapNode);
284 return ImmutableOrderedMapNodeBuilder.create((OrderedMapNode) original);
288 public Optional<ModificationApplyOperation> getChild(final YangInstanceIdentifier.PathArgument identifier) {
289 if (identifier instanceof YangInstanceIdentifier.NodeIdentifierWithPredicates) {
290 return entryStrategy;
292 return Optional.absent();
296 public String toString() {
297 return "OrderedMapModificationStrategy [entry=" + entryStrategy + "]";
301 public static class UnorderedLeafSetModificationStrategy extends NormalizedNodeContainerModificationStrategy {
303 private final Optional<ModificationApplyOperation> entryStrategy;
305 @SuppressWarnings({ "unchecked", "rawtypes" })
306 protected UnorderedLeafSetModificationStrategy(final LeafListSchemaNode schema) {
307 super((Class) LeafSetNode.class);
308 entryStrategy = Optional.<ModificationApplyOperation> of(new ValueNodeModificationStrategy.LeafSetEntryModificationStrategy(schema));
311 @SuppressWarnings("rawtypes")
313 protected NormalizedNodeContainerBuilder createBuilder(final NormalizedNode<?, ?> original) {
314 checkArgument(original instanceof LeafSetNode<?>);
315 return ImmutableLeafSetNodeBuilder.create((LeafSetNode<?>) original);
319 public Optional<ModificationApplyOperation> getChild(final YangInstanceIdentifier.PathArgument identifier) {
320 if (identifier instanceof YangInstanceIdentifier.NodeWithValue) {
321 return entryStrategy;
323 return Optional.absent();
327 public static class UnorderedMapModificationStrategy extends NormalizedNodeContainerModificationStrategy {
329 private final Optional<ModificationApplyOperation> entryStrategy;
331 protected UnorderedMapModificationStrategy(final ListSchemaNode schema) {
332 super(MapNode.class);
333 entryStrategy = Optional.<ModificationApplyOperation> of(new DataNodeContainerModificationStrategy.ListEntryModificationStrategy(schema));
336 @SuppressWarnings("rawtypes")
338 protected NormalizedNodeContainerBuilder createBuilder(final NormalizedNode<?, ?> original) {
339 checkArgument(original instanceof MapNode);
340 return ImmutableMapNodeBuilder.create((MapNode) original);
344 public Optional<ModificationApplyOperation> getChild(final YangInstanceIdentifier.PathArgument identifier) {
345 if (identifier instanceof YangInstanceIdentifier.NodeIdentifierWithPredicates) {
346 return entryStrategy;
348 return Optional.absent();
352 public String toString() {
353 return "UnorderedMapModificationStrategy [entry=" + entryStrategy + "]";